HPE Comware 7

NETCONF XML API Reference

The information in this document is subject to change without notice.

© Copyright 2019 Hewlett Packard Enterprise Development LP
Contents
ACL·······························································································1
ACL/Groups ······························································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ACL/NamedGroups ···················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
ACL/PfilterApply ························································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
ACL/ZonePairPfilterApply ············································································································ 4
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5

i
ACL
ACL/Groups
This table contains ACL information.

XML structure
<ACL>
<Groups>
<Group>
<GroupType></GroupType>
<GroupID></GroupID>
<CountClear></CountClear>
</Group>
</Groups>
</ACL>

Table description
Item Description
Feature name ACL
Table name Groups
Table type Multi-instance table
Row name Group
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 1—IPv4.
GroupType ACL type. Index • 2—IPv6. N/A
• 3—MAC.
• 4—User-defined.
The value range
depends on the
GroupType column.
Unsigned integer.
GroupID ACL number. Index • 2000 to 5999 if
Value range: 2000 to 5999. GroupType is 1.
• 2000 to 3999 if
GroupType is 2.
CountClear Resets counters. N/A This column must be empty. N/A

1
ACL/NamedGroups
This table contains named ACL information.

XML structure
<ACL>
<NamedGroups>
<Group>
<GroupType></GroupType>
<GroupIndex></GroupIndex>
<CountClear></CountClear>
</Group>
</NamedGroups>
</ACL>

Table description
Item Description
Feature name ACL
Table name NamedGroups
Table type Multi-instance table
Row name Group
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 1—IPv4.
GroupType ACL type. Index • 2—IPv6. N/A
• 3—MAC.
• 4—User-defined.

2
 Column Column Column
Data type and restrictions Remarks
name description type
An ACL name must start
with an English letter
and cannot be all.
String. The value range
Length: 1 to 63 characters. depends on the
GroupType column.
• ACL name:
ACL name or Case-insensitive string of • 2000 to 3999 if
GroupIndex Index
number. 1 to 63 characters. GroupType is 1.
• ACL number: • 2000 to 3999 if
String of digits in the GroupType is 2.
range of 2000 to 5999. • 4000 to 4999 if
GroupType is 3.
• 5000 to 5999 if
GroupType is 4.
CountClear Resets counters. N/A This column must be empty. N/A

ACL/PfilterApply
This table contains packet filter application information.

XML structure
<ACL>
<PfilterApply>
<Pfilter>
<AppObjType></AppObjType>
<AppObjIndex></AppObjIndex>
<AppDirection></AppDirection>
<AppAclType></AppAclType>
<AppAclGroup></AppAclGroup>
<CountClear></CountClear>
</Pfilter>
</PfilterApply>
</ACL>

Table description
Item Description
Feature name ACL
Table name PfilterApply
Table type Multi-instance table
Row name Pfilter
Restrictions None

3
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Enumeration:
Type of the
• 1—Interface.
AppObjType application Index N/A
object. • 2—VLAN.
• 3—Global.
The value depends on the
AppObjType column.
• Interface index if
Index of the Unsigned integer. AppObjType is 1.
AppObjIndex application Index Value range: 0 to • VLAN ID in the range
object. 4294967295. of 1 to 4094 if
AppObjType is 2.
• The value is 0 if
AppObjType is 3.
Enumeration:
Application
AppDirection
direction.
Index • 1—Inbound. N/A
• 2—Outbound.
Enumeration:
• 1—IPv4.
• 2—IPv6.
• 3—Ethernet frame • Type 5 is a special
AppAclType ACL type. Index header ACL. ACL.
• 4—User-defined
ACL.
• 5—ACL with the
default action.
An ACL name must start
String. with an English letter and
Length: 1 to 63 cannot be all.
characters. The value range depends
• ACL name: on the AppAclType column.
Case-insensitive
• 2000 to 3999 if
string of 1 to 63
ACL name or AppAclType is 1.
AppAclGroup Index characters.
number. • 2000 to 3999 if
• ACL number:
AppAclType is 2.
String of digits
valued 0 or in the • 4000 to 4999 if
range of 2000 to AppAclType is 3.
5999. • 5000 to 5999 if
AppAclType is 4.
• 0 if AppAclType is 5.
Resets This column must be
CountClear N/A N/A
counters. empty.

ACL/ZonePairPfilterApply
This table contains packet filter application information for zone-pair.

4
XML structure
<ACL>
<ZonePairPfilterApply>
<Pfilter>
<SrcZone></SrcZone>
<DestZone></DestZone>
<AclType></AclType>
<AclGroup></AclGroup>
<Clear></Clear>
</Pfilter>
</ZonePairPfilterApply>
</ACL>

Table description
Item Description
Feature name ACL
Table name ZonePairPfilterApply
Table type Multi-instance table
Row name Pfilter
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
String, case insensitive.
Name of the
SrcZone
source zone.
Index • Length: 1 to 31 Cannot contain midline( - ).
characters.

Name of the String, case insensitive.

DestZone destination Index • Length: 1 to 31 Cannot contain midline( - ).
zone. characters.
Enumeration:
Type 3 is not supported in
• 1—IPv4 ACL.
the current software
AclType ACL type. Index • 2—IPv6 ACL. version, and is reserved for
• 3—Ethernet frame future support.
header ACL.
An ACL name must start
• ACL name: with an English letter and
Case-insensitive cannot be all.
string of 1 to 63
The value range depends
ACL name or characters.
AclGroup Index on the AppAclType column.
number. • ACL number:
An unsigned integer • 2000 to 5999 if
in the range of 2000 AppAclType is 1.
to 5999. • 2000 to 3999 if
AppAclType is 2.

5
 Column Column Data type and
Column name Remarks
description type restrictions
Resets This column must be
Clear N/A N/A
counters. empty.

6
Contents
ACL·······························································································1
ACL/Groups ······························································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ACL/NamedGroups ···················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
ACL/Intervals ···························································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5
ACL/IPv4BasicRules··················································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6
ACL/IPv4NamedBasicRules ········································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ···························································································································· 9
ACL/IPv6BasicRules················································································································· 10
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 11
ACL/IPv6NamedBasicRules ······································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
ACL/IPv4AdvanceRules ············································································································ 16
XML structure ··················································································································· 16
Table description ··············································································································· 18
Columns ·························································································································· 18
ACL/IPv4NamedAdvanceRules··································································································· 27
XML structure ··················································································································· 28
Table description ··············································································································· 30
Columns ·························································································································· 30
ACL/IPv6AdvanceRules ············································································································ 39
XML structure ··················································································································· 39
Table description ··············································································································· 41
Columns ·························································································································· 41
ACL/IPv6NamedAdvanceRules··································································································· 47
XML structure ··················································································································· 47
Table description ··············································································································· 49
Columns ·························································································································· 49
ACL/MACRules ······················································································································· 55
XML structure ··················································································································· 56
Table description ··············································································································· 57
Columns ·························································································································· 57
ACL/MACNamedRules·············································································································· 60
XML structure ··················································································································· 60
Table description ··············································································································· 61
Columns ·························································································································· 61
ACL/PfilterIgnoreAction ············································································································· 64
XML structure ··················································································································· 64
Table description ··············································································································· 64
Columns ·························································································································· 65

i
ACL/PfilterDefAction ················································································································· 65
XML structure ··················································································································· 65
Table description ··············································································································· 65
Columns ·························································································································· 65
ACL/PfilterApply ······················································································································ 66
XML structure ··················································································································· 66
Table description ··············································································································· 66
Columns ·························································································································· 66
ACL/UserRules ······················································································································· 67
XML structure ··················································································································· 68
Table description ··············································································································· 69
Columns ·························································································································· 69
ACL/UserNamedRules ·············································································································· 74
XML structure ··················································································································· 75
Table description ··············································································································· 76
Columns ·························································································································· 76
ACL/ZonePairPfilterApply ·········································································································· 82
XML structure ··················································································································· 82
Table description ··············································································································· 83
Columns ·························································································································· 83

ii
ACL
ACL/Groups
This table contains ACL information.

XML structure
<ACL>
<Groups>
<Group>
<GroupType></GroupType>
<GroupID></GroupID>
<MatchOrder></MatchOrder>
<Step></Step>
<Name></Name>
<Description></Description>
</Group>
</Groups>
</ACL>

Table description
Item Description
Feature name ACL
Table name Groups
Table type Multi-instance table
Row name Group
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Colum Data type and
Remarks
name description n type restrictions
Enumeration:
• 1—IPv4.
GroupType ACL type Index • 2—IPv6. N/A
• 3—MAC.
• 4—User-defined.

1
 Column Column Colum Data type and
Remarks
name description n type restrictions
The value range depends on the
GroupType column.
• 2000 to 5999 if GroupType is 1.
 IPv4 basic ACL: 2000 to
2999.
 IPv4 advanced ACL: 3000 to
Unsigned integer. 3999.
GroupID ACL number Index  Ethernet frame header ACL:
Value range: 2000 to 4000 to 4999.
5999.
 User-defined ACL: 5000 to
5999.
• 2000 to 3999 if GroupType is 2.
 IPv6 basic ACL: 2000 to
2999.
 IPv6 advanced ACL: 3000 to
3999.
Enumeration:
• 1—Config
(default). In this
order, rules are The match order can only be
Order in which sorted in modified for ACLs that do not contain
MatchOrder the rules are N/A ascending order of any rules.
sorted rule ID. The match order can only be config
• 2—Auto. In this for user-defined ACLs.
order, rules are
sorted in
depth-first order.

ACL rule Unsigned integer.

The rule numbering step for
Step numbering N/A Value range: 1 to 20.
user-defined ACLs can only be 5.
step Default: 5.
String, case-insensitive.
Length: 1 to 63
Name ACL name N/A characters. This column cannot be modified.
The string must start
with an English letter.
String, case-sensitive.
ACL By default, an ACL has no
Description N/A Length: 1 to 127
description description.
characters.

ACL/NamedGroups
This table contains named ACL information.

XML structure
<ACL>
<NamedGroups>
<Group>
<GroupType></GroupType>

2
 <GroupCategory></GroupCategory>
<GroupIndex></GroupIndex>
<MatchOrder></MatchOrder>
<Step></Step>
<Name></Name>
<Description></Description>
</Group>
</NamedGroups>
</ACL>

Table description
Item Description
Feature name ACL
Table name NamedGroups
Table type Multi-instance table
Row name Group
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Colum Data type and
Remarks
name description n type restrictions
Enumeration:
• 1—IPv4.
GroupType ACL type Index • 2—IPv6. N/A
• 3—MAC.
• 4—User-defined.
The value range depends on the
Enumeration: GroupType column.
GroupCateg • 0—invalid. • 1 to 2 if GroupType is 1 or 2.
ACL Category Index
ory • 1—basic.  basic ACL: 1.
• 2—advanced.  advanced ACL: 2.
• 0 if GroupType is 3 or 4.
An ACL name must start with an
String. English letter and cannot be all.
Length: 1 to 63 The GroupIndex cannot be specified
characters. as an ACL name in GET operations
• ACL name: for an ACL created by specifying
Case-insensitive both a number and a name.
ACL name or
GroupIndex Index string of 1 to 63 The value range depends on the
number
characters. GroupType column.
• ACL number: • 2000 to 3999 if GroupType is 1.
String of digits in  IPv4 basic ACL: 2000 to
the range of 2000 2999.
to 5999.
 IPv4 advanced ACL: 3000 to
3999.

3
 Column Column Colum Data type and
Remarks
name description n type restrictions
• 2000 to 3999 if GroupType is 2.
 IPv6 basic ACL: 2000 to
2999.
 IPv6 advanced ACL: 3000 to
3999.
• 4000 to 4999 if GroupType is 3.
 Ethernet frame header ACL:
4000 to 4999.
• 5000 to 5999 if GroupType is 4.
User-defined ACL: 5000 to 5999.
Enumeration:
• 1—Config
(default). In this
order, rules are The match order can only be
Order in which sorted in modified for ACLs that do not contain
MatchOrder the rules are N/A ascending order of any rules.
sorted rule ID. The match order can only be config
• 2—Auto. In this for user-defined ACLs.
order, rules are
sorted in
depth-first order.

ACL rule Unsigned integer.

The rule numbering step for
Step numbering N/A Value range: 1 to 20.
user-defined ACLs can only be 5.
step Default: 5.
String, case-insensitive.
Length: 1 to 63
Name ACL name N/A characters. This column cannot be modified.
The string must start
with an English letter.
String, case-sensitive.
ACL By default, an ACL has no
Description N/A Length: 1 to 127
description description.
characters.

ACL/Intervals
This table contains ACL interval information.

XML structure
<ACL>
<Intervals>
<Interval>
<IntervalType></IntervalType>
<IntervalValue></IntervalValue>
</Interval>
</Intervals>
</ACL>

4
Table description
Item Description
Feature name ACL
Table name Intervals
Table type Multi-instance table
Row name Interval
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name Remarks
description type restrictions
The type of the interval specified
for generating packet filtering
Enumeration: logs or traps.
The type of
IntervalType
the interval
Index • 1—logging. You cannot create, merge, or
• 2—trap. replace an interval when there is
an effective interval of a different
type.
Unsigned integer.
The value of
IntervalValue N/A Value range: 5 to It must be a multiple of 5.
the interval
1440.

ACL/IPv4BasicRules
This table contains information about IPv4 basic ACL rules.

XML structure
<ACL>
<IPv4BasicRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcObjectGroup></SrcObjectGroup>
<Fragment></Fragment>
<TimeRange></TimeRange>

5
 <VRF></VRF>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
</Rule>
</IPv4BasicRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv4BasicRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
You must create an ACL
Unsigned integer. first before you create,
GroupID ACL number. Index
Value range: 2000 to 2999. merge, or replace rules for
it.
If you set this column to
65535, the system
Unsigned integer. automatically assigns a
Value range: 0 to 65535. new rule ID. This rule ID is
RuleID Rule ID. Index
The value 65535 is an invalid the nearest higher
rule ID. multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
action when you remove
Action on or delete a rule.
Enumeration:
packets You must specify an
Action
matching the
N/A • 1—Deny.
action when you replace a
rule. • 2—Permit. rule, or when you merge
or create a rule that does
not exist.
Boolean:

Whether a rule • true—Matches any

source IP addresses This column must be
matches any
SrcAny N/A (default). configured together with
source IP
• false—Matches the the SrcIPv4 column.
addresses.
specified source IP
address.

6
Column Column Column
Data type and restrictions Remarks
name description type
This column must be
Members include: configured together with
Source IPv4 Data the SrcAny column.
SrcIPv4
information. structure • SrcIPv4Addr.
• SrcIPv4Wildcard. The two members must
both be specified.
Example: 1.1.1.1.
This column is available
Source IPv4 String, dotted decimal when the SrcAny column
SrcIPv4Addr N/A
address. notation. is false.
It must be empty when the
SrcAny column is true.
Example: 255.255.255.0.
This column is available
Wildcard mask
SrcIPv4Wildc String, dotted decimal when the SrcAny column
for the source N/A
ard notation. is false.
IPv4 address.
It must be empty when the
SrcAny column is true.

String, case-insensitive. This column and the

SrcObjectGro Source object
N/A SrcAny column cannot
up group name. Length: 1 to 31 characters. both be configured.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments (default).
String, case-insensitive.
Length: 1 to 32 characters.
TimeRange Time range. N/A It cannot be the word all.
The string must start with an
English letter.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.
Boolean:

Whether to • true—Counts the rule

Counting count the rule N/A matches. N/A
matches. • false—Does not count
the rule matches
(default).

7
 Column Column Column
Data type and restrictions Remarks
name description type
Boolean:

Whether to log • true—Logs rule match

Logging rule match N/A events. N/A
events. • false—Does not log
rule match events
(default).
A comment can only be
configured for an existing
rule.
Rule String, case-sensitive.
Comment N/A When the MatchOrder
comment. Length: 1 to 127 characters.
column is 2, you can
modify only the comment
for a rule.

ACL/IPv4NamedBasicRules
This table contains information about namd IPv4 basic ACL rules.

XML structure
<ACL>
<IPv4NamedBasicRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcObjectGroup></SrcObjectGroup>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
</Rule>
</IPv4NamedBasicRules>
</ACL>

8
Table description
Item Description
Feature name ACL
Table name IPv4NamedBasicRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
Length: 1 to 63 characters.
• ACL name: You must create an ACL
ACL name or Case-insensitive string first before you create,
GroupIndex Index
number. of 1 to 63 characters. merge, or replace rules for
• ACL number: it.
String of digits in the
range of 2000 to 2999.
If you set this column to
65535, the system
Unsigned integer. automatically assigns a
Value range: 0 to 65535. new rule ID. This rule ID is
RuleID Rule ID. Index
The value 65535 is an invalid the nearest higher
rule ID. multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
action when you remove
Action on or delete a rule.
Enumeration:
packets You must specify an
Action
matching the
N/A • 1—Deny.
action when you replace a
rule. • 2—Permit. rule, or when you merge
or create a rule that does
not exist.
Boolean:

Whether a rule • true—Matches any

source IP addresses This column must be
matches any
SrcAny N/A (default). configured together with
source IP
• false—Matches the the SrcIPv4 column.
addresses.
specified source IP
address.
This column must be
Members include: configured together with
Source IPv4 Data the SrcAny column.
SrcIPv4
information. structure • SrcIPv4Addr.
• SrcIPv4Wildcard. The two members must
both be specified.

9
 Column Column Column
Data type and restrictions Remarks
name description type
Example: 1.1.1.1.
This column is available
Source IPv4 String, dotted decimal when the SrcAny column
SrcIPv4Addr N/A
address. notation. is false.
It must be empty when the
SrcAny column is true.
Example: 255.255.255.0.
This column is available
Wildcard mask
SrcIPv4Wildc String, dotted decimal when the SrcAny column
for the source N/A
ard notation. is false.
IPv4 address.
It must be empty when the
SrcAny column is true.

String, case-insensitive. This column and the

SrcObjectGro Source object
N/A SrcAny column cannot
up group name.
Length: 1 to 31 characters. both be configured.

Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments (default).
String, case-insensitive.
Length: 1 to 32 characters.
TimeRange Time range. N/A It cannot be the word all.
The string must start with an
English letter.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.
Boolean:

Whether to • true—Counts the rule

Counting count the rule N/A matches. N/A
matches. • false—Does not count
the rule matches
(default).
Boolean:

Whether to log • true—Logs rule match

Logging rule match N/A events. N/A
events. • false—Does not log
rule match events
(default).
A comment can only be
configured for an existing
rule.
Rule String, case-sensitive.
Comment N/A When the MatchOrder
comment. Length: 1 to 127 characters.
column is 2, you can
modify only the comment
for a rule.

ACL/IPv6BasicRules
10
 This table contains information about IPv6 basic ACL rules.

XML structure
<ACL>
<IPv6BasicRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<SrcAny></SrcAny>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<SrcObjectGroup></SrcObjectGroup>
<RoutingTypeAny></RoutingTypeAny>
<RoutingTypeValue></RoutingTypeValue>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
</Rule>
</IPv6BasicRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv6BasicRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
You must create an ACL
Unsigned integer. first before you create,
GroupID ACL number. Index
Value range: 2000 to 2999. merge, or replace rules for
it.

11
Column Column Column
Data type and restrictions Remarks
name description type
If you set this column to
65535, the system
Unsigned integer. automatically assigns a
Value range: 0 to 65535. new rule ID. This rule ID is
RuleID Rule ID. Index
The value 65535 is an invalid rule the nearest higher
ID. multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
action when you remove
Action on or delete a rule.
Enumeration:
packets You must specify an
Action
matching the
N/A • 1—Deny.
action when you replace a
rule. • 2—Permit. rule, or when you merge
or create a rule that does
not exist.
Boolean:
Whether a rule
matches any • true—Matches any source This column must be
SrcAny N/A IPv6 addresses (default). configured together with
source IP
• false—Matches the specified the SrcIPv6 column.
addresses.
source IPv6 address.
This column must be
Members include: configured together with
Source IPv6 Data the SrcAny column.
SrcIPv6
information. structure • SrcIPv6Addr.
• SrcIPv6Prefix. The two members must
both be specified.
Example: 1:1::1:1.
This column is available
SrcIPv6Ad Source IPv6 Hexadecimal string, when the SrcAny column
N/A
dr address. colon-separated. is false.
It must be empty when the
SrcAny column is true.
This column is available
Length of the when the SrcAny column
SrcIPv6Pr Unsigned integer.
source IPv6 N/A is false.
efix Value range: 1 to 128.
address prefix. It must be empty when the
SrcAny column is true.

String, case-insensitive. This column and the

SrcObject Source object
N/A SrcAny column cannot
Group group name. Length: 1 to 31 characters. both be configured.
Boolean:
Whether a rule
matches any • true—Matches any types of This column and the
RoutingTy routing header. RoutingTypeValue
types of N/A
peAny • false—Matches the specified column cannot both be
routing
type of routing header configured.
header.
(default).
This column and the
RoutingTy Routing Unsigned integer. RoutingTypeAny column
N/A
peValue header type. Value range: 0 to 255. cannot both be
configured.

Whether a rule Boolean:

Fragment N/A N/A
matches only • true—Matches only non-first

12
 Column Column Column
Data type and restrictions Remarks
name description type
non-first fragments.
fragments. • false—Matches both
fragments and non-fragments
(default).
String, case-insensitive.
TimeRang Length: 1 to 32 characters.
Time range. N/A It cannot be the word all.
e The string must start with an
English letter.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.
Boolean:
Whether to • true—Counts the rule
Counting count the rule N/A matches. N/A
matches. • false—Does not count the
rule matches (default).
Boolean:
Whether to log • true—Logs rule match
Logging rule match N/A events. N/A
events. • false—Does not log rule
match events (default).
A comment can only be
configured for an existing
rule.
Rule String, case-sensitive.
Comment N/A When the MatchOrder
comment. Length: 1 to 127 characters.
column is 2, you can
modify only the comment
for a rule.

ACL/IPv6NamedBasicRules
This table contains information about named IPv6 basic ACL rules.

XML structure
<ACL>
<IPv6NamedBasicRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<SrcAny></SrcAny>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<SrcObjectGroup></SrcObjectGroup>
<RoutingTypeAny></RoutingTypeAny>

13
 <RoutingTypeValue></RoutingTypeValue>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
</Rule>
</IPv6NamedBasicRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv6NamedBasicRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
Length: 1 to 63 characters.
• ACL name: You must create an ACL
GroupInde ACL name or Case-insensitive string of 1 to first before you create,
Index
x number. 63 characters. merge, or replace rules for
• ACL number: it.
String of digits in the range of
2000 to 2999.
If you set this column to
65535, the system
Unsigned integer. automatically assigns a
Value range: 0 to 65535. new rule ID. This rule ID is
RuleID Rule ID. Index
The value 65535 is an invalid rule the nearest higher
ID. multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
action when you remove
Action on or delete a rule.
Enumeration:
packets You must specify an
Action
matching the
N/A • 1—Deny.
action when you replace a
rule. • 2—Permit. rule, or when you merge
or create a rule that does
not exist.

14
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
Whether a rule
matches any • true—Matches any source This column must be
SrcAny N/A IPv6 addresses (default). configured together with
source IP
• false—Matches the specified the SrcIPv6 column.
addresses.
source IPv6 address.
This column must be
Members include: configured together with
Source IPv6 Data the SrcAny column.
SrcIPv6
information. structure • SrcIPv6Addr.
• SrcIPv6Prefix. The two members must
both be specified.
Example: 1:1::1:1.
This column is available
SrcIPv6Ad Source IPv6 Hexadecimal string, when the SrcAny column
N/A
dr address. colon-separated. is false.
It must be empty when the
SrcAny column is true.
This column is available
Length of the when the SrcAny column
SrcIPv6Pr Unsigned integer.
source IPv6 N/A is false.
efix Value range: 1 to 128.
address prefix. It must be empty when the
SrcAny column is true.

String, case-insensitive. This column and the

SrcObject Source object
N/A SrcAny column cannot
Group group name. Length: 1 to 31 characters. both be configured.
Boolean:
Whether a rule
matches any • true—Matches any types of This column and the
RoutingTy routing header. RoutingTypeValue
types of N/A
peAny • false—Matches the specified column cannot both be
routing
type of routing header configured.
header.
(default).
This column and the
RoutingTy Routing Unsigned integer. RoutingTypeAny column
N/A
peValue header type. Value range: 0 to 255. cannot both be
configured.
Boolean:
Whether a rule • true—Matches only non-first
matches only fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and non-fragments
(default).
String, case-insensitive.
TimeRang Length: 1 to 32 characters.
Time range. N/A It cannot be the word all.
e The string must start with an
English letter.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.
Boolean:
Whether to
Counting count the rule N/A • true—Counts the rule N/A
matches. matches.
• false—Does not count the

15
 Column Column Column
Data type and restrictions Remarks
name description type
rule matches (default).
Boolean:
Whether to log • true—Logs rule match
Logging rule match N/A events. N/A
events. • false—Does not log rule
match events (default).
A comment can only be
configured for an existing
rule.
Rule String, case-sensitive.
Comment N/A When the MatchOrder
comment. Length: 1 to 127 characters.
column is 2, you can
modify only the comment
for a rule.

ACL/IPv4AdvanceRules
This table contains information about IPv4 advanced ACL rules.

XML structure
<ACL>
<IPv4AdvanceRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<ProtocolType></ProtocolType>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcObjectGroup></SrcObjectGroup>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>
<DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<DstObjectGroup></DstObjectGroup>
<ECN></ECN>
<DSCP></DSCP>
<DSCPRange>
<StartDSCP></StartDSCP>
<EndDSCP></EndDSCP>
</DSCPRange>
<Precedence></Precedence>
<TOS></TOS>

16
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<TcpFlag>
<ACK></ACK>
<FIN></FIN>
<PSH></PSH>
<RST></RST>
<SYN></SYN>
<URG></URG>
</TcpFlag>
<Established></Established>
<ICMP>
<ICMPType></ICMPType>
<ICMPCode></ICMPCode>
</ICMP>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<QoSLocalID></QoSLocalID>
<EncapType></EncapType>
<InProtocolType></InProtocolType>
<VxlanID></VxlanID>
<InSrcAny></InSrcAny>
<InSrcIPv4>
<InSrcIPv4Addr></InSrcIPv4Addr>
<InSrcIPv4Wildcard></InSrcIPv4Wildcard>
</InSrcIPv4>
<InDstAny></InDstAny>
<InDstIPv4>
<InDstIPv4Addr></InDstIPv4Addr>
<InDstIPv4Wildcard></InDstIPv4Wildcard>
</InDstIPv4>
<InSrcPort>
<InSrcPortOp></InSrcPortOp>
<InSrcPortValue1></InSrcPortValue1>
<InSrcPortValue2></InSrcPortValue2>
</InSrcPort>
<InDstPort>
<InDstPortOp></InDstPortOp>
<InDstPortValue1></InDstPortValue1>

17
 <InDstPortValue2></InDstPortValue2>
</InDstPort>
<InEstablished></InEstablished>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<UserGroup></UserGroup>
<UserGroupAny></UserGroupAny>
<GreValue></GreValue>
<Options></Options>
<FragmentType></FragmentType>
<Ttl>
<TtlOp></TtlOp>
<TtlValue1></TtlValue1>
<TtlValue2></TtlValue2>
</Ttl>
<PktLength>
<PktLengthOp></PktLengthOp>
<PktLengthValue1></PktLengthValue1>
<PktLengthValue2></PktLengthValue2>
</PktLength>
</Rule>
</IPv4AdvanceRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv4AdvanceRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
You must create an ACL
Unsigned integer. first before you create,
GroupID ACL number. Index
Value range: 3000 to 3999. merge, or replace rules for
it.
Unsigned integer. If you set this column to
RuleID Rule ID. Index Value range: 0 to 65535. 65535, the system
The value 65535 is an invalid automatically assigns a

18
Column Column Column
Data type and restrictions Remarks
name description type
rule ID. new rule ID. This rule ID is
the nearest higher
multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
action when you remove
or delete a rule.
Enumeration:
Action on packets You must specify an
Action
matching the rule.
N/A • 1—Deny.
action when you replace a
• 2—Permit. rule, or when you merge
or create a rule that does
not exist.
You cannot specify a
protocol type when you
Unsigned integer. remove or delete a rule.
ProtocolTy Value range: 0 to 256. You must specify a
Protocol type. N/A protocol type or an
pe The value 256 represents all encapsulation type when
IPv4 protocols. you replace a rule, or
when you merge or create
a rule that does not exist.
Boolean:
• true—Matches any The VXLAN
Whether a rule encapsulation supports
matches any source IP addresses
SrcAny N/A (default). this column.
source IP
addresses. • false—Matches the This column must be
specified source IP configured together with
address. the SrcIPv4 column.

This column must be

Members include: configured together with
Source IPv4 Data the SrcAny column.
SrcIPv4
information. structure • SrcIPv4Addr.
• SrcIPv4Wildcard. The two members must
both be specified.
Example: 1.1.1.1.
This column is available
SrcIPv4Ad Source IPv4 String, dotted decimal when the SrcAny column
N/A
dr address. notation. is false.
It must be empty when the
SrcAny column is true.
Example: 255.255.255.0.
This column is available
Wildcard mask for
SrcIPv4Wi String, dotted decimal when the SrcAny column
the source IPv4 N/A
ldcard notation. is false.
address.
It must be empty when the
SrcAny column is true.

String, case-insensitive. This column and the

SrcObject Source object
N/A SrcAny column cannot
Group group name. Length: 1 to 31 characters. both be configured.

Whether a rule Boolean:

matches any • true—Matches any The VXLAN
DstAny N/A encapsulation supports
destination IP destination IP
addresses. addresses (default). this column.

19
Column Column Column
Data type and restrictions Remarks
name description type
• false—Matches the This column must be
specified destination IP configured together with
address. the DstIPv4 column.
This column must be
Members include: configured together with
Destination IPv4 Data the DstAny column.
DstIPv4
information. structure • DstIPv4Addr.
• DstIPv4Wildcard. The two members must
both be specified.
Example: 1.1.1.1.
This column is available
DstIPv4Ad Destination IPv4 String, dotted decimal when the DstAny column
N/A
dr address. notation. is false.
It must be empty when the
DstAny column is true.
Example: 255.255.255.0.
This column is available
Wildcard mask for
DstIPv4Wi String, dotted decimal when the DstAny column
the destination N/A
ldcard notation. is false.
IPv4 address.
It must be empty when the
DstAny column is true.

String, case-insensitive. This column and the

DstObject Destination object
N/A DstAny column cannot
Group group name. Length: 1 to 31 characters. both be configured.
Unsigned integer. ECN and TOS cannot be
ECN ECN flag. N/A
Value range: 0 to 3. specified together.

Unsigned integer.
DSCP DSCP priority. N/A N/A
Value range: 0 to 63.
Members include: DSCP and DSCPRange
DSCPRan DSCP priority Data
ge structure • StartDSCP cannot be specified
range. together.
• EndDSCP

StartDSC Start DSCP Unsigned integer. The end DSCP must be

priority of a DSCP N/A
P Value range: 0 to 63. greater than start DSCP.
priority range.
End DSCP priority Unsigned integer.
EndDSCP of a DSCP priority N/A N/A
range. Value range: 0 to 63.

Unsigned integer. The DSCP priority and the

Precedenc
IP precedence. N/A IP precedence cannot
e Value range: 0 to 7. both be specified.

Unsigned integer. The DSCP priority and the

TOS ToS preference. N/A ToS precedence cannot
Value range: 0 to 15. both be specified.
Only the TCP and UDP
Members include: protocols and the VXLAN
Source port Data • SrcPortOp. encapsulation support this
SrcPort column.
information. structure • SrcPortValue1.
• SrcPortValue2. The members must be all
specified.
SrcPortOp Source port N/A Enumeration: N/A

20
Column Column Column
Data type and restrictions Remarks
name description type
operator. • 1—lt (lower than).
• 2—eq (equal to).
• 3—gt (greater than).
• 4—neq (not equal to).
• 5—range (inclusive
range).

SrcPortVal Unsigned integer.

Start source port. N/A N/A
ue1 Value range: 0 to 65535.
When SrcPortOp is 5, the
value range is 0 to 65535.
Unsigned integer. Otherwise, it can only be
SrcPortVal
End source port. N/A 65536. The value 65536
ue2 Value range: 0 to 65536. indicates that the end
source port is not
available.

Members include: Only the TCP and UDP

protocols support this
Destination port Data • DstPortOp.
DstPort column.
information. structure • DstPortValue1.
The members must be all
• DstPortValue2. specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port
DstPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

DstPortVal Start destination Unsigned integer.

N/A N/A
ue1 port. Value range: 0 to 65535.
When DstPortOp is 5, the
value range is 0 to 65535.
Unsigned integer. Otherwise, it can only be
DstPortVal End destination N/A 65536. The value 65536
ue2 port. Value range: 0 to 65536. indicates that the end
destination port is not
available.
Members include:
• ACK.
• FIN.
Data
TcpFlag TCP flags. structure. • PSH. N/A
• RST.
• SYN.
• URG.
Unsigned integer.
ACK flag in a TCP Value range: 0 or 1. Only the TCP protocol
ACK N/A
packet. • 0—ACK flag is not set. supports this column.
• 1—ACK flag is set.

FIN flag in a TCP Unsigned integer. Only the TCP protocol

FIN N/A
packet. Value range: 0 or 1. supports this column.

21
Column Column Column
Data type and restrictions Remarks
name description type
• 0—FIN flag is not set.
• 1—FIN flag is set.
Unsigned integer.
PSH flag in a TCP Value range: 0 or 1. Only the TCP protocol
PSH N/A
packet. • 0—PSH flag is not set. supports this column.
• 1—PSH flag is set.
Unsigned integer.
RST flag in a TCP Value range: 0 or 1. Only the TCP protocol
RST N/A
packet. • 0—RST flag is not set. supports this column.
• 1—RST flag is set.
Unsigned integer.
SYN flag in a TCP Value range: 0 or 1. Only the TCP protocol
SYN N/A
packet. • 0—SYN flag is not set. supports this column.
• 1—SYN flag is set.
Unsigned integer.
URG flag in a TCP Value range: 0 or 1. Only the TCP protocol
URG N/A
packet. • 0—URG flag is not set. supports this column.
• 1—URG flag is set.
Only the TCP protocol
supports this column.
On a router, the rule
Whether a rule Boolean: matches TCP connection
matches flags packets with the ACK or
Establishe indicating the • true—Matches the RST flag set. On a switch,
N/A flags.
d established status the availability and usage
of a TCP • false—Ignores the of this column depend on
connection. flags. the device model.
This column and the
TcpFlag column cannot
both be configured.
Members include:
The members must both
ICMP ICMP messages. N/A • ICMPType. be specified.
• ICMPCode.

Type of ICMP Unsigned integer. Only the ICMP protocol

ICMPType N/A
messages. Value range: 0 to 255. supports this column.

Unsigned integer.
Value range: 0 to 256.
ICMPCod Code of ICMP Only the ICMP protocol
N/A The value 256 indicates that
e messages. supports this column.
no ICMP message code is
specified.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments (default).
TimeRang
Time range. N/A String, case-insensitive. It cannot be the word all.
e

22
Column Column Column
Data type and restrictions Remarks
name description type
Length: 1 to 32 characters.
The string must start with an
English letter.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.

Unsigned integer.
QoSLocalI
Local QoS ID. N/A N/A
D
Value range: 1 to 4095.

You cannot specify an

encapsulation type when
you remove or delete a
Members include: rule.

EncapTyp Encapsulation • VXLAN encapsulation.

N/A If you specify an
e type. • GRE encapsulation. encapsulation type you
• IPINIP encapsulation. must specify an inner
protocol when you replace
a rule, or when you merge
or create a rule that does
not exist.

You cannot specify an

inner protocol type when
you remove or delete a
Unsigned integer. rule.

InProtocol Inner protocol Value range: 0 to 256. If you specify an inner

N/A
Type type. protocol type,you must
The value 256 represents all specify an encapsulation
IPv4 protocols. type when you replace a
rule, or when you merge
or create a rule that does
not exist.

Unsigned integer Only the VXLAN

VxlanID VXLAN ID. N/A encapsulation supports
Value range: 0 to 16777215 this column.

Boolean:

Whether a rule • true—Matches any

inner source IP This column must be
matches any inner
InSrcAny N/A addresses (default). configured together with
source IP
• false—Matches the the InSrcIPv4 column.
addresses.
specified inner source
IP address.

Only the VXLAN

encapsulation supports
Members include: this column.
Inner source IPv4 Data
InSrcIPv4
information. structure • InSrcIPv4Addr.
• InSrcIPv4Wildcard. This column must be
configured together with
the InSrcAny column.

23
Column Column Column
Data type and restrictions Remarks
name description type

The two members must

both be specified.

Example: 1.1.1.1.

This column is available

InSrcIPv4 Inner source IPv4 String, dotted decimal when the InSrcAny
N/A
Addr address. notation. column is false.

It must be empty when the

InSrcAny column is true.

Example: 255.255.255.0.

This column is available

Wildcard mask for
InSrcIPv4 String, dotted decimal when the InSrcAny
the inner source N/A
Wildcard notation. column is false.
IPv4 address.
It must be empty when the
InSrcAny column is true.

Boolean:

Whether a rule • true—Matches any

inner destination IP This column must be
matches any inner
InDstAny N/A addresses (default). configured together with
destination IP
• false—Matches the the InDstIPv4 column.
addresses.
specified inner
destination IP address.

Only the VXLAN

encapsulation supports
this column.
Members include:
Inner destination Data This column must be
InDstIPv4
IPv4 information. structure • InDstIPv4Addr. configured together with
• InDstIPv4Wildcard. the InDstAny column.

The two members must

both be specified.

Example: 1.1.1.1.

This column is available

InDstIPv4 Inner destination String, dotted decimal when the InDstAny
N/A
Addr IPv4 address. notation. column is false.

It must be empty when the

InDstAny column is true.

Example: 255.255.255.0.
Wildcard mask for
InDstIPv4 the inner String, dotted decimal This column is available
N/A when the InDstAny
Wildcard destination IPv4 notation.
address. column is false.

It must be empty when the

24
Column Column Column
Data type and restrictions Remarks
name description type
InDstAny column is true.

Only the TCP and UDP

Members include: inner protocols support
Inner source port Data • InSrcPortOp. this column.
InSrcPort
information. structure • InSrcPortValue1.
The members must be all
• InSrcPortValue2.
specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
InSrcPort Inner source port
Op operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
InSrcPortV Start inner source
N/A N/A
alue1 port.
Value range: 0 to 65535.

When InSrcPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
InSrcPortV End inner source
N/A only be 65536. The value
alue2 port.
Value range: 0 to 65536. 65536 indicates that the
end inner source port is
not available.

Only the TCP and UDP

Members include: inner protocols support
Inner destination Data • InDstPortOp. this column.
InDstPort
port information. structure • InDstPortValue1.
The members must be all
• InDstPortValue2.
specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
InDstPort Inner destination
Op port operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
InDstPortV Start inner
N/A N/A
alue1 destination port.
Value range: 0 to 65535.

When InDstPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
InDstPortV End inner
N/A only be 65536. The value
alue2 destination port.
Value range: 0 to 65536. 65536 indicates that the
end inner destination port
is not available.

25
Column Column Column
Data type and restrictions Remarks
name description type

Whether a rule Boolean:

matches flags
InEstablis indicating the • true—Matches the Only the TCP inner
N/A flags. protocol supports this
hed inner established
• false—Ignores the column.
status of a TCP
connection. flags.

Boolean:
• true—Counts the rule
Whether to count matches.
Counting N/A N/A
the rule matches. • false—Does not count
the rule matches
(default).
Boolean:

Whether to log • true—Logs rule match

Logging N/A events. N/A
rule match events.
• false—Does not log rule
match events (default).
A comment can only be
configured for an existing
rule.
String, case-sensitive.
Comment Rule comment. N/A When the MatchOrder
Length: 1 to 127 characters.
column is 2, you can
modify only the comment
for a rule.

String, case-insensitive. This column is available

UserGrou
User group name. N/A when the UserGroupAny
p Length: 1 to 32 characters. column is false.
Boolean:

Whether a rule • true—Matches any user

UserGrou group.
matches any user N/A N/A
pAny • false—Matches the
group.
specified user group
(default).
Hexadecimal string.
Config a gre Only the GRE protocol
GreValue N/A Length: 1 to 8 characters.
value. supports this column.
Value range: 0 to FFFFFFFF.
Boolean: Only when the
Options IP options. N/A • true—Options. ProtocolType value is
• false—Not options, 256,and then the table
default. can supports this column.

Unsigned integer.
Value range: 0 to 3.
• 0—First-fragment.
Fragment Check fragment
N/A • 1—Non-fragment. N/A
Type packet type.
• 2—Non-or-first-fragmen
t.
• 3—Any-fragment.

26
 Column Column Column
Data type and restrictions Remarks
name description type
Members include:
Whether a rule Data • TtlOp.
Ttl N/A
matches TTL. structure • TtlValue1.
• TtlValue2.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
TtlOp TTL operator. N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).
Unsigned integer.
TtlValue1 Start TTL value. N/A Value range: 1 to 255. N/A

When the TtlOp is 5, the

Unsigned integer. value range is 1 to 255.
Otherwise, it can only be
TtlValue2 End TTL value. N/A Value range: 1 to 256. 256. The value 256
indicates that the end TTL
value is not available.

Members include:
Whether a rule
Data • PktLengthOp.
PktLength matches packet N/A
length.
structure • PktLengthValue1.
• PktLengthValue2.

Enumeration:
• 1—lt (lower than).
PktLength Packet length • 2—eq (equal to).
N/A N/A
Op operator. • 3—gt (greater than).
• 4—neq (not equal to).
• 5—range (inclusive
range).

PktLength Start packet Unsigned integer.

N/A N/A
Value1 length value. Value range: 0 to 65535.
When the PktLengthOp is
5, the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
PktLength End packet length
N/A only be 65536. The value
Value2 value. Value range: 0 to 65536. 65536 indicates that the
packet length value is not
available.

ACL/IPv4NamedAdvanceRules
This table contains information about named IPv4 advanced ACL rules.

27
XML structure
<ACL>
<IPv4NamedAdvanceRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<ProtocolType></ProtocolType>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcObjectGroup></SrcObjectGroup>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>
<DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<DstObjectGroup></DstObjectGroup>
<ECN></ECN>
<DSCP></DSCP>
<DSCPRange>
<StartDSCP></StartDSCP>
<EndDSCP></EndDSCP>
</DSCPRange>
<Precedence></Precedence>
<TOS></TOS>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<TcpFlag>
<ACK></ACK>
<FIN></FIN>
<PSH></PSH>
<RST></RST>
<SYN></SYN>
<URG></URG>
</TcpFlag>
<Established></Established>

28
<ICMP>
<ICMPType></ICMPType>
<ICMPCode></ICMPCode>
</ICMP>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<QoSLocalID></QoSLocalID>
<EncapType></EncapType>
<InProtocolType></InProtocolType>
<VxlanID></VxlanID>
<InSrcAny></InSrcAny>
<InSrcIPv4>
<InSrcIPv4Addr></InSrcIPv4Addr>
<InSrcIPv4Wildcard></InSrcIPv4Wildcard>
</InSrcIPv4>
<InDstAny></InDstAny>
<InDstIPv4>
<InDstIPv4Addr></InDstIPv4Addr>
<InDstIPv4Wildcard></InDstIPv4Wildcard>
</InDstIPv4>
<InSrcPort>
<InSrcPortOp></InSrcPortOp>
<InSrcPortValue1></InSrcPortValue1>
<InSrcPortValue2></InSrcPortValue2>
</InSrcPort>
<InDstPort>
<InDstPortOp></InDstPortOp>
<InDstPortValue1></InDstPortValue1>
<InDstPortValue2></InDstPortValue2>
</InDstPort>
<InEstablished></InEstablished>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<UserGroup></UserGroup>
<UserGroupAny></UserGroupAny>
<GreValue></GreValue>
<Options></Options>
<FragmentType></FragmentType>
<Ttl>
<TtlOp></TtlOp>
<TtlValue1></TtlValue1>
<TtlValue2></TtlValue2>
</Ttl>
<PktLength>
<PktLengthOp></PktLengthOp>
<PktLengthValue1></PktLengthValue1>

29
 <PktLengthValue2></PktLengthValue2>
</PktLength>
</Rule>
</IPv4NamedAdvanceRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv4NamedAdvanceRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
Length: 1 to 63 characters.
• ACL name: You must create an ACL
GroupInde ACL name or Case-insensitive string first before you create,
Index
x number. of 1 to 63 characters. merge, or replace rules for
• ACL number: it.
String of digits in the
range of 3000 to 3999.
If you set this column to
65535, the system
Unsigned integer. automatically assigns a
Value range: 0 to 65535. new rule ID. This rule ID is
RuleID Rule ID. Index
The value 65535 is an invalid the nearest higher
rule ID. multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
action when you remove
or delete a rule.
Enumeration:
Action on packets You must specify an
Action
matching the rule.
N/A • 1—Deny.
action when you replace a
• 2—Permit. rule, or when you merge
or create a rule that does
not exist.
You cannot specify a
Unsigned integer. protocol type when you
ProtocolTy Value range: 0 to 256. remove or delete a rule.
Protocol type. N/A
pe The value 256 represents all You must specify a
IPv4 protocols. protocol type or an
encapsulation type when

30
Column Column Column
Data type and restrictions Remarks
name description type
you replace a rule, or
when you merge or create
a rule that does not exist.
Boolean:
• true—Matches any The VXLAN
Whether a rule encapsulation supports
matches any source IP addresses
SrcAny N/A (default). this column.
source IP
addresses. • false—Matches the This column must be
specified source IP configured together with
address. the SrcIPv4 column.

This column must be

Members include: configured together with
Source IPv4 Data the SrcAny column.
SrcIPv4
information. structure • SrcIPv4Addr.
• SrcIPv4Wildcard. The two members must
both be specified.
Example: 1.1.1.1.
This column is available
SrcIPv4Ad Source IPv4 String, dotted decimal when the SrcAny column
N/A
dr address. notation. is false.
It must be empty when the
SrcAny column is true.
Example: 255.255.255.0.
This column is available
Wildcard mask for
SrcIPv4Wi String, dotted decimal when the SrcAny column
the source IPv4 N/A
ldcard notation. is false.
address.
It must be empty when the
SrcAny column is true.

String, case-insensitive. This column and the

SrcObject Source object
N/A SrcAny column cannot
Group group name. Length: 1 to 31 characters. both be configured.
Boolean:
• true—Matches any The VXLAN
Whether a rule encapsulation supports
matches any destination IP
DstAny N/A addresses (default). this column.
destination IP
addresses. • false—Matches the This column must be
specified destination IP configured together with
address. the DstIPv4 column.

This column must be

Members include: configured together with
Destination IPv4 Data the DstAny column.
DstIPv4
information. structure • DstIPv4Addr.
• DstIPv4Wildcard. The two members must
both be specified.
Example: 1.1.1.1.
This column is available
DstIPv4Ad Destination IPv4 String, dotted decimal when the DstAny column
N/A
dr address. notation. is false.
It must be empty when the
DstAny column is true.

Wildcard mask for Example: 255.255.255.0.

DstIPv4Wi String, dotted decimal
the destination N/A This column is available
ldcard notation.
IPv4 address. when the DstAny column

31
Column Column Column
Data type and restrictions Remarks
name description type
is false.
It must be empty when the
DstAny column is true.

String, case-insensitive. This column and the

DstObject Destination object
N/A DstAny column cannot
Group group name. Length: 1 to 31 characters. both be configured.
Unsigned integer. ECN and TOS cannot be
ECN ECN flag. N/A
Value range: 0 to 3. specified together.

Unsigned integer.
DSCP DSCP priority. N/A N/A
Value range: 0 to 63.
Members include: DSCP and DSCPRange
DSCPRan DSCP priority Data
ge structure • StartDSCP cannot be specified
range. together.
• EndDSCP

StartDSC Start DSCP Unsigned integer. The end DSCP must be

priority of a DSCP N/A
P Value range: 0 to 63. greater than start DSCP.
priority range.
End DSCP priority Unsigned integer.
EndDSCP of a DSCP priority N/A N/A
range. Value range: 0 to 63.

Unsigned integer. The DSCP priority and the

Precedenc
IP precedence. N/A IP precedence cannot
e Value range: 0 to 7. both be specified.

Unsigned integer. The DSCP priority and the

TOS ToS preference. N/A ToS precedence cannot
Value range: 0 to 15. both be specified.
Only the TCP and UDP
Members include: protocols and the VXLAN
Source port Data • SrcPortOp. encapsulation support this
SrcPort column.
information. structure • SrcPortValue1.
• SrcPortValue2. The members must be all
specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Source port
SrcPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

SrcPortVal Unsigned integer.

Start source port. N/A N/A
ue1 Value range: 0 to 65535.
When SrcPortOp is 5, the
value range is 0 to 65535.
Unsigned integer. Otherwise, it can only be
SrcPortVal
End source port. N/A 65536. The value 65536
ue2 Value range: 0 to 65536. indicates that the end
source port is not
available.

Destination port Data Members include: Only the TCP and UDP
DstPort
information. structure • DstPortOp. protocols support this

32
Column Column Column
Data type and restrictions Remarks
name description type
• DstPortValue1. column.
• DstPortValue2. The members must be all
specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port
DstPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

DstPortVal Start destination Unsigned integer.

N/A N/A
ue1 port. Value range: 0 to 65535.
When DstPortOp is 5, the
value range is 0 to 65535.
Unsigned integer. Otherwise, it can only be
DstPortVal End destination N/A 65536. The value 65536
ue2 port. Value range: 0 to 65536. indicates that the end
destination port is not
available.
Members include:
• ACK.
• FIN.
Data
TcpFlag TCP flags. structure. • PSH. N/A
• RST.
• SYN.
• URG.
Unsigned integer.
ACK flag in a TCP Value range: 0 or 1. Only the TCP protocol
ACK N/A
packet. • 0—ACK flag is not set. supports this column.
• 1—ACK flag is set.
Unsigned integer.
FIN flag in a TCP Value range: 0 or 1. Only the TCP protocol
FIN N/A
packet. • 0—FIN flag is not set. supports this column.
• 1—FIN flag is set.
Unsigned integer.
PSH flag in a TCP Value range: 0 or 1. Only the TCP protocol
PSH N/A
packet. • 0—PSH flag is not set. supports this column.
• 1—PSH flag is set.
Unsigned integer.
RST flag in a TCP Value range: 0 or 1. Only the TCP protocol
RST N/A
packet. • 0—RST flag is not set. supports this column.
• 1—RST flag is set.
Unsigned integer.
SYN flag in a TCP Value range: 0 or 1. Only the TCP protocol
SYN N/A
packet. • 0—SYN flag is not set. supports this column.
• 1—SYN flag is set.
URG URG flag in a TCP N/A Unsigned integer. Only the TCP protocol

33
Column Column Column
Data type and restrictions Remarks
name description type
packet. Value range: 0 or 1. supports this column.
• 0—URG flag is not set.
• 1—URG flag is set.
Only the TCP protocol
supports this column.
On a router, the rule
Whether a rule Boolean: matches TCP connection
matches flags packets with the ACK or
Establishe indicating the • true—Matches the RST flag set. On a switch,
N/A flags.
d established status the availability and usage
of a TCP • false—Ignores the of this column depend on
connection. flags. the device model.
This column and the
TcpFlag column cannot
both be configured.
Members include:
The members must both
ICMP ICMP messages. N/A • ICMPType. be specified.
• ICMPCode.

Type of ICMP Unsigned integer. Only the ICMP protocol

ICMPType N/A
messages. Value range: 0 to 255. supports this column.

Unsigned integer.
Value range: 0 to 256.
ICMPCod Code of ICMP Only the ICMP protocol
N/A The value 256 indicates that
e messages. supports this column.
no ICMP message code is
specified.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments (default).
String, case-insensitive.
TimeRang Length: 1 to 32 characters.
Time range. N/A It cannot be the word all.
e The string must start with an
English letter.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.

Unsigned integer.
QoSLocalI
Local QoS ID. N/A N/A
D
Value range: 1 to 4095.

You cannot specify an

encapsulation type when
Members include: you remove or delete a
EncapTyp Encapsulation • VXLAN encapsulation. rule.
N/A • GRE encapsulation.
e type.
• IPINIP encapsulation. If you specify an
encapsulation type,you
must specify an inner
protocol when you replace

34
Column Column Column
Data type and restrictions Remarks
name description type
a rule, or when you merge
or create a rule that does
not exist.

You cannot specify an

inner protocol type when
you remove or delete a
Unsigned integer. rule.

InProtocol Inner protocol Value range: 0 to 256. If you specify an inner

N/A
Type type. protocol type,you must
The value 256 represents all specify an encapsulation
IPv4 protocols. type when you replace a
rule, or when you merge
or create a rule that does
not exist.

Unsigned integer Only the VXLAN

VxlanID VXLAN ID. N/A encapsulation supports
Value range: 0 to 16777215 this column.

Boolean:

Whether a rule • true—Matches any

inner source IP This column must be
matches any inner
InSrcAny N/A addresses (default). configured together with
source IP
• false—Matches the the InSrcIPv4 column.
addresses.
specified inner source
IP address.

Only the VXLAN

encapsulation supports
this column.
Members include:
Inner source IPv4 Data This column must be
InSrcIPv4
information. structure • InSrcIPv4Addr. configured together with
• InSrcIPv4Wildcard. the InSrcAny column.

The two members must

both be specified.

Example: 1.1.1.1.

This column is available

InSrcIPv4 Inner source IPv4 String, dotted decimal when the InSrcAny
N/A
Addr address. notation. column is false.

It must be empty when the

InSrcAny column is true.

Example: 255.255.255.0.

This column is available

Wildcard mask for
InSrcIPv4 String, dotted decimal when the InSrcAny
the inner source N/A
Wildcard notation. column is false.
IPv4 address.
It must be empty when the
InSrcAny column is true.

35
Column Column Column
Data type and restrictions Remarks
name description type

Boolean:

Whether a rule • true—Matches any

inner destination IP This column must be
matches any inner
InDstAny N/A addresses (default). configured together with
destination IP
• false—Matches the the InDstIPv4 column.
addresses.
specified inner
destination IP address.

Only the VXLAN

encapsulation supports
this column.
Members include:
Inner destination Data This column must be
InDstIPv4
IPv4 information. structure • InDstIPv4Addr. configured together with
• InDstIPv4Wildcard. the InDstAny column.

The two members must

both be specified.

Example: 1.1.1.1.

This column is available

InDstIPv4 Inner destination String, dotted decimal when the InDstAny
N/A
Addr IPv4 address. notation. column is false.

It must be empty when the

InDstAny column is true.

Example: 255.255.255.0.

Wildcard mask for This column is available

InDstIPv4 the inner String, dotted decimal when the InDstAny
N/A
Wildcard destination IPv4 notation. column is false.
address.
It must be empty when the
InDstAny column is true.

Members include: Only the TCP and UDP

inner protocols support
• InSrcPortOp.
Inner source port Data this column.
InSrcPort
information. structure • InSrcPortValue1.
The members must be all
InSrcPortValue2. specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
InSrcPort Inner source port
Op operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
InSrcPortV Start inner source
N/A N/A
alue1 port.
Value range: 0 to 65535.

36
Column Column Column
Data type and restrictions Remarks
name description type

When InSrcPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
InSrcPortV End inner source
N/A only be 65536. The value
alue2 port.
Value range: 0 to 65536. 65536 indicates that the
end inner source port is
not available.

Only the TCP and UDP

Members include: inner protocols support
Inner destination Data • InDstPortOp. this column.
InDstPort
port information. structure • InDstPortValue1.
The members must be all
• InDstPortValue2.
specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
InDstPort Inner destination
Op port operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
InDstPortV Start inner
N/A N/A
alue1 destination port.
Value range: 0 to 65535.

When InDstPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
InDstPortV End inner
N/A only be 65536. The value
alue2 destination port.
Value range: 0 to 65536. 65536 indicates that the
end inner destination port
is not available.

Whether a rule Boolean:

matches flags
InEstablis indicating the • true—Matches the Only the TCP inner
N/A flags. protocol supports this
hed inner established
• false—Ignores the column.
status of a TCP
connection. flags.

Boolean:
• true—Counts the rule
Whether to count matches.
Counting N/A N/A
the rule matches. • false—Does not count
the rule matches
(default).
Boolean:

Whether to log • true—Logs rule match

Logging N/A events. N/A
rule match events.
• false—Does not log rule
match events (default).

Comment Rule comment. N/A String, case-sensitive. A comment can only be

configured for an existing

37
Column Column Column
Data type and restrictions Remarks
name description type
Length: 1 to 127 characters. rule.
When the MatchOrder
column is 2, you can
modify only the comment
for a rule.

String, case-insensitive. This column is available

UserGrou
User group name. N/A when the UserGroupAny
p Length: 1 to 32 characters. column is false.
Boolean:

Whether a rule • true—Matches any user

UserGrou group.
matches any user N/A N/A
pAny • false—Matches the
group.
specified user group
(default).
Hexadecimal string.
Config a gre Only the GRE protocol
GreValue N/A Length: 1 to 8 characters.
value. supports this column.
Value range: 0 to FFFFFFFF.
Boolean: Only when the
Options IP options. N/A • true—Options. ProtocolType value is
• false—Not options, 256,and then the table
default. can supports this column.

Unsigned integer.
Value range: 0 to 3.
• 0—First-fragment.
Fragment Check fragment
N/A • 1—Non-fragment. N/A
Type packet type.
• 2—Non-or-first-fragmen
t.
• 3—Any-fragment.

Members include:
Whether a rule Data • TtlOp.
Ttl N/A
matches TTL. structure • TtlValue1.
• TtlValue2.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
TtlOp TTL operator. N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).
Unsigned integer.
TtlValue1 Start TTL value. N/A N/A
Value range: 1 to 255.
When the TtlOp is 5, the
value range is 1 to 255.
Unsigned integer. Otherwise, it can only be
TtlValue2 End TTL value. N/A
Value range: 1 to 256. 256. The value 256
indicates that the end TTL
value is not available.

Whether a rule Data

PktLength Members include: N/A
matches packet structure

38
 Column Column Column
Data type and restrictions Remarks
name description type
length. • PktLengthOp.
• PktLengthValue1.
• PktLengthValue2.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
PktLength Packet length
Op operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

PktLength Start packet Unsigned integer.

N/A N/A
Value1 length value. Value range: 0 to 65535.
When the PktLengthOp is
5, the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
PktLength End packet length
N/A only be 65536. The value
Value2 value. Value range: 0 to 65536. 65536 indicates that the
packet length value is not
available.

ACL/IPv6AdvanceRules
This table contains information about IPv6 advanced ACL rules.

XML structure
<ACL>
<IPv6AdvanceRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<ProtocolType></ProtocolType>
<SrcAny></SrcAny>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<SrcObjectGroup></SrcObjectGroup>
<DstAny></DstAny>
<DstIPv6>
<DstIPv6Addr></DstIPv6Addr>
<DstIPv6Prefix></DstIPv6Prefix>
</DstIPv6>
<DstObjectGroup></DstObjectGroup>
<ECN></ECN>
<DSCP></DSCP>

39
<FlowLabel></FlowLabel>
<RoutingTypeAny></RoutingTypeAny>
<RoutingTypeValue></RoutingTypeValue>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<TcpFlag>
<ACK></ACK>
<FIN></FIN>
<PSH></PSH>
<RST></RST>
<SYN></SYN>
<URG></URG>
</TcpFlag>
<Established></Established>
<ICMP6>
<ICMP6Type></ICMP6Type>
<ICMP6Code></ICMP6Code>
</ICMP6>
<Fragment></Fragment>
<HopTypeAny></HopTypeAny>
<HopTypeValue></HopTypeValue>
<TimeRange></TimeRange>
<VRF></VRF>
<QoSLocalID></QoSLocalID>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<UserGroup></UserGroup>
<UserGroupAny></UserGroupAny>
<GreValue></GreValue>
<Options></Options>
<FragmentType></FragmentType>
<Ttl>
<TtlOp></TtlOp>
<TtlValue1></TtlValue1>
<TtlValue2></TtlValue2>
</Ttl>
<PktLength>
<PktLengthOp></PktLengthOp>
<PktLengthValue1></PktLengthValue1>

40
 <PktLengthValue2></PktLengthValue2>
</PktLength>
</Rule>
</IPv6AdvanceRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv6AdvanceRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
You must create an ACL
Unsigned integer. first before you create,
GroupID ACL number. Index
Value range: 3000 to 3999. merge, or replace rules for
it.
If you set this column to
65535, the system
Unsigned integer. automatically assigns a
Value range: 0 to 65535. new rule ID. This rule ID is
RuleID Rule ID. Index
The value 65535 is an invalid the nearest higher
rule ID. multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
action when you remove
Action on or delete a rule.
Enumeration:
packets You must specify an
Action
matching the
N/A • 1—Deny.
action when you replace a
rule. • 2—Permit. rule, or when you merge
or create a rule that does
not exist.
You cannot specify a
protocol type when you
Unsigned integer. remove or delete a rule.
Value range: 0 to 256. You must specify a
ProtocolType Protocol type. N/A
The value 256 represents all protocol type when you
IPv6 protocols. replace a rule, or when
you merge or create a rule
that does not exist.

Whether a rule Boolean: This column must be

SrcAny N/A
matches any • true—Matches any configured together with

41
Column Column Column
Data type and restrictions Remarks
name description type
source IPv6 source IPv6 addresses the SrcIPv6 column.
addresses. (default).
• false—Matches the
specified source IPv6
address.
This column must be
Members include: configured together with
Source IPv6 Data the SrcAny column.
SrcIPv6
information. structure • SrcIPv6Addr.
• SrcIPv6Prefix. The two members must
both be specified.
Example: 1:1::1:1.
This column is available
Source IPv6 Hexadecimal string, when the SrcAny column
SrcIPv6Addr N/A
address. colon-separated. is false.
It must be empty when the
SrcAny column is true.
This column is available
Length of the when the SrcAny column
Unsigned integer.
SrcIPv6Prefix source IPv6 N/A is false.
address prefix. Value range: 1 to 128.
It must be empty when the
SrcAny column is true.

String, case-insensitive. This column and the

SrcObjectGro Source object
N/A SrcAny column cannot
up group name. Length: 1 to 31 characters. both be configured.
Boolean:

Whether a rule • true—Matches any

destination IPv6 This column must be
matches any
DstAny N/A addresses (default). configured together with
destination IPv6
• false—Matches the the DstIPv6 column.
addresses.
specified destination
IPv6 address.
This column must be
Members include: configured together with
Destination IPv6 Data the DstAny column.
DstIPv6
information. structure • DstIPv6Addr.
• DstIPv6Prefix. The two members must
both be specified.
Example: 1:1::1:1.
This column is available
Destination IPv6 Hexadecimal string, when the DstAny column
DstIPv6Addr N/A
address. colon-separated. is false.
It must be empty when the
DstAny column is true.
This column is available
Length of the when the DstAny column
Unsigned integer.
DstIPv6Prefix destination IPv6 N/A is false.
address prefix. Value range: 1 to 128.
It must be empty when the
DstAny column is true.
Destination String, case-insensitive. This column and the
DstObjectGro object group N/A DstAny column cannot
up name. Length: 1 to 31 characters. both be configured.

ECN ECN flag. N/A Unsigned integer. N/A

42
Column Column Column
Data type and restrictions Remarks
name description type
Value range: 0 to 3.
Unsigned integer.
DSCP DSCP priority. N/A N/A
Value range: 0 to 63.

Flow label value Unsigned integer.

FlowLabel in an IPv6 packet N/A N/A
header. Value range: 0 to 1048575.

Boolean:
Whether a rule • true—Matches any This column and the
RoutingType matches any types of routing header. RoutingTypeValue
N/A
Any types of routing • false—Matches the column cannot both be
header. specified type of routing configured.
header (default).
This column and the
RoutingType Routing header Unsigned integer. RoutingTypeAny column
N/A
Value type. Value range: 0 to 255. cannot both be
configured.

Members include: Only the TCP and UDP

protocols support this
Source port Data • SrcPortOp.
SrcPort column.
information. structure • SrcPortValue1.
The members must be all
• SrcPortValue2. specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Source port
SrcPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

SrcPortValue Unsigned integer.

Start source port. N/A N/A
1 Value range: 0 to 65535.
When SrcPortOp is 5, the
value range is 0 to 65535.
Unsigned integer. Otherwise, it can only be
SrcPortValue
End source port. N/A 65536. The value 65536
2 Value range: 0 to 65536. indicates that the end
source port is not
available.

Members include: Only the TCP and UDP

protocols support this
Destination port Data • DstPortOp.
DstPort column.
information. structure • DstPortValue1.
The members must be all
• DstPortValue2. specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port
DstPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

43
Column Column Column
Data type and restrictions Remarks
name description type
DstPortValue Start destination Unsigned integer.
N/A N/A
1 port. Value range: 0 to 65535.
When DstPortOp is 5, the
value range is 0 to 65535.
Unsigned integer. Otherwise, it can only be
DstPortValue End destination N/A 65536. The value 65536
2 port. Value range: 0 to 65536. indicates that the end
destination port is not
available.
Members include:
• ACK.
• FIN.
Data
TcpFlag TCP flags. structure. • PSH. N/A
• RST.
• SYN.
• URG.
Unsigned integer.
ACK flag in a Value range: 0 or 1. Only the TCP protocol
ACK N/A
TCP packet. • 0—ACK flag is not set. supports this column.
• 1—ACK flag is set.
Unsigned integer.
FIN flag in a TCP Value range: 0 or 1. Only the TCP protocol
FIN N/A
packet. • 0—FIN flag is not set. supports this column.
• 1—FIN flag is set.
Unsigned integer.
PSH flag in a Value range: 0 or 1. Only the TCP protocol
PSH N/A
TCP packet. • 0—PSH flag is not set. supports this column.
• 1—PSH flag is set.
Unsigned integer.
RST flag in a Value range: 0 or 1. Only the TCP protocol
RST N/A
TCP packet. • 0—RST flag is not set. supports this column.
• 1—RST flag is set.
Unsigned integer.
SYN flag in a Value range: 0 or 1. Only the TCP protocol
SYN N/A
TCP packet. • 0—SYN flag is not set. supports this column.
• 1—SYN flag is set.
Unsigned integer.
URG flag in a Value range: 0 or 1. Only the TCP protocol
URG N/A
TCP packet. • 0—URG flag is not set. supports this column.
• 1—URG flag is set.
Only the TCP protocol
Whether a rule Boolean: supports this column.
matches flags On a router, the rule
• true—Matches the
Established indicating the N/A matches TCP connection
flags.
established packets with the ACK or
status of a TCP • false—Ignores the
RST flag set. On a switch,
connection. flags.
the availability and usage
of this column depend on

44
Column Column Column
Data type and restrictions Remarks
name description type
the device model.
This column and the
TcpFlag column cannot
both be configured.
Members include:
ICMPv6 The members must both
ICMP6 N/A • ICMP6Type. be specified.
messages.
• ICMP6Code.

Type of ICMPv6 Unsigned integer. Only the ICMPv6 protocol

ICMP6Type N/A
messages. Value range: 0 to 255. supports this column.

Unsigned integer.
Value range: 0 to 256.
Code of ICMPv6 Only the ICMPv6 protocol
ICMP6Code N/A The value 256 indicates that
messages. supports this column.
no ICMPv6 message code is
specified.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments (default).
Boolean:

Whether a rule • true—Matches any

types of Hop-by-Hop This column and the
matched any
Options header. HopTypeValue column
HopTypeAny types of N/A
• false—Matches the cannot both be
Hop-by-Hop
specified type of configured.
Options header.
Hop-by-Hop Options
header (default).
This column and the
Type of Unsigned integer.
HopTypeValu HopTypeAny column
Hop-by-Hop N/A
e Value range: 0 to 255. cannot both be
Options header.
configured.
String, case-insensitive.
Length: 1 to 32 characters.
TimeRange Time range. N/A It cannot be the word all.
The string must start with an
English letter.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.

Unsigned integer.
QoSLocalID Local QoS ID. N/A N/A
Value range: 1 to 4095.
Boolean:
• true—Counts the rule
Whether to count matches.
Counting N/A N/A
the rule matches. • false—Does not count
the rule matches
(default).
Logging Whether to log N/A Boolean: N/A

45
Column Column Column
Data type and restrictions Remarks
name description type
rule match • true—Logs rule match
events. events.
• false—Does not log rule
match events (default).
A comment can only be
configured for an existing
rule.
String, case-sensitive.
Comment Rule comment. N/A When the MatchOrder
Length: 1 to 127 characters.
column is 2, you can
modify only the comment
for a rule.

String, case-insensitive. This column is available

User group
UserGroup N/A when the UserGroupAny
name. Length: 1 to 32 characters. column is false.
Boolean:

Whether a rule • true—Matches any user

UserGroupAn group.
matches any N/A N/A
y • false—Matches the
user group.
specified user group
(default).
Hexadecimal string.
Config a gre Only the GRE protocol
GreValue N/A Length: 1 to 8 characters.
value. supports this column.
Value range: 0 to FFFFFFFF.
Boolean: Only when the
Options IP options. N/A • true—Options. ProtocolType value is
• false—Not options, 256,and then the table
default. can supports this column.

Unsigned integer.
Value range: 0 to 3.
• 0—First-fragment.
FragmentTyp Check fragment
N/A • 1—Non-fragment. N/A
e packet type.
• 2—Non-or-first-fragmen
t.
• 3—Any-fragment.

Members include:
Whether a rule Data • TtlOp.
Ttl N/A
matches TTL. structure • TtlValue1.
• TtlValue2.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
TtlOp TTL operator. N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).
Unsigned integer.
TtlValue1 Start TTL value. N/A N/A
Value range: 1 to 255.
TtlValue2 End TTL value. N/A Unsigned integer. When the TtlOp is 5, the

46
 Column Column Column
Data type and restrictions Remarks
name description type
Value range: 1 to 256. value range is 1 to 255.
Otherwise, it can only be
256. The value 256
indicates that the end TTL
value is not available.
Members include:
Whether a rule
Data • PktLengthOp.
PktLength matches packet N/A
length.
structure • PktLengthValue1.
• PktLengthValue2.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Packet length
PktLengthOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

PktLengthVal Start packet Unsigned integer.

N/A N/A
ue1 length value. Value range: 0 to 65535.
When the PktLengthOp is
5, the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
PktLengthVal End packet
N/A only be 65536. The value
ue2 length value. Value range: 0 to 65536. 65536 indicates that the
packet length value is not
available.

ACL/IPv6NamedAdvanceRules
This table contains information about named IPv6 advanced ACL rules.

XML structure
<ACL>
<IPv6NamedAdvanceRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<ProtocolType></ProtocolType>
<SrcAny></SrcAny>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<SrcObjectGroup></SrcObjectGroup>
<DstAny></DstAny>
<DstIPv6>
<DstIPv6Addr></DstIPv6Addr>

47
 <DstIPv6Prefix></DstIPv6Prefix>
</DstIPv6>
<DstObjectGroup></DstObjectGroup>
<ECN></ECN>
<DSCP></DSCP>
<FlowLabel></FlowLabel>
<RoutingTypeAny></RoutingTypeAny>
<RoutingTypeValue></RoutingTypeValue>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<TcpFlag>
<ACK></ACK>
<FIN></FIN>
<PSH></PSH>
<RST></RST>
<SYN></SYN>
<URG></URG>
</TcpFlag>
<Established></Established>
<ICMP6>
<ICMP6Type></ICMP6Type>
<ICMP6Code></ICMP6Code>
</ICMP6>
<Fragment></Fragment>
<HopTypeAny></HopTypeAny>
<HopTypeValue></HopTypeValue>
<TimeRange></TimeRange>
<VRF></VRF>
<QoSLocalID></QoSLocalID>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<UserGroup></UserGroup>
<UserGroupAny></UserGroupAny>
<GreValue></GreValue>
<Options></Options>
<FragmentType></FragmentType>
<Ttl>
<TtlOp></TtlOp>
<TtlValue1></TtlValue1>

48
 <TtlValue2></TtlValue2>
</Ttl>
<PktLength>
<PktLengthOp></PktLengthOp>
<PktLengthValue1></PktLengthValue1>
<PktLengthValue2></PktLengthValue2>
</PktLength>
</Rule>
</IPv6NamedAdvanceRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv6NamedAdvanceRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
Length: 1 to 63 characters.
• ACL name: You must create an ACL
ACL name or Case-insensitive string first before you create,
GroupIndex Index
number. of 1 to 63 characters. merge, or replace rules for
• ACL number: it.
String of digits in the
range of 3000 to 3999.
If you set this column to
65535, the system
Unsigned integer. automatically assigns a
Value range: 0 to 65535. new rule ID. This rule ID is
RuleID Rule ID. Index
The value 65535 is an invalid the nearest higher
rule ID. multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
action when you remove
Action on or delete a rule.
Enumeration:
packets You must specify an
Action
matching the
N/A • 1—Deny.
action when you replace a
rule. • 2—Permit. rule, or when you merge
or create a rule that does
not exist.

49
Column Column Column
Data type and restrictions Remarks
name description type
You cannot specify a
protocol type when you
Unsigned integer. remove or delete a rule.
Value range: 0 to 256. You must specify a
ProtocolType Protocol type. N/A
The value 256 represents all protocol type when you
IPv6 protocols. replace a rule, or when
you merge or create a rule
that does not exist.
Boolean:

Whether a rule • true—Matches any

source IPv6 addresses This column must be
matches any
SrcAny N/A (default). configured together with
source IPv6
• false—Matches the the SrcIPv6 column.
addresses.
specified source IPv6
address.
This column must be
Members include: configured together with
Source IPv6 Data the SrcAny column.
SrcIPv6
information. structure • SrcIPv6Addr.
• SrcIPv6Prefix. The two members must
both be specified.
Example: 1:1::1:1.
This column is available
Source IPv6 Hexadecimal string, when the SrcAny column
SrcIPv6Addr N/A
address. colon-separated. is false.
It must be empty when the
SrcAny column is true.
This column is available
Length of the when the SrcAny column
Unsigned integer.
SrcIPv6Prefix source IPv6 N/A is false.
address prefix. Value range: 1 to 128.
It must be empty when the
SrcAny column is true.

String, case-insensitive. This column and the

SrcObjectGro Source object
N/A SrcAny column cannot
up group name. Length: 1 to 31 characters. both be configured.
Boolean:

Whether a rule • true—Matches any

destination IPv6 This column must be
matches any
DstAny N/A addresses (default). configured together with
destination IPv6
• false—Matches the the DstIPv6 column.
addresses.
specified destination
IPv6 address.

50
Column Column Column
Data type and restrictions Remarks
name description type
This column must be
Members include: configured together with
Destination IPv6 Data the DstAny column.
DstIPv6
information. structure • DstIPv6Addr.
• DstIPv6Prefix. The two members must
both be specified.
Example: 1:1::1:1.
This column is available
Destination IPv6 Hexadecimal string, when the DstAny column
DstIPv6Addr N/A
address. colon-separated. is false.
It must be empty when the
DstAny column is true.
This column is available
Length of the when the DstAny column
Unsigned integer.
DstIPv6Prefix destination IPv6 N/A is false.
address prefix. Value range: 1 to 128.
It must be empty when the
DstAny column is true.
Destination String, case-insensitive. This column and the
DstObjectGro object group N/A DstAny column cannot
up name. Length: 1 to 31 characters. both be configured.
Unsigned integer.
ECN ECN flag. N/A N/A
Value range: 0 to 3.
Unsigned integer.
DSCP DSCP priority. N/A N/A
Value range: 0 to 63.

Flow label value Unsigned integer.

FlowLabel in an IPv6 packet N/A N/A
header. Value range: 0 to 1048575.

Boolean:
Whether a rule • true—Matches any This column and the
RoutingType matches any types of routing header. RoutingTypeValue
N/A
Any types of routing • false—Matches the column cannot both be
header. specified type of routing configured.
header (default).
This column and the
RoutingType Routing header Unsigned integer. RoutingTypeAny column
N/A
Value type. Value range: 0 to 255. cannot both be
configured.

Members include: Only the TCP and UDP

protocols support this
Source port Data • SrcPortOp.
SrcPort column.
information. structure • SrcPortValue1.
The members must be all
• SrcPortValue2. specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Source port
SrcPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).
SrcPortValue Start source port. N/A Unsigned integer. N/A

51
Column Column Column
Data type and restrictions Remarks
name description type
1 Value range: 0 to 65535.
When SrcPortOp is 5, the
value range is 0 to 65535.
Unsigned integer. Otherwise, it can only be
SrcPortValue
End source port. N/A 65536. The value 65536
2 Value range: 0 to 65536. indicates that the end
source port is not
available.

Members include: Only the TCP and UDP

protocols support this
Destination port Data • DstPortOp.
DstPort column.
information. structure • DstPortValue1.
The members must be all
• DstPortValue2. specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port
DstPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

DstPortValue Start destination Unsigned integer.

N/A N/A
1 port. Value range: 0 to 65535.
When DstPortOp is 5, the
value range is 0 to 65535.
Unsigned integer. Otherwise, it can only be
DstPortValue End destination N/A 65536. The value 65536
2 port. Value range: 0 to 65536. indicates that the end
destination port is not
available.
Members include:
• ACK.
• FIN.
Data
TcpFlag TCP flags. structure. • PSH. N/A
• RST.
• SYN.
• URG.
Unsigned integer.
ACK flag in a Value range: 0 or 1. Only the TCP protocol
ACK N/A
TCP packet. • 0—ACK flag is not set. supports this column.
• 1—ACK flag is set.
Unsigned integer.
FIN flag in a TCP Value range: 0 or 1. Only the TCP protocol
FIN N/A
packet. • 0—FIN flag is not set. supports this column.
• 1—FIN flag is set.
Unsigned integer.
PSH flag in a Value range: 0 or 1. Only the TCP protocol
PSH N/A
TCP packet. • 0—PSH flag is not set. supports this column.
• 1—PSH flag is set.

52
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
RST flag in a Value range: 0 or 1. Only the TCP protocol
RST N/A
TCP packet. • 0—RST flag is not set. supports this column.
• 1—RST flag is set.
Unsigned integer.
SYN flag in a Value range: 0 or 1. Only the TCP protocol
SYN N/A
TCP packet. • 0—SYN flag is not set. supports this column.
• 1—SYN flag is set.
Unsigned integer.
URG flag in a Value range: 0 or 1. Only the TCP protocol
URG N/A
TCP packet. • 0—URG flag is not set. supports this column.
• 1—URG flag is set.
Only the TCP protocol
supports this column.
On a router, the rule
Whether a rule Boolean: matches TCP connection
matches flags packets with the ACK or
• true—Matches the RST flag set. On a switch,
Established indicating the N/A flags. the availability and usage
established
status of a TCP • false—Ignores the of this column depend on
connection. flags. the device model.
This column and the
TcpFlag column cannot
both be configured.
Members include:
ICMPv6 The members must both
ICMP6 N/A • ICMP6Type. be specified.
messages.
• ICMP6Code.

Type of ICMPv6 Unsigned integer. Only the ICMPv6 protocol

ICMP6Type N/A
messages. Value range: 0 to 255. supports this column.

Unsigned integer.
Value range: 0 to 256.
Code of ICMPv6 Only the ICMPv6 protocol
ICMP6Code N/A The value 256 indicates that
messages. supports this column.
no ICMPv6 message code is
specified.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments (default).
Boolean:

Whether a rule • true—Matches any

types of Hop-by-Hop This column and the
matched any
Options header. HopTypeValue column
HopTypeAny types of N/A
• false—Matches the cannot both be
Hop-by-Hop
specified type of configured.
Options header.
Hop-by-Hop Options
header (default).
HopTypeValu Type of N/A Unsigned integer. This column and the

53
Column Column Column
Data type and restrictions Remarks
name description type
e Hop-by-Hop Value range: 0 to 255. HopTypeAny column
Options header. cannot both be
configured.
String, case-insensitive.
Length: 1 to 32 characters.
TimeRange Time range. N/A It cannot be the word all.
The string must start with an
English letter.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.

Unsigned integer.
QoSLocalID Local QoS ID. N/A N/A
Value range: 1 to 4095.
Boolean:
• true—Counts the rule
Whether to count matches.
Counting N/A N/A
the rule matches. • false—Does not count
the rule matches
(default).
Boolean:
Whether to log • true—Logs rule match
Logging rule match N/A events. N/A
events. • false—Does not log rule
match events (default).
A comment can only be
configured for an existing
rule.
String, case-sensitive.
Comment Rule comment. N/A When the MatchOrder
Length: 1 to 127 characters.
column is 2, you can
modify only the comment
for a rule.

String, case-insensitive. This column is available

User group
UserGroup N/A when the UserGroupAny
name. Length: 1 to 32 characters. column is false.
Boolean:

Whether a rule • true—Matches any user

UserGroupAn group.
matches any N/A N/A
y • false—Matches the
user group.
specified user group
(default).
Hexadecimal string.
Config a gre Only the GRE protocol
GreValue N/A Length: 1 to 8 characters.
value. supports this column.
Value range: 0 to FFFFFFFF.
Boolean: Only when the
Options IP options. N/A • true—Options. ProtocolType value is
• false—Not options, 256,and then the table
default. can supports this column.

FragmentTyp Check fragment Unsigned integer.

N/A N/A
e packet type. Value range: 0 to 3.

54
 Column Column Column
Data type and restrictions Remarks
name description type
• 0—First-fragment.
• 1—Non-fragment.
• 2—Non-or-first-fragmen
t.
• 3—Any-fragment.

Members include:
Whether a rule Data • TtlOp.
Ttl N/A
matches TTL. structure • TtlValue1.
• TtlValue2.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
TtlOp TTL operator. N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).
Unsigned integer.
TtlValue1 Start TTL value. N/A Value range: 1 to 255. N/A

When the TtlOp is 5, the

value range is 1 to 255.
Unsigned integer. Otherwise, it can only be
TtlValue2 End TTL value. N/A
Value range: 1 to 256. 256. The value 256
indicates that the end TTL
value is not available.
Members include:
Whether a rule
Data • PktLengthOp.
PktLength matches packet N/A
length.
structure • PktLengthValue1.
• PktLengthValue2.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Packet length
PktLengthOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

PktLengthVal Start packet Unsigned integer.

N/A N/A
ue1 length value. Value range: 0 to 65535.
When the PktLengthOp is
5, the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
PktLengthVal End packet
N/A only be 65536. The value
ue2 length value. Value range: 0 to 65536. 65536 indicates that the
packet length value is not
available.

ACL/MACRules
This table contains information about Ethernet frame header ACL rules.

55
XML structure
<ACL>
<MACRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<SrcMACAddr>
<SrcMACAddress></SrcMACAddress>
<SrcMACMask></SrcMACMask>
</SrcMACAddr>
<DstMACAddr>
<DstMACAddress></DstMACAddress>
<DstMACMask></DstMACMask>
</DstMACAddr>
<COS></COS>
<Protocol>
<ProtocolType></ProtocolType>
<ProtocolTypeMask></ProtocolTypeMask>
</Protocol>
<LSAP>
<LSAPType></LSAPType>
<LSAPTypeMask></LSAPTypeMask>
</LSAP>
<EncapType></EncapType>
<VxlanID></VxlanID>
<InSrcMACAddr>
<InSrcMACAddress></InSrcMACAddress>
<InSrcMACMask></InSrcMACMask>
</InSrcMACAddr>
<InDstMACAddr>
<InDstMACAddress></InDstMACAddress>
<InDstMACMask></InDstMACMask>
</InDstMACAddr>
<InProtocol>
<InProtocolType></InProtocolType>
<InProtocolTypeMask></InProtocolTypeMask>
</InProtocol>
<TimeRange></TimeRange>
<Counting></Counting>
<Comment></Comment>
</Rule>
</MACRules>
</ACL>

56
Table description
Item Description
Feature name ACL
Table name MACRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
You must create an ACL
Unsigned integer. first before you create,
GroupID ACL number. Index
Value range: 4000 to 4999. merge, or replace rules for
it.
If you set this column to
65535, the system
Unsigned integer. automatically assigns a
Value range: 0 to 65535. new rule ID. This rule ID is
RuleID Rule ID. Index
The value 65535 is an invalid the nearest higher
rule ID. multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
action when you remove
Action on or delete a rule.
Enumeration:
packets You must specify an
Action
matching the
N/A • 1—Deny.
action when you replace a
rule. • 2—Permit. rule, or when you merge
or create a rule that does
not exist.

Information The VXLAN

Members include:
about the Data encapsulation supports
SrcMACAddr
source MAC structure • SrcMACAddress. this column.
address. • SrcMACMask. The members must both
be specified.
Six groups of two
SrcMACAddr Source MAC Example:
N/A hexadecimal digits,
ess address. 00-0c-af-e3-5d-c0.
hyphen-separated.
Mask of the Six groups of two
SrcMACMask source MAC N/A hexadecimal digits, Example: ff-ff-ff-ff-ff-ff.
address. hyphen-separated.

Information Members include: The VXLAN

about the Data encapsulation supports
DstMACAddr
destination structure • DstMACAddress.
this column.
MAC address. • DstMACMask.
The members must both

57
Column Column Column
Data type and restrictions Remarks
name description type
be specified.
Six groups of two
DstMACAddr Destination Example:
N/A hexadecimal digits,
ess MAC address. 00-0c-af-e3-5d-c0.
hyphen-separated.
Mask of the Six groups of two
DstMACMask destination N/A hexadecimal digits, Example: ff-ff-ff-ff-ff-ff.
MAC address. hyphen-separated.
Unsigned integer.
COS 802.1p priority. N/A N/A
Value range: 0 to 7.

The VXLAN
encapsulation supports
Members include: this column.
Link layer Data
Protocol
protocol. structure • ProtocolType. The members must both
be specified.
• ProtocolTypeMask.
This column and the
LSAP column cannot both
be configured.
Hexadecimal string. Values of link layer
Type of the link
ProtocolType N/A Length: 1 to 4 characters. protocol types are
layer protocol.
Value range: 0 to FFFF. assigned by IANA.

Mask of the Hexadecimal string.

ProtocolType
link layer N/A Length: 1 to 4 characters. N/A
Mask
protocol type. Value range: 0 to FFFF.
The members must both
Members include: be specified.
Data
LSAP LSAP.
structure • LSAPType. This column and the
• LSAPTypeMask. Protocol column cannot
both be configured.
Hexadecimal string.
LSAPType Type of LSAP. N/A Length: 1 to 4 characters. N/A
Value range: 0 to FFFF.
Hexadecimal string.
LSAPTypeMa Mask of the
N/A Length: 1 to 4 characters. N/A
sk LSAP type.
Value range: 0 to FFFF.
Members include:

Encapsulation • VXLAN encapsulation.

EncapType N/A • GRE encapsulation. N/A
type.
• IPINIP encapsulation.

Unsigned integer Only the VXLAN

VxlanID VXLAN ID. N/A encapsulation supports
Value range: 0 to 16777215 this column.

Only the VXLAN

Information Members include: encapsulation supports
InSrcMACAd about the inner Data
dr source MAC structure • InSrcMACAddress. this column.
address. • InSrcMACMask.
The members must both

58
Column Column Column
Data type and restrictions Remarks
name description type
be specified.

Six groups of two

InSrcMACAd Inner source Example:
N/A hexadecimal digits,
dress MAC address. 00-0c-af-e3-5d-c0.
hyphen-separated.

Mask of the Six groups of two

InSrcMACMa
sk
inner source N/A hexadecimal digits, Example: ff-ff-ff-ff-ff-ff.
MAC address. hyphen-separated.

Only the VXLAN

Information Members include: encapsulation supports
InDstMACAd about the inner Data this column.
dr destination structure • InDstMACAddress.
MAC address. • InDstMACMask. The members must both
be specified.

Inner Six groups of two

InDstMACAd Example:
destination N/A hexadecimal digits,
dress 00-0c-af-e3-5d-c0.
MAC address. hyphen-separated.

Mask of the
Six groups of two
InDstMACMa inner
sk destination
N/A hexadecimal digits, Example: ff-ff-ff-ff-ff-ff.
hyphen-separated.
MAC address.

Only the VXLAN

encapsulation supports
Members include: this column.
Inner link layer Data
InProtocol
protocol. structure • ProtocolType. The members must both
• ProtocolTypeMask. be specified.

Hexadecimal string.
Type of the Values of inner link layer
InProtocolTyp
inner link layer N/A Length: 1 to 4 characters. protocol types are
e
protocol. assigned by IANA.
Value range: 0 to FFFF.

Hexadecimal string.
Mask of the
InProtocolTyp
inner link layer N/A Length: 1 to 4 characters. N/A
eMask
protocol type.
Value range: 0 to FFFF.
String, case-insensitive.
Length: 1 to 32 characters.
TimeRange Time range. N/A It cannot be the word all.
The string must start with an
English letter.
Boolean:
Whether to
Counting count the rule N/A • true—Counts the rule N/A
matches. matches.
• false—Does not count

59
 Column Column Column
Data type and restrictions Remarks
name description type
the rule matches
(default).
A comment can only be
configured for an existing
rule.
String, case-sensitive.
Comment Rule comment. N/A When the MatchOrder
Length: 1 to 127 characters.
column is 2, you can
modify only the comment
for a rule.

ACL/MACNamedRules
This table contains information about Named Ethernet frame header ACL rules.

XML structure
<ACL>
<MACNamedRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<SrcMACAddr>
<SrcMACAddress></SrcMACAddress>
<SrcMACMask></SrcMACMask>
</SrcMACAddr>
<DstMACAddr>
<DstMACAddress></DstMACAddress>
<DstMACMask></DstMACMask>
</DstMACAddr>
<COS></COS>
<Protocol>
<ProtocolType></ProtocolType>
<ProtocolTypeMask></ProtocolTypeMask>
</Protocol>
<LSAP>
<LSAPType></LSAPType>
<LSAPTypeMask></LSAPTypeMask>
</LSAP>
<EncapType></EncapType>
<VxlanID></VxlanID>
<InSrcMACAddr>
<InSrcMACAddress></InSrcMACAddress >
<InSrcMACMask></InSrcMACMask>
</InSrcMACAddr>
<InDstMACAddr>
<InDstMACAddress></InDstMACAddress>

60
 <InDstMACMask></InDstMACMask>
</InDstMACAddr>
<InProtocol>
<InProtocolType></InProtocolType>
<InProtocolTypeMask></InProtocolTypeMask>
</InProtocol>
<TimeRange></TimeRange>
<Counting></Counting>
<Comment></Comment>
</Rule>
</MACNamedRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name MACNamedRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
Length: 1 to 63 characters.
• ACL name: You must create an ACL
ACL name or Case-insensitive string first before you create,
GroupIndex Index
number. of 1 to 63 characters. merge, or replace rules for
• ACL number: it.
String of digits in the
range of 4000 to 4999.
If you set this column to
65535, the system
Unsigned integer. automatically assigns a
Value range: 0 to 65535. new rule ID. This rule ID is
RuleID Rule ID. Index
The value 65535 is an invalid the nearest higher
rule ID. multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
Action on Enumeration: action when you remove
packets or delete a rule.
Action
matching the
N/A • 1—Deny.
You must specify an
rule. • 2—Permit.
action when you replace a
rule, or when you merge

61
Column Column Column
Data type and restrictions Remarks
name description type
or create a rule that does
not exist.

Information The VXLAN

Members include:
about the Data encapsulation supports
SrcMACAddr
source MAC structure • SrcMACAddress. this column.
address. • SrcMACMask. The members must both
be specified.
Six groups of two
SrcMACAddr Source MAC Example:
N/A hexadecimal digits,
ess address. 00-0c-af-e3-5d-c0.
hyphen-separated.
Mask of the Six groups of two
SrcMACMask source MAC N/A hexadecimal digits, Example: ff-ff-ff-ff-ff-ff.
address. hyphen-separated.

Information The VXLAN

Members include:
about the Data encapsulation supports
DstMACAddr
destination structure • DstMACAddress. this column.
MAC address. • DstMACMask. The members must both
be specified.
Six groups of two
DstMACAddr Destination Example:
N/A hexadecimal digits,
ess MAC address. 00-0c-af-e3-5d-c0.
hyphen-separated.
Mask of the Six groups of two
DstMACMask destination N/A hexadecimal digits, Example: ff-ff-ff-ff-ff-ff.
MAC address. hyphen-separated.
Unsigned integer.
COS 802.1p priority. N/A N/A
Value range: 0 to 7.

The VXLAN
encapsulation supports
Members include: this column.
Link layer Data
Protocol
protocol. structure • ProtocolType. The members must both
be specified.
• ProtocolTypeMask.
This column and the
LSAP column cannot both
be configured.
Hexadecimal string. Values of link layer
Type of the link
ProtocolType N/A Length: 1 to 4 characters. protocol types are
layer protocol.
Value range: 0 to FFFF. assigned by IANA.

Mask of the Hexadecimal string.

ProtocolType
link layer N/A Length: 1 to 4 characters. N/A
Mask
protocol type. Value range: 0 to FFFF.
The members must both
Members include: be specified.
Data
LSAP LSAP.
structure • LSAPType. This column and the
• LSAPTypeMask. Protocol column cannot
both be configured.
Hexadecimal string.
LSAPType Type of LSAP. N/A N/A
Length: 1 to 4 characters.

62
Column Column Column
Data type and restrictions Remarks
name description type
Value range: 0 to FFFF.
Hexadecimal string.
LSAPTypeMa Mask of the
N/A Length: 1 to 4 characters. N/A
sk LSAP type.
Value range: 0 to FFFF.
Members include:

Encapsulation • VXLAN encapsulation.

EncapType N/A • GRE encapsulation. N/A
type.
• IPINIP encapsulation.

Unsigned integer Only the VXLAN

VxlanID VXLAN ID. N/A encapsulation supports
Value range: 0 to 16777215 this column.

Only the VXLAN

Information Members include: encapsulation supports
InSrcMACAd about the inner Data this column.
dr source MAC structure • InSrcMACAddress.
address. • InSrcMACMask. The members must both
be specified.

Six groups of two

InSrcMACAd Inner source Example:
N/A hexadecimal digits,
dress MAC address. 00-0c-af-e3-5d-c0.
hyphen-separated.

Mask of the Six groups of two

InSrcMACMa
sk
inner source N/A hexadecimal digits, Example: ff-ff-ff-ff-ff-ff.
MAC address. hyphen-separated.

Only the VXLAN

Information Members include: encapsulation supports
InDstMACAd about the inner Data this column.
dr destination structure • InDstMACAddress.
MAC address. • InDstMACMask. The members must both
be specified.

Inner Six groups of two

InDstMACAd Example:
destination N/A hexadecimal digits,
dress 00-0c-af-e3-5d-c0.
MAC address. hyphen-separated.

Mask of the
Six groups of two
InDstMACMa inner
sk destination
N/A hexadecimal digits, Example: ff-ff-ff-ff-ff-ff.
hyphen-separated.
MAC address.

Only the VXLAN

encapsulation supports
Members include: this column.
Inner link layer Data
InProtocol
protocol. structure • ProtocolType. The members must both
• ProtocolTypeMask. be specified.

InProtocolTyp Type of the N/A Hexadecimal string. Values of inner link layer

63
 Column Column Column
Data type and restrictions Remarks
name description type
e inner link layer protocol types are
protocol. Length: 1 to 4 characters. assigned by IANA.

Value range: 0 to FFFF.

Hexadecimal string.
Mask of the
InProtocolTyp
inner link layer N/A Length: 1 to 4 characters. N/A
eMask
protocol type.
Value range: 0 to FFFF.
String, case-insensitive.
Length: 1 to 32 characters.
TimeRange Time range. N/A It cannot be the word all.
The string must start with an
English letter.
Boolean:

Whether to • true—Counts the rule

Counting count the rule N/A matches. N/A
matches. • false—Does not count
the rule matches
(default).
A comment can only be
configured for an existing
rule.
String, case-sensitive.
Comment Rule comment. N/A When the MatchOrder
Length: 1 to 127 characters.
column is 2, you can
modify only the comment
for a rule.

ACL/PfilterIgnoreAction
This table contains information about the ignoring packet filter permit action.

XML structure
<ACL>
<PfilterIgnoreAction>
<IgnoreAction></IgnoreAction>
</PfilterIgnoreAction>
</ACL>

Table description
Item Description
Feature name ACL
Table name PfilterIgnoreAction
Table type Single-instance table
Row name N/A

64
 Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:

Whether to • true—Ignore
ignore the the packet filter permit
IgnoreAction N/A action. N/A
packet filter
permit action. • false—Not
ignore the packet filter
permit action (default).

ACL/PfilterDefAction
This table contains information about the default global packet filter actions.

XML structure
<ACL>
<PfilterDefAction>
<DefaultAction></DefaultAction>
</PfilterDefAction>
</ACL>

Table description
Item Description
Feature name ACL
Table name PfilterDefAction
Table type Single-instance table
Row name N/A
Restrictions None
Support for row creation and deletion No

Columns
Column Column
Column name Data type and restrictions
description type
Enumeration:
Default packet
DefaultAction
filter action
N/A • 1—Permit (default).
• 2—Deny.

65
ACL/PfilterApply
This table contains information about packet filter application.

XML structure
<ACL>
<PfilterApply>
<Pfilter>
<AppObjType></AppObjType>
<AppObjIndex></AppObjIndex>
<AppDirection></AppDirection>
<AppAclType></AppAclType>
<AppAclGroup></AppAclGroup>
<HardCount></HardCount>
<InnerEncap></InnerEncap>
<ShareMode></ShareMode>
</Pfilter>
</PfilterApply>
</ACL>

Table description
Item Description
Feature name ACL
Table name PfilterApply
Table type Multi-instance table
Row name Pfilter
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
Type of the Support for the specified
• 1—Interface.
AppObjType application Index type depends on the
object. • 2—VLAN. device model.
• 3—Global.
The value depends on the
Index of the Unsigned integer. AppObjType column.
AppObjIndex application Index Value range: 0 to • Interface index if
object. 4294967295. AppObjType is 1.
• VLAN ID in the range

66
 Column Column Column
Data type and restrictions Remarks
name description type
of 1 to 4094 if
AppObjType is 2.
• The value is 0 if
AppObjType is 3.
Enumeration:
Application
AppDirection
direction.
Index • 1—Inbound. N/A
• 2—Outbound.
Enumeration:
• 1—IPv4 ACL.
• 2—IPv6 ACL.
• Type 5 is a special
AppAclType ACL type. Index • 3—MAC ACL. ACL.
• 4—User-defined ACL.
• 5—ACL with the default
action.
An ACL name must start
with an English letter and
cannot be all.
String. The value range depends
Length: 1 to 63 characters. on the AppAclType
column.
• ACL name:
Case-insensitive string • 2000 to 3999 if
ACL name or AppAclType is 1.
AppAclGroup Index of 1 to 63 characters.
number.
• ACL number: • 2000 to 3999 if
String of digits valued 0 AppAclType is 2.
or in the range of 2000 • 4000 to 4999 if
to 5999. AppAclType is 3.
• 5000 to 5999 if
AppAclType is 4.
• 0 if AppAclType is 5.
Support for this function
Whether to count Enumeration: depends on the device
rule matches in model.
HardCount
hardware for the
N/A • 1—enable.
Global default action and
ACL. • 2—disable. VLAN default action do
not support this function.
Match the inner Support for this function
packet Enumeration: depends on the device
InnerEncap information of N/A • 0—None (default). model.
encapsulation • 1—VXLAN. This column cannot be
packets. modified.
Boolean:
Support for this function
Whether to apply • true—Apply the ACL in depends on the device
the ACL in N/A sharing mode. model.
ShareMode
sharing mode. • false—Do not apply the This column cannot be
ACL in sharing mode modified.
(default).

ACL/UserRules
This table contains information about user-defined ACL rules.

67
XML structure
<ACL>
<UserRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<L2Rule>
<L2RuleString></L2RuleString>
<L2RuleMask></L2RuleMask>
<L2Offset></L2Offset>
</L2Rule>
<IPv4Rule>
<IPv4RuleString></IPv4RuleString>
<IPv4RuleMask></IPv4RuleMask>
<IPv4Offset></IPv4Offset>
</IPv4Rule>
<IPv6Rule>
<IPv6RuleString></IPv6RuleString>
<IPv6RuleMask></IPv6RuleMask>
<IPv6Offset></IPv6Offset>
</IPv6Rule>
<L4Rule>
<L4RuleString></L4RuleString>
<L4RuleMask></L4RuleMask>
<L4Offset></L4Offset>
</L4Rule>
<L5Rule>
<L5RuleString></L5RuleString>
<L5RuleMask></L5RuleMask>
<L5Offset></L5Offset>
</L5Rule>
<UdfFormat></UdfFormat>
<ProtocolType></ProtocolType>
<IPv6ProtocolType></IPv6ProtocolType>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>

68
 <DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<DstIPv6>
<DstIPv6Addr></DstIPv6Addr>
<DstIPv6Prefix></DstIPv6Prefix>
</DstIPv6>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<DSCP></DSCP>
<TimeRange></TimeRange>
<Counting></Counting>
<Comment></Comment>
</Rule>
</UserRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name UserRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
You must create an ACL
Unsigned integer. first before you create,
GroupID ACL number. Index
Value range: 5000 to 5999. merge, or replace rules for
it.

Unsigned integer. If you set this column to

Value range: 0 to 65535. 65535, the system
RuleID Rule ID. Index automatically assigns a
The value 65535 is an invalid new rule ID. This rule ID is
rule ID. the nearest higher

69
Column Column Column
Data type and restrictions Remarks
name description type
multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
action when you remove
Action on or delete a rule.
Enumeration:
packets You must specify an
Action
matching the
N/A • 1—Deny.
action when you replace a
rule. • 2—Permit. rule, or when you merge
or create a rule that does
not exist.

Specifies that the Members include:

offset is relative • L2RuleString.
Data The members must all be
L2Rule to the beginning
structure • L2RuleMask. specified.
of the Layer 2
frame header. • L2Offset.
Hexadecimal string.
String for the The length must be an
L2RuleString N/A Length: 2 to the
match pattern. even number.
device-specific upper limit.

Hexadecimal string. The length must be an

Match pattern even number, and equal
L2RuleMask N/A Length: 2 to the
mask. to that of the match
device-specific upper limit. pattern string.
Offset in bytes Unsigned integer.
after which the
L2Offset N/A Value range: 0 to the N/A
match operation
begins. device-specific upper limit.

Specifies that the Members include:

offset is relative • IPv4RuleString.
Data The members must all be
IPv4Rule to the beginning
structure • IPv4RuleMask. specified.
of the IPv4
header. • IPv4Offset.
Hexadecimal string.
IPv4RuleStrin String for the The length must be an
N/A Length: 2 to the
g match pattern. even number.
device-specific upper limit.

Hexadecimal string. The length must be an

IPv4RuleMas Match pattern even number, and equal
N/A Length: 2 to the
k mask. to that of the match
device-specific upper limit. pattern string.
Offset in bytes Unsigned integer.
after which the
IPv4Offset N/A Value range: 0 to the N/A
match operation
begins. device-specific upper limit.

Specifies that the Members include:

offset is relative • IPv6RuleString.
Data The members must all be
IPv6Rule to the beginning
structure • IPv6RuleMask. specified.
of the IPv6
header. • IPv6Offset.
Hexadecimal string.
IPv6RuleStrin String for the The length must be an
N/A Length: 2 to the
g match pattern. even number.
device-specific upper limit.

IPv6RuleMas Match pattern N/A Hexadecimal string. The length must be an

70
Column Column Column
Data type and restrictions Remarks
name description type
k mask. Length: 2 to the even number, and equal
device-specific upper limit. to that of the match
pattern string.
Specifies an
offset in bytes Unsigned integer.
IPv6Offset after which the N/A Value range: 0 to the N/A
match operation device-specific upper limit.
begins.

Specifies that the Members include:

offset is relative • L4RuleString.
Data The members must all be
L4Rule to the beginning
structure • L4RuleMask. specified.
of the Layer 4
header. • L4Offset.
Hexadecimal string.
String for the The length must be an
L4RuleString N/A Length: 2 to the
match pattern. even number.
device-specific upper limit.

Hexadecimal string. The length must be an

Match pattern even number, and equal
L4RuleMask N/A Length: 2 to the
mask. to that of the match
device-specific upper limit. pattern string.
Specifies an
offset in bytes Unsigned integer.
L4Offset after which the N/A Value range: 0 to the N/A
match operation device-specific upper limit.
begins.

Members include: This column is available

Specifies that the when the ProtocolType is
offset is relative Data • L5RuleString. specified.
L5Rule to the beginning structure • L5RuleMask.
of the payload. The members must all be
• L5Offset. specified.
Hexadecimal string.
String for the The length must be an
L5RuleString N/A Length: 2 to the
match pattern. even number.
device-specific upper limit.

Hexadecimal string. The length must be an

Match pattern even number, and equal
L5RuleMask N/A Length: 2 to the
mask. to that of the match
device-specific upper limit. pattern string.
Specifies an
offset in bytes Unsigned integer.
L5Offset after which the N/A Value range: 0 to the N/A
match operation device-specific upper limit.
begins.
Enumeration:
This column is available
User-defined • 1—IFA packet.
UdfFormat N/A when the ProtocolType is
packet fortmat. • 2—Raw ip packet. specified.
• 3—VXLAN packet.
Unsigned integer.
You cannot specify a
Value range: 0 to 256.
ProtocolType Protocol type. N/A protocol type when you
The value 256 represents all remove or delete a rule.
IPv4 protocols.

71
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
You cannot specify a
IPv6ProtocolT Value range: 0 to 256.
Protocol type. N/A protocol type when you
ype The value 256 represents all remove or delete a rule.
IPv6 protocols.
Boolean: This column is available
• true—Matches any when the ProtocolType is
Whether a rule specified.
matches any source IP addresses
SrcAny N/A (default). This column must be
source IP
addresses. • false—Matches the configured together with
specified source IP the SrcIPv4 or SrcIPv6
address. column.

This column must be

Members include: configured together with
Source IPv4 Data the SrcAny column.
SrcIPv4 information. structure • SrcIPv4Addr.
• SrcIPv4Wildcard. The two members must
both be specified.
Example: 1.1.1.1.
This column is available
Source IPv4 String, dotted decimal when the SrcAny column
SrcIPv4Addr N/A
address. notation. is false.
It must be empty when the
SrcAny column is true.
Example: 255.255.255.0.
This column is available
Wildcard mask
SrcIPv4Wildc String, dotted decimal when the SrcAny column
for the source N/A
ard notation. is false.
IPv4 address.
It must be empty when the
SrcAny column is true.
This column must be
Members include: configured together with
Source IPv6 Data
SrcIPv6 • SrcIPv6Addr. the SrcAny column.
information. structure
SrcIPv6Prefix. The two members must
both be specified.
Example: 1:1::1:1.
This column is available
Source IPv6 Hexadecimal string, when the SrcAny column
SrcIPv6Addr N/A
address. colon-separated. is false.
It must be empty when the
SrcAny column is true.
This column is available
Length of the when the SrcAny column
Unsigned integer.
source IPv6 N/A is false.
SrcIPv6Prefix Value range: 1 to 128.
address prefix. It must be empty when the
SrcAny column is true.
Boolean: This column is available
• true—Matches any when the ProtocolType is
Whether a rule specified.
matches any destination IP
DstAny N/A addresses (default). This column must be
destination IP
addresses. • false—Matches the configured together with
specified destination IP the DstIPv4 or DstIPv6
address. column.

72
Column Column Column
Data type and restrictions Remarks
name description type
This column must be
Members include: configured together with
Destination IPv4 Data the DstAny column.
DstIPv4 information. structure • DstIPv4Addr.
• DstIPv4Wildcard. The two members must
both be specified.
Example: 1.1.1.1.
This column is available
Destination IPv4 String, dotted decimal when the DstAny column
DstIPv4Addr N/A
address. notation. is false.
It must be empty when the
DstAny column is true.
Example: 255.255.255.0.
Wildcard mask This column is available
DstIPv4Wildc for the String, dotted decimal when the DstAny column
N/A
ard destination IPv4 notation. is false.
address. It must be empty when the
DstAny column is true.
This column must be
Members include: configured together with
Destination IPv6 Data
DstIPv6 • DstIPv6Addr. the DstAny column.
information. structure
DstIPv6Prefix. The two members must
both be specified.
Example: 1:1::1:1.
This column is available
Destination IPv6 Hexadecimal string, when the DstAny column
DstIPv6Addr N/A
address. colon-separated. is false.
It must be empty when the
DstAny column is true.
This column is available
Length of the when the DstAny column
Unsigned integer.
destination IPv6 N/A is false.
DstIPv6Prefix Value range: 1 to 128.
address prefix. It must be empty when the
DstAny column is true.

Members include: Only the TCP and UDP

protocols support this
Source port Data • SrcPortOp.
column.
SrcPort information. structure • SrcPortValue1.
The members must be all
• SrcPortValue2. specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Source port
SrcPortOp operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
SrcPortValue Start source port. N/A N/A
1 Value range: 0 to 65535.

Unsigned integer. When SrcPortOp is 5, the

SrcPortValue End source port. N/A
2 Value range: 0 to 65536. value range is 0 to 65535.

73
 Column Column Column
Data type and restrictions Remarks
name description type
Otherwise, it can only be
65536. The value 65536
indicates that the end
source port is not
available.

Members include: Only the TCP and UDP

protocols support this
Destination port Data • DstPortOp.
column.
DstPort information. structure • DstPortValue1.
The members must be all
• DstPortValue2. specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port
DstPortOp operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Start destination Unsigned integer.

DstPortValue N/A N/A
1 port. Value range: 0 to 65535.

When DstPortOp is 5, the

value range is 0 to 65535.
Unsigned integer. Otherwise, it can only be
DstPortValue End destination
N/A 65536. The value 65536
2 port. Value range: 0 to 65536. indicates that the end
destination port is not
available.

Unsigned integer. This column is available

DSCP DSCP priority. N/A when the ProtocolType is
Value range: 0 to 63. specified.
String, case-insensitive.
Length: 1 to 32 characters.
TimeRange Time range. N/A It cannot be the word all.
The string must start with an
English letter.
Boolean:
• true—Counts the rule
Whether to count matches.
Counting N/A N/A
the rule matches. • false—Does not count
the rule matches
(default).

String, case-sensitive. A comment can only be

Comment Rule comment. N/A configured for an existing
Length: 1 to 127 characters. rule.

ACL/UserNamedRules
This table contains information about named user-defined ACL rules.

74
XML structure
<ACL>
<UserNamedRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<L2Rule>
<L2RuleString></L2RuleString>
<L2RuleMask></L2RuleMask>
<L2Offset></L2Offset>
</L2Rule>
<IPv4Rule>
<IPv4RuleString></IPv4RuleString>
<IPv4RuleMask></IPv4RuleMask>
<IPv4Offset></IPv4Offset>
</IPv4Rule>
<IPv6Rule>
<IPv6RuleString></IPv6RuleString>
<IPv6RuleMask></IPv6RuleMask>
<IPv6Offset></IPv6Offset>
</IPv6Rule>
<L4Rule>
<L4RuleString></L4RuleString>
<L4RuleMask></L4RuleMask>
<L4Offset></L4Offset>
</L4Rule>
<L5Rule>
<L5RuleString></L5RuleString>
<L5RuleMask></L5RuleMask>
<L5Offset></L5Offset>
</L5Rule>
<UdfFormat></UdfFormat>
<ProtocolType></ProtocolType>
<IPv6ProtocolType></IPv6ProtocolType>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>

75
 <DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<DstIPv6>
<DstIPv6Addr></DstIPv6Addr>
<DstIPv6Prefix></DstIPv6Prefix>
</DstIPv6>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<DSCP></DSCP>
<TimeRange></TimeRange>
<Counting></Counting>
<Comment></Comment>
</Rule>
</UserNamedRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name UserNamedRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
Length: 1 to 63 characters.
• ACL name: You must create an ACL
ACL name or Case-insensitive string first before you create,
GroupIndex Index
number. of 1 to 63 characters. merge, or replace rules for
• ACL number: it.
String of digits in the
range of 5000 to 5999.

76
Column Column Column
Data type and restrictions Remarks
name description type
If you set this column to
65535, the system
Unsigned integer. automatically assigns a
Value range: 0 to 65535. new rule ID. This rule ID is
RuleID Rule ID. Index
The value 65535 is an invalid the nearest higher
rule ID. multiple of the numbering
step to the current highest
rule ID, starting from 0.
You cannot specify an
action when you remove
Action on or delete a rule.
Enumeration:
packets You must specify an
Action
matching the
N/A • 1—Deny.
action when you replace a
rule. • 2—Permit. rule, or when you merge
or create a rule that does
not exist.

Specifies that the Members include:

offset is relative • L2RuleString.
Data The members must all be
L2Rule to the beginning
structure • L2RuleMask. specified.
of the Layer 2
frame header. • L2Offset.
Hexadecimal string.
String for the The length must be an
L2RuleString N/A Length: 2 to the
match pattern. even number.
device-specific upper limit.

Hexadecimal string. The length must be an

Match pattern even number, and equal
L2RuleMask N/A Length: 2 to the
mask. to that of the match
device-specific upper limit. pattern string.
Offset in bytes Unsigned integer.
after which the
L2Offset N/A Value range: 0 to the N/A
match operation
begins. device-specific upper limit.

Specifies that the Members include:

offset is relative • IPv4RuleString.
Data The members must all be
IPv4Rule to the beginning
structure • IPv4RuleMask. specified.
of the IPv4
header. • IPv4Offset.
Hexadecimal string.
IPv4RuleStrin String for the The length must be an
N/A Length: 2 to the
g match pattern. even number.
device-specific upper limit.

Hexadecimal string. The length must be an

IPv4RuleMas Match pattern even number, and equal
N/A Length: 2 to the
k mask. to that of the match
device-specific upper limit. pattern string.
Offset in bytes Unsigned integer.
after which the
IPv4Offset N/A Value range: 0 to the N/A
match operation
begins. device-specific upper limit.

Specifies that the Members include:

offset is relative • IPv6RuleString.
Data The members must all be
IPv6Rule to the beginning
structure • IPv6RuleMask. specified.
of the IPv6
header. • IPv6Offset.

77
Column Column Column
Data type and restrictions Remarks
name description type
Hexadecimal string.
IPv6RuleStrin String for the The length must be an
N/A Length: 2 to the
g match pattern. even number.
device-specific upper limit.

Hexadecimal string. The length must be an

IPv6RuleMas Match pattern even number, and equal
N/A Length: 2 to the
k mask. to that of the match
device-specific upper limit. pattern string.
Specifies an
offset in bytes Unsigned integer.
IPv6Offset after which the N/A Value range: 0 to the N/A
match operation device-specific upper limit.
begins.

Specifies that the Members include:

offset is relative • L4RuleString.
Data The members must all be
L4Rule to the beginning
structure • L4RuleMask. specified.
of the Layer 4
header. • L4Offset.
Hexadecimal string.
String for the The length must be an
L4RuleString N/A Length: 2 to the
match pattern. even number.
device-specific upper limit.

Hexadecimal string. The length must be an

Match pattern even number, and equal
L4RuleMask N/A Length: 2 to the
mask. to that of the match
device-specific upper limit. pattern string.
Specifies an
offset in bytes Unsigned integer.
L4Offset after which the N/A Value range: 0 to the N/A
match operation device-specific upper limit.
begins.

This column is available

Members include:
Specifies that the when the ProtocolType is
offset is relative Data • L5RuleString. specified.
L5Rule
to the beginning structure • L5RuleMask.
of the payload. The members must all be
• L5Offset.
specified.

Hexadecimal string.
String for the The length must be an
L5RuleString N/A
match pattern. Length: 2 to the even number.
device-specific upper limit.

Hexadecimal string. The length must be an

Match pattern even number, and equal
L5RuleMask N/A
mask. Length: 2 to the to that of the match
device-specific upper limit. pattern string.

Specifies an Unsigned integer.

offset in bytes
L5Offset after which the N/A N/A
match operation Value range: 0 to the
begins. device-specific upper limit.

UdfFormat User-defined N/A Enumeration: This column is available

78
Column Column Column
Data type and restrictions Remarks
name description type
packet fortmat. • 1—IFA packet. when the ProtocolType is
• 2—Raw ip packet. specified.
• 3—VXLAN packet.

Unsigned integer.
You cannot specify a
Value range: 0 to 256.
ProtocolType Protocol type. N/A protocol type when you
remove or delete a rule.
The value 256 represents all
IPv4 protocols.
Unsigned integer.
Value range: 0 to 256. You cannot specify a
IPv6ProtocolT
Protocol type. N/A protocol type when you
ype The value 256 represents all remove or delete a rule.
IPv6 protocols.

Boolean: This column is available

when the ProtocolType is
Whether a rule • true—Matches any specified.
matches any source IP addresses
SrcAny N/A (default).
source IP This column must be
addresses. • false—Matches the configured together with
specified source IP the SrcIPv4 or SrcIPv6
address. column.

This column must be

Members include: configured together with
Source IPv4 Data the SrcAny column.
SrcIPv4
information. structure • SrcIPv4Addr.
• SrcIPv4Wildcard. The two members must
both be specified.

Example: 1.1.1.1.

This column is available

Source IPv4 String, dotted decimal when the SrcAny column
SrcIPv4Addr N/A
address. notation. is false.

It must be empty when the

SrcAny column is true.

Example: 255.255.255.0.

This column is available

Wildcard mask
SrcIPv4Wildc String, dotted decimal when the SrcAny column
for the source N/A
ard notation. is false.
IPv4 address.
It must be empty when the
SrcAny column is true.

This column must be

Members include: configured together with
SrcIPv6
Source IPv6 Data • SrcIPv6Addr. the SrcAny column.
information. structure
SrcIPv6Prefix. The two members must
both be specified.

79
Column Column Column
Data type and restrictions Remarks
name description type

Example: 1:1::1:1.

This column is available

Source IPv6 Hexadecimal string, when the SrcAny column
SrcIPv6Addr N/A
address. colon-separated. is false.

It must be empty when the

SrcAny column is true.

This column is available

when the SrcAny column
Length of the Unsigned integer.
is false.
SrcIPv6Prefix source IPv6 N/A
address prefix. Value range: 1 to 128.
It must be empty when the
SrcAny column is true.

Boolean: This column is available

when the ProtocolType is
Whether a rule • true—Matches any specified.
matches any destination IP
DstAny N/A addresses (default).
destination IP This column must be
addresses. • false—Matches the configured together with
specified destination IP the DstIPv4 or DstIPv6
address. column.

This column must be

Members include: configured together with
Destination IPv4 Data the DstAny column.
DstIPv4
information. structure • DstIPv4Addr.
• DstIPv4Wildcard. The two members must
both be specified.

Example: 1.1.1.1.

This column is available

Destination IPv4 String, dotted decimal when the DstAny column
DstIPv4Addr N/A
address. notation. is false.

It must be empty when the

DstAny column is true.

Example: 255.255.255.0.

Wildcard mask This column is available

DstIPv4Wildc for the String, dotted decimal when the DstAny column
N/A
ard destination IPv4 notation. is false.
address.
It must be empty when the
DstAny column is true.

This column must be

Members include: configured together with
DstIPv6
Destination IPv6 Data • DstIPv6Addr. the DstAny column.
information. structure
DstIPv6Prefix. The two members must
both be specified.

80
Column Column Column
Data type and restrictions Remarks
name description type

Example: 1:1::1:1.

This column is available

Destination IPv6 Hexadecimal string, when the DstAny column
DstIPv6Addr N/A
address. colon-separated. is false.

It must be empty when the

DstAny column is true.

This column is available

when the DstAny column
Length of the Unsigned integer.
is false.
DstIPv6Prefix destination IPv6 N/A
address prefix. Value range: 1 to 128.
It must be empty when the
DstAny column is true.

Only the TCP and UDP

Members include: protocols support this
Source port Data • SrcPortOp. column.
SrcPort
information. structure • SrcPortValue1.
The members must be all
• SrcPortValue2.
specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Source port
SrcPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
SrcPortValue
Start source port. N/A N/A
1
Value range: 0 to 65535.

When SrcPortOp is 5, the

value range is 0 to 65535.
Unsigned integer. Otherwise, it can only be
SrcPortValue
End source port. N/A 65536. The value 65536
2
Value range: 0 to 65536. indicates that the end
source port is not
available.

Only the TCP and UDP

Members include: protocols support this
Destination port Data • DstPortOp. column.
DstPort
information. structure • DstPortValue1.
The members must be all
• DstPortValue2.
specified.

Enumeration:
Destination port • 1—lt (lower than).
DstPortOp N/A N/A
operator. • 2—eq (equal to).
• 3—gt (greater than).

81
 Column Column Column
Data type and restrictions Remarks
name description type
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
DstPortValue Start destination
N/A N/A
1 port.
Value range: 0 to 65535.

When DstPortOp is 5, the

value range is 0 to 65535.
Unsigned integer. Otherwise, it can only be
DstPortValue End destination
N/A 65536. The value 65536
2 port.
Value range: 0 to 65536. indicates that the end
destination port is not
available.

Unsigned integer. This column is available

DSCP DSCP priority. N/A when the ProtocolType is
Value range: 0 to 63. specified.

String, case-insensitive.
Length: 1 to 32 characters.
TimeRange Time range. N/A It cannot be the word all.
The string must start with an
English letter.
Boolean:
• true—Counts the rule
Whether to count matches.
Counting N/A N/A
the rule matches. • false—Does not count
the rule matches
(default).

String, case-sensitive. A comment can only be

Comment Rule comment. N/A configured for an existing
Length: 1 to 127 characters. rule.

ACL/ZonePairPfilterApply
This table contains information about packet filter application for zone-pair.

XML structure
<ACL>
<ZonePairPfilterApply>
<Pfilter>
<SrcZone></SrcZone>
<DestZone></DestZone>
<AclType></AclType>
<AclGroup></AclGroup>
</Pfilter>
</ZonePairPfilterApply>
</ACL>

82
Table description
Item Description
Feature name ACL
Table name ZonePairPfilterApply
Table type Multi-instance table
Row name Pfilter
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String, case insensitive. Cannot contain
SrcZone Index
source zone. Length: 1 to 31 characters. midline( - ).

Name of the String, case insensitive. Cannot contain

DestZone Index
destination zone. Length: 1 to 31 characters. midline( - ).

Enumeration:
Type 3 is not supported in
• 1—IPv4 ACL.
the current software
AclType ACL type. Index • 2—IPv6 ACL. version, and is reserved
• 3—Ethernet frame for future support.
header ACL.
An ACL name must start
with an English letter and
• ACL name: cannot be all.
Case-insensitive string
The value range depends
of 1 to 63 characters.
ACL name or on the AppAclType
AclGroup
number.
Index • ACL number: column.
An unsigned integer in
the range of 2000 to • 2000 to 5999 if
5999. AppAclType is 1.
• 2000 to 3999 if
AppAclType is 2.

83
Contents
ACL·······························································································1
ACL/Base ································································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ACL/Capability ·························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
ACL/Groups ······························································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
ACL/NamedGroups ···················································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
ACL/Intervals ···························································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7
ACL/IPv4BasicRules··················································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 9
ACL/IPv4NamedBasicRules ······································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
ACL/IPv6BasicRules················································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 13
Columns ·························································································································· 14
ACL/IPv6NamedBasicRules ······································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 16
Columns ·························································································································· 16
ACL/IPv4AdvanceRules ············································································································ 18
XML structure ··················································································································· 18
Table description ··············································································································· 20
Columns ·························································································································· 21
ACL/IPv4NamedAdvanceRules··································································································· 29
XML structure ··················································································································· 30
Table description ··············································································································· 32
Columns ·························································································································· 32
ACL/IPv6AdvanceRules ············································································································ 41
XML structure ··················································································································· 41
Table description ··············································································································· 43
Columns ·························································································································· 43
ACL/IPv6NamedAdvanceRules··································································································· 49
XML structure ··················································································································· 50
Table description ··············································································································· 51
Columns ·························································································································· 52
ACL/MACRules ······················································································································· 58
XML structure ··················································································································· 58
Table description ··············································································································· 59
Columns ·························································································································· 60

i
ACL/MACNamedRules·············································································································· 62
XML structure ··················································································································· 62
Table description ··············································································································· 63
Columns ·························································································································· 64
ACL/PfilterDefAction ················································································································· 66
XML structure ··················································································································· 66
Table description ··············································································································· 67
Columns ·························································································································· 67
ACL/PfilterIgnoreAction ············································································································· 67
XML structure ··················································································································· 67
Table description ··············································································································· 67
Columns ·························································································································· 68
ACL/PfilterApply ······················································································································ 68
XML structure ··················································································································· 68
Table description ··············································································································· 68
Columns ·························································································································· 69
ACL/PfilterGroupRunInfo ··········································································································· 70
XML structure ··················································································································· 70
Table description ··············································································································· 70
Columns ·························································································································· 71
ACL/PfilterRuleRunInfo ············································································································· 72
XML structure ··················································································································· 72
Table description ··············································································································· 73
Columns ·························································································································· 73
ACL/PfilterStatisticSum ············································································································· 74
XML structure ··················································································································· 74
Table description ··············································································································· 75
Columns ·························································································································· 75
ACL/UserRules ······················································································································· 76
XML structure ··················································································································· 76
Table description ··············································································································· 77
Columns ·························································································································· 77
ACL/UserNamedRules ·············································································································· 84
XML structure ··················································································································· 84
Table description ··············································································································· 86
Columns ·························································································································· 86
ACL/ZonePairPfilterApply ·········································································································· 92
XML structure ··················································································································· 92
Table description ··············································································································· 93
Columns ·························································································································· 93
ACL/ZonePairPfilterRules ·········································································································· 93
XML structure ··················································································································· 93
Table description ··············································································································· 94
Columns ·························································································································· 94

ii
ACL
ACL/Base
This table contains ACL base table.

XML structure
<ACL>
<Base>
<ProcessingStatus></ProcessingStatus>
</Base>
</ACL>

Table description
Item Description
Feature name ACL
Table name Base
Table type Single-instance table
Row name N/A
Restrictions None.

Columns
Column name Column description Column type Data type and restrictions
Enumeration:
ACL processing
ProcessingStatus
status
N/A • 1—Processing.
• 2—Idle.

ACL/Capability
This table contains ACL capability information, and it is used to obtain custom ACL parameters.

XML structure
<ACL>
<Capability>
<UserAclL2>
<L2MaxOffset></L2MaxOffset>
<L2MaxLen></L2MaxLen>
</UserAclL2>

1
 <UserAclL4>
<L4MaxOffset></L4MaxOffset>
<L4MaxLen></L4MaxLen>
</UserAclL4>
<UserAclIPv4>
<IPv4MaxOffset></IPv4MaxOffset>
<IPv4MaxLen></IPv4MaxLen>
</UserAclIPv4>
<UserAclIPv6>
<IPv6MaxOffset></IPv6MaxOffset>
<IPv6MaxLen></IPv6MaxLen>
</UserAclIPv6>
</Capability>
</ACL>

Table description
Item Description
Feature name ACL
Table name Capability
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column
Column description Column type Data type and restrictions
name
Custom Layer 2 frame Members include:
UserAclL2 header parameters for Data structure • L2MaxOffset.
user-defined ACL rules • L2MaxLen.
Maximum offset relative to Unsigned integer.
L2MaxOffset the beginning of the Layer N/A
2 frame header Value range: 0 to 254.

Maximum length of the Unsigned integer.

L2MaxLen N/A
match pattern string Value range: 0 to 254.

Custom Layer 4 header Members include:

UserAclL4 parameters for Data structure • L4MaxOffse.
user-defined ACL rules • L4MaxLen.
Maximum offset relative to Unsigned integer.
L4MaxOffset the beginning of the Layer N/A
4 header Value range: 0 to 254.

Maximum length of the Unsigned integer.

L4MaxLen N/A
match pattern string Value range: 0 to 254.

2
 Column
Column description Column type Data type and restrictions
name
Custom IPv4 header Members include:
UserAclIPv4 parameters for Data structure • IPv4MaxOffset.
user-defined ACL rules • IPv4MaxLen.
Maximum offset relative to Unsigned integer.
IPv4MaxOffset the beginning of the IPv4 N/A
header Value range: 0 to 254.

Maximum length of the Unsigned integer.

IPv4MaxLen N/A
match pattern string Value range: 0 to 254.

Custom IPv6 header Members include:

UserAclIPv6 parameters for Data structure • IPv6MaxOffset.
user-defined ACL rules • IPv6MaxLen.
Maximum offset relative to Unsigned integer.
IPv6MaxOffset the beginning of the IPv6 N/A
header Value range: 0 to 254.

Maximum length of the Unsigned integer.

IPv6MaxLen N/A
match pattern string Value range: 0 to 254.

ACL/Groups
This table displays ACL information.

XML structure
<ACL>
<Groups>
<Group>
<GroupType></GroupType>
<GroupID></GroupID>
<MatchOrder></MatchOrder>
<Step></Step>
<Name></Name>
<Description></Description>
<RuleNum></RuleNum>
</Group>
</Groups>
</ACL>

Table description
Item Description
Feature name ACL
Table name Groups
Table type Multi-instance table
Row name Group

3
 Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—IPv4.
GroupType ACL type Index N/A
• 2—IPv6. 3—MAC.
• 4—User-defined.
The value range depends on
the GroupType column.
• 2000 to 5999 if
GroupType is 1.
 IPv4 basic ACL: 2000
to 2999.
 IPv4 advanced ACL:
3000 to 3999.
ACL Unsigned integer.  Ethernet frame
GroupID Index header ACL: 4000 to
number Value range: 2000 to 5999.
4999.
 User-defined ACL:
5000 to 5999.
• 2000 to 3999 if
GroupType is 2.
 IPv6 basic ACL: 2000
to 2999.
 IPv6 advanced ACL:
3000 to 3999.
Enumeration:
• 1—Config. In this
Order in order, rules are sorted
which the in ascending order of
MatchOrder N/A N/A
rules are rule ID.
sorted • 2—Auto. In this order,
rules are sorted in
depth-first order.
ACL rule Unsigned integer.
Step numbering N/A N/A
step Value range: 1 to 20.

String, case-insensitive.
Name ACL name N/A N/A
Length: 1 to 63 characters.
String, case-sensitive.
ACL By default, an ACL has no
Description N/A Length: 1 to 127
description description.
characters.
Number of Unsigned integer.
RuleNum rules in the N/A N/A
ACL Value range: 0 to 65535.

4
ACL/NamedGroups
This table displays named ACL information.

XML structure
<ACL>
<NamedGroups>
<Group>
<GroupType></GroupType>
<GroupCategory></GroupCategory>
<GroupIndex></GroupIndex>
<MatchOrder></MatchOrder>
<Step></Step>
<Name></Name>
<Description></Description>
<RuleNum></RuleNum>
<GroupNum></GroupNum>
</Group>
</NamedGroups>
</ACL>

Table description
Item Description
Feature name ACL
Table name NamedGroups
Table type Multi-instance table
Row name Group
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Enumeration:
• 1—IPv4.
GroupType ACL type Index • 2—IPv6. N/A
• 3—MAC.
• 4—User-defined.

5
 Column Column Data type and
Column name Remarks
description type restrictions
The value range depends
on the GroupType column.
Enumeration: • 1 to 2 if GroupType is
ACL • 0—invalid. 1 or 2.
GroupCategory Index
Category • 1—basic.  basic ACL: 1.
• 2—advanced.  advanced ACL: 2.
• 0 if GroupType is 3 or
4.
The GroupIndex cannot be
specified as an ACL name
in GET operations for an
ACL created by specifying
both a number and a
name.
The value range depends
on the GroupType column.
• 2000 to 3999 if
GroupType is 1.
String.  IPv4 basic ACL:
Length: 1 to 63 2000 to 2999.
characters.  IPv4 advanced
• ACL name: ACL: 3000 to
Case-insensitive 3999.
ACL name or
GroupIndex
number
Index string of 1 to 63 • 2000 to 3999 if
characters. GroupType is 2.
• ACL number:  IPv6 basic ACL:
String of digits in the 2000 to 2999.
range of 2000 to  IPv6 advanced
5999. ACL: 3000 to
3999.
• 4000 to 4999 if
GroupType is 3.
 Ethernet frame
header ACL: 4000
to 4999.
• 5000 to 5999 if
GroupType is 4.
User-defined ACL: 5000 to
5999.
Enumeration:
• 1—Config. In this
Order in order, rules are
which the sorted in ascending
MatchOrder N/A order of rule ID. N/A
rules are
sorted • 2—Auto. In this
order, rules are
sorted in depth-first
order.
ACL rule Unsigned integer.
Step numbering N/A N/A
step Value range: 1 to 20.

String, case-insensitive.
Name ACL name N/A Length: 1 to 63 N/A
characters.

6
 Column Column Data type and
Column name Remarks
description type restrictions
String, case-sensitive.
ACL By default, an ACL has no
Description N/A Length: 1 to 127
description description.
characters.
Number of Unsigned integer.
RuleNum rules in the N/A N/A
ACL Value range: 0 to 65535.

Number of
GroupNum N/A Unsigned integer. N/A
ACLs.

ACL/Intervals
This table contains ACL interval information.

XML structure
<ACL>
<Intervals>
<Interval>
<IntervalType></IntervalType>
<IntervalValue></IntervalValue>
</Interval>
</Intervals>
</ACL>

Table description
Item Description
Feature name ACL
Table name Intervals
Table type Multi-instance table
Row name Interval
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Enumeration: The type of the interval specified
The type of
IntervalType
the interval
Index • 1—logging. for generating packet filtering
• 2—trap. logs or traps.

Unsigned integer.
The value of
IntervalValue N/A Value range: 5 to It must be a multiple of 5.
the interval
1440.

7
ACL/IPv4BasicRules
This table contains IPv4 basic ACL rule information.

XML structure
<ACL>
<IPv4BasicRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcObjectGroup></SrcObjectGroup>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
</Rule>
</IPv4BasicRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv4BasicRules
Table type Multi-instance table
Row name Rule
Restrictions None

8
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
GroupID ACL number. Index N/A
Value range: 2000 to 2999.
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.
Enumeration:
Action on packets
Action
matching the rule.
N/A • 1—Deny. N/A
• 2—Permit.
Boolean:
Whether a rule • true—Matches any
matches any source IP addresses.
SrcAny N/A N/A
source IP • false—Matches the
addresses. specified source IP
address.
Members include:
Source IPv4 Data The two members must
SrcIPv4
information. structure • SrcIPv4Addr. both be specified.
• SrcIPv4Wildcard.
Example: 1.1.1.1.
This column is available
when the SrcAny
Source IPv4 String, dotted decimal
SrcIPv4Addr N/A column is false.
address. notation.
It must be empty when
the SrcAny column is
true.
Example: 255.255.255.0.
This column is available
Wildcard mask for when the SrcAny
SrcIPv4Wild String, dotted decimal
the source IPv4 N/A column is false.
card notation.
address. It must be empty when
the SrcAny column is
true.

String, case-insensitive.
SrcObjectGr Source object
N/A N/A
oup group name.
Length: 1 to 31 characters.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments.
String, case-insensitive.
TimeRange Time range. N/A N/A
Length: 1 to 32 characters.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.

9
 Column Column Column Data type and
Remarks
name description type restrictions
Boolean:

Whether to count • true—Counts the rule

Counting N/A matches. N/A
the rule matches.
• false—Does not count
the rule matches.
Boolean:

Whether to log • true—Logs rule match

Logging N/A events. N/A
rule match events.
• false—Does not log
rule match events.
String, case-sensitive.
Comment Rule comment. N/A Length: 1 to 127 N/A
characters.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.
Number of Unsigned integer.
Count packets that N/A 64 N/A
match a rule. Value range: 0 to 2 - 1.

Index of the rule Unsigned integer.

MatchIndex N/A N/A
after sorting. Value range: 0 to 65534.

ACL/IPv4NamedBasicRules
This table contains named IPv4 basic ACL rule information.

XML structure
<ACL>
<IPv4NamedBasicRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcObjectGroup></SrcObjectGroup>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>

10
 <Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
<RuleNum></RuleNum>
</Rule>
</IPv4NamedBasicRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv4NamedBasicRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String.
Length: 1 to 63 characters.
• ACL name:
ACL name or Case-insensitive
GroupIndex Index string of 1 to 63 N/A
number.
characters.
• ACL number:
String of digits in the
range of 2000 to 2999.
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.
Enumeration:
Action on packets
Action
matching the rule.
N/A • 1—Deny. N/A
• 2—Permit.
Boolean:
Whether a rule • true—Matches any
matches any source IP addresses.
SrcAny N/A N/A
source IP • false—Matches the
addresses. specified source IP
address.
Members include:
Source IPv4 Data The two members must
SrcIPv4
information. structure • SrcIPv4Addr. both be specified.
• SrcIPv4Wildcard.

11
Column Column Column Data type and
Remarks
name description type restrictions
Example: 1.1.1.1.
This column is available
when the SrcAny
Source IPv4 String, dotted decimal
SrcIPv4Addr N/A column is false.
address. notation.
It must be empty when
the SrcAny column is
true.
Example: 255.255.255.0.
This column is available
Wildcard mask for when the SrcAny
SrcIPv4Wild String, dotted decimal
the source IPv4 N/A column is false.
card notation.
address. It must be empty when
the SrcAny column is
true.

String, case-insensitive.
SrcObjectGr Source object
N/A N/A
oup group name.
Length: 1 to 31 characters.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments.
String, case-insensitive.
TimeRange Time range. N/A N/A
Length: 1 to 32 characters.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.
Boolean:

Whether to count • true—Counts the rule

Counting N/A matches. N/A
the rule matches.
• false—Does not count
the rule matches.
Boolean:

Whether to log • true—Logs rule match

Logging N/A events. N/A
rule match events.
• false—Does not log
rule match events.
String, case-sensitive.
Comment Rule comment. N/A Length: 1 to 127 N/A
characters.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.
Number of Unsigned integer.
Count packets that N/A 64 N/A
match a rule. Value range: 0 to 2 - 1.

Index of the rule Unsigned integer.

MatchIndex N/A N/A
after sorting. Value range: 0 to 65534.

12
 Column Column Column Data type and
Remarks
name description type restrictions
Number of rules in Unsigned integer.
RuleNum N/A N/A
the ACL. Value range: 0 to 65535.

ACL/IPv6BasicRules
This table contains IPv6 basic ACL rule information.

XML structure
<ACL>
<IPv6BasicRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<SrcAny></SrcAny>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<SrcObjectGroup></SrcObjectGroup>
<RoutingTypeAny></RoutingTypeAny>
<RoutingTypeValue></RoutingTypeValue>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
</Rule>
</IPv6BasicRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv6BasicRules
Table type Multi-instance table
Row name Rule

13
 Item Description
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
GroupID ACL number. Index N/A
Value range: 2000 to 2999.
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.
Action on Enumeration:
packets
Action
matching the
N/A • 1—Deny. N/A
rule. • 2—Permit.

Boolean:
Whether a rule • true—Matches any
matches any source IPv6 addresses.
SrcAny N/A N/A
source IP • false—Matches the
addresses. specified source IPv6
address.
Members include:
Source IPv6 Data The members must
SrcIPv6
information. structure • SrcIPv6Address. both be specified.
• SrcIPv6Prefix.
Example: 1:1::1:1.
This column is
available when the
Source IPv6 Hexadecimal string, SrcAny column is
SrcIPv6Addr N/A
address. colon-separated. false.
It must be empty when
the SrcAny column is
true.
This column is
available when the
Length of the SrcAny column is
Unsigned integer.
SrcIPv6Prefix source IPv6 N/A false.
address prefix. Value range: 1 to 128.
It must be empty when
the SrcAny column is
true.

String, case-insensitive.
SrcObjectGro Source object
N/A N/A
up group name.
Length: 1 to 31 characters.
Boolean:
Whether a rule • true—Matches any types
RoutingTypeA matches any of routing header.
N/A N/A
ny types of routing • false—Matches the
header. specified type of routing
header.

14
 Column Column Column
Data type and restrictions Remarks
name description type
RoutingTypeV Routing header Unsigned integer.
N/A N/A
alue type. Value range: 0 to 255.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments.
String, case-insensitive.
TimeRange Time range. N/A N/A
Length: 1 to 32 characters.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.
Boolean:
Whether to • true—Counts the rule
Counting count the rule N/A matches. N/A
matches. • false—Does not count
the rule matches.
Boolean:
Whether to log • true—Logs rule match
Logging rule match N/A events. N/A
events. • false—Does not log rule
match events.
String, case-sensitive.
Comment Rule comment. N/A N/A
Length: 1 to 127 characters.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.
Number of Unsigned integer.
Count packets that N/A 64 N/A
match a rule. Value range: 0 to 2 - 1.

Index of the rule Unsigned integer.

MatchIndex N/A N/A
after sorting. Value range: 0 to 65534.

ACL/IPv6NamedBasicRules
This table contains named IPv6 basic ACL rule information.

XML structure
<ACL>
<IPv6NamedBasicRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<SrcAny></SrcAny>

15
 <SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<SrcObjectGroup></SrcObjectGroup>
<RoutingTypeAny></RoutingTypeAny>
<RoutingTypeValue></RoutingTypeValue>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
<RuleNum></RuleNum>
</Rule>
</IPv6NamedBasicRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv6NamedBasicRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
Length: 1 to 63 characters.
• ACL name:
ACL name or Case-insensitive string of
GroupIndex Index N/A
number. 1 to 63 characters.
• ACL number:
String of digits in the
range of 2000 to 2999.
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.

16
Column Column Column
Data type and restrictions Remarks
name description type
Action on Enumeration:
packets
Action
matching the
N/A • 1—Deny. N/A
rule. • 2—Permit.

Boolean:
Whether a rule • true—Matches any
matches any source IPv6 addresses.
SrcAny N/A N/A
source IP • false—Matches the
addresses. specified source IPv6
address.
Members include:
Source IPv6 Data The members must
SrcIPv6
information. structure • SrcIPv6Address. both be specified.
• SrcIPv6Prefix.
Example: 1:1::1:1.
This column is
available when the
Source IPv6 Hexadecimal string, SrcAny column is
SrcIPv6Addr N/A
address. colon-separated. false.
It must be empty when
the SrcAny column is
true.
This column is
available when the
Length of the SrcAny column is
Unsigned integer.
SrcIPv6Prefix source IPv6 N/A false.
address prefix. Value range: 1 to 128.
It must be empty when
the SrcAny column is
true.

String, case-insensitive.
SrcObjectGro Source object
N/A N/A
up group name.
Length: 1 to 31 characters.
Boolean:
Whether a rule • true—Matches any types
RoutingTypeA matches any of routing header.
N/A N/A
ny types of routing • false—Matches the
header. specified type of routing
header.

RoutingTypeV Routing header Unsigned integer.

N/A N/A
alue type. Value range: 0 to 255.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments.
String, case-insensitive.
TimeRange Time range. N/A N/A
Length: 1 to 32 characters.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.

17
 Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
Whether to • true—Counts the rule
Counting count the rule N/A matches. N/A
matches. • false—Does not count
the rule matches.
Boolean:
Whether to log • true—Logs rule match
Logging rule match N/A events. N/A
events. • false—Does not log rule
match events.
String, case-sensitive.
Comment Rule comment. N/A N/A
Length: 1 to 127 characters.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.
Number of Unsigned integer.
Count packets that N/A 64 N/A
match a rule. Value range: 0 to 2 - 1.

Index of the rule Unsigned integer.

MatchIndex N/A N/A
after sorting. Value range: 0 to 65534.

Number of rules Unsigned integer.

RuleNum N/A N/A
in the ACL. Value range: 0 to 65535.

ACL/IPv4AdvanceRules
This table contains IPv4 advanced ACL rule information.

XML structure
<ACL>
<IPv4AdvanceRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<ProtocolType></ProtocolType>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcObjectGroup></SrcObjectGroup>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>

18
 <DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<DstObjectGroup></DstObjectGroup>
<ECN></ECN>
<DSCP></DSCP>
<DSCPRange>
<StartDSCP></StartDSCP>
<EndDSCP></EndDSCP>
</DSCPRange>
<Precedence></Precedence>
<TOS></TOS>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<TcpFlag>
<ACK></ACK>
<FIN></FIN>
<PSH></PSH>
<RST></RST>
<SYN></SYN>
<URG></URG>
</TcpFlag>
<Established></Established>
<ICMP>
<ICMPType></ICMPType>
<ICMPCode></ICMPCode>
</ICMP>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<QoSLocalID></QoSLocalID>
<EncapType></EncapType>
<InProtocolType></InProtocolType>
<VxlanID></VxlanID>
<InSrcAny></InSrcAny>
<InSrcIPv4>
<InSrcIPv4Addr></InSrcIPv4Addr>
<InSrcIPv4Wildcard></InSrcIPv4Wildcard>
</InSrcIPv4>
<InDstAny></InDstAny>
<InDstIPv4>

19
 <InDstIPv4Addr></InDstIPv4Addr>
<InDstIPv4Wildcard></InDstIPv4Wildcard>
</InDstIPv4>
<InSrcPort>
<InSrcPortOp></InSrcPortOp>
<InSrcPortValue1></InSrcPortValue1>
<InSrcPortValue2></InSrcPortValue2>
</InSrcPort>
<InDstPort>
<InDstPortOp></InDstPortOp>
<InDstPortValue1></InDstPortValue1>
<InDstPortValue2></InDstPortValue2>
</InDstPort>
<InEstablished></InEstablished>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<UserGroup></UserGroup>
<UserGroupAny></UserGroupAny>
<GreValue></GreValue>
<Options></Options>
<FragmentType></FragmentType>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
<Ttl>
<TtlOp></TtlOp>
<TtlValue1></TtlValue1>
<TtlValue2></TtlValue2>
</Ttl>
<PktLength>
<PktLengthOp></PktLengthOp>
<PktLengthValue1></PktLengthValue1>
<PktLengthValue2></PktLengthValue2>
</PktLength>
</Rule>
</IPv4AdvanceRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv4AdvanceRules
Table type Multi-instance table
Row name Rule

20
 Item Description
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
GroupID ACL number. Index N/A
Value range: 3000 to 3999.
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.
Action on Enumeration:
packets
Action
matching the
N/A • 1—Deny. N/A
rule. • 2—Permit.

Unsigned integer.
Value range: 0 to 256.
ProtocolType Protocol type. N/A N/A
The value 256 represents all
IPv4 protocols.
Boolean:
Whether a rule • true—Matches any
matches any source IP addresses.
SrcAny N/A N/A
source IP • false—Matches the
addresses. specified source IP
address.
Members include:
Source IPv4 Data The members must both
SrcIPv4
information. structure • SrcIPv4Addr. be specified.
• SrcIPv4Wildcard.
Example: 1.1.1.1.
This column is available
when the SrcAny
Source IPv4 String, dotted decimal
SrcIPv4Addr N/A column is false.
address. notation.
It must be empty when
the SrcAny column is
true.
Example: 255.255.255.0.
This column is available
Wildcard mask when the SrcAny
SrcIPv4Wildc String, dotted decimal
for the source N/A column is false.
ard notation.
IPv4 address. It must be empty when
the SrcAny column is
true.

Source object String, case-insensitive.

SrcObjectGro N/A N/A
up group name. Length: 1 to 31 characters.

21
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
The VXLAN
Whether a rule • true—Matches any encapsulation supports
matches any destination IP this column.
DstAny N/A addresses (default).
destination IP This column must be
addresses. • false—Matches the configured together with
specified destination IP the DstIPv4 column.
address.
Members include:
Destination IPv4 Data The members must both
DstIPv4
information. structure • DstIPv4Addr. be specified.
• DstIPv4Wildcard.
Example: 1.1.1.1.
This column is available
when the DstAny
Destination IPv4 String, dotted decimal
DstIPv4Addr N/A column is false.
address. notation.
It must be empty when
the DstAny column is
true.
Example: 255.255.255.0.
This column is available
Wildcard mask
when the DstAny
DstIPv4Wildc for the String, dotted decimal
N/A column is false.
ard destination IPv4 notation.
address. It must be empty when
the DstAny column is
true.
Destination String, case-insensitive.
DstObjectGro object group N/A N/A
up name. Length: 1 to 31 characters.

Unsigned integer. ECN and TOS cannot be

ECN ECN flag. N/A
Value range: 0 to 3. specified together.

Unsigned integer.
DSCP DSCP priority. N/A N/A
Value range: 0 to 63.
Members include: DSCP and DSCPRange
DSCP priority Data
DSCPRange
range. structure • StartDSCP cannot be specified
• EndDSCP together.

Start DSCP
priority of a Unsigned integer. The end DSCP must be
StartDSCP N/A
DSCP priority Value range: 0 to 63. greater than start DSCP.
range.
End DSCP
priority of a Unsigned integer.
EndDSCP N/A N/A
DSCP priority Value range: 0 to 63.
range.
Unsigned integer.
Precedence IP precedence. N/A N/A
Value range: 0 to 7.
Unsigned integer.
TOS ToS preference. N/A N/A
Value range: 0 to 15.

22
Column Column Column
Data type and restrictions Remarks
name description type
Members include: Only the TCP and UDP
protocols support this
Source port Data • SrcPortOp. column.
SrcPort
information. structure • SrcPortValue1.
The members must be
• SrcPortValue2. all specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Source port
SrcPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

SrcPortValue Start source Unsigned integer.

N/A N/A
1 port. Value range: 0 to 65535.
When the SrcPortOp is
5, the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
SrcPortValue
End source port. N/A only be 65536. The value
2 Value range: 0 to 65536. 65536 indicates that the
end source port is not
available.

Members include: Only the TCP and UDP

protocols support this
Destination port Data • DstPortOp. column.
DstPort
information. structure • DstPortValue1.
The members must be
• DstPortValue2. all specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port
DstPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

DstPortValue Start destination Unsigned integer.

N/A N/A
1 port. Value range: 0 to 65535.
When the DstPortOp is
5, the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
DstPortValue End destination
N/A only be 65536. The value
2 port. Value range: 0 to 65536. 65536 indicates that the
end destination port is
not available.
Members include:
• ACK.
• FIN.
Data
TcpFlag TCP flags.
structure • PSH. N/A
• RST.
• SYN.
• URG.

23
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
ACK flag in a Value range: 0 or 1. Only the TCP protocol
ACK N/A
TCP packet. • 0—ACK flag is not set. supports this column.
• 1—ACK flag is set.
Unsigned integer.
FIN flag in a Value range: 0 or 1. Only the TCP protocol
FIN N/A
TCP packet. • 0—FIN flag is not set. supports this column.
• 1—FIN flag is set.
Unsigned integer.
PSH flag in a Value range: 0 or 1. Only the TCP protocol
PSH N/A
TCP packet. • 0—PSH flag is not set. supports this column.
• 1—PSH flag is set.
Unsigned integer.
RST flag in a Value range: 0 or 1. Only the TCP protocol
RST N/A
TCP packet. • 0—RST flag is not set. supports this column.
• 1—RST flag is set.
Unsigned integer.
SYN flag in a Value range: 0 or 1. Only the TCP protocol
SYN N/A
TCP packet. • 0—SYN flag is not set. supports this column.
• 1—SYN flag is set.
Unsigned integer.
URG flag in a Value range: 0 or 1. Only the TCP protocol
URG N/A
TCP packet. • 0—URG flag is not set. supports this column.
• 1—URG flag is set.
Only the TCP protocol
supports this column.
Whether a rule Boolean:
matches flags On a router, the rule
indicating the • true—Matches the matches TCP connection
Established N/A flags. packets with the ACK or
established
status of a TCP • false—Ignores the RST flag set. On a
connection. flags. switch, the availability
and usage of this column
depend on the device
model.
Members include:
ICMP Data The members must both
ICMP
messages. structure • ICMPType. be specified.
• ICMPCode.

Type of ICMP Unsigned integer. Only the ICMP protocol

ICMPType N/A
messages. Value range: 0 to 255. supports this column.

Unsigned integer.
Value range: 0 to 256.
Code of ICMP Only the ICMP protocol
ICMPCode N/A The value 256 indicates that
messages. supports this column.
no ICMP message code is
specified.

24
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments.
String, case-insensitive.
TimeRange Time range. N/A N/A
Length: 0 to 32 characters.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.

Unsigned integer.
QoSLocalID Local QoS ID. N/A N/A
Value range: 1 to 4095.
Members include:

Encapsulation • VXLAN encapsulation.

EncapType N/A • GRE encapsulation. N/A
type.
• IPINIP encapsulation.

Unsigned integer.
Only the VXLAN
InProtocolTyp Inner protocol Value range: 0 to 256.
N/A encapsulation supports
e type.
this column.
The value 256 represents all
IPv4 protocols.

Unsigned integer Only the VXLAN

VxlanID VXLAN ID N/A encapsulation supports
Value range: 0 to 16777215 this column.

Boolean:

Whether a rule • true—Matches any

matches any inner source IP
InSrcAny N/A addresses. N/A
inner source IP
addresses. • false—Matches the
specified inner source
IP address.

Only the VXLAN

Members include: encapsulation supports
Inner source this column.
Data
InSrcIPv4 IPv4
structure • InSrcIPv4Addr.
information. • InSrcIPv4Wildcard. The two members must
both be specified.

25
Column Column Column
Data type and restrictions Remarks
name description type

Example: 1.1.1.1.

This column is available

when the InSrcAny
InSrcIPv4Add Inner source String, dotted decimal
N/A column is false.
r IPv4 address. notation.
It must be empty when
the InSrcAny column is
true.

Example: 255.255.255.0.

This column is available

Wildcard mask
when the InSrcAny
InSrcIPv4Wild for the inner String, dotted decimal
N/A column is false.
card source IPv4 notation.
address.
It must be empty when
the InSrcAny column is
true.

Boolean:

Whether a rule • true—Matches any

matches any inner destination IP
InDstAny N/A addresses. N/A
inner destination
IP addresses. • false—Matches the
specified inner
destination IP address.

Only the VXLAN

Members include: encapsulation supports
Inner destination this column.
Data
InDstIPv4 IPv4
structure • InDstIPv4Addr.
information. • InDstIPv4Wildcard. The two members must
both be specified.

Example: 1.1.1.1.

This column is available

when the InDstAny
InDstIPv4Add Inner destination String, dotted decimal
N/A column is false.
r IPv4 address. notation.
It must be empty when
the InDstAny column is
true.

Example: 255.255.255.0.

This column is available

Wildcard mask
when the InDstAny
InDstIPv4Wild for the inner String, dotted decimal
N/A column is false.
card destination IPv4 notation.
address.
It must be empty when
the InDstAny column is
true.

26
Column Column Column
Data type and restrictions Remarks
name description type

Only the TCP and UDP

Members include: inner protocols support
Inner source Data • InSrcPortOp. this column.
InSrcPort
port information. structure • InSrcPortValue1.
The members must be
• InSrcPortValue2.
all specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Inner source
InSrcPortOp
port operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
InSrcPortValu Start inner
N/A N/A
e1 source port.
Value range: 0 to 65535.

When InSrcPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
InSrcPortValu End inner
N/A only be 65536. The value
e2 source port.
Value range: 0 to 65536. 65536 indicates that the
end inner source port is
not available.

Only the TCP and UDP

Members include: inner protocols support
Inner destination Data • InDstPortOp. this column.
InDstPort
port information. structure • InDstPortValue1.
The members must be
• InDstPortValue2.
all specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Inner destination
InDstPortOp
port operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
InDstPortValu Start inner
N/A N/A
e1 destination port.
Value range: 0 to 65535.

When InDstPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
InDstPortValu End inner
N/A only be 65536. The value
e2 destination port.
Value range: 0 to 65536. 65536 indicates that the
end inner destination
port is not available.

27
Column Column Column
Data type and restrictions Remarks
name description type

Whether a rule
matches flags Boolean:
indicating the • true—Matches the Only the TCP inner
InEstablished inner N/A flags. protocol supports this
established • false—Ignores the column.
status of a TCP flags.
connection.
Boolean:
Whether to • true—Counts the rule
Counting count the rule N/A matches. N/A
matches. • false—Does not count
the rule matches.
Boolean:
Whether to log • true—Logs rule match
Logging rule match N/A events. N/A
events. • false—Does not log rule
match events.
String, case-sensitive.
Comment Rule comment. N/A N/A
Length: 1 to 127 characters.

User group String, case-insensitive.

UserGroup N/A N/A
name. Length: 1 to 32 characters.
Boolean:

UserGroupAn
Whether a rule • true—Matches any user
matches any N/A group. N/A
y
user group. • false—Matches the
specified user group.
Hexadecimal string.
Config a gre Only the GRE protocol
GreValue N/A Length: 1 to 8 characters.
value. supports this column.
Value range: 0 to FFFFFFFF.

Boolean: Only when the

ProtocolType value is
Options IP options. N/A • true—Options. 256,and then the table
• false—Not options, can supports this
default. column.
Unsigned integer.
Value range: 0 to 3.
• 0—First-fragment.
FragmentTyp Check fragment
N/A • 1—Non-fragment. N/A
e packet type.
• 2—Non-or-first-fragmen
t.
• 3—Any-fragment.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.
Number of Unsigned integer.
Count packets that N/A 64 N/A
match a rule. Value range: 0 to 2 - 1.

28
 Column Column Column
Data type and restrictions Remarks
name description type
Index of the rule Unsigned integer.
MatchIndex N/A N/A
after sorting. Value range: 0 to 65534.
Members include:
Whether a rule Data • TtlOp.
Ttl N/A
matches TTL. structure • TtlValue1.
• TtlValue2.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
TtlOp TTL operator. N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).
Unsigned integer.
TtlValue1 Start TTL value. N/A N/A
Value range: 1 to 255.
When the TtlOp is 5, the
value range is 1 to 255.
Unsigned integer. Otherwise, it can only be
TtlValue2 End TTL value. N/A 256. The value 256
Value range: 1 to 256. indicates that the end
TTL value is not
available.
Members include:
Whether a rule
Data • PktLengthOp.
PktLength matches packet N/A
length.
structure • PktLengthValue1.
• PktLengthValue2.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Packet length
PktLengthOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

PktLengthVal Start packet Unsigned integer.

N/A N/A
ue1 length value. Value range: 0 to 65535.
When the PktLengthOp
is 5, the value range is 0
Unsigned integer. to 65535. Otherwise, it
PktLengthVal End packet
N/A can only be 65536. The
ue2 length value. Value range: 0 to 65536. value 65536 indicates
that the packet length
value is not available.

ACL/IPv4NamedAdvanceRules
This table contains named IPv4 advanced ACL rule information.

29
XML structure
<ACL>
<IPv4NamedAdvanceRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<ProtocolType></ProtocolType>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcObjectGroup></SrcObjectGroup>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>
<DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<DstObjectGroup></DstObjectGroup>
<ECN></ECN>
<DSCP></DSCP>
<DSCPRange>
<StartDSCP></StartDSCP>
<EndDSCP></EndDSCP>
</DSCPRange>
<Precedence></Precedence>
<TOS></TOS>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<TcpFlag>
<ACK></ACK>
<FIN></FIN>
<PSH></PSH>
<RST></RST>
<SYN></SYN>
<URG></URG>
</TcpFlag>
<Established></Established>

30
<ICMP>
<ICMPType></ICMPType>
<ICMPCode></ICMPCode>
</ICMP>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<QoSLocalID></QoSLocalID>
<EncapType></EncapType>
<InProtocolType></InProtocolType>
<VxlanID></VxlanID>
<InSrcAny></InSrcAny>
<InSrcIPv4>
<InSrcIPv4Addr></InSrcIPv4Addr>
<InSrcIPv4Wildcard></InSrcIPv4Wildcard>
</InSrcIPv4>
<InDstAny></InDstAny>
<InDstIPv4>
<InDstIPv4Addr></InDstIPv4Addr>
<InDstIPv4Wildcard></InDstIPv4Wildcard>
</InDstIPv4>
<InSrcPort>
<InSrcPortOp></InSrcPortOp>
<InSrcPortValue1></InSrcPortValue1>
<InSrcPortValue2></InSrcPortValue2>
</InSrcPort>
<InDstPort>
<InDstPortOp></InDstPortOp>
<InDstPortValue1></InDstPortValue1>
<InDstPortValue2></InDstPortValue2>
</InDstPort>
<InEstablished></InEstablished>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<UserGroup></UserGroup>
<UserGroupAny></UserGroupAny>
<GreValue></GreValue>
<Options></Options>
<FragmentType></FragmentType>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
<RuleNum></RuleNum>
<Ttl>
<TtlOp></TtlOp>
<TtlValue1></TtlValue1>
<TtlValue2></TtlValue2>

31
 </Ttl>
<PktLength>
<PktLengthOp></PktLengthOp>
<PktLengthValue1></PktLengthValue1>
<PktLengthValue2></PktLengthValue2>
</PktLength>
</Rule>
</IPv4NamedAdvanceRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv4NamedAdvanceRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
Length: 1 to 63 characters.
• ACL name:
ACL name or Case-insensitive string
GroupIndex Index N/A
number. of 1 to 63 characters.
• ACL number:
String of digits in the
range of 3000 to 3999.
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.
Action on Enumeration:
packets
Action
matching the
N/A • 1—Deny. N/A
rule. • 2—Permit.

Unsigned integer.
Value range: 0 to 256.
ProtocolType Protocol type. N/A N/A
The value 256 represents all
IPv4 protocols.
Boolean:
Whether a rule • true—Matches any
matches any source IP addresses.
SrcAny N/A N/A
source IP • false—Matches the
addresses. specified source IP
address.

32
Column Column Column
Data type and restrictions Remarks
name description type
Members include:
Source IPv4 Data The members must both
SrcIPv4
information. structure • SrcIPv4Addr. be specified.
• SrcIPv4Wildcard.
Example: 1.1.1.1.
This column is available
when the SrcAny
Source IPv4 String, dotted decimal
SrcIPv4Addr N/A column is false.
address. notation.
It must be empty when
the SrcAny column is
true.
Example: 255.255.255.0.
This column is available
Wildcard mask when the SrcAny
SrcIPv4Wildc String, dotted decimal
for the source N/A column is false.
ard notation.
IPv4 address. It must be empty when
the SrcAny column is
true.

String, case-insensitive.
SrcObjectGro Source object
N/A N/A
up group name.
Length: 1 to 31 characters.
Boolean:

Whether a rule • true—Matches any

matches any destination IP
DstAny N/A addresses. N/A
destination IP
addresses. • false—Matches the
specified destination IP
address.
Members include:
Destination IPv4 Data The members must both
DstIPv4
information. structure • DstIPv4Addr. be specified.
• DstIPv4Wildcard.
Example: 1.1.1.1.
This column is available
when the DstAny
Destination IPv4 String, dotted decimal
DstIPv4Addr N/A column is false.
address. notation.
It must be empty when
the DstAny column is
true.
Example: 255.255.255.0.
This column is available
Wildcard mask
when the DstAny
DstIPv4Wildc for the String, dotted decimal
N/A column is false.
ard destination IPv4 notation.
address. It must be empty when
the DstAny column is
true.
Destination String, case-insensitive.
DstObjectGro object group N/A N/A
up name. Length: 1 to 31 characters.

Unsigned integer. ECN and TOS cannot be

ECN ECN flag. N/A
Value range: 0 to 3. specified together.

33
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
DSCP DSCP priority. N/A N/A
Value range: 0 to 63.
Members include: DSCP and DSCPRange
DSCP priority Data
DSCPRange
range. structure • StartDSCP cannot be specified
• EndDSCP together.

Start DSCP
priority of a Unsigned integer. The end DSCP must be
StartDSCP N/A
DSCP priority Value range: 0 to 63. greater than start DSCP.
range.
End DSCP
priority of a Unsigned integer.
EndDSCP N/A N/A
DSCP priority Value range: 0 to 63.
range.
Unsigned integer.
Precedence IP precedence. N/A N/A
Value range: 0 to 7.
Unsigned integer.
TOS ToS preference. N/A N/A
Value range: 0 to 15.

Members include: Only the TCP and UDP

protocols support this
Source port Data • SrcPortOp. column.
SrcPort
information. structure • SrcPortValue1.
The members must be
• SrcPortValue2. all specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Source port
SrcPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

SrcPortValue Start source Unsigned integer.

N/A N/A
1 port. Value range: 0 to 65535.
When the SrcPortOp is
5, the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
SrcPortValue
End source port. N/A only be 65536. The value
2 Value range: 0 to 65536. 65536 indicates that the
end source port is not
available.

Members include: Only the TCP and UDP

protocols support this
Destination port Data • DstPortOp. column.
DstPort
information. structure • DstPortValue1.
The members must be
• DstPortValue2. all specified.

34
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port
DstPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

DstPortValue Start destination Unsigned integer.

N/A N/A
1 port. Value range: 0 to 65535.
When the DstPortOp is
5, the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
DstPortValue End destination
N/A only be 65536. The value
2 port. Value range: 0 to 65536. 65536 indicates that the
end destination port is
not available.
Members include:
• ACK.
• FIN.
Data
TcpFlag TCP flags.
structure • PSH. N/A
• RST.
• SYN.
• URG.
Unsigned integer.
ACK flag in a Value range: 0 or 1. Only the TCP protocol
ACK N/A
TCP packet. • 0—ACK flag is not set. supports this column.
• 1—ACK flag is set.
Unsigned integer.
FIN flag in a Value range: 0 or 1. Only the TCP protocol
FIN N/A
TCP packet. • 0—FIN flag is not set. supports this column.
• 1—FIN flag is set.
Unsigned integer.
PSH flag in a Value range: 0 or 1. Only the TCP protocol
PSH N/A
TCP packet. • 0—PSH flag is not set. supports this column.
• 1—PSH flag is set.
Unsigned integer.
RST flag in a Value range: 0 or 1. Only the TCP protocol
RST N/A
TCP packet. • 0—RST flag is not set. supports this column.
• 1—RST flag is set.
Unsigned integer.
SYN flag in a Value range: 0 or 1. Only the TCP protocol
SYN N/A
TCP packet. • 0—SYN flag is not set. supports this column.
• 1—SYN flag is set.
Unsigned integer.
URG flag in a Value range: 0 or 1. Only the TCP protocol
URG N/A
TCP packet. • 0—URG flag is not set. supports this column.
• 1—URG flag is set.

35
Column Column Column
Data type and restrictions Remarks
name description type
Only the TCP protocol
supports this column.
Whether a rule Boolean:
matches flags On a router, the rule
indicating the • true—Matches the matches TCP connection
Established N/A flags. packets with the ACK or
established
status of a TCP • false—Ignores the RST flag set. On a
connection. flags. switch, the availability
and usage of this column
depend on the device
model.
Members include:
ICMP Data The members must both
ICMP
messages. structure • ICMPType. be specified.
• ICMPCode.

Type of ICMP Unsigned integer. Only the ICMP protocol

ICMPType N/A
messages. Value range: 0 to 255. supports this column.

Unsigned integer.
Value range: 0 to 256.
Code of ICMP Only the ICMP protocol
ICMPCode N/A The value 256 indicates that
messages. supports this column.
no ICMP message code is
specified.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches both
fragments. fragments and
non-fragments.
String, case-insensitive.
TimeRange Time range. N/A N/A
Length: 0 to 32 characters.
String, case-sensitive.
VRF VRF. N/A N/A
Length: 1 to 31 characters.

Unsigned integer.
QoSLocalID Local QoS ID. N/A N/A
Value range: 1 to 4095.
Members include:

Encapsulation • VXLAN encapsulation.

EncapType N/A • GRE encapsulation. N/A
type.
• IPINIP encapsulation.

Unsigned integer.
Only the VXLAN
InProtocolTyp Inner protocol Value range: 0 to 256.
N/A encapsulation supports
e type.
this column.
The value 256 represents all
IPv4 protocols.

Unsigned integer Only the VXLAN

VxlanID VXLAN ID. N/A encapsulation supports
Value range: 0 to 16777215 this column.

36
Column Column Column
Data type and restrictions Remarks
name description type

Boolean:

Whether a rule • true—Matches any

matches any inner source IP
InSrcAny N/A addresses. N/A
inner source IP
addresses. • false—Matches the
specified inner source
IP address.

Only the VXLAN

Members include: encapsulation supports
Inner source this column.
Data
InSrcIPv4 IPv4
structure • InSrcIPv4Addr.
information. • InSrcIPv4Wildcard. The two members must
both be specified.

Example: 1.1.1.1.

This column is available

when the InSrcAny
InSrcIPv4Add Inner source String, dotted decimal
N/A column is false.
r IPv4 address. notation.
It must be empty when
the InSrcAny column is
true.

Example: 255.255.255.0.

This column is available

Wildcard mask
when the InSrcAny
InSrcIPv4Wild for the inner String, dotted decimal
N/A column is false.
card source IPv4 notation.
address.
It must be empty when
the InSrcAny column is
true.

Boolean:

Whether a rule • true—Matches any

matches any inner destination IP
InDstAny N/A addresses. N/A
inner destination
IP addresses. • false—Matches the
specified inner
destination IP address.

Only the VXLAN

Members include: encapsulation supports
Inner destination this column.
Data
InDstIPv4 IPv4
structure • InDstIPv4Addr.
information. • InDstIPv4Wildcard. The two members must
both be specified.

37
Column Column Column
Data type and restrictions Remarks
name description type

Example: 1.1.1.1.

This column is available

when the InDstAny
InDstIPv4Add Inner destination String, dotted decimal
N/A column is false.
r IPv4 address. notation.
It must be empty when
the InDstAny column is
true.

Example: 255.255.255.0.

This column is available

Wildcard mask
when the InDstAny
InDstIPv4Wild for the inner String, dotted decimal
N/A column is false.
card destination IPv4 notation.
address.
It must be empty when
the InDstAny column is
true.

Only the TCP and UDP

Members include: inner protocols support
Inner source Data • InSrcPortOp. this column.
InSrcPort
port information. structure • InSrcPortValue1.
The members must be
• InSrcPortValue2.
all specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Inner source
InSrcPortOp
port operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
InSrcPortValu Start inner
N/A N/A
e1 source port.
Value range: 0 to 65535.

When InSrcPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
InSrcPortValu End inner
N/A only be 65536. The value
e2 source port.
Value range: 0 to 65536. 65536 indicates that the
end inner source port is
not available.

Only the TCP and UDP

Members include: inner protocols support
Inner destination Data • InDstPortOp. this column.
InDstPort
port information. structure • InDstPortValue1.
The members must be
• InDstPortValue2.
all specified.

38
Column Column Column
Data type and restrictions Remarks
name description type

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Inner destination
InDstPortOp
port operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
InDstPortValu Start inner
N/A N/A
e1 destination port.
Value range: 0 to 65535.

When InDstPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
InDstPortValu End inner
N/A only be 65536. The value
e2 destination port.
Value range: 0 to 65536. 65536 indicates that the
end inner destination
port is not available.

Whether a rule
matches flags Boolean:
indicating the • true—Matches the Only the TCP inner
InEstablished inner N/A flags. protocol supports this
established • false—Ignores the column.
status of a TCP flags.
connection.
Boolean:
Whether to • true—Counts the rule
Counting count the rule N/A matches. N/A
matches. • false—Does not count
the rule matches.
Boolean:
Whether to log • true—Logs rule match
Logging rule match N/A events. N/A
events. • false—Does not log rule
match events.
String, case-sensitive.
Comment Rule comment. N/A N/A
Length: 1 to 127 characters.

User group String, case-insensitive.

UserGroup N/A N/A
name. Length: 1 to 32 characters.
Boolean:

UserGroupAn
Whether a rule • true—Matches any user
matches any N/A group. N/A
y
user group. • false—Matches the
specified user group.
Hexadecimal string.
Config a gre Only the GRE protocol
GreValue N/A Length: 1 to 8 characters.
value. supports this column.
Value range: 0 to FFFFFFFF.

39
Column Column Column
Data type and restrictions Remarks
name description type
Boolean: Only when the
ProtocolType value is
Options IP options. N/A • true—Options. 256,and then the table
• false—Not options, can supports this
default. column.
Unsigned integer.
Value range: 0 to 3.
• 0—First-fragment.
FragmentTyp Check fragment
N/A • 1—Non-fragment. N/A
e packet type.
• 2—Non-or-first-fragmen
t.
• 3—Any-fragment.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.
Number of Unsigned integer.
Count packets that N/A 64 N/A
match a rule. Value range: 0 to 2 - 1.

Index of the rule Unsigned integer.

MatchIndex N/A N/A
after sorting. Value range: 0 to 65534.

Number of rules Unsigned integer.

RuleNum N/A N/A
in the ACL. Value range: 0 to 65535.

Members include:
Whether a rule Data • TtlOp.
Ttl N/A
matches TTL. structure • TtlValue1.
• TtlValue2.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
TtlOp TTL operator. N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).
Unsigned integer.
TtlValue1 Start TTL value. N/A Value range: 1 to 255. N/A

When the TtlOp is 5, the

value range is 1 to 255.
Unsigned integer. Otherwise, it can only be
TtlValue2 End TTL value. N/A 256. The value 256
Value range: 1 to 256. indicates that the end
TTL value is not
available.
Members include:
Whether a rule
Data • PktLengthOp.
PktLength matches packet N/A
length.
structure • PktLengthValue1.
• PktLengthValue2.
Packet length
PktLengthOp N/A Enumeration: N/A
operator.

40
 Column Column Column
Data type and restrictions Remarks
name description type
• 1—lt (lower than).
• 2—eq (equal to).
• 3—gt (greater than).
• 4—neq (not equal to).
• 5—range (inclusive
range).

PktLengthVal Start packet Unsigned integer.

N/A N/A
ue1 length value. Value range: 0 to 65535.
When the PktLengthOp
is 5, the value range is 0
Unsigned integer. to 65535. Otherwise, it
PktLengthVal End packet
N/A can only be 65536. The
ue2 length value. Value range: 0 to 65536. value 65536 indicates
that the packet length
value is not available.

ACL/IPv6AdvanceRules
This table contains IPv6 advanced ACL rule information.

XML structure
<ACL>
<IPv6AdvanceRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<ProtocolType></ProtocolType>
<SrcAny></SrcAny>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<SrcObjectGroup></SrcObjectGroup>
<DstAny></DstAny>
<DstIPv6>
<DstIPv6Addr></DstIPv6Addr>
<DstIPv6Prefix></DstIPv6Prefix>
</DstIPv6>
<DstObjectGroup></DstObjectGroup>
<ECN></ECN>
<DSCP></DSCP>
<FlowLabel></FlowLabel>
<RoutingTypeAny></RoutingTypeAny>
<RoutingTypeValue></RoutingTypeValue>
<SrcPort>

41
 <SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<TcpFlag>
<ACK></ACK>
<FIN></FIN>
<PSH></PSH>
<RST></RST>
<SYN></SYN>
<URG></URG>
</TcpFlag>
<Established></Established>
<ICMP6>
<ICMP6Type></ICMP6Type>
<ICMP6Code></ICMP6Code>
</ICMP6>
<Fragment></Fragment>
<HopTypeAny></HopTypeAny>
<HopTypeValue></HopTypeValue>
<TimeRange></TimeRange>
<VRF></VRF>
<QoSLocalID></QoSLocalID>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<UserGroup></UserGroup>
<UserGroupAny></UserGroupAny>
<GreValue></GreValue>
<Options></Options>
<FragmentType></FragmentType>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
<Ttl>
<TtlOp></TtlOp>
<TtlValue1></TtlValue1>
<TtlValue2></TtlValue2>
</Ttl>
<PktLength>
<PktLengthOp></PktLengthOp>
<PktLengthValue1></PktLengthValue1>
<PktLengthValue2></PktLengthValue2>

42
 </PktLength>
</Rule>
</IPv6AdvanceRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv6AdvanceRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Unsigned integer.
GroupID ACL number. Index Value range: 3000 to N/A
3999.
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.
Action on Enumeration:
packets
Action
matching the
N/A • 1—Deny. N/A
rule. • 2—Permit.

Unsigned integer.
Value range: 0 to 256.
ProtocolType Protocol type. N/A The value 256 N/A
represents all IPv6
protocols.
Boolean:

Whether a rule • true—Matches any

matches any source IPv6
SrcAny N/A addresses. N/A
source IPv6
addresses. • false—Matches the
specified source
IPv6 address.
Members include:
Source IPv6 Data The two members must
SrcIPv6
information. structure • SrcIPv6Addr. both be specified.
• SrcIPv6Prefix.

43
 Column Column Data type and
Column name Remarks
description type restrictions
Example: 1:1::1:1.
This column is available
Source IPv6 Hexadecimal string, when the SrcAny column
SrcIPv6Addr N/A
address. colon-separated. is false.
It must be empty when the
SrcAny column is true.
This column is available
Length of the when the SrcAny column
Unsigned integer.
SrcIPv6Prefix source IPv6 N/A is false.
address prefix. Value range: 1 to 128.
It must be empty when the
SrcAny column is true.

String, case-insensitive.
Source object
SrcObjectGroup N/A N/A
group name. Length: 1 to 31
characters.
Boolean:
• true—Matches any
Whether a rule destination IPv6
matches any addresses.
DstAny N/A N/A
destination IPv6 • false—Matches the
addresses. specified
destination IPv6
address.
Members include:
Destination IPv6 Data The two members must
DstIPv6
information. structure • DstIPv6Addr. both be specified.
• DstIPv6Prefix.
Example: 1:1::1:1.
This column is available
Destination IPv6 Hexadecimal string, when the DstAny column
DstIPv6Addr N/A
address. colon-separated. is false.
It must be empty when the
DstAny column is true.
This column is available
Length of the when the DstAny column
Unsigned integer.
DstIPv6Prefix destination IPv6 N/A is false.
address prefix. Value range: 1 to 128.
It must be empty when the
DstAny column is true.

Destination String, case-insensitive.

DstObjectGroup object group N/A Length: 1 to 31 N/A
name. characters.
Unsigned integer.
ECN ECN flag. N/A N/A
Value range: 0 to 3.
Unsigned integer.
DSCP DSCP priority. N/A N/A
Value range: 0 to 63.

Flow label value Unsigned integer.

FlowLabel in an IPv6 N/A Value range: 0 to N/A
packet header. 1048575.

44
 Column Column Data type and
Column name Remarks
description type restrictions
Boolean:

Whether a rule • true—Matches any

RoutingTypeAn matches any types of routing
N/A header. N/A
y types of routing
header. • false—Matches the
specified type of
routing header.

RoutingTypeVal Routing header Unsigned integer.

N/A N/A
ue type. Value range: 0 to 255.

Members include: Only the TCP and UDP

protocols support this
Source port Data • SrcPortOp. column.
SrcPort
information. structure • SrcPortValue1.
The members must be all
• SrcPortValue2. specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Source port • 3—gt (greater
SrcPortOp N/A than). N/A
operator.
• 4—neq (not equal
to).
• 5—range (inclusive
range).

Start source Unsigned integer.

SrcPortValue1 N/A N/A
port. Value range: 0 to 65535.
When the SrcPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
SrcPortValue2 End source port. N/A only be 65536. The value
Value range: 0 to 65536. 65536 indicates that the
end source port is not
available.

Members include: Only the TCP and UDP

protocols support this
Destination port Data • DstPortOp. column.
DstPort
information. structure • DstPortValue1.
The members must be all
• DstPortValue2. specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port • 3—gt (greater
DstPortOp N/A than). N/A
operator.
• 4—neq (not equal
to).
• 5—range (inclusive
range).

Start destination Unsigned integer.

DstPortValue1 N/A N/A
port. Value range: 0 to 65535.

45
 Column Column Data type and
Column name Remarks
description type restrictions
When the DstPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
End destination
DstPortValue2 N/A only be 65536. The value
port. Value range: 0 to 65536. 65536 indicates that the
end destination port is not
available.
Members include:
• ACK.
• FIN.
Data
TcpFlag TCP flags.
structure • PSH. N/A
• RST.
• SYN.
• URG.
Unsigned integer.
Value range: 0 or 1.
ACK flag in a Only the TCP protocol
ACK N/A • 0—ACK flag is not
TCP packet. supports this column.
set.
• 1—ACK flag is set.
Unsigned integer.
Value range: 0 or 1.
FIN flag in a Only the TCP protocol
FIN N/A • 0—FIN flag is not
TCP packet. supports this column.
set.
• 1—FIN flag is set.
Unsigned integer.
Value range: 0 or 1.
PSH flag in a Only the TCP protocol
PSH N/A • 0—PSH flag is not
TCP packet. supports this column.
set.
• 1—PSH flag is set.
Unsigned integer.
Value range: 0 or 1.
RST flag in a Only the TCP protocol
RST N/A • 0—RST flag is not
TCP packet. supports this column.
set.
• 1—RST flag is set.
Unsigned integer.
Value range: 0 or 1.
SYN flag in a Only the TCP protocol
SYN N/A • 0—SYN flag is not
TCP packet. supports this column.
set.
• 1—SYN flag is set.
Unsigned integer.
Value range: 0 or 1.
URG flag in a Only the TCP protocol
URG N/A • 0—URG flag is not
TCP packet. supports this column.
set.
• 1—URG flag is set.

46
 Column Column Data type and
Column name Remarks
description type restrictions
Only the TCP protocol
supports this column.
Whether a rule Boolean:
matches flags On a router, the rule
indicating the • true—Matches the matches TCP connection
Established N/A flags. packets with the ACK or
established
status of a TCP • false—Ignores the RST flag set. On a switch,
connection. flags. the availability and usage
of this column depend on
the device model.
Members include:
ICMPv6 Data The members must both
ICMP6
messages. structure • ICMP6Type. be specified.
• ICMP6Code.

Type of ICMPv6 Unsigned integer. Only the ICMPv6 protocol

ICMP6Type N/A
messages. Value range: 0 to 255. supports this column.

Unsigned integer.
Value range: 0 to 256.
Code of ICMPv6 The value 256 indicates Only the ICMPv6 protocol
ICMP6Code N/A
messages. that no ICMPv6 supports this column.
message code is
specified.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches
fragments. both fragments and
non-fragments.
Boolean:
• true—Matches any
Whether a rule types of
matched any Hop-by-Hop
HopTypeAny types of N/A Options header. N/A
Hop-by-Hop • false—Matches the
Options header. specified type of
Hop-by-Hop
Options header.
Type of Unsigned integer.
HopTypeValue Hop-by-Hop N/A N/A
Options header. Value range: 0 to 255.

String, case-insensitive.
TimeRange Time range. N/A Length: 0 to 32 N/A
characters.
String, case-sensitive.
VRF VRF. N/A Length: 0 to 31 N/A
characters.

Unsigned integer.
QoSLocalID Local QoS ID. N/A N/A
Value range: 1 to 4095.

47
 Column Column Data type and
Column name Remarks
description type restrictions
Boolean:

Whether to • true—Counts the

Counting count the rule N/A rule matches. N/A
matches. • false—Does not
count the rule
matches.
Boolean:
Whether to log • true—Logs rule
Logging rule match N/A match events. N/A
events. • false—Does not log
rule match events.
String, case-sensitive.
Comment Rule comment. N/A Length: 1 to 127 N/A
characters.
String, case-insensitive.
User group
UserGroup N/A Length: 1 to 32 N/A
name.
characters.
Boolean:

Whether a rule • true—Matches any

UserGroupAny matches any N/A user group. N/A
user group. • false—Matches the
specified user
group.
Hexadecimal string.
Length: 1 to 8
Config a gre Only the GRE protocol
GreValue N/A characters.
value. supports this column.
Value range: 0 to
FFFFFFFF.

Boolean: Only when the

ProtocolType value is
Options IP options. N/A • true—Options. 256,and then the table can
• false—Not options. supports this column.
Unsigned integer.
Value range: 0 to 3.
• 0—First-fragment.
Check fragment
FragmentType N/A • 1—Non-fragment. N/A
packet type.
• 2—Non-or-first-frag
ment.
• 3—Any-fragment.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.
Number of Unsigned integer.
Count packets that N/A 64 N/A
match a rule. Value range: 0 to 2 - 1.

Index of the rule Unsigned integer.

MatchIndex N/A N/A
after sorting. Value range: 0 to 65534.

48
 Column Column Data type and
Column name Remarks
description type restrictions
Members include:
Whether a rule Data • TtlOp.
Ttl N/A
matches TTL. structure • TtlValue1.
• TtlValue2.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
• 3—gt (greater
TtlOp TTL operator. N/A than). N/A
• 4—neq (not equal
to).
• 5—range (inclusive
range).
Unsigned integer.
TtlValue1 Start TTL value. N/A N/A
Value range: 1 to 255.
When the TtlOp is 5, the
value range is 1 to 255.
Unsigned integer. Otherwise, it can only be
TtlValue2 End TTL value. N/A
Value range: 1 to 256. 256. The value 256
indicates that the end TTL
value is not available.
Members include:
Whether a rule
Data • PktLengthOp.
PktLength matches packet N/A
length.
structure • PktLengthValue1.
• PktLengthValue2.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Packet length • 3—gt (greater
PktLengthOp N/A than). N/A
operator.
• 4—neq (not equal
to).
• 5—range (inclusive
range).

PktLengthValue Start packet Unsigned integer.

N/A N/A
1 length value. Value range: 0 to 65535.
When the PktLengthOp is
5, the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
PktLengthValue End packet
N/A only be 65536 The value
2 length value. Value range: 0 to 65536. 65536 indicates that the
packet length value is not
available.

ACL/IPv6NamedAdvanceRules
This table contains named IPv6 advanced ACL rule information.

49
XML structure
<ACL>
<IPv6NamedAdvanceRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<ProtocolType></ProtocolType>
<SrcAny></SrcAny>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<SrcObjectGroup></SrcObjectGroup>
<DstAny></DstAny>
<DstIPv6>
<DstIPv6Addr></DstIPv6Addr>
<DstIPv6Prefix></DstIPv6Prefix>
</DstIPv6>
<DstObjectGroup></DstObjectGroup>
<ECN></ECN>
<DSCP></DSCP>
<FlowLabel></FlowLabel>
<RoutingTypeAny></RoutingTypeAny>
<RoutingTypeValue></RoutingTypeValue>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<TcpFlag>
<ACK></ACK>
<FIN></FIN>
<PSH></PSH>
<RST></RST>
<SYN></SYN>
<URG></URG>
</TcpFlag>
<Established></Established>
<ICMP6>
<ICMP6Type></ICMP6Type>
<ICMP6Code></ICMP6Code>

50
 </ICMP6>
<Fragment></Fragment>
<HopTypeAny></HopTypeAny>
<HopTypeValue></HopTypeValue>
<TimeRange></TimeRange>
<VRF></VRF>
<QoSLocalID></QoSLocalID>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<UserGroup></UserGroup>
<UserGroupAny></UserGroupAny>
<GreValue></GreValue>
<Options></Options>
<FragmentType></FragmentType>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
<RuleNum></RuleNum>
<Ttl>
<TtlOp></TtlOp>
<TtlValue1></TtlValue1>
<TtlValue2></TtlValue2>
</Ttl>
<PktLength>
<PktLengthOp></PktLengthOp>
<PktLengthValue1></PktLengthValue1>
<PktLengthValue2></PktLengthValue2>
</PktLength>
</Rule>
</IPv6NamedAdvanceRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv6NamedAdvanceRules
Table type Multi-instance table
Row name Rule
Restrictions None

51
Columns
Column Column Data type and
Column name Remarks
description type restrictions
String.
Length: 1 to 63
characters.
• ACL name:
ACL name or Case-insensitive
GroupIndex Index string of 1 to 63 N/A
number.
characters.
• ACL number:
String of digits in
the range of 3000 to
3999.
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.
Action on Enumeration:
packets
Action
matching the
N/A • 1—Deny. N/A
rule. • 2—Permit.

Unsigned integer.
Value range: 0 to 256.
ProtocolType Protocol type. N/A The value 256 N/A
represents all IPv6
protocols.
Boolean:

Whether a rule • true—Matches any

matches any source IPv6
SrcAny N/A addresses. N/A
source IPv6
addresses. • false—Matches the
specified source
IPv6 address.
Members include:
Source IPv6 Data The two members must
SrcIPv6
information. structure • SrcIPv6Addr. both be specified.
• SrcIPv6Prefix.
Example: 1:1::1:1.
This column is available
Source IPv6 Hexadecimal string, when the SrcAny column
SrcIPv6Addr N/A
address. colon-separated. is false.
It must be empty when the
SrcAny column is true.
This column is available
Length of the when the SrcAny column
Unsigned integer.
SrcIPv6Prefix source IPv6 N/A is false.
address prefix. Value range: 1 to 128.
It must be empty when the
SrcAny column is true.

String, case-insensitive.
Source object
SrcObjectGroup N/A N/A
group name. Length: 1 to 31
characters.

52
 Column Column Data type and
Column name Remarks
description type restrictions
Boolean:
• true—Matches any
Whether a rule destination IPv6
matches any addresses.
DstAny N/A N/A
destination IPv6 • false—Matches the
addresses. specified
destination IPv6
address.
Members include:
Destination IPv6 Data The two members must
DstIPv6
information. structure • DstIPv6Addr. both be specified.
• DstIPv6Prefix.
Example: 1:1::1:1.
This column is available
Destination IPv6 Hexadecimal string, when the DstAny column
DstIPv6Addr N/A
address. colon-separated. is false.
It must be empty when the
DstAny column is true.
This column is available
Length of the when the DstAny column
Unsigned integer.
DstIPv6Prefix destination IPv6 N/A is false.
address prefix. Value range: 1 to 128.
It must be empty when the
DstAny column is true.

Destination String, case-insensitive.

DstObjectGroup object group N/A Length: 1 to 31 N/A
name. characters.
Unsigned integer.
ECN ECN flag. N/A N/A
Value range: 0 to 3.
Unsigned integer.
DSCP DSCP priority. N/A N/A
Value range: 0 to 63.

Flow label value Unsigned integer.

FlowLabel in an IPv6 N/A Value range: 0 to N/A
packet header. 1048575.
Boolean:

Whether a rule • true—Matches any

RoutingTypeAn matches any types of routing
N/A header. N/A
y types of routing
header. • false—Matches the
specified type of
routing header.

RoutingTypeVal Routing header Unsigned integer.

N/A N/A
ue type. Value range: 0 to 255.

Members include: Only the TCP and UDP

protocols support this
Source port Data • SrcPortOp. column.
SrcPort
information. structure • SrcPortValue1.
The members must be all
• SrcPortValue2. specified.

53
 Column Column Data type and
Column name Remarks
description type restrictions
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Source port • 3—gt (greater
SrcPortOp N/A than). N/A
operator.
• 4—neq (not equal
to).
• 5—range (inclusive
range).

Start source Unsigned integer.

SrcPortValue1 N/A N/A
port. Value range: 0 to 65535.
When the SrcPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
SrcPortValue2 End source port. N/A only be 65536. The value
Value range: 0 to 65536. 65536 indicates that the
end source port is not
available.

Members include: Only the TCP and UDP

protocols support this
Destination port Data • DstPortOp. column.
DstPort
information. structure • DstPortValue1.
The members must be all
• DstPortValue2. specified.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port • 3—gt (greater
DstPortOp N/A than). N/A
operator.
• 4—neq (not equal
to).
• 5—range (inclusive
range).

Start destination Unsigned integer.

DstPortValue1 N/A N/A
port. Value range: 0 to 65535.
When the DstPortOp is 5,
the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
End destination
DstPortValue2 N/A only be 65536. The value
port. Value range: 0 to 65536. 65536 indicates that the
end destination port is not
available.
Members include:
• ACK.
• FIN.
Data
TcpFlag TCP flags.
structure • PSH. N/A
• RST.
• SYN.
• URG.

54
 Column Column Data type and
Column name Remarks
description type restrictions
Unsigned integer.
Value range: 0 or 1.
ACK flag in a Only the TCP protocol
ACK N/A • 0—ACK flag is not
TCP packet. supports this column.
set.
• 1—ACK flag is set.
Unsigned integer.
Value range: 0 or 1.
FIN flag in a Only the TCP protocol
FIN N/A • 0—FIN flag is not
TCP packet. supports this column.
set.
• 1—FIN flag is set.
Unsigned integer.
Value range: 0 or 1.
PSH flag in a Only the TCP protocol
PSH N/A • 0—PSH flag is not
TCP packet. supports this column.
set.
• 1—PSH flag is set.
Unsigned integer.
Value range: 0 or 1.
RST flag in a Only the TCP protocol
RST N/A • 0—RST flag is not
TCP packet. supports this column.
set.
• 1—RST flag is set.
Unsigned integer.
Value range: 0 or 1.
SYN flag in a Only the TCP protocol
SYN N/A • 0—SYN flag is not
TCP packet. supports this column.
set.
• 1—SYN flag is set.
Unsigned integer.
Value range: 0 or 1.
URG flag in a Only the TCP protocol
URG N/A • 0—URG flag is not
TCP packet. supports this column.
set.
• 1—URG flag is set.
Only the TCP protocol
supports this column.
Whether a rule Boolean:
matches flags On a router, the rule
indicating the • true—Matches the matches TCP connection
Established N/A flags. packets with the ACK or
established
status of a TCP • false—Ignores the RST flag set. On a switch,
connection. flags. the availability and usage
of this column depend on
the device model.
Members include:
ICMPv6 Data The members must both
ICMP6
messages. structure • ICMP6Type. be specified.
• ICMP6Code.

Type of ICMPv6 Unsigned integer. Only the ICMPv6 protocol

ICMP6Type N/A
messages. Value range: 0 to 255. supports this column.

55
 Column Column Data type and
Column name Remarks
description type restrictions
Unsigned integer.
Value range: 0 to 256.
Code of ICMPv6 The value 256 indicates Only the ICMPv6 protocol
ICMP6Code N/A
messages. that no ICMPv6 supports this column.
message code is
specified.
Boolean:
Whether a rule • true—Matches only
matches only non-first fragments.
Fragment N/A N/A
non-first • false—Matches
fragments. both fragments and
non-fragments.
Boolean:
• true—Matches any
Whether a rule types of
matched any Hop-by-Hop
HopTypeAny types of N/A Options header. N/A
Hop-by-Hop • false—Matches the
Options header. specified type of
Hop-by-Hop
Options header.
Type of Unsigned integer.
HopTypeValue Hop-by-Hop N/A N/A
Options header. Value range: 0 to 255.

String, case-insensitive.
TimeRange Time range. N/A Length: 0 to 32 N/A
characters.
String, case-sensitive.
VRF VRF. N/A Length: 0 to 31 N/A
characters.

Unsigned integer.
QoSLocalID Local QoS ID. N/A N/A
Value range: 1 to 4095.
Boolean:

Whether to • true—Counts the

Counting count the rule N/A rule matches. N/A
matches. • false—Does not
count the rule
matches.
Boolean:
Whether to log • true—Logs rule
Logging rule match N/A match events. N/A
events. • false—Does not log
rule match events.
String, case-sensitive.
Comment Rule comment. N/A Length: 1 to 127 N/A
characters.

56
 Column Column Data type and
Column name Remarks
description type restrictions
String, case-insensitive.
User group
UserGroup N/A Length: 1 to 32 N/A
name.
characters.
Boolean:

Whether a rule • true—Matches any

UserGroupAny matches any N/A user group. N/A
user group. • false—Matches the
specified user
group.
Hexadecimal string.
Length: 1 to 8
Config a gre Only the GRE protocol
GreValue N/A characters.
value. supports this column.
Value range: 0 to
FFFFFFFF.
Boolean: Only when the
Options IP options. N/A • true—Options. ProtocolType value is
• false—Not options, 256,and then the table can
default. supports this column.

Unsigned integer.
Value range: 0 to 3.
• 0—First-fragment.
Check fragment
FragmentType N/A • 1—Non-fragment. N/A
packet type.
• 2—Non-or-first-frag
ment.
• 3—Any-fragment.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.
Number of Unsigned integer.
Count packets that N/A 64 N/A
match a rule. Value range: 0 to 2 - 1.

Index of the rule Unsigned integer.

MatchIndex N/A N/A
after sorting. Value range: 0 to 65534.

Number of rules Unsigned integer.

RuleNum N/A N/A
in the ACL. Value range: 0 to 65535.

Members include:
Whether a rule Data • TtlOp.
Ttl N/A
matches TTL. structure • TtlValue1.
• TtlValue2.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
TtlOp TTL operator. N/A • 3—gt (greater N/A
than).
• 4—neq (not equal
to).
• 5—range (inclusive

57
 Column Column Data type and
Column name Remarks
description type restrictions
range).
Unsigned integer.
TtlValue1 Start TTL value. N/A N/A
Value range: 1 to 255.
When the TtlOp is 5, the
value range is 1 to 255.
Unsigned integer. Otherwise, it can only be
TtlValue2 End TTL value. N/A
Value range: 1 to 256. 256. The value 256
indicates that the end TTL
value is not available.
Members include:
Whether a rule
Data • PktLengthOp.
PktLength matches packet N/A
length.
structure • PktLengthValue1.
• PktLengthValue2.
Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Packet length • 3—gt (greater
PktLengthOp N/A than). N/A
operator.
• 4—neq (not equal
to).
• 5—range (inclusive
range).

PktLengthValue Start packet Unsigned integer.

N/A N/A
1 length value. Value range: 0 to 65535.
When the PktLengthOp is
5, the value range is 0 to
Unsigned integer. 65535. Otherwise, it can
PktLengthValue End packet
N/A only be 65536. The value
2 length value. Value range: 0 to 65536. 65536 indicates that the
packet length value is not
available.

ACL/MACRules
This table contains Ethernet frame header ACL rule information.

XML structure
<ACL>
<MACRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<SrcMACAddr>
<SrcMACAddress></SrcMACAddress>
<SrcMACMask></SrcMACMask>
</SrcMACAddr>

58
 <DstMACAddr>
<DstMACAddress></DstMACAddress>
<DstMACMask></DstMACMask>
</DstMACAddr>
<COS></COS>
<Protocol>
<ProtocolType></ProtocolType>
<ProtocolTypeMask></ProtocolTypeMask>
</Protocol>
<LSAP>
<LSAPType></LSAPType>
<LSAPTypeMask></LSAPTypeMask>
</LSAP>
<EncapType></EncapType>
<VxlanID></VxlanID>
<InSrcMACAddr>
<InSrcMACAddress></InSrcMACAddress>
<InSrcMACMask></InSrcMACMask>
</InSrcMACAddr>
<InDstMACAddr>
<InDstMACAddress></InDstMACAddress>
<InDstMACMask></InDstMACMask>
</InDstMACAddr>
<InProtocol>
<InProtocolType></InProtocolType>
<InProtocolTypeMask></InProtocolTypeMask>
</InProtocol>
<TimeRange></TimeRange>
<Counting></Counting>
<Comment></Comment>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
</Rule>
</MACRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name MACRules
Table type Multi-instance table
Row name Rule
Restrictions None

59
Columns
Column Column
Column name Data type and restrictions Remarks
description type
Unsigned integer.
GroupID ACL number. Index N/A
Value range: 4000 to 4999.
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.
Enumeration:
Action on packets
Action
matching the rule.
N/A • 1—Deny. N/A
• 2—Permit.

Information about Members include:

Data The members must
SrcMACAddr the source MAC
structure • SrcMACAddress. both be specified.
address. • SrcMACMask.
SrcMACAddres Source MAC Six groups of two hexadecimal Example:
N/A
s address. digits, hyphen-separated. 00-0c-af-e3-5d-c0.
Mask of the
Six groups of two hexadecimal Example:
SrcMACMask source MAC N/A
digits, hyphen-separated. ff-ff-ff-ff-ff-ff.
address.

Information about Members include:

Data The members must
DstMACAddr the destination
structure • DstMACAddress. both be specified.
MAC address. • DstMACMask.
DstMACAddres Destination MAC Six groups of two hexadecimal Example:
N/A
s address. digits, hyphen-separated. 00-0c-af-e3-5d-c0.
Mask of the
Six groups of two hexadecimal Example:
DstMACMask destination MAC N/A
digits, hyphen-separated. ff-ff-ff-ff-ff-ff.
address.
Unsigned integer.
COS 802.1p priority. N/A N/A
Value range: 0 to 7.
Members include:
Link layer Data The members must
Protocol
protocol. structure • ProtocolType. both be specified.
• ProtocolTypeMask.
Hexadecimal string.
Type of the link
ProtocolType N/A Length: 1 to 4 characters. N/A
layer protocol.
Value range: 0 to FFFF.

Mask of the link Hexadecimal string.

ProtocolTypeM
layer protocol N/A Length: 1 to 4 characters. N/A
ask
type. Value range: 0 to FFFF.
Members include:
Data The members must
LSAP LSAP.
structure • LSAPType. both be specified.
• LSAPTypeMask.
Hexadecimal string.
LSAPType Type of LSAP. N/A Length: 1 to 4 characters. N/A
Value range: 0 to FFFF.

60
 Column Column
Column name Data type and restrictions Remarks
description type
Hexadecimal string.
Mask of the LSAP
LSAPTypeMask N/A Length: 1 to 4 characters. N/A
type.
Value range: 0 to FFFF.
Members include:

Encapsulation • VXLAN encapsulation.

EncapType N/A • GRE encapsulation. N/A
type.
• IPINIP encapsulation.

Unsigned integer Only the VXLAN

encapsulation
VxlanID VXLAN ID N/A
supports this
Value range: 0 to 16777215 column.

Only the VXLAN

encapsulation
Information about Members include: supports this
Data
InSrcMACAddr the inner source
structure • InSrcMACAddress. column.
MAC address. • InSrcMACMask.
The members must
both be specified.

InSrcMACAddr Inner source MAC Six groups of two hexadecimal Example:

N/A
ess address. digits, hyphen-separated. 00-0c-af-e3-5d-c0.

Mask of the inner Example:

Six groups of two hexadecimal
InSrcMACMask source MAC N/A
address.
digits, hyphen-separated. ff-ff-ff-ff-ff-ff.

Only the VXLAN

encapsulation
Information about Members include: supports this
the inner Data
InDstMACAddr
destination MAC structure • InDstMACAddress. column.
address. • InDstMACMask.
The members must
both be specified.

InDstMACAddr Inner destination Six groups of two hexadecimal Example:

N/A
ess MAC address. digits, hyphen-separated. 00-0c-af-e3-5d-c0.

Mask of the inner Example:

Six groups of two hexadecimal
InDstMACMask destination MAC N/A
address.
digits, hyphen-separated. ff-ff-ff-ff-ff-ff.

Only the VXLAN

encapsulation
supports this
Members include: column.
Inner link layer Data
InProtocol
protocol. structure • ProtocolType.
• ProtocolTypeMask. The members must
both be specified.

InProtocolType Type of the inner N/A Hexadecimal string. N/A

61
 Column Column
Column name Data type and restrictions Remarks
description type
link layer protocol.
Length: 1 to 4 characters.

Value range: 0 to FFFF.

Hexadecimal string.
Mask of the inner
InProtocolType
link layer protocol N/A Length: 1 to 4 characters. N/A
Mask
type.
Value range: 0 to FFFF.
String, case-insensitive.
TimeRange Time range. N/A N/A
Length: 1 to 32 characters.
Boolean:

Whether to count • true—Counts the rule

Counting N/A matches. N/A
the rule matches.
• false—Does not count
the rule matches.
String, case-sensitive.
Comment Rule comment. N/A N/A
Length: 1 to 127 characters.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.
Number of Unsigned integer.
Count packets that N/A 64 N/A
match a rule. Value range: 0 to 2 - 1.

Index of the rule Unsigned integer.

MatchIndex N/A N/A
after sorting. Value range: 0 to 65534.

ACL/MACNamedRules
This table contains named Ethernet frame header ACL rule information.

XML structure
<ACL>
<MACNamedRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<SrcMACAddr>
<SrcMACAddress></SrcMACAddress>
<SrcMACMask></SrcMACMask>
</SrcMACAddr>
<DstMACAddr>
<DstMACAddress></DstMACAddress>
<DstMACMask></DstMACMask>

62
 </DstMACAddr>
<COS></COS>
<Protocol>
<ProtocolType></ProtocolType>
<ProtocolTypeMask></ProtocolTypeMask>
</Protocol>
<LSAP>
<LSAPType></LSAPType>
<LSAPTypeMask></LSAPTypeMask>
</LSAP>
<EncapType></EncapType>
<VxlanID></VxlanID>
<InSrcMACAddr>
<InSrcMACAddress></InSrcMACAddress>
<InSrcMACMask></InSrcMACMask>
</InSrcMACAddr>
<InDstMACAddr>
<InDstMACAddress></InDstMACAddress>
<InDstMACMask></InDstMACMask>
</InDstMACAddr>
<InProtocol>
<InProtocolType></InProtocolType>
<InProtocolTypeMask></InProtocolTypeMask>
</InProtocol>
<TimeRange></TimeRange>
<Counting></Counting>
<Comment></Comment>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
<RuleNum></RuleNum>
</Rule>
</MACNamedRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name MACNamedRules
Table type Multi-instance table
Row name Rule
Restrictions None

63
Columns
Column Column
Column name Data type and restrictions Remarks
description type
String.
Length: 1 to 63 characters.
• ACL name:
ACL name or Case-insensitive string of
GroupIndex Index N/A
number. 1 to 63 characters.
• ACL number:
String of digits in the
range of 4000 to 4999.
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.
Enumeration:
Action on packets
Action
matching the rule.
N/A • 1—Deny. N/A
• 2—Permit.

Information about Members include:

Data The members must
SrcMACAddr the source MAC
structure • SrcMACAddress. both be specified.
address. • SrcMACMask.
SrcMACAddres Source MAC Six groups of two hexadecimal Example:
N/A
s address. digits, hyphen-separated. 00-0c-af-e3-5d-c0.
Mask of the
Six groups of two hexadecimal Example:
SrcMACMask source MAC N/A
digits, hyphen-separated. ff-ff-ff-ff-ff-ff.
address.

Information about Members include:

Data The members must
DstMACAddr the destination
structure • DstMACAddress. both be specified.
MAC address. • DstMACMask.
DstMACAddres Destination MAC Six groups of two hexadecimal Example:
N/A
s address. digits, hyphen-separated. 00-0c-af-e3-5d-c0.
Mask of the
Six groups of two hexadecimal Example:
DstMACMask destination MAC N/A
digits, hyphen-separated. ff-ff-ff-ff-ff-ff.
address.
Unsigned integer.
COS 802.1p priority. N/A N/A
Value range: 0 to 7.
Members include:
Link layer Data The members must
Protocol
protocol. structure • ProtocolType. both be specified.
• ProtocolTypeMask.
Hexadecimal string.
Type of the link
ProtocolType N/A Length: 1 to 4 characters. N/A
layer protocol.
Value range: 0 to FFFF.

Mask of the link Hexadecimal string.

ProtocolTypeM
layer protocol N/A Length: 1 to 4 characters. N/A
ask
type. Value range: 0 to FFFF.
Members include:
Data The members must
LSAP LSAP.
structure • LSAPType. both be specified.
• LSAPTypeMask.

64
 Column Column
Column name Data type and restrictions Remarks
description type
Hexadecimal string.
LSAPType Type of LSAP. N/A Length: 1 to 4 characters. N/A
Value range: 0 to FFFF.
Hexadecimal string.
Mask of the LSAP
LSAPTypeMask N/A Length: 1 to 4 characters. N/A
type.
Value range: 0 to FFFF.
Members include:

Encapsulation • VXLAN encapsulation.

EncapType N/A • GRE encapsulation. N/A
type.
• IPINIP encapsulation.

Unsigned integer Only the VXLAN

encapsulation
VxlanID VXLAN ID N/A
supports this
Value range: 0 to 16777215 column.

Only the VXLAN

encapsulation
Information about Members include: supports this
Data
InSrcMACAddr the inner source
structure • InSrcMACAddress. column.
MAC address. • InSrcMACMask.
The members must
both be specified.

InSrcMACAddr Inner source MAC Six groups of two hexadecimal Example:

N/A
ess address. digits, hyphen-separated. 00-0c-af-e3-5d-c0.

Mask of the inner Example:

Six groups of two hexadecimal
InSrcMACMask source MAC N/A
address.
digits, hyphen-separated. ff-ff-ff-ff-ff-ff.

Only the VXLAN

encapsulation
Information about Members include: supports this
the inner Data
InDstMACAddr
destination MAC structure • InDstMACAddress. column.
address. • InDstMACMask.
The members must
both be specified.

InDstMACAddr Inner destination Six groups of two hexadecimal Example:

N/A
ess MAC address. digits, hyphen-separated. 00-0c-af-e3-5d-c0.

Mask of the inner Example:

Six groups of two hexadecimal
InDstMACMask destination MAC N/A
address.
digits, hyphen-separated. ff-ff-ff-ff-ff-ff.

Only the VXLAN

encapsulation
Members include: supports this
Inner link layer Data
InProtocol
protocol. structure • ProtocolType. column.
• ProtocolTypeMask.
The members must
both be specified.

65
 Column Column
Column name Data type and restrictions Remarks
description type

Hexadecimal string.
Type of the inner
InProtocolType N/A Length: 1 to 4 characters. N/A
link layer protocol.
Value range: 0 to FFFF.

Hexadecimal string.
Mask of the inner
InProtocolType
link layer protocol N/A Length: 1 to 4 characters. N/A
Mask
type.
Value range: 0 to FFFF.
String, case-insensitive.
TimeRange Time range. N/A N/A
Length: 1 to 32 characters.
Boolean:

Whether to count • true—Counts the rule

Counting N/A matches. N/A
the rule matches.
• false—Does not count
the rule matches.
String, case-sensitive.
Comment Rule comment. N/A N/A
Length: 1 to 127 characters.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.
Number of Unsigned integer.
Count packets that N/A 64 N/A
match a rule. Value range: 0 to 2 - 1.

Index of the rule Unsigned integer.

MatchIndex N/A N/A
after sorting. Value range: 0 to 65534.

Number of rules in Unsigned integer.

RuleNum N/A N/A
the ACL. Value range: 0 to 65535.

ACL/PfilterDefAction
This table contains information about the default global packet filter actions.

XML structure
<ACL>
<PfilterDefAction>
<DefaultAction></DefaultAction>
</PfilterDefAction>
</ACL>

66
Table description
Item Description
Feature name ACL
Table name PfilterDefAction
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column
Column name Data type and restrictions
description type
Enumeration:
Default packet
DefaultAction
filter action
N/A • 1—Permit.
• 2—Deny.

ACL/PfilterIgnoreAction
This table contains information about the ignoring the packet filter permit action.

XML structure
<ACL>
<PfilterIgnoreAction>
<IgnoreAction></IgnoreAction>
</PfilterIgnoreAction>
</ACL>

Table description
Item Description
Feature name ACL
Table name PfilterIgnoreAction
Table type Single-instance table
Row name N/A
Restrictions None

67
Columns
Column Column
Column name Data type and restrictions Remarks
description type
Boolean:
Whether to the • true—Ignore the packet
IgnoreAction ignore packet filter N/A filter permit action. N/A
permit action. • false—Not ignore the
packet filter permit action.

ACL/PfilterApply
This table contains information about packet filter application.

XML structure
<ACL>
<PfilterApply>
<Pfilter>
<AppObjType></AppObjType>
<AppObjIndex></AppObjIndex>
<AppDirection></AppDirection>
<AppAclType></AppAclType>
<AppAclGroup></AppAclGroup>
<HardCount></HardCount>
<InnerEncap></InnerEncap>
<ShareMode></ShareMode>
<AppSequence></AppSequence>
</Pfilter>
</PfilterApply>
</ACL>

Table description
Item Description
Feature name ACL
Table name PfilterApply
Table type Multi-instance table
Row name Pfilter
Restrictions None

68
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Enumeration:
Type of the
• 1—Interface.
AppObjType application Index N/A
object. • 2—VLAN.
• 3—Global.
The value depends on
the AppObjType column.
• Interface index if
Index of the Unsigned integer. AppObjType is 1.
AppObjIndex application Index Value range: 0 to • VLAN ID in the
object. 4294967295. range of 1 to 4094 if
AppObjType is 2.
• The value is 0 if
AppObjType is 3.
Enumeration:
Application
AppDirection
direction.
Index • 1—Inbound. N/A
• 2—Outbound.
Enumeration:
• 1—IPv4 ACL.
• 2—IPv6 ACL.
• 3—MAC ACL. • Type 5 is a special
AppAclType ACL type. Index
ACL.
• 4—User-defined
ACL.
• 5—ACL with the
default action.

String. The value range

depends on the
Length: 1 to 63
AppAclType column.
characters.
• ACL name: • 2000 to 3999 if
Case-insensitive AppAclType is 1.
ACL name or string of 1 to 63 • 2000 to 3999 if
AppAclGroup Index
number. characters. AppAclType is 2.
• ACL number: • 4000 to 4999 if
String of digits AppAclType is 3.
valued 0 or in the • 5000 to 5999 if
range of 2000 to AppAclType is 4.
5999. • 0 if AppAclType is 5.
Whether to count Enumeration:
rule matches in
HardCount
hardware for the
N/A • 1—enable. N/A
ACL. • 2—disable.

Match the inner

packet Enumeration:
InnerEncap information of N/A • 0—None. N/A
encapsulation • 1—VXLAN.
packets.

69
 Column Column Data type and
Column name Remarks
description type restrictions
Boolean:

Whether to apply • true—Apply the ACL

the ACL in N/A in sharing mode. N/A
ShareMode
sharing mode. • false—Do not apply
the ACL in sharing
mode.
Unsigned integer.
ACL application
AppSequence N/A Value range: 1 to N/A
sequence.
4294967295.

ACL/PfilterGroupRunInfo
This table contains running information about packet filter ACLs on application objects.

XML structure
<ACL>
<PfilterGroupRunInfo>
<GroupRunInfo>
<AppObjType></AppObjType>
<AppObjIndex></AppObjIndex>
<AppDirection></AppDirection>
<AppAclType></AppAclType>
<AppAclGroup></AppAclGroup>
<AclGroupStatus></AclGroupStatus>
<AclGroupCountStatus></AclGroupCountStatus>
<AclGroupPermitPkts></AclGroupPermitPkts>
<AclGroupPermitBytes></AclGroupPermitBytes>
<AclGroupDenyPkts></AclGroupDenyPkts>
<AclGroupDenyBytes></AclGroupDenyBytes>
</GroupRunInfo>
</PfilterGroupRunInfo>
</ACL>

Table description
Item Description
Feature name ACL
Table name PfilterGroupRunInfo
Table type Multi-instance table
Row name GroupRunInfo
Restrictions None

70
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Enumeration:
Type of the
• 1—Interface.
AppObjType application Index N/A
object. • 2—VLAN.
• 3—Global.
The value depends on the
AppObjType column.
• Interface index if
Index of the Unsigned integer. AppObjType is 1.
AppObjIndex application Index Value range: 0 to • VLAN ID in the range of
object. 4294967295. 1 to 4094 if
AppObjType is 2.
• The value is 0 if
AppObjType is 3.
Enumeration:
Application
AppDirection
direction.
Index • 1—Inbound. N/A
• 2—Outbound.
Enumeration:
• 1—IPv4 ACL. • Type 5 is a special
• 2—IPv6 ACL. ACL. The default action
AppAclType ACL type. Index • 3—MAC ACL. can be the default MAC
action, default IPv4
• 4—User-defined
action, or default IPv6
ACL.
action.
• 5—ACL with the
default action.
The value depends on the
AppAclType column.
• 2000 to 3999 if
AppAclType is 1.
String.
• 2000 to 3999 if
Length: 1 to 63 AppAclType is 2.
characters.
• 4000 to 4999 if
• ACL name: AppAclType is 3.
Case-insensitive
ACL name or string of 1 to 63 • 5000 to 5999 if
AppAclGroup Index AppAclType is 4.
number. characters.
• ACL number: • 1 if AppAclType is 4
String of digits and the default action is
valued 0 or in the default MAC action.
range of 2000 to • 2 if AppAclType is 4
5999. and the default action is
default IPv4 action.
• 3 if AppAclType is 4
and the default action is
default IPv6 action.
Enumeration:
Whether an
• 1—Succeeded.
ACL is
AclGroupStatus
successfully
N/A • 2—Failed. N/A
applied. • 3—Partly
succeeded.

71
 Column Column Data type and
Column name Remarks
description type restrictions
Whether an
ACL with Enumeration:
hardware • 1—Succeeded.
AclGroupCountSt
atus
counting N/A • 2—Failed. N/A
enabled is
• 3—Partly
successfully
succeeded.
applied.
If the device does not
Number of Unsigned integer. support match counting for
AclGroupPermitP
permitted N/A 64 packet filter,
kts Value range: 0 to 2 - 1.
packets. 0×FFFFFFFFFFFFFFFF is
returned.
If the device does not
Number of Unsigned integer. support match counting for
AclGroupPermitB
permitted N/A 64 packet filter,
ytes Value range: 0 to 2 - 1.
bytes. 0×FFFFFFFFFFFFFFFF is
returned.
If the device does not
Number of Unsigned integer. support match counting for
AclGroupDenyPkt
denied N/A 64 packet filter,
s Value range: 0 to 2 - 1.
packets. 0×FFFFFFFFFFFFFFFF is
returned.
If the device does not
Number of Unsigned integer. support match counting for
AclGroupDenyByt
denied N/A 64 packet filter,
es Value range: 0 to 2 - 1.
bytes. 0×FFFFFFFFFFFFFFFF is
returned.

ACL/PfilterRuleRunInfo
This table contains running information about packet filter ACL rules on application objects.

XML structure
<ACL>
<PfilterRuleRunInfo>
<RuleRunInfo>
<AppObjType></AppObjType>
<AppObjIndex></AppObjIndex>
<AppDirection></AppDirection>
<AppAclType></AppAclType>
<AppAclGroup></AppAclGroup>
<AppAclRuleIndex></AppAclRuleIndex>
<AclRuleStatus></AclRuleStatus>
<AclRuleCountStatus></AclRuleCountStatus>
<AclRuleMatchPkts></AclRuleMatchPkts>
<AclRuleMatchBytes></AclRuleMatchBytes>
</RuleRunInfo>
</PfilterRuleRunInfo>
</ACL>

72
Table description
Item Description
Feature name ACL
Table name PfilterRuleRunInfo
Table type Multi-instance table
Row name RuleRunInfo
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Enumeration:
Type of the
• 1—Interface.
AppObjType application Index N/A
object. • 2—VLAN.
• 3—Global.
The value depends on
the AppObjType
column.
Unsigned integer. • Interface index if
Index of the
AppObjType is 1.
AppObjIndex application Index Value range: 0 to
object. • VLAN ID in the
4294967295.
range of 1 to 4094
if AppObjType is 2.
• The value is 0 if
AppObjType is 3.
Enumeration:
Application
AppDirection
direction.
Index • 1—Inbound. N/A
• 2—Outbound.
Enumeration:
• 1—IPv4 ACL.
AppAclType ACL type. Index • 2—IPv6 ACL. N/A
• 3—MAC ACL.
• 4—User-defined
ACL.
String. The value range
Length: 1 to 63 depends on the
characters. AppAclType column.
• ACL name: • 2000 to 3999 if
Case-insensitive AppAclType is 1.
ACL name or string of 1 to 63
AppAclGroup
number.
Index • 2000 to 3999 if
characters.
AppAclType is 2.
• ACL number:
• 4000 to 4999 if
String of digits
AppAclType is 3.
valued 0 or in the
range of 2000 to • 5000 to 5999 if
5999. AppAclType is 4.

73
 Column Column Data type and
Column name Remarks
description type restrictions
Index of the Unsigned integer.
AppAclRuleIndex Index N/A
ACL rules. Value range: 0 to 65534.
Enumeration:
Whether an
• 1—Succeeded.
ACL rule is
AclRuleStatus
successfully
N/A • 2—Failed. N/A
applied. • 3—Partly
succeeded.
Whether an
ACL rule with Enumeration:
hardware • 1—Succeeded.
AclRuleCountStatus counting N/A • 2—Failed. N/A
enabled is
• 3—Partly
successfully
succeeded.
applied.
If the device does not
Number of Unsigned integer. support match counting
AclRuleMatchPkts matched N/A 64 for packet filter,
packets. Value range: 0 to 2 - 1. 0×FFFFFFFFFFFFFFFF
is returned.
If the device does not
Number of Unsigned integer. support match counting
AclRuleMatchBytes matched N/A 64 for packet filter,
bytes. Value range: 0 to 2 - 1. 0×FFFFFFFFFFFFFFFF
is returned.

ACL/PfilterStatisticSum
This table contains accumulative statistics about an ACL on a specific direction.

XML structure
<ACL>
<PfilterStatisticSum>
<StatisticSum>
<Direction></Direction>
<AclType></AclType>
<AclGroup></AclGroup>
<AclRuleIndex></AclRuleIndex>
<MatchPackets></MatchPackets>
<MatchBytes></MatchBytes>
</StatisticSum>
</PfilterStatisticSum>
</ACL>

74
Table description
Item Description
Feature name ACL
Table name PfilterStatisticSum
Table type Multi-instance table
Row name StatisticSum
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Enumeration:
Application
Direction
direction
Index • 1—Inbound. N/A
• 2—Outbound.
Enumeration:
• 1—IPv4 ACL.
AclType ACL type Index • 2—IPv6 ACL. N/A
• 3—MAC ACL.
• 4—User-defined
ACL.
String. The value range
Length: 1 to 63 depends on the AclType
characters. column.
• ACL name: • 2000 to 3999 if
Case-insensitive AclType is 1.
ACL name or string of 1 to 63
AclGroup
number
Index • 2000 to 3999 if
characters.
AclType is 2.
• ACL number:
• 4000 to 4999 if
String of digits
AppAclType is 3.
valued 0 or in the
range of 2000 to • 5000 to 5999 if
5999. AppAclType is 4.

Index of the ACL Unsigned integer.

AclRuleIndex Index N/A
rules Value range: 0 to 65534.
If the device does not
Unsigned integer. support match counting
Number of
MatchPackets N/A 64 for packet filter,
matched packets Value range: 0 to 2 - 1. 0×FFFFFFFFFFFFFFFF
is returned.
If the device does not
Unsigned integer. support match counting
Number of
MatchBytes N/A 64 for packet filter,
matched bytes Value range: 0 to 2 - 1. 0×FFFFFFFFFFFFFFFF
is returned.

75
ACL/UserRules
This table contains information about user-defined ACL rules.

XML structure
<ACL>
<UserRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>
<L2Rule>
<L2RuleString></L2RuleString>
<L2RuleMask></L2RuleMask>
<L2Offset></L2Offset>
</L2Rule>
<IPv4Rule>
<IPv4RuleString></IPv4RuleString>
<IPv4RuleMask></IPv4RuleMask>
<IPv4Offset></IPv4Offset>
</IPv4Rule>
<IPv6Rule>
<IPv6RuleString></IPv6RuleString>
<IPv6RuleMask></IPv6RuleMask>
<IPv6Offset></IPv6Offset>
</IPv6Rule>
<L4Rule>
<L4RuleString></L4RuleString>
<L4RuleMask></L4RuleMask>
<L4Offset></L4Offset>
</L4Rule>
<L5Rule>
<L5RuleString></L5RuleString>
<L5RuleMask></L5RuleMask>
<L5Offset></L5Offset>
</L5Rule>
<UdfFormat></UdfFormat>
<ProtocolType></ProtocolType>
<IPv6ProtocolType></IPv6ProtocolType>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>

76
 </SrcIPv6>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>
<DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<DstIPv6>
<DstIPv6Addr></DstIPv6Addr>
<DstIPv6Prefix></DstIPv6Prefix>
</DstIPv6>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<DSCP></DSCP>
<TimeRange></TimeRange>
<Counting></Counting>
<Comment></Comment>
<Status></Status>
<Count></Count>
</Rule>
</UserRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name UserRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column
Column description Data type and restrictions Remarks
name type
Unsigned integer.
GroupID ACL number. Index N/A
Value range: 5000 to 5999.

77
Column Column
Column description Data type and restrictions Remarks
name type
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.
Enumeration:
Action on packets
Action
matching the rule.
N/A • 1—Deny. N/A
• 2—Permit.

Specifies that the Members include:

The members
offset is relative to the Data • L2RuleString.
L2Rule must all be
beginning of the Layer structure • L2RuleMask. specified.
2 frame header.
• L2Offset.
Hexadecimal string.
String for the match
L2RuleString N/A Length: 2 to the device-specific N/A
pattern.
upper limit.
Hexadecimal string.
L2RuleMask Match pattern mask. N/A Length: 2 to the device-specific N/A
upper limit.

Offset in bytes after Unsigned integer.

L2Offset which the match N/A Value range: 0 to the N/A
operation begins. device-specific upper limit.

Specifies that the Members include:

The members
offset is relative to the Data • IPv4RuleString.
IPv4Rule must all be
beginning of the IPv4 structure • IPv4RuleMask. specified.
header.
• IPv4Offset.
Hexadecimal string.
IPv4RuleStrin String for the match
N/A Length: 2 to the device-specific N/A
g pattern.
upper limit.
Hexadecimal string.
IPv4RuleMas
Match pattern mask. N/A Length: 2 to the device-specific N/A
k
upper limit.

Offset in bytes after Unsigned integer.

IPv4Offset which the match N/A Value range: 0 to the N/A
operation begins. device-specific upper limit.

Specifies that the Members include:

The members
offset is relative to the Data • IPv6RuleString.
IPv6Rule must all be
beginning of the IPv6 structure • IPv6RuleMask. specified.
header.
• IPv6Offset.
Hexadecimal string.
IPv6RuleStrin String for the match
N/A Length: 2 to the device-specific N/A
g pattern.
upper limit.
Hexadecimal string.
IPv6RuleMas
Match pattern mask. N/A Length: 2 to the device-specific N/A
k
upper limit.
Specifies an offset in Unsigned integer.
bytes after which the
IPv6Offset N/A Value range: 0 to the N/A
match operation
begins. device-specific upper limit.

78
Column Column
Column description Data type and restrictions Remarks
name type
Specifies that the Members include:
The members
offset is relative to the Data • L4RuleString.
L4Rule must all be
beginning of the Layer structure • L4RuleMask. specified.
4 header.
• L4Offset.
Hexadecimal string.
String for the match
L4RuleString N/A Length: 2 to the device-specific N/A
pattern.
upper limit.
Hexadecimal string.
L4RuleMask Match pattern mask. N/A Length: 2 to the device-specific N/A
upper limit.
Specifies an offset in Unsigned integer.
bytes after which the
L4Offset N/A Value range: 0 to the N/A
match operation
begins. device-specific upper limit.

Members include:
Specifies that the
• L5RuleString. The members
offset is relative to the Data
L5Rule must all be
beginning of the structure • L5RuleMask. specified.
payload.
• L5Offset.

Hexadecimal string.
String for the match
L5RuleString N/A N/A
pattern. Length: 2 to the device-specific
upper limit.

Hexadecimal string.
L5RuleMask Match pattern mask. N/A N/A
Length: 2 to the device-specific
upper limit.

Specifies an offset in Unsigned integer.

bytes after which the
L5Offset N/A N/A
match operation Value range: 0 to the
begins. device-specific upper limit.

Enumeration:
User-defined packet • 1—IFA packet.
UdfFormat N/A N/A
fortmat. • 2—Raw ip packet.
• 3—VXLAN packet.

Unsigned integer.

Value range: 0 to 256.

ProtocolType Protocol type. N/A N/A
The value 256 represents all
IPv4 protocols.
Unsigned integer.
Value range: 0 to 256.
IPv6ProtocolT
Protocol type. N/A N/A
ype The value 256 represents all
IPv6 protocols.

79
Column Column
Column description Data type and restrictions Remarks
name type

This column is
available when
Boolean: the ProtocolType
is specified.
Whether a rule • true—Matches any source
SrcAny matches any source N/A IP addresses (default).
This column
IP addresses. • false—Matches the must be
specified source IP configured
address. together with the
SrcIPv4 or
SrcIPv6 column.

Members include: The members

Source IPv4 Data
SrcIPv4
information. structure • SrcIPv4Addr. must both be
• SrcIPv4Wildcard. specified.

Example:
1.1.1.1.

This column is
available when
the SrcAny
SrcIPv4Addr Source IPv4 address. N/A String, dotted decimal notation.
column is false.

It must be empty
when the
SrcAny column
is true.

Example:
255.255.255.0.

This column is
available when
SrcIPv4Wildc Wildcard mask for the the SrcAny
N/A String, dotted decimal notation.
ard source IPv4 address. column is false.

It must be empty
when the
SrcAny column
is true.

Members include: The two

SrcIPv6
Source IPv6 Data • SrcIPv6Addr. members must
information. structure both be
• SrcIPv6Prefix.
specified.

80
Column Column
Column description Data type and restrictions Remarks
name type
Example:
1:1::1:1.
This column is
available when
Hexadecimal string, the SrcAny
SrcIPv6Addr Source IPv6 address. N/A colon-separated. column is false.

It must be empty
when the
SrcAny column
is true.
This column is
available when
the SrcAny
Unsigned integer. column is false.
Length of the source
SrcIPv6Prefix N/A Value range: 1 to 128. It must be empty
IPv6 address prefix.
when the
SrcAny column
is true.

Boolean:
Whether a rule • true—Matches any
matches any destination IP addresses.
DstAny N/A N/A
destination IP • false—Matches the
addresses. specified destination IP
address.

Members include: The members

Destination IPv4 Data
DstIPv4
information. structure • DstIPv4Addr. must both be
• DstIPv4Wildcard. specified.

Example:
1.1.1.1.

This column is
available when
Destination IPv4 the DstAny
DstIPv4Addr N/A String, dotted decimal notation.
address. column is false.

It must be empty
when the
DstAny column
is true.

Example:
255.255.255.0.

This column is
available when
Wildcard mask for the
DstIPv4Wildc the DstAny
destination IPv4 N/A String, dotted decimal notation.
ard column is false.
address.
It must be empty
when the
DstAny column
is true.

81
Column Column
Column description Data type and restrictions Remarks
name type

Members include: The two

DstIPv6
Destination IPv6 Data • DstIPv6Addr. members must
information. structure both be
• DstIPv6Prefix.
specified.
Example:
1:1::1:1.
This column is
available when
Hexadecimal string, the DstAny
Destination IPv6 column is false.
DstIPv6Addr N/A colon-separated.
address.
It must be empty
when the
DstAny column
is true.
This column is
available when
the DstAny
Length of the Unsigned integer. column is false.
DstIPv6Prefix destination IPv6 N/A Value range: 1 to 128. It must be empty
address prefix. when the
DstAny column
is true.

Only the TCP

and UDP
Members include: protocols
support this
Source port Data • SrcPortOp.
SrcPort column.
information. structure • SrcPortValue1.
• SrcPortValue2. The members
must be all
specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
SrcPortOp Source port operator. N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
SrcPortValue
Start source port. N/A N/A
1
Value range: 0 to 65535.

82
Column Column
Column description Data type and restrictions Remarks
name type

When the
SrcPortOp is 5,
the value range
Unsigned integer. is 0 to 65535.
SrcPortValue Otherwise, it can
End source port. N/A
2 only be 65536.
Value range: 0 to 65536. The value 65536
indicates that the
end source port
is not available.

Only the TCP

and UDP
Members include: protocols
support this
Destination port Data • DstPortOp.
DstPort column.
information. structure • DstPortValue1.
• DstPortValue2. The members
must be all
specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port
DstPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
DstPortValue
Start destination port. N/A N/A
1
Value range: 0 to 65535.

When the
DstPortOp is 5,
the value range
is 0 to 65535.
Unsigned integer. Otherwise, it can
DstPortValue
End destination port. N/A only be 65536.
2
Value range: 0 to 65536. The value 65536
indicates that the
end destination
port is not
available.

Unsigned integer.
DSCP DSCP priority. N/A N/A
Value range: 0 to 63.
String, case-insensitive.
TimeRange Time range. N/A N/A
Length: 1 to 32 characters.

83
 Column Column
Column description Data type and restrictions Remarks
name type
Boolean:

Whether to count the • true—Counts the rule

Counting N/A matches. N/A
rule matches.
• false—Does not count the
rule matches.
String, case-sensitive.
Comment Rule comment. N/A N/A
Length: 1 to 127 characters.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.

Number of packets Unsigned integer.

Count N/A 64 N/A
that match a rule. Value range: 0 to 2 - 1.

ACL/UserNamedRules
This table contains information about named user-defined ACL rules.

XML structure
<ACL>
<UserNamedRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<L2Rule>
<L2RuleString></L2RuleString>
<L2RuleMask></L2RuleMask>
<L2Offset></L2Offset>
</L2Rule>
<IPv4Rule>
<IPv4RuleString></IPv4RuleString>
<IPv4RuleMask></IPv4RuleMask>
<IPv4Offset></IPv4Offset>
</IPv4Rule>
<IPv6Rule>
<IPv6RuleString></IPv6RuleString>
<IPv6RuleMask></IPv6RuleMask>
<IPv6Offset></IPv6Offset>
</IPv6Rule>
<L4Rule>
<L4RuleString></L4RuleString>
<L4RuleMask></L4RuleMask>
<L4Offset></L4Offset>
</L4Rule>

84
 <L5Rule>
<L5RuleString></L5RuleString>
<L5RuleMask></L5RuleMask>
<L5Offset></L5Offset>
</L5Rule>
<UdfFormat></UdfFormat>
<ProtocolType></ProtocolType>
<IPv6ProtocolType></IPv6ProtocolType>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>
<SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>
<DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<DstIPv6>
<DstIPv6Addr></DstIPv6Addr>
<DstIPv6Prefix></DstIPv6Prefix>
</DstIPv6>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<DSCP></DSCP>
<TimeRange></TimeRange>
<Counting></Counting>
<Comment></Comment>
<Status></Status>
<Count></Count>
</Rule>
</UserNamedRules>
</ACL>

85
Table description
Item Description
Feature name ACL
Table name UserNamedRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column
Column description Data type and restrictions Remarks
name type
String.
Length: 1 to 63 characters.
• ACL name:
GroupIndex ACL name or number. Index Case-insensitive string of 1 N/A
to 63 characters.
• ACL number:
String of digits in the range
of 5000 to 5999.
Unsigned integer.
RuleID Rule ID. Index N/A
Value range: 0 to 65534.
Enumeration:
Action on packets
Action
matching the rule.
N/A • 1—Deny. N/A
• 2—Permit.

Specifies that the Members include:

The members
offset is relative to the Data • L2RuleString.
L2Rule must all be
beginning of the Layer structure • L2RuleMask. specified.
2 frame header.
• L2Offset.
Hexadecimal string.
String for the match
L2RuleString N/A Length: 2 to the device-specific N/A
pattern.
upper limit.
Hexadecimal string.
L2RuleMask Match pattern mask. N/A Length: 2 to the device-specific N/A
upper limit.

Offset in bytes after Unsigned integer.

L2Offset which the match N/A Value range: 0 to the N/A
operation begins. device-specific upper limit.

Specifies that the Members include:

The members
offset is relative to the Data • IPv4RuleString.
IPv4Rule must all be
beginning of the IPv4 structure • IPv4RuleMask. specified.
header.
• IPv4Offset.
Hexadecimal string.
IPv4RuleStrin String for the match
N/A Length: 2 to the device-specific N/A
g pattern.
upper limit.

86
Column Column
Column description Data type and restrictions Remarks
name type
Hexadecimal string.
IPv4RuleMas
Match pattern mask. N/A Length: 2 to the device-specific N/A
k
upper limit.

Offset in bytes after Unsigned integer.

IPv4Offset which the match N/A Value range: 0 to the N/A
operation begins. device-specific upper limit.

Specifies that the Members include:

The members
offset is relative to the Data • IPv6RuleString.
IPv6Rule must all be
beginning of the IPv6 structure • IPv6RuleMask. specified.
header.
• IPv6Offset.
Hexadecimal string.
IPv6RuleStrin String for the match
N/A Length: 2 to the device-specific N/A
g pattern.
upper limit.
Hexadecimal string.
IPv6RuleMas
Match pattern mask. N/A Length: 2 to the device-specific N/A
k
upper limit.
Specifies an offset in Unsigned integer.
bytes after which the
IPv6Offset N/A Value range: 0 to the N/A
match operation
begins. device-specific upper limit.

Specifies that the Members include:

The members
offset is relative to the Data • L4RuleString.
L4Rule must all be
beginning of the Layer structure • L4RuleMask. specified.
4 header.
• L4Offset.
Hexadecimal string.
String for the match
L4RuleString N/A Length: 2 to the device-specific N/A
pattern.
upper limit.
Hexadecimal string.
L4RuleMask Match pattern mask. N/A Length: 2 to the device-specific N/A
upper limit.
Specifies an offset in Unsigned integer.
bytes after which the
L4Offset N/A Value range: 0 to the N/A
match operation
begins. device-specific upper limit.

Members include:
Specifies that the
• L5RuleString. The members
offset is relative to the Data
L5Rule must all be
beginning of the structure • L5RuleMask. specified.
payload.
• L5Offset.

Hexadecimal string.
String for the match
L5RuleString N/A N/A
pattern. Length: 2 to the device-specific
upper limit.

87
Column Column
Column description Data type and restrictions Remarks
name type

Hexadecimal string.
L5RuleMask Match pattern mask. N/A N/A
Length: 2 to the device-specific
upper limit.

Specifies an offset in Unsigned integer.

bytes after which the
L5Offset N/A N/A
match operation Value range: 0 to the
begins. device-specific upper limit.

Enumeration:
User-defined packet • 1—IFA packet.
UdfFormat N/A N/A
fortmat. • 2—Raw ip packet.
• 3—VXLAN packet.

Unsigned integer.

Value range: 0 to 256.

ProtocolType Protocol type. N/A N/A
The value 256 represents all
IPv4 protocols.
Unsigned integer.
Value range: 0 to 256.
IPv6ProtocolT
Protocol type. N/A N/A
ype The value 256 represents all
IPv6 protocols.

Boolean:

Whether a rule • true—Matches any source

SrcAny matches any source N/A IP addresses. N/A
IP addresses. • false—Matches the
specified source IP
address.

Members include: The members

Source IPv4 Data
SrcIPv4
information. structure • SrcIPv4Addr. must both be
• SrcIPv4Wildcard. specified.

Example:
1.1.1.1.

This column is
available when
the SrcAny
SrcIPv4Addr Source IPv4 address. N/A String, dotted decimal notation.
column is false.

It must be empty
when the
SrcAny column
is true.

88
Column Column
Column description Data type and restrictions Remarks
name type

Example:
255.255.255.0.

This column is
available when
SrcIPv4Wildc Wildcard mask for the the SrcAny
N/A String, dotted decimal notation.
ard source IPv4 address. column is false.

It must be empty
when the
SrcAny column
is true.

Members include: The two

SrcIPv6
Source IPv6 Data • SrcIPv6Addr. members must
information. structure both be
• SrcIPv6Prefix.
specified.
Example:
1:1::1:1.
This column is
available when
Hexadecimal string, the SrcAny
SrcIPv6Addr Source IPv6 address. N/A colon-separated. column is false.

It must be empty
when the
SrcAny column
is true.
This column is
available when
the SrcAny
Unsigned integer. column is false.
Length of the source
SrcIPv6Prefix N/A Value range: 1 to 128. It must be empty
IPv6 address prefix.
when the
SrcAny column
is true.

Boolean:
Whether a rule • true—Matches any
matches any destination IP addresses.
DstAny N/A N/A
destination IP • false—Matches the
addresses. specified destination IP
address.

Members include: The members

Destination IPv4 Data
DstIPv4
information. structure • DstIPv4Addr. must both be
• DstIPv4Wildcard. specified.

89
Column Column
Column description Data type and restrictions Remarks
name type

Example:
1.1.1.1.

This column is
available when
Destination IPv4 the DstAny
DstIPv4Addr N/A String, dotted decimal notation.
address. column is false.

It must be empty
when the
DstAny column
is true.

Example:
255.255.255.0.

This column is
available when
Wildcard mask for the
DstIPv4Wildc the DstAny
destination IPv4 N/A String, dotted decimal notation.
ard column is false.
address.
It must be empty
when the
DstAny column
is true.

Members include: The two

DstIPv6
Destination IPv6 Data • DstIPv6Addr. members must
information. structure both be
• DstIPv6Prefix.
specified.
Example:
1:1::1:1.
This column is
available when
Hexadecimal string, the DstAny
Destination IPv6 column is false.
DstIPv6Addr N/A colon-separated.
address.
It must be empty
when the
DstAny column
is true.
This column is
available when
the DstAny
Length of the Unsigned integer. column is false.
DstIPv6Prefix destination IPv6 N/A Value range: 1 to 128. It must be empty
address prefix. when the
DstAny column
is true.

90
Column Column
Column description Data type and restrictions Remarks
name type

Only the TCP

and UDP
Members include: protocols
support this
Source port Data • SrcPortOp.
SrcPort column.
information. structure • SrcPortValue1.
• SrcPortValue2. The members
must be all
specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
SrcPortOp Source port operator. N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
SrcPortValue
Start source port. N/A N/A
1
Value range: 0 to 65535.

When the
SrcPortOp is 5,
the value range
Unsigned integer. is 0 to 65535.
SrcPortValue Otherwise, it can
End source port. N/A
2 only be 65536.
Value range: 0 to 65536. The value 65536
indicates that the
end source port
is not available.

Only the TCP

and UDP
Members include: protocols
support this
Destination port Data • DstPortOp.
DstPort column.
information. structure • DstPortValue1.
• DstPortValue2. The members
must be all
specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port
DstPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
DstPortValue
Start destination port. N/A N/A
1
Value range: 0 to 65535.

91
 Column Column
Column description Data type and restrictions Remarks
name type

When the
DstPortOp is 5,
the value range
is 0 to 65535.
Unsigned integer. Otherwise, it can
DstPortValue
End destination port. N/A only be 65536.
2
Value range: 0 to 65536. The value 65536
indicates that the
end destination
port is not
available.

Unsigned integer.
DSCP DSCP priority. N/A N/A
Value range: 0 to 63.
String, case-insensitive.
TimeRange Time range. N/A N/A
Length: 1 to 32 characters.
Boolean:

Whether to count the • true—Counts the rule

Counting N/A matches. N/A
rule matches.
• false—Does not count the
rule matches.
String, case-sensitive.
Comment Rule comment. N/A N/A
Length: 1 to 127 characters.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.

Number of packets Unsigned integer.

Count N/A 64 N/A
that match a rule. Value range: 0 to 2 - 1.

ACL/ZonePairPfilterApply
This table contains information about packet filter application for zone pair.

XML structure
<ACL>
<ZonePairPfilterApply>
<Pfilter>
<SrcZone></SrcZone>
<DestZone></DestZone>
<AclType></AclType>
<AclGroup></AclGroup>
<AppSequence></AppSequence>
</Pfilter>
</ZonePairPfilterApply>
</ACL>

92
Table description
Item Description
Feature name ACL
Table name ZonePairPfilterApply
Table type Multi-instance table
Row name Pfilter
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
String, case insensitive.
Name of the Cannot contain
SrcZone
source zone.
Index • Length: 1 to 31 midline( - ).
characters.
String, case insensitive.
Name of the Cannot contain
DestZone
destination zone.
Index • Length: 1 to 31 midline( - ).
characters.
Enumeration:
Type 3 is not supported
• 1—IPv4 ACL.
in the current software
AclType ACL type. Index • 2—IPv6 ACL. version, and is reserved
• 3—Ethernet frame for future support.
header ACL.
An ACL name must start
• ACL name: with an English letter and
Case-insensitive cannot be all.
string of 1 to 63 The value range
ACL name or characters. depends on the
AclGroup Index
number. • ACL number: AppAclType column.
An unsigned integer • 2000 to 5999 if
in the range of 2000 AppAclType is 1.
to 5999. • 2000 to 3999 if
AppAclType is 2.
Unsigned integer.
ACL application
AppSequence N/A Value range: 1 to N/A
sequence.
4294967295.

ACL/ZonePairPfilterRules
This table contains running information about packet filter ACL rules for zone pair.

XML structure
<ACL>
<ZonePairPfilterRules>

93
 <Rule>
<SrcZone></SrcZone>
<DestZone></DestZone>
<AclType></AclType>
<AclGroup></AclGroup>
<AclRuleID></AclRuleID>
<RuleMatchPkts></RuleMatchPkts>
<RuleMatchBytes></RuleMatchBytes>
</Rule>
</ZonePairPfilterRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name ZonePairPfilterRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
String, case insensitive.
Name of the Cannot contain
SrcZone
source zone.
Index • Length: 1 to 31 midline( - ).
characters.

Name of the String, case insensitive.

Cannot contain
DestZone destination Index • Length: 1 to 31 midline( - ).
zone. characters.
Enumeration:
Type 3 is not supported
• 1—IPv4 ACL.
in the current software
AclType ACL type. Index • 2—IPv6 ACL. version, and is reserved
• 3—Ethernet frame for future support.
header ACL.
An ACL name must start
with an English letter
• ACL name: and cannot be all.
Case-insensitive string
The value range
of 1 to 63 characters.
ACL name or depends on the
AclGroup
number.
Index • ACL number: AppAclType column.
An unsigned integer in
the range of 2000 to • 2000 to 5999 if
5999. AppAclType is 1.
• 2000 to 3999 if
AppAclType is 2.

94
 Column Column Data type and
Column name Remarks
description type restrictions
Index of the Unsigned integer.
AclRuleID Index N/A
ACL rules. Value range: 0 to 65534.
If the device does not
Number of Unsigned integer. support match counting
RuleMatchPkts matched N/A 64 for packet filter,
packets. Value range: 0 to 2 - 1. 0×FFFFFFFFFFFFFFFF
is returned.
If the device does not
Number of Unsigned integer. support match counting
RuleMatchBytes matched N/A 64 for packet filter,
bytes. Value range: 0 to 2 - 1. 0×FFFFFFFFFFFFFFFF
is returned.

95
Contents
ACL·······························································································1
ACL ········································································································································ 1

i
ACL
ACL
Message Explanation
Can't edit rules for an ACL when the match order is
The ACL group created in auto mode cannot modify rules.
auto.
以 auto 形式创建的 ACL 组不能修改规则。
当规则匹配顺序为自动排序时，不能修改规则。

Cannot add rule comment information when the rule does not
The rule doesn't exist. Please create the rule first.
exist.
规则不存在，请在添加描述信息前先添加规则。
规则不存在时不能添加规则评论信息。

Can’t name or rename an existing ACL. Cannot modify the name as an existing ACL.
不能命名或重命名一个已存在的ACL。 不能修改名字为已存在的ACL。

Can't change the match order for an ACL that When an ACL is configured with rules, the matching order cannot
contains rules. be modified.
不能修改一个包含规则的ACL的匹配顺序。 当ACL已经配置了规则，不能修改匹配顺序。

The rule already exists. The newly created rule content is the same as other existing rules.
规则已存在。 新建的规则内容与其他已存在的规则内容相同。

The rule ID is out of range. Automatically assigned rule number is out of range.
规则编号超出范围。 自动分配的规则编码超出了范围。

The modified step size is too large, and the number of rules that
The step is too large to generate sufficient rule IDs.
can be assigned is insufficient.
步长过大，可分配的规则编号不足。
修改后的步长过大，可分配的规则编号不足。

The name is already used by another ACL. The newly created ACL name is occupied by other existing ACLs.
该名字已被另一个ACL使用。 新建的ACL名称被其他已经存在的ACL占用。

Maximum number of rules in the ACL already is The number of rules has reached the upper limit when a new ACL
reached. rule is created.
此ACL的规则数已达上限。 新建ACL规则时规则个数已达到上限。

Resources are insufficient for processing the

Insufficient memory.
request.
设备内存不足。
系统资源不足，请求无法完成。

The ACL doesn't exist. Add a rule to an ACL group that does not exist.
指定的ACL不存在。 向不存在的ACL组下添加规则。

The source IPv4 address object group doesn't The object-group referenced by the source address of the IPv4
exist. type ACL rule does not exist.
指定的源IPv4地址对象组不存在。 IPv4类型ACL规则源地址引用的对象组不存在。

The source IPv6 address object group doesn't The object-group referenced by the source address of the IPv6
exist. type ACL rule does not exist.
指定的源IPv6地址对象组不存在。 IPv6类型ACL规则源地址引用的对象组不存在。

The destination IPv4 address object group doesn't The object-group referenced by the destination address of the
exist. IPv4 type ACL rule does not exist.
指定的目的IPv4地址对象组不存在。 IPv4类型ACL规则目的地址引用的对象组不存在。

1
The destination IPv6 address object group doesn't The object-group referenced by the destination address of the
exist. IPv6 type ACL rule does not exist.
指定的目的IPv6地址对象组不存在。 IPv6类型ACL规则目的地址引用的对象组不存在。

The object-group type referenced by the source address of the

Illegal source IPv4 address object group type.
IPv4 type ACL is not the IPv4 type.
指定的源IPv4地址对象组类型不正确。
IPv4类型ACL规则源地址引用的对象组类型不是IPv4类型。

The object-group type referenced by the source address of the

Illegal source IPv6 address object group type.
IPv6 type ACL is not the IPv6 type.
指定的源IPv6地址对象组类型不正确。
IPv6类型ACL规则源地址引用的对象组类型不是IPv6类型。

The object-group type referenced by the destination address of

Illegal destination IPv4 address object group type.
the IPv4 type ACL is not the IPv4 type.
指定的目的IPv4地址对象组类型不正确。
IPv4类型ACL规则目的地址引用的对象组类型不是IPv4类型。

The object-group type referenced by the destination address of

Illegal destination IPv6 address object group type.
the IPv6 type ACL is not the IPv6 type.
指定的目的IPv6地址对象组类型不正确。
IPv6类型ACL规则目的地址引用的对象组类型不是IPv6类型。

The ACL specified to be deleted is referenced by other modules

Can't delete the ACL because it is being used.
and cannot be deleted.
该ACL正被引用，无法删除。
指定要删除的ACL被其他模块引用，不能被删除。

2
Contents
ADVPN ··························································································1
ResetTunnelAdvpnSession ·········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ResetAllSessions ······················································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
ResetTunnelAdvpnSessionStat ····································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
ResetAllSessionStats·················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4

i
ADVPN
ResetTunnelAdvpnSession
This table is used to clear ADVPN sessions in the specified tunnel.

XML structure
<ADVPN>
<ResetTunnelAdvpnSession>
<Reset>
<IPVersion></IPVersion>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
</Reset>
</ResetTunnelAdvpnSession>
</ADVPN>

Table description
Item Description
Feature name ADVPN
Table name ResetTunnelAdvpnSession
Table type Multi-instance table
Row name Reset
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration
Version of the IP This column must not
IPVersion Index • 4—IPv4
protocol be empty.
• 6—IPv6
TunnelID Tunnel ID Index Unsigned integer N/A
PrivateAddre IPv4 address or IPv6
Private address N/A String
ss address.

ResetAllSessions
This table is used to clear all ADVPN sessions.

1
XML structure
<ADVPN>
<ResetAllSessions>
<Reset>
<IPVersion></IPVersion>
</Reset>
</ResetAllSessions>
</ADVPN>

Table description
Item Description
Feature name ADVPN
Table name ResetAllSessions
Table type Single-instance table
Row name Reset
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration
Version of the IP This column must not
IPVersion Index • 4—IPv4
protocol be empty.
• 6—IPv6

ResetTunnelAdvpnSessionStat
This table is used to clrear ADVPN session statistics for the specified tunnel.

XML structure
<ADVPN>
<ResetTunnelAdvpnSessionStat>
<Reset>
<IPVersion></IPVersion>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
</Reset>
</ResetTunnelAdvpnSessionStat>
</ADVPN>

2
Table description
Item Description
Feature name ADVPN
Table name ResetSessionStatistics
Table type Multi-instance table
Row name Reset
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration
Version of the IP This column must not
IPVersion Index • 4—IPv4
protocol be empty.
• 6—IPv6
TunnelID Tunnel ID Index Unsigned integer N/A
PrivateAddre IPv4 address or IPv6
Private address N/A String
ss address.

ResetAllSessionStats
This table is used to clear all ADVPN session statistics.

XML structure
<ADVPN>
<ResetAllSessionStats>
<Reset>
<IPVersion></IPVersion>
</Reset>
</ResetAllSessionStats>
</ADVPN>

Table description
Item Description
Feature name ADVPN
Table name ResetAllSessionStatistics
Table type Single-instance table
Row name Reset
Restrictions None

3
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration
Version of the IP This column must not
IPVersion Index • 4—IPv4
protocol be empty.
• 6—IPv6

4
Contents
ADVPN ··························································································1
TunnelAdvpnCfg ························································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
IPv4Networks ···························································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
IPv6Networks ···························································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4

i
ADVPN
TunnelAdvpnCfg
This table is used to configure ADVPN feature in the specified tunnel.

XML structure
<ADVPN>
<TunnelAdvpnCfg>
<Tunnel>
<TunnelID></TunnelID>
<IPv4Client></IPv4Client>
<Compatible></Compatible>
<IPv6Client></IPv6Client>
<DumbTime></DumbTime>
<IdleTime></IdleTime>
<SourcePort></SourcePort>
</Tunnel>
</TunnelAdvpnCfg>
</ADVPN>

Table description
Item Description
Feature name ADVPN
Table name TunnelAdvpnCfg
Table type Multi-instance table
Row name Tunnel
Restrictions None

Support for row creation and

No
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A
Name of the
VAM client String Case-insensitive and
IPv4Client bounded to an N/A contains only letters,
IPv4 ADVPN Length: 1 to 63 characters
digits, and dots (.).
tunnel interface

1
 Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
The value of “2”
Compatibility • 0—Incompatible means not specifying
Compatible N/A
configuration • 1—Compatible the IPv4 VAM client
• 2—Invalid config.
Name of the
VAM client String Case-insensitive and
IPv6Client bounded to an N/A contains only letters,
IPv6 ADVPN Length: 1 to 63 characters
digits, and dots (.).
tunnel interface
Unsigned integer
Dumb time for an Value range: 10 to 600
DumbTime N/A N/A
ADVPN session The default value is 120
seconds

Idle timeout time Unsigned integer.

for a Value range:60 to 65535.
IdleTime N/A N/A
spoke-spoke The default value is 600
ADVPN tunnel seconds
Only supports tunnel
in the following
modes:
• 9—DVPN tunnel
with the
passenger
protocol being
UDP and the
Unsigned integer
Source UDP port transport
SourcePort N/A Value range: 1025 to 65535 protocol being
number
The default value is 18001 IPv4.
• 11—DVPN
tunnel with the
passenger
protocol being
UDP and the
transport
protocol being
IPv6.

IPv4Networks
This table is used to configure the IPv4 subnets under the specified tunnel which is ADVPN node.

XML structure
<ADVPN>
<IPv4Networks>
<IPv4Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>

2
 </IPv4Network>
</IPv4Networks>
</ADVPN>

Table description
Item Description
Feature name ADVPN
Table name IPv4Networks
Table type Multi-instance table
Row name IPv4Network
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A.
Private IPv4
Address Index IPv4 address N/A.
network address
Mask of the Unsigned integer
MaskLength private IPv4 Index Example: 24
network address Value range: 0 to 32

Preference for Unsigned integer

Preference the route to the N/A Value range: 1 to 255 N/A.
private network The default value is 8

IPv6Networks
This table is used to configure the IPv6 subnets under the specified tunnel which is ADVPN node.

XML structure
<ADVPN>
<IPv6Networks>
<IPv6Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>
</IPv6Network>
</IPv6Networks>
</ADVPN>

3
Table description
Item Description
Feature name ADVPN
Table name IPv6Networks
Table type Multi-instance table
Row name IPv6Network
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A.
Private IPv6 Example:
Address Index IPv6 address
network address 1001::
Prefix length of Unsigned integer
MaskLength private IPv6 Index N/A.
network address Value range: 0 to 128

Preference for Unsigned integer

Preference the route to the N/A Value range: 1 to 255 N/A.
private network The default value is 8

4
Contents
ADVPN ··························································································1
TunnelAdvpnCfg ·························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
IPv4Networks ······························································································································ 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
IPv6Networks ······························································································································ 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 4
IPv4TunnelAdvpnSession ·············································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 6
Columns ······························································································································ 6
IPv6TunnelAdvpnSession ·············································································································· 9
XML structure ······················································································································· 9
Table description ················································································································· 10
Columns ···························································································································· 10
IPv4TunnelRunInfo····················································································································· 13
XML structure ····················································································································· 13
Table description ················································································································· 14
Columns ···························································································································· 14
IPv6TunnelRunInfo····················································································································· 14
XML structure ····················································································································· 15
Table description ················································································································· 15
Columns ···························································································································· 15

i
ADVPN
TunnelAdvpnCfg
This table displays the configuration about ADVPN tunnels.

XML structure
<ADVPN>
<TunnelAdvpnCfg>
<Tunnel>
<TunnelID></TunnelID>
<IPv4Client></IPv4Client>
<Compatible></Compatible>
<IPv6Client></IPv6Client>
<DumbTime></DumbTime>
<IdleTime></IdleTime>
<SourcePort></SourcePort>
</Tunnel>
</TunnelAdvpnCfg>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name TunnelAdvpnCfg

Table type Multi-instance table

Row name Tunnel

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A

Name of the Case-insensitive and

String
IPv4Client VAM client N/A contains only letters,
Length: 1 to 63 characters
bounded to an digits, and dots (.).

1
Column Column Column
Data type and restrictions Remarks
name description type
IPv4 ADVPN
tunnel interface

Enumeration:
The value of “2”
Compatibility • 0—Incompatible means not specifying
Compatible N/A
configuration • 1—Compatible the IPv4 VAM client
• 2—Invalid config.

Name of the
VAM client Case-insensitive and
String
IPv6Client bounded to an N/A contains only letters,
Length: 1 to 63 characters
IPv6 ADVPN digits, and dots (.).
tunnel interface

Unsigned integer

Dumb time for an Value range: 10 to 600

DumbTime N/A N/A
ADVPN session The default value is 120
seconds

Idle timeout time Unsigned integer.

for a Value range:60 to 65535.

IdleTime N/A N/A
spoke-spoke The default value is 600
ADVPN tunnel seconds

Only supports tunnel

in the following
modes:

• 9—DVPN tunnel
with the
passenger
protocol being
Unsigned integer
UDP and the
Source UDP port
SourcePort N/A Value range: 1025 to 65535 transport protocol
number
The default value is 18001 being IPv4.
• 11—DVPN
tunnel with the
passenger
protocol being
UDP and the
transport protocol
being IPv6.

2
IPv4Networks
This table displays the IPv4 subnets configuration under an ADVPN node.

XML structure
<ADVPN>
<IPv4Networks>
<IPv4Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>
</IPv4Network>
</IPv4Networks>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name IPv4Networks

Table type Multi-instance table

Row name IPv4Network

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A.

Private IPv4
Address Index IPv4 address N/A.
network address

Mask of the
Unsigned integer
MaskLength private IPv4 Index Example: 24
Value range: 0 to 32
network address

Preference for Unsigned integer

Preference the route to the N/A Value range: 1 to 255 N/A.

private network The default value is 8

3
IPv6Networks
This table displays the IPv6 subnets configuration under an ADVPN node.

XML structure
<ADVPN>
<IPv6Networks>
<IPv6Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>
</IPv6Network>
</IPv6Networks>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name IPv6Networks

Table type Multi-instance table

Row name IPv6Network

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A.

Private IPv6 Example:

Address Index IPv6 address
network address 1001::

Prefix length of
Unsigned integer
MaskLength private IPv6 Index N/A.
Value range: 0 to 128
network address

Preference for Unsigned integer

Preference N/A N/A.
the route to the Value range: 1 to 255

4
 Column Column Column
Data type and restrictions Remarks
name description type
private network The default value is 8

IPv4TunnelAdvpnSession
This table is used to display IPv4 ADVPN tunnel session information.

XML structure
<ADVPN>
<IPv4TunnelAdvpnSession>
<IPv4AdvpnSession>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
<PublicAddress></PublicAddress>
<AdvpnPort></AdvpnPort>
<SPI>
<AhInbound></AhInbound>
<AhOutbound></AhOutbound>
<EspInbound></EspInbound>
<EspOutbound></EspOutbound>
</SPI>
<BehindNAT></BehindNAT>
<SessionType></SessionType>
<TunnelState></TunnelState>
<HoldingTime></HoldingTime>
<Input>
<TotalPackets></TotalPackets>
<DataPackets></DataPackets>
<ControlPackets></ControlPackets>
<Multicasts></Multicasts>
<Errors></Errors>
</Input>
<Output>
<TotalPackets></TotalPackets>
<DataPackets></DataPackets>
<ControlPackets></ControlPackets>
<Multicasts></Multicasts>
<Errors></Errors>
</Output>
<IPsecTunnelID></IPsecTunnelID>
<SAIndex>
<AhInbound></AhInbound>
<AhOutbound></AhOutbound>
<EspInbound></EspInbound>
<EspOutbound></EspOutbound>
</SAIndex>
5
 </IPv4AdvpnSession>
</IPv4TunnelAdvpnSession>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name IPv4TunnelAdvpnSession

Table type Multi-instance table

Row name IPv4AdvpnSession

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A

Private address
PrivateAddres
of the ADVPN Index Ipv4Address IPv4 address
s
tunnel peer

Public address of
IPv4 address.
PublicAddress the ADVPN N/A String
IPv6 address.
tunnel peer

Only supported
UDP port number
Unsigned integer when the link layer
AdvpnPort for the ADVPN N/A
Value range: 1025 to 65535 protocol is UDP or
tunnel
IPsec-UDP.

Members include: Only supported

SP index for the • AhInbound when link layer
Data
SPI inbound and • AhOutbound protocol is
structure
outbound SAs • EspInbound IPsec-UDP or IPsec-

• EspOutbound GRE.

Inbound AH SP Unsigned integer

AhInbound N/A N/A
index 32
Value range: 0 to 2 -1.

Outbound AH SP Unsigned integer

AhOutbound N/A N/A
index 32
Value range: 0 to 2 -1.

6
Column Column Column
Data type and restrictions Remarks
name description type

Inbound ESP SP Unsigned integer

EspInbound N/A N/A
index 32
Value range: 0 to 2 -1.

Outbound ESP Unsigned integer

EspOutbound N/A N/A
SP index 32
Value range: 0 to 2 -1.

Whether the NAT Boolean:

BehindNAT peer node is N/A • true N/A
behind NAT • False

Enumeration:

• 0—Unknown
ADVPN tunnel • 1—Hub-Hub
SessionType N/A N/A
type • 2—Hub-Spoke
• 3—Spoke-Hub
• 4—Spoke-Spoke

Enumeration:

ADVPN tunnel • 0—Establishing

TunnelState N/A N/A
state • 1—Dumb
• 2—Success

Duration that the

tunnel has been
HoldingTime N/A Unsigned integer Unit: seconds
in the current
state

Members include:

• TotalPackets
Statistics for Data • DataPackets
Input N/A
incoming packets structure • ControlPackets
• Multicasts
• Errors

The number of all

TotalPackets N/A Unsigned Integer64 N/A
incoming packets

The number of
DataPackets incoming data N/A Unsigned Integer64 N/A
packets

The number of
ControlPacket
incoming control N/A Unsigned integer 64 N/A
s
packets

Multicasts The number of N/A Unsigned integer 64 N/A

7
Column Column Column
Data type and restrictions Remarks
name description type
incoming
multicast packets

The number of
incoming
Errors N/A Unsigned integer 64 N/A
erroneous
packets

Members include:

• TotalPackets
Statistics for Data • DataPackets
Output N/A
outgoing packets structure • ControlPackets
• Multicasts
• Errors

The number of all

TotalPackets N/A Unsigned integer N/A
outgoing packets

The number of
DataPackets outgoing data N/A Unsigned integer 64 N/A
packets

The number of
ControlPacket
outgoing control N/A Unsigned integer 64 N/A
s
packets

The number of
Multicasts outgoing multicas N/A Unsigned integer 64. N/A
t packets

The number of
Errors outgoing erroneo N/A Unsigned integer 64 N/A
us packets

IPsecTunnelI IPsec tunnel

N/A Unsigned integer 32 N/A
D index

Members include:

• AhInbound
IPsec SA index Data
SAIndex • AhOutbound N/A
information structure
• EspInbound
• EspOutbound

Inbound IPsec
AhInbound N/A Unsigned integer 32 N/A
AH SA index

8
 Column Column Column
Data type and restrictions Remarks
name description type

Outbound IPsec
AhOutbound N/A Unsigned integer 32 N/A
AH SA index

Inbound IPsec
EspInbound N/A Unsigned integer 32 N/A
ESP SA index

Outbound IPsec
EspOutbound N/A Unsigned integer 32 N/A
ESP SA index

IPv6TunnelAdvpnSession
This table is used to display IPv6 ADVPN tunnel session information.

XML structure
<ADVPN>
<IPv6TunnelAdvpnSession>
<IPv6AdvpnSession>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
<PublicAddress></PublicAddress>
<AdvpnPort></AdvpnPort>
<SPI>
<AhInbound></AhInbound>
<AhOutbound></AhOutbound>
<EspInbound></EspInbound>
<EspOutbound></EspOutbound>
</SPI>
<BehindNAT></BehindNAT>
<SessionType></SessionType>
<TunnelState></TunnelState>
<HoldingTime></HoldingTime>
<Input>
<TotalPackets></TotalPackets>
<DataPackets></DataPackets>
<ControlPackets></ControlPackets>
<Multicasts></Multicasts>
<Errors></Errors>
</Input>
<Output>
<TotalPackets></TotalPackets>
<DataPackets></DataPackets>
<ControlPackets></ControlPackets>
<Multicasts></Multicasts>

9
 <Errors></Errors>
</Output>
<IPsecTunnelID></IPsecTunnelID>
<SAIndex>
<AhInbound></AhInbound>
<AhOutbound></AhOutbound>
<EspInbound></EspInbound>
<EspOutbound></EspOutbound>
</SAIndex>
</IPv6AdvpnSession>
</IPv6TunnelAdvpnSession>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name IPv6TunnelAdvpnSession

Table type Multi-instance table

Row name IPv6AdvpnSession

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A

Private address
PrivateAddres
of the ADVPN Index Ipv6Address IPv6 address
s
tunnel peer

Public address of
IPv4 address.
PublicAddress the ADVPN N/A String
IPv6 address.
tunnel peer

Only supported
UDP port number
Unsigned integer when the link layer
AdvpnPort for the ADVPN N/A
Value range: 1025 to 65535 protocol is UDP or
tunnel
IPsec-UDP.

SP index for the Members include: Only supported

Data
SPI inbound and • AhInbound when the link layer
structure
outbound SAs • AhOutbound protocol is

10
Column Column Column
Data type and restrictions Remarks
name description type
• EspInbound IPsec-UDP or IPsec-
• EspOutbound GRE.

Inbound AH SP Unsigned integer

AhInbound N/A N/A
index 32
Value range: 0 to 2 -1.

Outbound AH SP Unsigned integer

AhOutbound N/A N/A
index 32
Value range: 0 to 2 -1.

Inbound ESP SP Unsigned integer

EspInbound N/A N/A
index 32
Value range: 0 to 2 -1.

Outbound ESP Unsigned integer

EspOutbound N/A N/A
SP index 32
Value range: 0 to 2 -1.

Whether the NAT Boolean:

BehindNAT peer node is N/A • true N/A
behind NAT • False

Enumeration:

• 0—Unknown
ADVPN tunnel • 1—Hub-Hub
SessionType N/A N/A
type • 2—Hub-Spoke
• 3—Spoke-Hub
• 4—Spoke-Spoke

Enumeration:

ADVPN tunnel • 0—Establishing

TunnelState N/A N/A
state • 1—Dumb
• 2—Success

Duration that the

tunnel has been
HoldingTime N/A Unsigned integer Unit: seconds
in the current
state

Members include:

• TotalPackets
Statistics for Data • DataPackets
Input N/A
incoming packets structure • ControlPackets
• Multicasts
• Errors

The number of all

TotalPackets N/A Unsigned integer 64 N/A
incoming packets

11
Column Column Column
Data type and restrictions Remarks
name description type
The number of
DataPackets incoming data N/A Unsigned integer 64 N/A
packets

The number of
ControlPacket
incoming control N/A Unsigned integer 64 N/A
s
packets

The number of
Multicasts incoming N/A Unsigned integer 64 N/A
multicast packets

The number of
incoming
Errors N/A Unsigned integer 64 N/A
erroneous
packets

Members include:

• TotalPackets
Statistics for Data • DataPackets
Output N/A
outgoing packets structure • ControlPackets
• Multicasts
• Errors

The number of all

TotalPackets N/A Unsigned integer 64 N/A
outgoing packets

The number of
DataPackets outgoing data N/A Unsigned integer 64 N/A
packets

The number of
ControlPacket
outgoing control N/A Unsigned integer 64 N/A
s
packets

The number of
Multicasts outgoing N/A Unsigned integer 64. N/A
multicast packets

The number of
outgoing
Errors N/A Unsigned integer 64 N/A
erroneous
packets

IPsecTunnelI IPsec tunnel

N/A Unsigned integer 32 N/A
D index

12
 Column Column Column
Data type and restrictions Remarks
name description type

Members include:

• AhInbound
IPsec SA index Data
SAIndex • AhOutbound N/A
information structure
• EspInbound
• EspOutbound

Inbound IPsec
AhInbound N/A Unsigned integer 32 N/A
AH SA index

Outbound IPsec
AhOutbound N/A Unsigned integer 32 N/A
AH SA index

Inbound IPsec
EspInbound N/A Unsigned integer 32 N/A
ESP SA index

Outbound IPsec
EspOutbound N/A Unsigned integer 32 N/A
ESP SA index

IPv4TunnelRunInfo
This table displays the IPv4 interface information.

XML structure
<ADVPN>
<IPv4TunnelRunInfo>
<TunnelRunInfo>
<TunnelID></TunnelID>
<ClientName></ClientName>
<DomainName></DomainName>
<LinkProtocol></LinkProtocol>
<SessionNum></SessionNum>
</TunnelRunInfo>
</IPv4TunnelRunInfo>
</ADVPN>

13
Table description

Item Description
Feature name ADVPN

Table name IPv4TunnelRunInfo

Table type Multi-instance table

Row name TunnelRunInfo

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A

Name of the
String Case-insensitive and
VAM client
ClientName N/A contains only letters,
bound to the Length: 1 to 63 characters
digits, and dots (.).
tunnel interface

Case-insensitive and
Domain name of String
DomainName N/A contains only letters,
the VAM client Length: 1 to 31 characters
digits, and dots (.).

Enumeration:

• 0—Unknown
Link layer
• 1—GRE
LinkProtocol protocol for the N/A N/A
• 2—UDP
ADVPN tunnel
• 3—IPsec-GRE
• 4—IPsec-UDP

Number of
ADVPN tunnels
SessionNum established on N/A Unsigned integer N/A
the tunnel
interface

IPv6TunnelRunInfo
This table displays the IPv6 interface information.

14
XML structure
<ADVPN>
<IPv6TunnelRunInfo>
<TunnelRunInfo>
<TunnelID></TunnelID>
<ClientName></ClientName>
<DomainName></DomainName>
<LinkProtocol></LinkProtocol>
<SessionNum></SessionNum>
</TunnelRunInfo>
</IPv6TunnelRunInfo>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name IPv6TunnelRunInfo

Table type Multi-instance table

Row name TunnelRunInfo

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A

Name of the
String Case-insensitive and
VAM client
ClientName N/A contains only letters,
bound to the Length: 1 to 63 characters
digits, and dots (.).
tunnel interface

Case-insensitive and
Domain name of String
DomainName N/A contains only letters,
the VAM client Length: 1 to 31 characters
digits, and dots (.).

Enumeration:

Link layer • 0—Unknown

LinkProtocol protocol for the N/A • 1—GRE N/A
ADVPN tunnel • 2—UDP
• 3—IPsec-GRE

15
Column Column Column
Data type and restrictions Remarks
name description type
• 4—IPsec-UDP

Number of
ADVPN tunnels
SessionNum established on N/A Unsigned integer N/A
the tunnel
interface

16
Contents
SessionDeleted event ··················································································································· 1
XML structure for event subscription ························································································· 1
XML structure for event report ································································································· 2
SessionStateChanged event ·········································································································· 4
XML structure for event subscription ························································································· 4
XML structure for event report ································································································· 5

i
SessionDeleted event
This event is used to report ADVPN tunnel information when the ADVPN tunnel is deleted.

XML structure for event subscription

<SessionDeletedEvent>
<Tunnel>
<TunnelID></TunnelID>
</Tunnel>
</SessionDeletedEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>ADVPN</stream>
<filter type="subtree">
<SessionDeletedEvent xmlns="http://www.h3c.com/netconf/event:1.0/advpn:1.0">
<Tunnel>
<TunnelID>1</TunnelID>
</Tunnel>
</SessionDeletedEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name ADVPN
Event name SessionDeletedEvent
Event namespace http://www.h3c.com/netconf/event:1.0/advpn:1.0
Support for extended query No

Columns

Column Support for

Column name Data type and restrictions
description extended queries
TunnelID Tunnel ID Unsigned integer No

1
XML structure for event report
<SessionDeletedEvent>
<Tunnel>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
<PublicAddress></PublicAddress>
<PeerPrivateAddress></PeerPrivateAddress>
<PeerPublicAddress></PeerPublicAddress>
<Type></Type>
<LastState></LastState>
<LastStateDuration></LastStateDuration>
<DomainName></DomainName>
<GroupName></GroupName>
</Tunnel>
</SessionDeletedEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<SessionDeletedEvent xmlns="http://www.h3c.com/netconf/event:1.0/advpn:1.0">
<Tunnel>
<TunnelID>1</TunnelID>
<PrivateAddress>112.168.60.56</PrivateAddress>
<PublicAddress>192.168.60.137</PublicAddress>
<PeerPrivateAddress>112.168.60.18</PeerPrivateAddress>
<PeerPublicAddress>192.168.60.11</PeerPublicAddress>
<Type>2</Type>
<LastState>2</LastState>
<LastStateDuration>0H8M8S</LastStateDuration>
<DomainName>abc</DomainName>
<GroupName>aaa</GroupName>
</Tunnel>
</SessionDeletedEvent>
</notification>

Columns

Support for
Column
Column name Data type and restrictions extended
description
queries
TunnelID Tunnel ID Unsigned integer No
PrivateAddress Private address String, dotted decimal notation. No
PublicAddress Public address String, dotted decimal notation. No
PeerPrivateAddre Peer’s private
String, dotted decimal notation. No
ss address

PeerPublicAddre Peer’s public address String, dotted decimal notation. No

2
 Support for
Column
Column name Data type and restrictions extended
description
queries
ss
Enumeration:
• 0—Unknown
• 1—Hub-Hub
Type ADVPN tunnel type No
• 2—Hub-Spoke
• 3—Spoke-Hub
• 4—Spoke-Spoke
Enumeration:
ADVPN tunnel’s last • 0—Establishing
LastState state before the No
tunnel is deleted • 1—Dumb
• 2—Success

ADVPN tunnel’s String, in the format of xxHxxMxxS.

LastStateDuratio
holding time before H, M, and S represent hours, minutes, No
n
the tunnel is deleted. and seconds.
Domain name of the String
DomainName No
VAM client
Group name of the String
GroupName No
ADVPN tunnel

3
SessionStateChanged event
This event is used to report ADVPN tunnel information when the ADVPN tunnel’s state is changed.

XML structure for event subscription

<SessionStateChangedEvent>
<Tunnel>
<TunnelID></TunnelID>
</Tunnel>
</SessionStateChangedEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>ADVPN</stream>
<filter type="subtree">
<SessionStateChangedEvent
xmlns="http://www.h3c.com/netconf/event:1.0/advpn:1.0">
<Tunnel>
<TunnelID>1</TunnelID>
</Tunnel>
</SessionStateChangedEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name ADVPN
Event name SessionStateChangedEvent
Event namespace http://www.h3c.com/netconf/event:1.0/advpn:1.0
Support for extended query No

Columns

Column Support for

Column name Data type and restrictions
description extended queries
TunnelID Tunnel ID Unsigned integer No

4
XML structure for event report
<SessionStateChangedEvent>
<Tunnel>
<TunnelID></TunnelID>
<CurrentState></CurrentState>
<NextState></NextState>
<PrivateAddress></PrivateAddress>
<PublicAddress></PublicAddress>
<PeerPrivateAddress></PeerPrivateAddress>
<PeerPublicAddress></PeerPublicAddress>
<Type></Type>
<LastState></LastState>
<LastStateDuration></LastStateDuration>
<DomainName></DomainName>
<GroupName></GroupName>
</Tunnel>
</SessionStateChangedEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<SessionStateChangedEvent xmlns="http://www.h3c.com/netconf/event:1.0/advpn:1.0">
<Tunnel>
<TunnelID>1</TunnelID>
<CurrentState>0</CurrentState>
<NextState>2</NextState>
<PrivateAddress>112.168.60.56</PrivateAddress>
<PublicAddress>192.168.60.137</PublicAddress>
<PeerPrivateAddress>112.168.60.18</PeerPrivateAddress>
<PeerPublicAddress>192.168.60.11</PeerPublicAddress>
<Type>2</Type>
<LastState>0</LastState>
<LastStateDuration>0H0M5S</LastStateDuration>
<DomainName>abc</DomainName>
<GroupName>aaa</GroupName>
</Tunnel>
</SessionStateChangedEvent>
</notification>

Columns

Column Support for extended

Column name Data type and restrictions
description queries
TunnelID Tunnel ID Unsigned integer No

ADVPN tunnel’s Enumeration:

CurrentState No
current state • 0—Establishing

5
 Column Support for extended
Column name Data type and restrictions
description queries
• 1—Dumb
• 2—Success
Enumeration:
ADVPN tunnel’s next • 0—Establishing
NextState No
state • 1—Dumb
• 2—Success
PrivateAddress Private address String, dotted decimal notation. No
PublicAddress Public address String, dotted decimal notation. No
PeerPrivateAddre Peer’s private
String, dotted decimal notation. No
ss address

PeerPublicAddre
Peer’s public address String, dotted decimal notation. No
ss

Enumeration:
• 0—Unknown
• 1—Hub-Hub
Type ADVPN tunnel type No
• 2—Hub-Spoke
• 3—Spoke-Hub
• 4—Spoke-Spoke

ADVPN tunnel’s last Enumeration:

state before the • 0—Establishing
LastState No
tunnel’s state is • 1—Dumb
changed. • 2—Success

ADVPN tunnel’s String, in the format of

LastStateDuratio holding time before xxHxxMxxS.
No
n the tunnel’s state is H, M, and S represent hours,
changed minutes, and seconds.

Domain name of the String

DomainName No
VAM client

Group name of the String

GroupName No
ADVPN tunnel

6
Contents
AFT ·······························································································1
AFT/AftEnable ··························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AFT/AftLogEnable ······················································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AFT/AftFlowBegin ······················································································································ 2
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
AFT/AftFlowEnd ························································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
AFT/AftPrefixNat64 ···················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
AFT/AftAddressGroup ················································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6
AFT/AftAddressGroupMember ······································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
AFT/AftV6toV4SrcDynamicAcl ······································································································ 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 8

i
AFT
AFT/AftEnable
This table contains informations about AFT enabling switch on the interface.

XML structure
<AFT>
<AftEnable>
<Interface>
<IfIndex></IfIndex>
<EnableSwitch></EnableSwitch>
</Interface>
</AftEnable>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftEnable
Table type Multi-instance table
Row name Interface
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Some versions support
interface name. For
relevant information,
you can see the XSD
document of your
Interface index or String. case-sensitive. product. For more
IfIndex Index
interface name Length: 1 to 99 characters. information about
IfIndex, you can
reference “Appendix” in
Ifmgr NETCONF XML
API Configuration
document.

EnableSwitch Whether enable N/A Boolean: N/A

AFT on the

1
 inerface • true—YES
• false—NO(default).

AFT/AftLogEnable
This table contains information about AFT logging switch

XML structure
<AFT>
<AftLogEnable>
<EnableSwitch></EnableSwitch>
</AftLogEnable>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftLogEnable
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether enable
EnableSwitch N/A • true—YES
AFT logging
• false—NO(default).

AFT/AftFlowBegin
This table contains information about AFT flow begin enabling switch

2
XML structure
<AFT>
<AftFlowBegin>
<EnableSwitch></EnableSwitch>
</AftFlowBegin>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftFlowBegin
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether enable
EnableSwitch AFT flow-begin N/A • true—YES
logging
• false—NO(default).

AFT/AftFlowEnd
This table contains information about AFT flow end enabling switch

XML structure
<AFT>
<AftFlowEnd>
<EnableSwitch></EnableSwitch>
</AftFlowEnd>
</AFT>

3
Table description
Item Description
Feature name AFT
Table name AftFlowEnd
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether enable
EnableSwitch AFT flow-end N/A • true—YES
logging
• false—NO(default).

AFT/AftPrefixNat64
This table contains information about AFT NAT64 prefix

XML structure
<AFT>
<AftPrefixNat64>
<PrefixNat64>
<Ipv6Prefix></Ipv6Prefix>
<Ipv6PrefixLength></Ipv6PrefixLength>
</PrefixNat64>
</AftPrefixNat64>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftPrefixNat64
Table type Multi-instance table
Row name PrefixNat64

4
 Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
IPv6 NAT64 IPv6: Hexadecimal string, Example:
Ipv6Prefix Index
prefix colon-separated. 1000::
Unsigned integer.
Ipv6PrefixLen IPv6 NAT64
Index Value N/A
gth prefix length
range:32,40,48,56,64,96.

AFT/AftAddressGroup
This table contains information about AFT address groups.

XML structure
<AFT>
<AftAddressGroup>
<GroupNumbers>
<GroupNumber></GroupNumber>
</GroupNumbers>
</AftAddressGroup>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftAddressGroup
Table type Muti-instance table
Row name GroupNumbers
Restrictions None
Support for row creation and deletion Yes

5
Columns
Column Column Column
Data type and restrictions
name description type
GroupNumbe AFT address Unsigned integer.
Index
r group number Value range: 0 to 65535.

AFT/AftAddressGroupMember
This table contains information about AFT address group members.

XML structure
<AFT>
<AftAddressGroupMember>
<GroupMembers>
<GroupNumber></GroupNumber>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
</GroupMembers>
</AftAddressGroupMember>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftAddressGroupMember
Table type Multi-instance table
Row name GroupMembers
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
GroupNumbe Address group Unsigned integer.
Index N/A
r number Value range: 0 to 65535.

StartIpv4Addr Start IPv4 IPv4: String, dotted decimal The StartIpv4Address

address of the Index cannot be greater than
ess notation.
address group the EndIpv4Address. If

6
 member they are the same, the
group member has only
one IP address.
The IP addresses of
address members on
the device must not
overlap.
The source address in
a packet destined for an
external network is
translated into an
address in one of group
members.
End IPv4
EndIpv4Addr address of the IPv4: String, dotted decimal
Index N/A
ess address group notation.
member

AFT/AftV6toV4SrcDynamicAcl
This table contains information about AFT IPv6 to IPv4 source dynamic acl rules.

XML structure
<AFT>
<AftV6toV4SrcDynamicAcl>
<RuleNumbers>
<Ipv6Acl></Ipv6Acl>
<Type></Type>
<AddressGroup></AddressGroup>
<IfIndex></IfIndex>
<AddrGrpType></AddrGrpType>
<PortBlockSize></PortBlockSize>
<Ipv4VpnName></Ipv4VpnName>
</RuleNumbers>
</AftV6toV4SrcDynamicAcl>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftV6toV4SrcDynamicAcl
Table type Multi-instance table
Row name RuleNumbers
Restrictions None

7
 Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-insensitive.
Must start with a-z or A-Z, the
Ipv6Acl name or word “all” can not be used as
Ipv6Acl Index name. or the acl number N/A
number
Value range: 2000 to 3999.
Length: 1 to 63 characters..
Enumeration:
Address group or
Type N/A • 0—address group. N/A
easy ip
• 1—easy ip.

AddressGrou Address group Unsigned integer.

N/A N/A
p number Value range: 0 to 65535
Some versions support
interface name. For
relevant information,
you can reference the
XSD document of your
Interface index or String. case-sensitive. product. For more
IfIndex N/A
interface name Length: 1 to 99 characters. information about
IfIndex, you can
reference “Appendix”
in Ifmgr NETCONF
XML API Configuration
document.
Enumeration:
Address group
AddrGrpType N/A • 0—NPt. N/A
type:pat or nopat
• 1—PT

Whether to use Unsigned integer.

PortBlockSize N/A Can be empty
port block Value range: 100 to 64512.

Ipv4VpnNam Whether to use String.

N/A Can be empty
e vpn Length:1 to 31 characters

8
Contents
AFT ·······························································································1
AFT/AftEnable ··························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AFT/AftLogEnable ······················································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AFT/AftFlowBegin ······················································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
AFT/AftFlowEnd ························································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
AFT/AftPrefixNat64 ···················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
AFT/AftAddressGroup ················································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
AFT/AftAddressGroupMember ······································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6
AFT/AftV6toV4SrcDynamicAcl ······································································································ 6
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7

i
AFT
AFT/AftEnable
This table contains informations about AFT enable switch on the interface.

XML structure
<AFT>
<AftEnable>
<Interface>
<IfIndex></IfIndex>
<EnableSwitch></EnableSwitch>
</Interface>
</AftEnable>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftEnable
Table type Multi-instance table
Row name Interface
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Some versions support
interface name. For
relevant information,
you can reference the
XSD document of your
Interface index or String. case-sensitive. product. For more
IfIndex Index
interface name Length: 1 to 99 characters. information about
IfIndex, you can
reference “Appendix”
in Ifmgr NETCONF XML
API Configuration
document.

Boolean:
Whether enable
EnableSwitch AFT on the N/A • true—YES N/A
inerface
• false—NO

1
AFT/AftLogEnable
This table contains informations about AFT log enable switch

XML structure
<AFT>
<AftLogEnable>
<EnableSwitch></EnableSwitch>
</AftLogEnable>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftLogEnable
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether eanble
EnableSwitch N/A • true—YES
AFT log
• false—NO

AFT/AftFlowBegin
This table contains informations about AFT flow begin enable switch

XML structure
<AFT>
<AftFlowBegin>
<EnableSwitch></EnableSwitch>
</AftFlowBegin>

2
 </AFT>

Table description
Item Description
Feature name AFT
Table name AftFlowBegin
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether eanble
EnableSwitch AFT flow-begin N/A • true—YES
log
• false—NO

AFT/AftFlowEnd
This table contains informations about AFT flow end enable switch

XML structure
<AFT>
<AftFlowEnd>
<EnableSwitch></EnableSwitch>
</AftFlowEnd>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftFlowEnd
Table type Single-instance table
Row name None
Restrictions None

3
Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether eanble
EnableSwitch N/A • true—YES
AFT flow-end log
• false—NO

AFT/AftPrefixNat64
This table contains informations about AFT nat64 prefix

XML structure
<AFT>
<AftPrefixNat64>
<PrefixNat64>
<Ipv6Prefix></Ipv6Prefix>
<Ipv6PrefixLength></Ipv6PrefixLength>
</PrefixNat64>
</AftPrefixNat64>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftPrefixNat64
Table type Multi-instance table
Row name PrefixNat64
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
IPv6: Hexadecimal string, Example:
Ipv6Prefix Ipv6 nat64 prefix index
colon-separated. 1000::
Unsigned integer.
Ipv6PrefixLen Ipv6 nat64 prefix
index Value range:32、40、48、56、 N/A
gth length
64、96.

4
AFT/AftAddressGroup
This table contains informations about AFT address groups.

XML structure
<AFT>
<AftAddressGroup>
<GroupNumbers>
<GroupNumber></GroupNumber>
</GroupNumbers>
</AftAddressGroup>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftAddressGroup
Table type Muti-instance table
Row name GroupNumbers
Restrictions None

Columns
Column Column Column
Data type and restrictions
name description type
GroupNumbe AFT address Unsigned integer.
Index
r group number Value range: 0 to 65535.

AFT/AftAddressGroupMember
This table contains informations about AFT address group members.

XML structure
<AFT>
<AftAddressGroupMember>
<GroupMembers>

5
 <GroupNumber></GroupNumber>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
</GroupMembers>
</AftAddressGroupMember>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftAddressGroupMember
Table type Multi-instance table
Row name GroupMembers
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
GroupNumbe Address group Unsigned integer.
Index N/A
r number Value range: 0 to 65535.
The StartIpv4Address
cannot be greater than
the EndIpv4Address. If
they are the same, the
group member has only
one IP address.
Start IPv4 The IP addresses of
StartIpv4Addr address of the IPv4: String, dotted decimal address members on
Index
ess address group notation. the device must not
member overlap.
The source address in
a packet destined for an
external network is
translated into an
address in one of group
members.
End IPv4
EndIpv4Addr address of the IPv4: String, dotted decimal
Index N/A
ess address group notation.
member

AFT/AftV6toV4SrcDynamicAcl
This table contains the aft ipv6 to ipv4 source dynamic acl rules.

6
XML structure
<AFT>
<AftV6toV4SrcDynamicAcl>
<RuleNumbers>
<Ipv6Acl></Ipv6Acl>
<Type></Type>
<AddressGroup></AddressGroup>
<IfIndex></IfIndex>
<AddrGrpType></AddrGrpType>
<PortBlockSize></PortBlockSize>
<Ipv4VpnName></Ipv4VpnName>
</RuleNumbers>
</AftV6toV4SrcDynamicAcl>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftV6toV4SrcDynamicAcl
Table type Multi-instance table
Row name RuleNumbers
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-insensitive.
Must start with a-z or A-Z, the
Ipv6Acl name or word “all” can not be used as
Ipv6Acl Index name. or the acl number N/A
number
Value range: 2000 to 3999.
Length: 1 to 63 characters..
Enumeration:
Address group or
Type N/A • 0—address group. N/A
easy ip
• 1—easy ip.

AddressGrou Address group Unsigned integer.

N/A N/A
p number Value range: 0 to 65535
Some versions support
interface name. For
Interface index or String. case-sensitive. relevant information,
IfIndex N/A you can reference the
interface name Length: 1 to 99 characters. XSD document of your
product. For more
information about

7
 IfIndex, you can
reference “Appendix”
in Ifmgr NETCONF
XML API Configuration
document.
Enumeration:
Address group
AddrGrpType N/A • 0—NPt. N/A
type:pat or nopat
• 1—PT

Whether to use Unsigned integer.

PortBlockSize N/A Can be empty
port block Value range: 100 to 64512.

Ipv4VpnNam Whether to use String.

N/A Can be empty
e vpn Length:1 to 31 characters

8
Contents
AntiVirus ························································································1
AntiVirus/SignatureManualUpgrading ····························································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AntiVirus/SignatureAutoUpgradeNow ····························································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AntiVirus/SignatureRollback ········································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3

i
AntiVirus
AntiVirus/SignatureManualUpgrading
This table contains the information of AntiVirus signatures manual upgrade.

XML structure
<AntiVirus>
<SignatureManualUpgrading>
<URL></URL>
<Location></Location>
</SignatureManualUpgrading>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureManualUpgrading
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String: case-insensitive
When the file is remote,
URL the upgrade
URL N/A Length: 1 to 255 characters. N/A
signature file.
When the file is local,
Length: 1 to 127 character.
If Location is set to 0,
Enumeration: the device deletes the
The Location of
Location
the file.
N/A • 0—Local signature file after the
• 1—remote signature library update
is complete.

AntiVirus/SignatureAutoUpgradeNow
This table contains the information of AntiVirus signatures upgrade at once.

1
XML structure
<AntiVirus>
<SignatureAutoUpgrade>
<UpgradeNow></UpgradeNow>
</SignatureAutoUpgrade>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureAutoUpgrade
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Auto upgrade at
UpgradeNow N/A This column must be empty. N/A
once.

AntiVirus/SignatureRollback
This table contains the information of AntiVirus signatures rollback.

XML structure
<AntiVirus>
<SignatureRollback>
<Rollback></Rollback>
</SignatureRollback>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureRollback
Table type Single-instance table

2
 Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type

Boolean:
Rollback rollback N/A • true：rollback last version N/A
• false：rollback original
version

3
Contents
AntiVirus ························································································1
AntiVirus/Policies ······················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AntiVirus/PolicyInProfile ·············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AntiVirus/RuleInPolicy ················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
AntiVirus/SignatureAutoUpgrading································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
AntiVirus/ActionDefaultParameters ································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
AntiVirus/RuleInPolicySigID ········································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
AntiVirus/CloudQueryConfig ········································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7
AntiVirus/RuleInPolicyMd5 ··········································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8

i
AntiVirus
AntiVirus/Policies
This table contains AntiVirus policy.

XML structure
<AntiVirus>
<Policies>
<Policy>
<PolicyName></PolicyName>
<Description></Description>
<CloudQuery></CloudQuery>
</Policy>
</Policies>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

Description of String: case-sensitive.

Description N/A N/A
the policy Length: 1 to 255 characters.
Enumeration:
Enabling status
CloudQuery
of cloud querying
N/A • 1—Enabled. N/A
• 2—Disabled.

1
AntiVirus/PolicyInProfile
This table contains AntiVirus policy applied to the profile.

XML structure
<AntiVirus>
<PolicyInProfile>
<Profile>
<ProfileName></ProfileName>
<PolicyName></PolicyName>
</Profile>
</PolicyInProfil>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name PolicyInProfile
Table type Multi-instance table
Row name Profile
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
ProfileName Index N/A
profile Length: 1 to 100 characters.

Name of the String: case-insensitive.

PolicyName N/A N/A
policy Length: 1 to 63 characters.

AntiVirus/RuleInPolicy
This table contains the information of rules in an AntiVirus policy.

XML structure
<AntiVirus>
<RuleInPolicy>
<Policy>

2
 <PolicyName></PolicyName>
<Protocol>
<ProtocolName></ProtocolName>
<Direction></Direction>
<Action></Action>
</Protocol>
<Application>
<AppName></AppName>
<Action></Action>
</Application>
</Policy>
</RuleInPolicy>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicy
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.
Members include:
Protocol DataStru • ProtocolName
Protocol N/A
configuration cture • Direction
• Action
String: case-insensitive
• HTTP
ProtocolNam • FTP
Protocol name N/A N/A
e • SMTP
• POP3
• IMAP
Enumeration:
Direction of • 0—Upload
Direction N/A N/A
protocol traffic • 1—Download
• 2—Both
Action Actions for the N/A Enumeration: N/A

3
 specified • 1—Alert
protocol's traffic • 2—Block
• 3—Redirect
Members include:
Application Data
Application
configuration Structure • AppName N/A
• Action
String, case-insensitive.
AppName Application name N/A N/A
Length: 1 to 63 characters.
Enumeration:
Actions for the
• 1—Alert
Action specified N/A N/A
application • 2—Block
• 3—Permit

AntiVirus/SignatureAutoUpgrading
This table contains the information of AntiVirus signatures auto upgrading.

XML structure
<AntiVirus>
<SignatureAutoUpgrading>
<Enabled></Enabled>
<StartTime></StartTime>
<Type></Type>
<Day></Day>
</SignatureAutoUpgrading>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureAutoUpgrading
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enabled or Boolean:
Enabled N/A Default is false
disabled • true

4
 • false
The time that the Default is 03:01:00,
StartTime system auto N/A Time.
upgrading HH:MM:SS

Type of the Enumeration:

Type system auto N/A • 0—Week Default is 1
upgrading • 1—Periodic
When Type is 0, the
Unsigned integer. value range is 0 to 6.
Day Days N/A Otherwise, the value
Value range: 0 to 15. range is 1 to 15. The
default is 3.

AntiVirus/ActionDefaultParameters
This table contains Antivirus action default parameter information.

XML structure
<AntiVirus>
<ActionDefaultParameters>
<ActionDefaultParameter>
<Action></Action>
<ParameterName></ParameterName>
</ActionDefaultParameter>
</ActionDefaultParameters>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name ActionDefaultParameters
Table type Multi-instance table
Row name ActionDefaultParameter
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
Action action Index • 1—Block N/A
• 2—Capture

5
 • 3—Logging
• 4—Redirect
• 5—Mail
The value is from DIM
table. E.g. If Action is
ParameterNa String: case-insensitive. block, the
Parameter-Name N/A
me Length: 1 to 63 characters. ParameterName’s
value is from
DIM/BlockParameters.

AntiVirus/RuleInPolicySigID
This table contains the Exception sigs information of an AntiVirus policy.

XML structure
<AntiVirus>
<RuleInPolicySigID>
<Policy>
<PolicyName></PolicyName>
<ExceptionSigID></ExceptionSigID>
</Policy>
</RuleInPolicySigID>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicySigID
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

ExceptionSigI Unsigned integer.

ID of the virus Index N/A
D Value range: 1 to 536870910.

6
AntiVirus/CloudQueryConfig
This table contains cloud query configuration.

XML structure
<AntiVirus>
<CloudQueryConfig>
<HostName></HostName>
<CacheSize></CacheSize>
<CacheTime></CacheTime>
</CloudQueryConfig>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name CloudQueryConfig
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Name of the String, case-insensitive.
HostName N/A N/A
host Length: 1 to 255 characters.
Unsigned integer.
Size of the
CacheSize N/A Value range: 100000 to N/A
cache
200000.

Lifetime of the Unsigned integer.

CacheTime N/A N/A
cached entries Value range: 10 to 720.

AntiVirus/RuleInPolicyMd5
This table contains the MD5 exception information of an AntiVirus policy.

XML structure
<AntiVirus>
<RuleInPolicyMd5>

7
 <Policy>
<PolicyName></PolicyName>
<ExceptionMd5></ExceptionMd5>
</Policy>
</RuleInPolicyMd5>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicyMd5
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

ExceptionMd String: case-insensitive.

Value of the MD5 Index N/A
5 Length: 32 characters.

8
Contents
AntiVirus ························································································1
AntiVirus/Policies ······················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AntiVirus/PolicyInProfile ·············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AntiVirus/RuleInPolicy ················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
AntiVirus/Signatures ··················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
AntiVirus/SignatureFileInfos ········································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
AntiVirus/UpdatePercentage ········································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
AntiVirus/SignatureAutoUpgrading································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7
AntiVirus/ActionDefaultParameters ································································································ 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 8
AntiVirus/RuleInPolicySigID ········································································································· 8
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ···························································································································· 9
AntiVirus/FamilyInfos ·················································································································· 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
AntiVirus/CloudQueryConfig ······································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
AntiVirus/CloudQueryState ········································································································ 11
XML structure ··················································································································· 11
Table description ··············································································································· 12
Columns ·························································································································· 12
AntiVirus/RuleInPolicyMd5 ········································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 13

i
AntiVirus
AntiVirus/Policies
This table contains AntiVirus policy.

XML structure
<AntiVirus>
<Policies>
<Policy>
<PolicyName></PolicyName>
<Description></Description>
<CloudQuery></CloudQuery>
</Policy>
</Policies>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

Description of String: case-sensitive.

Description N/A N/A
the policy Length: 1 to 255 characters.
Enumeration:
Enabling status
CloudQuery
of cloud querying
N/A • 1—Enabled. N/A
• 2—Disabled.

1
AntiVirus/PolicyInProfile
This table contains AntiVirus policy applied to the profile.

XML structure
<AntiVirus>
<PolicyInProfile>
<Profile>
<ProfileName></ProfileName>
<PolicyName></PolicyName>
</Profile>
</PolicyInProfil>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name PolicyInProfile
Table type Multi-instance table
Row name Profile
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
ProfileName Index N/A
profile Length: 1 to 100 characters.

Name of the String: case-insensitive.

PolicyName N/A N/A
policy Length: 1 to 63 characters.

AntiVirus/RuleInPolicy
This table contains the information of rules in an AntiVirus policy.

XML structure
<AntiVirus>
<RuleInPolicy>
<Policy>
<PolicyName></PolicyName>

2
 <Protocol>
<ProtocolName></ProtocolName>
<Direction></Direction>
<Action></Action>
</Protocol>
<Application>
<AppName></AppName>
<Action></Action>
</Application>
</Policy>
</RuleInPolicy>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicy
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.
Members include:
Protocol DataStru • ProtocolName
Protocol N/A
configuration cture • Direction
• Action
String: case-insensitive.
• HTTP
ProtocolNam • FTP
Protocol name N/A N/A
e • SMTP
• POP3
• IMAP
Enumeration:
Direction of • 0—Upload
Direction N/A N/A
protocol traffic • 1—Download
• 2—Both
Enumeration:
Actions for the
• 1—Alert
Action specified N/A N/A
protocol's traffic • 2—Block
• 3—Redirect

3
 Column Column Column
Data type and restrictions Remarks
name description type
Members include:
Application Data
Application
configuration Structure • AppName N/A
• Action
String, case-insensitive.
AppName Application name N/A N/A
Length: 1 to 63 characters.
Enumeration:
Actions for the
• 1—Alert
Action specified N/A N/A
application • 2—Block
• 3—Permit

AntiVirus/Signatures
This table contains the pre-defined rules information of an AntiVirus policy.

XML structure
<AntiVirus>
<Signatures>
<Signature>
<SignatureID></SignatureID>
<Severity></Severity>
<SignatureName></SignatureName>
</Signature>
</Signatures>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name Signatures
Table type Multi-instance table
Row name Signature
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
SignatureID ID of the virus Index From signature file.
Value range: 1 to 536870910.

4
 Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 1—Critical
Severity of the
Severity
virus
N/A • 2—High From signature file.
• 3—Minor
• 4—Low

SignatureNa Name of the String: case-insensitive.

N/A From signature file.
me virus Length: 1 to 127 characters.

AntiVirus/SignatureFileInfos
This table contains AntiVirus policy.

XML structure
<AntiVirus>
<SignatureFileInfos>
<FileInfo>
<Version></Version>
<FileName></FileName>
<PublishedTime></PublishedTime>
<Updates></Updates>
</FileInfo>
</SignatureFileInfos>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureFileInfos
Table type Multi-instance table
Row name FileInfo
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
signature file
Version
version
Index • 1—Current N/A
• 2—Latest

5
 Column Column Column
Data type and restrictions Remarks
name description type
• 3—Factory

Name of the String: case-insensitive.

FileName N/A v.v(2.1)
signature file Length: 1 to 31 characters.

The time when DateTime.

PublishedTim
the signature is N/A Format: Consider time-zone
e
published YYYY-MM-DDTHH:MM:SS.

Updating String: case-insensitive.

Updates N/A N/A
Information Length: 1 to 255 characters.

AntiVirus/UpdatePercentage
This table contains the percentage of update.

XML structure
<AntiVirus>
<UpdatePercentage>
<Percentage></Percentage>
</UpdatePercentage>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name UpdatePercentage
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
When the value range
Unsigned integer. is 0 to 100, it means
Percentage of
Percentage N/A in upgrading,
update Value range: 0 to 100. Otherwise, it means
error

6
AntiVirus/SignatureAutoUpgrading
This table contains the information of AntiVirus signatures auto upgrading.

XML structure
<AntiVirus>
<SignatureAutoUpgrading>
<Enabled></Enabled>
<StartTime></StartTime>
<Type></Type>
<Day></Day>
</SignatureAutoUpgrading>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureAutoUpgrading
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
Enabled or
Enabled
disabled
N/A • true Default is false
• false
The time that the Default is 03:01:00,
StartTime system auto N/A Time.
upgrading HH:MM:SS

Type of the Enumeration:

Type system auto N/A • 0—Week Default is 1
upgrading • 1—Periodic
When Type is 0, the
Unsigned integer. value range is 0 to 6.
Day Days N/A Otherwise, the value
Value range: 0 to 15. range is 1 to 15. The
default is 3.

7
AntiVirus/ActionDefaultParameters
This table contains Antivirus action default parameter information.

XML structure
<AntiVirus>
<ActionDefaultParameters>
<ActionDefaultParameter>
<Action></Action>
<ParameterName></ParameterName>
</ActionDefaultParameter>
</ActionDefaultParameters>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name ActionDefaultParameters
Table type Multi-instance table
Row name ActionDefaultParameter
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 1—Block
• 2—Capture
Action action Index N/A
• 3—Logging
• 4—Redirect
• 5—Mail
The value is from DIM
table. E.g. If Action is
String: case-insensitive. block, the
ParameterNa
Parameter-Name N/A ParameterName’s
me Length: 1 to 63 characters. value is from
DIM/BlockParameters
.

AntiVirus/RuleInPolicySigID
This table contains the Exception sigs information of an AntiVirus policy.

8
XML structure
<AntiVirus>
<RuleInPolicySigID>
<Policy>
<PolicyName></PolicyName>
<ExceptionSigID></ExceptionSigID>
</Policy>
</RuleInPolicySigID>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicySigID
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

ExceptionSigI Unsigned integer.

ID of the virus Index N/A
D Value range: 1 to 536870910.

AntiVirus/FamilyInfos
This table contains information about virus families displayed on paginated lists.

XML structure
<AntiVirus>
<FamilyInfos>
<FamilyInfo>
<UserID></UserID>
<Position></Position>
<TotalCount></TotalCount>
<FamilyID></FamilyID>
<FamilyName></FamilyName>
</FamilyInfo>

9
 </FamilyInfos>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name FamilyInfos
Table type Multi-instance table
Row name FamilyInfo
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
The value is used to
identify each query
results in back end,
ID of the current and send to fore-end
UserID Index Unsigned integer.
virtual user. to get other paginated
results when query
results is more than
one page.
Position of the
family on the
Position Index Unsigned integer. N/Az
entire virus
families list.
If the query function is
used, the total
Total number of
TotalCount N/A Unsigned integer. number of virus
virus families.
families in the query
results is displayed.

Unsigned integer. The value is obtained

FamilyID ID of the family. Index from the anti-virus
Value range: 1 to 536870910. signature file.

String: case-insensitive. The value is obtained

Name of the
FamilyName N/A from the anti-virus
family. Length: 1 to 63 characters. signature file.

AntiVirus/CloudQueryConfig
This table contains cloud query configure information.

XML structure
<AntiVirus>
<CloudQueryConfig>

10
 <HostName></HostName>
<CacheSize></CacheSize>
<CacheTime></CacheTime>
</CloudQueryConfig>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name CloudQueryConfig
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Name of the String, case-insensitive.
HostName N/A N/A
host Length: 1 to 255 characters.

Size of the Unsigned integer.

CacheSize N/A N/A
cache Value range: 100000 to 200000.

Lifetime of the Unsigned integer.

CacheTime N/A N/A
cached entries Value range: 10 to 720.

AntiVirus/CloudQueryState
This table contains cloud query status information.

XML structure
<AntiVirus>
<CloudQueryState>
<HostName></HostName>
<HostState></HostState>
<HostStateErrCode></HostStateErrCode>
</CloudQueryState>
</AntiVirus>

11
Table description
Item Description
Feature name AntiVirus
Table name CloudQueryState
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Name of the String, case-insensitive.
HostName N/A N/A
host Length: 1 to 255 characters.
Enumeration:
Status of the
HostState
host
N/A • 0—Available N/A
• 1—Unavailable

HostStateErrCo Error code of Unsigned integer.

N/A N/A
de cloud query Value range: 0 to 3.

AntiVirus/RuleInPolicyMd5
This table contains the MD5 exception information of an AntiVirus policy.

XML structure
<AntiVirus>
<RuleInPolicyMd5>
<Policy>
<PolicyName></PolicyName>
<ExceptionMd5></ExceptionMd5>
</Policy>
</RuleInPolicyMd5>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicyMd5
Table type Multi-instance table

12
 Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

ExceptionMd String: case-insensitive.

Value of the MD5 Index N/A
5 Length: 32 characters.

13
Contents
AntiVirus ························································································2
AntiVirus/SignatureManualUpgrading ····························································································· 2
AntiVirus/SignatureAutoUpgradeNow ····························································································· 2
AntiVirus/RuleInPolicy ················································································································· 2
AntiVirus/RuleInPolicySigID ········································································································· 3

i
AntiVirus
AntiVirus/SignatureManualUpgrading
Message Explanation
Operation failed because no valid license could be
Please install a valid license.
found.
请安装正确的license。
操作失败：没有找到有效的license。

AntiVirus/SignatureAutoUpgradeNow
Message Explanation
Operation failed because no valid license could be
Please install a valid license.
found.
请安装正确的license。
操作失败：没有找到有效的license。

The signature file is updating. Please try again

Please try later.
later.
正在升级，稍后再试。
特征库正在升级，请稍后再试。

Operation failed because a connection to the

Please examine your network or server.
signature library server could not be established.
请检查网络和服务器是否正常。
操作失败: 连接特征库服务器失败。

Cannot execute this operation because of memory

Please try later.
alert.
待设备内存门限解除后再试。
由于内存门限不能执行此操作。

The signature version is up to date. No update is

No update is needed because the version is up to date.
needed.
不需要升级，已经是最新版本。
特征库已是最新版本，不需要进行升级。

Cannot update the signature library because the Cannot update the signature library because the required service
required service card cannot be found. card cannot be found.
未检测到业务板，特征库升级失败。 特征库升级操作需要有业务板。

AntiVirus/RuleInPolicy
Message Explanation
The maximum number of 100 application
A maximum of 100 application exceptions can be configured.
exceptions already reached.
最多可配置100个应用例外。
最多可配置100个应用例外。

2
AntiVirus/RuleInPolicySigID
Message Explanation
The maximum number of 512 signature exceptions
A maximum of 512 signature exceptions can be configured.
already reached.
最多可配置512个病毒例外。
最多可配置512个病毒例外。

3
Contents
AP ································································································1
AP/ResetAP ····························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AP/ResetAllAP ·························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
AP/PersistentAP ························································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
AP/RegroupAPByName ·············································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
AP/RegroupAPByMac ················································································································· 3
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
AP/RegroupAPBySerialID ············································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5
AP/RegroupAPByGroup ·············································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6
AP/AuthenticateAP ····················································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
AP/AuthenticateAllAP ················································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7
AP/ImportAuthenticateFile ··········································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8
AP/ProvisionAP ························································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 9
AP/RenameAP ·························································································································· 9
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ···························································································································· 9

i
AP
AP/ResetAP
This table contains information of AP resetting.

XML structure
<AP>
<ResetAP>
<AP>
<ApName></ApName>
</AP>
</ResetAP>
</AP>

Table description
Item Description
Feature name AP
Table name ResetAP
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ApName AP name Index String, case-sensitive. N/A.
Length: 1 to 64 characters.

AP/ResetAllAP
This table contains information of resetting all APs.

XML structure
<AP>
<ResetAllAP>
<Global>
<ResetType></ResetType>
</Global>

1
 </ResetAllAP>
</AP>

Table description
Item Description
Feature name AP
Table name ResetAllAP
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column
Column description Column type Data type and restrictions
name
ResetType Which type of APs will be Index Enumeration:
reset. • 1—All.
• 2—Unauthenticated.

AP/PersistentAP
This table contains information of AP persistence.

XML structure
<AP>
<PersistentAP>
<AP>
<ApName></ApName>
</AP>
</PersistentAP>
</AP>

Table description
Item Description
Feature name AP
Table name PersistentAP
Table type Multi-instance table
Row name AP
Restrictions None

2
Columns
Column Column Column
Data type and restrictions Remarks
name description type
ApName AP name Index String, case-sensitive. N/A.
Length: 1 to 64 characters.

AP/RegroupAPByName
This table contains information of AP regrouping.

XML structure
<AP>
<RegroupAPByName>
<AP>
<ApName></ApName>
<GroupName></GroupName>
</AP>
</RegroupAPByName>
</AP>

Table description
Item Description
Feature name AP
Table name RegroupAPByName
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ApName AP name Index String, case-sensitive. N/A.
Length: 1 to 64 characters.
GroupName The name of AP N/A String, lowercase. N/A
group which the Length: 1 to 31 characters.
AP will belong to.

AP/RegroupAPByMac
This table contains information of AP regrouping by MAC address.

3
XML structure
<AP>
<RegroupAPByMac>
<MAC>
<MacAddress></MacAddress>
<GroupName></GroupName>
</MAC>
</RegroupAPByMac>
</AP>

Table description
Item Description
Feature name AP
Table name RegroupAPByMac
Table type Multi-instance table
Row name MAC
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
MacAddress AP MAC address Index Six groups of two hexadecimal Example:
digits, hyphen-separated. 00-0c-af-e3-5d-c0.
GroupName The name of AP N/A String, lowercase. N/A
group which the Length: 1 to 31 characters.
AP will belong to.

AP/RegroupAPBySerialID
This table contains information of AP regrouping by serial ID.

XML structure
<AP>
<RegroupAPBySerialID>
<SerialID>
<SerialID></SerialID>
<GroupName></GroupName>
</SerialID>
</RegroupAPBySerialID>
</AP>

4
Table description
Item Description
Feature name AP
Table name RegroupAPBySerialID
Table type Multi-instance table
Row name SerialID
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
SerialID AP serial ID Index String, uppercase. If this column contains
Length: 1 to 127 characters. lowercase character, it
will be converted to
uppercase
automatically.
GroupName The name of AP N/A String, lowercase. N/A
group which the Length: 1 to 31 characters.
AP will belong to.

AP/RegroupAPByGroup
This table contains information of AP regrouping by group.

XML structure
<AP>
<RegroupAPByGroup>
<Group>
<OldGroupName></OldGroupName>
<NewGroupName></NewGroupName>
</Group>
</RegroupAPByGroup>
</AP>

Table description
Item Description
Feature name AP
Table name RegroupAPByGroup
Table type Multi-instance table
Row name Group

5
 Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
OldGroupNa The name of old Index String, lowercase. If this column contains
me AP group. Length: 1 to 31 characters. uppercase character, it
will be converted to
lowercase automatically.
NewGroupNa The name of AP N/A String, lowercase. If this column contains
me group which the Length: 1 to 31 characters. uppercase character, it
AP in old group will be converted to
will belong to. lowercase automatically.

AP/AuthenticateAP
This table contains information of authenticating APs.

XML structure
<AP>
<AuthenticateAP>
<AP>
<ApName></ApName>
<Action></Action>
</AP>
</AuthenticateAP>
</AP>

Table description
Item Description
Feature name AP
Table name AuthenticateAP
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ApName AP name Index String, case-sensitive. N/A.
Length: 1 to 64 characters.

6
 Column Column Column
Data type and restrictions Remarks
name description type
Action The N/A Enumeration: N/A
authenticating • 1—Accept.
action type.
• 2—Reject.

AP/AuthenticateAllAP
This table contains information of authenticating all APs.

XML structure
<AP>
<AuthenticateAllAP>
<Global>
<Action></Action>
</Global>
</AuthenticateAllAP>
</AP>

Table description
Item Description
Feature name AP
Table name AuthenticateAllAP
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Column
Data type and restrictions
name description type
Action The N/A Enumeration:
authenticating • 1—Accept.
action type.
• 2—Reject.

AP/ImportAuthenticateFile
This table contains information of importing authenticating file.

XML structure
<AP>

7
 <ImportAuthenticateFile>
<FileName></FileName>
</ImportAuthenticateFile>
</AP>

Table description
Item Description
Feature name AP
Table name ImportAuthenticateFile
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Data type and
Column name Column description Remarks
type restrictions
FileName The TXT file name N/A String, case-insensitive.
Should end with “.txt”
with full path which Length: 1 to 255 and specify the
will be imported as characters. authentication ACL
the AP ACL rules for
first.
AP authentication.

AP/ProvisionAP
This table contains information of provisioning APs.

XML structure
<AP>
<ProvisionAP>
<AP>
<ApName></ApName>
<Action></Action>
</AP>
</ProvisionAP>
</AP>

Table description
Item Description
Feature name AP
Table name ProvisionAP
Table type Multi-instance table

8
 Row name AP
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ApName AP name Index String, case-sensitive. N/A.
Length: 1 to 64 characters.
Action The N/A Enumeration: N/A
authenticating • 1—Provision.
action type.
• 2—Reset provisioning.

AP/RenameAP
This table contains information about renaming APs.

XML structure
<AP>
<RenameAP>
<AP>
<ApName></ApName>
<NewApName></NewApName>
</AP>
</RenameAP>
</AP>

Table description
Item Description
Feature name AP
Table name RenameAP
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-sensitive.
ApName AP name Index N/A.
Length: 1 to 64 characters.

9
Column Column Column
Data type and restrictions Remarks
name description type
String, case-sensitive.
NewApName New AP name Index N/A.
Length: 1 to 64 characters.

10
Contents
AP ································································································1
AP/GlobalCfg ···························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 2
AP/ManualAP ··························································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
AP/RadioOfManualAP················································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 7
Columns ···························································································································· 7
AP/PrvsOfManualAP ················································································································ 11
XML structure ··················································································································· 11
Table description ··············································································································· 12
Columns ·························································································································· 12
AP/PrvsOfManualAPACIPv4 ······································································································ 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
AP/PrvsOfManualAPACIPv6 ······································································································ 14
XML structure ··················································································································· 14
Table description ··············································································································· 14
Columns ·························································································································· 15
AP/EdcaRadio ························································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 15
Columns ·························································································································· 16
AP/RadioWmm ························································································································ 16
XML structure ··················································································································· 16
Table description ··············································································································· 17
Columns ·························································································································· 17
AP/Radio11n ·························································································································· 17
XML structure ··················································································································· 17
Table description ··············································································································· 18
Columns ·························································································································· 18
AP/Radio11ac ························································································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 20
AP/APGroup ··························································································································· 21
XML structure ··················································································································· 21
Table description ··············································································································· 22
Columns ·························································································································· 22
AP/APGroupMACRule ·············································································································· 24
XML structure ··················································································································· 24
Table description ··············································································································· 24
Columns ·························································································································· 24
AP/APGroupSerialIDRule ·········································································································· 24
XML structure ··················································································································· 24
Table description ··············································································································· 25
Columns ·························································································································· 25
AP/APGroupNameRule ············································································································· 25
XML structure ··················································································································· 25
Table description ··············································································································· 26
Columns ·························································································································· 26

i
AP/APGroupIPv4Rule ··············································································································· 26
XML structure ··················································································································· 26
Table description ··············································································································· 26
Columns ·························································································································· 27
AP/APGroupIPv6Rule ··············································································································· 27
XML structure ··················································································································· 27
Table description ··············································································································· 27
Columns ·························································································································· 28
AP/APGroupModel ··················································································································· 28
XML structure ··················································································································· 28
Table description ··············································································································· 28
Columns ·························································································································· 29
AP/APGroupRadio ··················································································································· 29
XML structure ··················································································································· 29
Table description ··············································································································· 30
Columns ·························································································································· 30
AP/APGroupRadio11n ·············································································································· 34
XML structure ··················································································································· 34
Table description ··············································································································· 35
Columns ·························································································································· 35
AP/APGroupRadio11ac ············································································································· 37
XML structure ··················································································································· 37
Table description ··············································································································· 37
Columns ·························································································································· 38
AP/APGroupPrvs ····················································································································· 38
XML structure ··················································································································· 38
Table description ··············································································································· 39
Columns ·························································································································· 39
AP/APGroupPrvsACIPv4 ··········································································································· 40
XML structure ··················································································································· 40
Table description ··············································································································· 40
Columns ·························································································································· 40
AP/APGroupPrvsACIPv6 ··········································································································· 40
XML structure ··················································································································· 40
Table description ··············································································································· 41
Columns ·························································································································· 41
AP/Location ···························································································································· 41
XML structure ··················································································································· 41
Table description ··············································································································· 41
Columns ·························································································································· 42
AP/APAuthentication ················································································································ 42
XML structure ··················································································································· 42
Table description ··············································································································· 42
Columns ·························································································································· 43
AP/LocalAC ···························································································································· 43
XML structure ··················································································································· 43
Table description ··············································································································· 44
Columns ·························································································································· 44
AP/ContainerTopology ·············································································································· 45
XML structure ··················································································································· 45
Table description ··············································································································· 45
Columns ·························································································································· 45
AP/Container ·························································································································· 46
XML structure ··················································································································· 46
Table description ··············································································································· 46
Columns ·························································································································· 46

ii
AP
AP/GlobalCfg
This table contains the informations of global.

XML structure
<AP>
<GlobalCfg>
<AutoAp></AutoAp>
<AutoPersistent></AutoPersistent>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Preempt></Preempt>
<FirmwareUpgrade></FirmwareUpgrade>
<TunnelEncryption></TunnelEncryption>
<Gps></Gps>
<LocalAC></LocalAC>
<CentralACIPv4></CentralACIPv4>
<CentralACIPv6></CentralACIPv6>
<ControlAddress></ControlAddress>
<ControlAddressIPv4></ControlAddressIPv4>
<ControlAddressIPv6></ControlAddressIPv6>
</GlobalCfg>
</AP>

Table description
Item Description
Feature name AP
Table name GlobalCfg
Table type Single-instance table
Row name N/A
Restrictions None
Support for row creation
No
and deletion

1
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Whether an AP Boolean:
can connect the • true—Support. N/A
AutoAp AC without N/A
creating a manual • false—Not support.
AP. Default value is false.

When an auto AP Boolean:

connects the AC , • true—Support. N/A
AutoPersist
whether convert N/A
ent
the AP to manual • false—Not support.
AP automatically. Default value is false.

Region code of Conform to ISO 3166

RegionCode N/A Unsigned short.
AP group. standard.
Boolean:
Whether the • true—Support. N/A
RegionLock region code of the N/A
AC is locked • false—Not support.
Default value is false.
Whether the AP in Boolean:
this group will be
• true: Switch N/A
forced to switch
Preempt N/A • false: Not switch
the backup tunnel
to active by Default value is false.
priority.
Whether the AC Boolean:
will upgrade AP’s N/A
FirmwareUp firmware • true—Enable
N/A
grade automatically if the • false—Disable
software is
mismatch. Default value is disable.

Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable

Whether to open Boolean:

Gps the N/A • true—Enable Only for FatAP Type
Gps report switch. • false—Disable
Whether to enable Boolean:
LocalAC Local ac. N/A • true—Enable Only for Local-ac Type
• false—Disable

CentralACIP The IPv4 Central String, dotted decimal Example: 1.1.1.1.

N/A
v4 AC address. notation. Only for Local-ac Type

CentralACIP The IPv6 Central Hexadecimal string, Example: 1:1::1:1.

N/A
v6 AC address. colon-separated. Only for Local-ac Type
CAPWAP control Boolean:
ControlAddr address
ess
N/A • true—Enable N/A
configuration
• false—Disable

2
 Column Column Column Data type and
Remarks
name description type restrictions
Specify an AC
ControlAddr String, dotted decimal
IPv4 address for N/A Example: 1.1.1.1.
essIPv4 notation.
AC rediscovery
Specify an AC
ControlAddr Hexadecimal string,
IPv4 address for N/A Example: 1:1::1:1.
essIPv6 colon-separated.
AC rediscovery

AP/ManualAP
This table contains manual AP information.

XML structure
<AP>
<ManualAP>
<AP>
<Name></Name>
<Model></Model>
<CfgSerialID></CfgSerialID>
<CfgMacAddress></CfgMacAddress>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
<ControlAddress></ControlAddress>
<ControlAddressIPv4></ControlAddressIPv4>
<ControlAddressIPv6></ControlAddressIPv6>
<ProvisionAutoUpgrade></ProvisionAutoUpgrade>
<ProvisionAutoRecover></ProvisionAutoRecover>
<LedMode></LedMode>
</AP>
</ManualAP>
</AP>

3
Table description
Item Description
Feature name AP
Table name ManualAP
Table type Multi-instance table
Row name AP
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Data type and
Column name Remarks
description type restrictions
String, case-sensitive. N/A.
Name AP name. Index Length: 1 to 64
characters.
Characters will be
automatically convert case.
Refer to AP/APDB.
This column is mandatory
String, case-insensitive. when the row is being
created.
Model AP model name. N/A Length: 1 to 63
characters. This column is not writable
when the row is being
deleted, removed.
This column should not be
changed when the row is
being replaced or merged.

String, uppercase. If this column contains

Configured AP serial lowercase character, it will
CfgSerialID N/A Length: 1 to 127
ID. be converted to uppercase
characters. automatically.
Six groups of two
Configured AP MAC
CfgMacAddress N/A hexadecimal digits, Example: 00-0c-af-e3-5d-c0.
address.
hyphen-separated.
Conform to ISO 3166
RegionCode Region code of AP. N/A Unsigned short.
stantard.

Whether the region Boolean:

RegionLock code of the AP is N/A • true—Support. N/A
locked. • false—Not support.
Unsigned short.
Priority AP connection priority N/A N/A
Value range: 0 to 7.
Whether the AP will be Boolean:
forced to switch the
Preempt N/A • true: Switch N/A
backup tunnel to active
by priority. • false: Not switch

4
 The transmit interval of Unsigned short.
EchoInterval tunnel echo N/A Value range: 0, 5 to 255. N/A
messages. Unit: seconds
The allowed maximum
number of echo
messages which are Unsigned short.
EchoCount N/A N/A
not received. If the Value range: 1 to 20.
count is reached, the
tunnel will be down.
The interval to Unsigned short.
RetransInterval retransmit a request N/A Value range: 1 to 30. N/A
message.
Unit: seconds
The allowed maximum Unsigned short.
number of Value range: 1 to 20.
retransmission
RetransCount N/A Unit: seconds N/A
attempts. If the count
is reached, the tunnel
will be down.
Unsigned short.
The interval of AP
Value range: 0 to 240.
StatisInterval sending the statistics N/A N/A
informations to AC. Default value is 50
seconds.
Whether the AC will Boolean:
upgrade AP’s firmware
FirmwareUpgrade N/A • true—Enable N/A
automatically if the
software is mismatch. • false—Disable

The IPv4 backup AC String, dotted decimal

BackupACIPv4 N/A Example: 1.1.1.1.
address. notation.
The IPv6 backup AC Hexadecimal string,
BackupACIPv6 N/A Example: 1:1::1:1.
address. colon-separated.
String, lowercase.
Which location the AP
LocationName N/A Length: 1 to 31 N/A
group belongs to.
characters.
String,
Description The description of AP. N/A Length: 1 to 64 N/A
characters.
Boolean:
Whether to enable
TunnelEncryption
tunnel encryption.
N/A • true—Enable N/A
• false—Disable
Boolean:
CAPWAP control
ControlAddress
address configuration.
N/A • true—Enable. N/A
• false—Disable.
Specify an AC IPv4
String, dotted decimal
ControlAddressIPv4 address for AC N/A Example: 1.1.1.1.
notation.
rediscovery.
Specify an AC IPv4
Hexadecimal string,
ControlAddressIPv6 address for AC N/A Example: 1:1::1:1.
colon-separated.
rediscovery.

Whether to enable Boolean:

ProvisionAutoUpgrade N/A N/A
provision • true—Enable.

5
 auto-upgrade. • false—Disable.
Boolean:
Whether to enable
ProvisionAutoRecover
provision auto-recover.
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 0—Normal
• 1—Quiet
LedMode LED mode N/A N/A
• 2—Awake
• 3—Always-on
• 4— Inherit

AP/RadioOfManualAP
This table contains radio information of manual AP.

XML structure
<AP>
<RadioOfManualAP>
<Radio>
<ApName></ApName>
<RadioID></RadioID>
<Mode></Mode>
<Bandwidth></Bandwidth>
<Status></Status>
<RateMulticast></RateMulticast>
<RateMandatory></RateMandatory>
<RateSupported></RateSupported>
<RateDisabled></RateDisabled>
<Preamble></Preamble>
<BeaconInterval></BeaconInterval>
<PowerLock></PowerLock>
<Distance></Distance>
<MaxRxDuration></MaxRxDuration>
<FragmentThreshold></FragmentThreshold>
<LongRetryThreshold></LongRetryThreshold>
<ProtectionThreshold></ProtectionThreshold>
<ShortRetryThreshold></ShortRetryThreshold>
<CfgChannel></CfgChannel>
<CfgMaxPower></CfgMaxPower>
<CfgMaxPowerPercent></CfgMaxPowerPercent>
</Radio>
</RadioOfManualAP>
</AP>

6
Table description
Item Description
Feature name AP
Table name RadioOfManualAP
Table type Multi-instance table
Row name Radio
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode. N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth. N/A N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M
Enumeration:
• 0—Disable
Status Radio status N/A N/A
• 1—Enable
• 2—Inherit

7
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
The value can have
• 7—12Mbps multi-selections.
RateMultica
Multicast rate. N/A • 8—18Mbps List of enumeration,
st separated by comma
• 9—24Mbps
Example: 1, 2.
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
• 13—auto
If this column is not
configured, the multicast
rate will be calculated
automatically.
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
The value can have
• 5—9Mbps multi-selections.
RateMandat
Mandatory rate. N/A • 6—11Mbps List of enumeration,
ory separated by comma
• 7—12Mbps
Example: 1, 2.
• 8—18Mbps
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps

8
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateSupport
Supported rate. N/A • 6—11Mbps rate uses.
ed List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateDisable
Disabled rate. N/A • 6—11Mbps rate uses.
d List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Boolean:
• true—Short. N/A
Preamble Preamble. N/A • false—Long.
The column is only for
2.4GHz radio mode.

Unsigned short.
BeaconInter Beacon Interval The value range is
N/A N/A
val time. 32~8191.
Unit: TU. 1TU = 1024ms
Enumeration:
• 0—Disable
PowerLock Lock the power. N/A N/A
• 1—Enable
• 2—Inherit

9
Column Column Column Data type and
Remarks
name description type restrictions
ChanneAuto Lock the channel N/A Boolean: When the value is true,
Lock • true—ChanneAutoLoc the radio automatically
k. selects an optimal
channel, and then locks
• false—ChanneAuto the channel.
UnLock.
When the AC detects
The default value is true.
any radar signals on its
channel, it immediately
selects another channel
(even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
The distance that
Distance N/A The value range is 1~40. N/A
Radio can cover.
Unit: km(kilometre).
Unsigned integer.
Max Reveived The value range is
MaxRxDurat
frame duration N/A 500~250000. N/A
ion
tim.
Unit: ms(millisecond).
Unsigned short.
The value range is
FragmentTh Fragment
N/A 256~2346. And the value N/A
reshold threshold.
must be an even number.
Unit: byte.
Unsigned short.
LongRetryT Long retry
N/A The value range is 1~15. N/A
hreshold threshold.
Unit: null.
N/A Unsigned short.
ProtectionT Protection
The value range is 0~2346. N/A
hreshold threshold.
Unit: byte.
Unsigned short.
ShortRetryT Short retry
N/A The value range is 1~15. N/A
hreshold threshold.
Unit: null.
When the value is true,
the radio automatically
Unsigned short. selects an optimal
The value range conforms channel, and then locks
to the channel.
Configured “AP/ChannelDB/Supported When the AC detects
CfgChannel N/A
channel number. ChannelList” column. If this any radar signals on its
column is not configured, channel, it immediately
the channel number will be selects another channel
calculated automatically. (even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
Value range: 1 to
CfgMaxPow Configured
N/A “AP/PowerDB/ValidMaxPo N/A
er maximum power
wer”.
Unit: dBm

10
 Column Column Column Data type and
Remarks
name description type restrictions
• When both
CfgMaxPower and
CfgMaxPowerPerce
nt are configured,
CfgMaxPowerPerce
Unsigned short. nt has higher
Configured priority.
CfgMaxPow
maximum power N/A Value range: 1 to 10.
erPercent • Value 1 represents
in percentage Unit: null. 10%, 2 represents
20%, etc.
The Remove operation
will set the value of this
parameter to 10 by
default.

AP/PrvsOfManualAP
This table contains provision information of manual AP.

XML structure
<AP>
<PrvsOfManualAP>
<Prvs>
<ApName></ApName>
<ACHostName></ACHostName>
<ACIPv4></ACIPv4>
<ACIPv6></ACIPv6>
<DnsDomain></DnsDomain>
<DnsServerIPv4></DnsServerIPv4>
<DnsServerIPv6></DnsServerIPv6>
<GatewayIPv4></GatewayIPv4>
<GatewayIPv6></GatewayIPv6>
<IPv4Address></IPv4Address>
<IPv6Address></IPv6Address>
<Dot1xSupplAnonyIdent></Dot1xSupplAnonyIdent>
<Dot1xSupplEapMethod></Dot1xSupplEapMethod>
<Dot1xSupplEnable></Dot1xSupplEnable>
<Dot1xSupplPasswdCiper></Dot1xSupplPasswdCiper>
<Dot1xSupplPasswdSimple></Dot1xSupplPasswdSimple>
<Dot1xSupplUsername></Dot1xSupplUsername>
</Prvs>
</PrvsOfManualAP>
</AP>

11
Table description
Item Description
Feature name AP
Table name PrvsOfManualAP
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name Index
Length: 1 to 64 characters.
String.
ACHostNam Specify an AC by
N/A Length: 1 to 253 N/A
e its hostname.
characters.
List of string, dotted
Specify an AC by Example: 1.1.1.1,
ACIPv4 N/A decimal notation,
its IPv4 address. 1.1.1.2.
Separated by comma.
Specify an AC by List of hexadecimal string,
Example:
ACIPv6 its IPv6 address. N/A colon-separated,
1:1::1:1,1:1::1:2.
Separated by comma.
Specify the String.
DnsDomain domain name N/A Length: 1 to 253. N/A
suffix.
Specify a DNS String, dotted decimal
DnsServerI
server by its IPv4 N/A notation. Example: 1.1.1.1.
Pv4
address.
Specify a DNS Hexadecimal string,
DnsServerI
server by its IPv6 N/A colon-separated. Example: 1:1::1:1.
Pv6
address.
Specify a gateway
GatewayIPv String, dotted decimal
by its IPv4 N/A Example: 1.1.1.1.
4 notation.
address.
Specify a gateway
GatewayIPv Hexadecimal string,
by its IPv6 N/A Example: 1:1::1:1.
6 colon-separated.
address
Specify an IP String, dotted decimal
address that the notation.
IPv4Addres
AP uses to N/A Example: 1.1.1.1.
s
establish a
CAPWAP tunnel.

12
 Column Column Column Data type and
Remarks
name description type restrictions
Specify an IPv6
address that the
IPv6Addres Hexadecimal string,
AP uses to N/A Example: 1:1::1:1.
s colon-separated.
establish a
CAPWAP tunnel.
Specify an String.
Dot1xSuppl anonymous Length: 1 to 253
N/A N/A
AnonyIdent identifier for the characters.
supplicant.
Enumeration:
• 1—md5
Specify an EAP • 2—peap-gtc
Dot1xSuppl
authentication N/A N/A
EapMethod
method. • 3—peap-mschapv2
• 4—ttls-gtc
• 5—ttls-mschapv2
Boolean:
Dot1xSuppl Enable the 802.1X
Enable supplicant feature.
N/A • true—Enable. N/A
• false—Disable.
Specify a String.
Dot1xSuppl
ciphertext Length: 1 to 201
PasswdCipe N/A N/A
password for the characters.
r
802.1X supplicant.
Dot1xSuppl Specify a plaintext String.
PasswdSim password for the N/A Length: 1 to 127 N/A
ple 802.1X supplicant. characters.
Specify a String.
Dot1xSuppl username for the N/A Length: 1 to 253 N/A
Username 802.1X supplicant. characters.

AP/PrvsOfManualAPACIPv4
This table contains provision information of manual AP of IPv4 address.

XML structure
<AP>
<PrvsOfManualAPACIPv4>
<Prvs>
<ApName></ApName>
<ACIPv4></ACIPv4>
</Prvs>
</PrvsOfManualAPACIPv4>
</AP>

13
Table description
Item Description
Feature name AP
Table name PrvsOfManualAPACIPv4
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name Index N/A
Length: 1 to 64 characters.
Specify an AC by String, dotted decimal
ACIPv4 N/A Example: 1.1.1.1.
its IPv4 address. notation.

AP/PrvsOfManualAPACIPv6
This table contains provision information of manual AP of IPv6 address.

XML structure
<AP>
<PrvsOfManualAPACIPv6>
<Prvs>
<ApName></ApName>
<ACIPv6></ACIPv6>
</Prvs>
</PrvsOfManualAPACIPv6>
</AP>

Table description
Item Description
Feature name AP
Table name PrvsOfManualAPACIPv6
Table type Multi-instance table
Row name Prvs
Restrictions None

14
 Item Description
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName ApName Index N/A
Length: 1 to 64 characters.
Example: 1.1.1.1.
Specify an AC by Hexadecimal string, This column is available
ACIPv6 N/A
its IPv6 address. colon-separated. when the SrcAny column
is false.

AP/EdcaRadio
This table contains radio EDCA information.

XML structure
<AP>
<EdcaRadio>
<EdcaPara>
<ApName></ApName>
<RadioID></RadioID>
<AccessCategory></AccessCategory>
<Noack></Noack>
<CfgAifsn></CfgAifsn>
<CfgEcwmin></CfgEcwmin>
<CfgEcwmax></CfgEcwmax>
<CfgTxOpLimit></CfgTxOpLimit>
</EdcaPara>
</EdcaRadio>
</AP>

Table description
Item Description
Feature name AP
Table name EdcaRadio
Table type Multi-instance table
Row name EdcaPara
Restrictions None
Support for row creation and deletion No

15
Columns
Column Column
Column description Data type and restrictions Remarks
name type
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
A label for the common set
of enhanced distributed Enumeration:
channel access
• 0—BK.
parameters that are used by
AccessCategory
a WMM STA to conten d for
Index • 1—BE. N/A
the channel in order to • 2—VI.
transmit MSDUs with • 3—VO.
certain priorities.
Boolean:
Whehter acknowledgement is • true—Not required. N/A
Noack N/A
required. • false—Required.
The default value is false.
ArbitrationInter Frame The value range conforms to
CfgAifsn N/A N/A
Spacing Number. “AP/RadiolDB/Aifsn” column.
The value range conforms to
CfgEcwmin Exponent form of CWmin. N/A “AP/RadiolDB/Ecwmin” N/A
column.
The value range conforms to
CfgEcwmax Exponent form of CWmax. N/A “AP/RadiolDB/Ecwmax” N/A
column.
The value range conforms to
Transmission oppurtunity
CfgTxOpLimit N/A “AP/RadiolDB/TxOpLimit” N/A
limit.
column.

AP/RadioWmm
This table contains radio WMM information.

XML structure
<AP>
<RadioWmm>
<Wmm>
<ApName></ApName>
<RadioID></RadioID>
<Status></Status>
</Wmm>
</RadioWmm>
</AP>

16
Table description
Item Description
Feature name AP
Table name RadioWmm
Table type Multi-instance table
Row name Wmm
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length:1to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Boolean:
WMM status of • true—Enable. N/A
Status N/A
radio. • false—Disable.
The default value is true.

AP/Radio11n
This table contains radio 802.11n information.

XML structure
<AP>
<Radio11n>
<Dot11n>
<ApName></ApName>
<RadioID></RadioID>
<MCSMulticast></MCSMulticast>
<MCSMandatory></MCSMandatory>
<MCSSupported></MCSSupported>
<Ampdu></Ampdu>
<Amsdu></Amsdu>
<ShortGI></ShortGI>
<Stbc></Stbc>
<Ldpc></Ldpc>

17
 <Mimo></Mimo>
<Greenap></Greenap>
<SmartAntenna></SmartAntenna>
<SmartAntennaPolicy></SmartAntennaPolicy>
<Protection></Protection>
<Client11nOnly></Client11nOnly>
<BandwidthAutoswitch></BandwidthAutoswitch >
</Dot11n>
</Radio11n>
</AP>

Table description
Item Description
Feature name AP
Table name Radio11n
Table type Multi-instance table
Row name Dot11n
Restrictions The table is only for 802.11n and 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Unsigned short. The MCSMulticast must
MCSMultica The index for Value range: 0 to 76, and be smaller than or equal
N/A to the MCSMandatory.
st multicast MCS. 255.
Default value is 255.
The MCSMandatory
Unsigned short. must be smaller than or
The maximum equal to the
MCSMandat Value range: 0 to 76, and
index for N/A MCSSupported, and the
ory 255.
mandatory MCS. MCSMandatory must be
Default value is 255. greater than or equal to
the MCSMulticast.
Unsigned short. The MCSSupported
The maximum
MCSSuppor Value range: 0 to 76, and must be greater than or
index for N/A
ted 255. equal to the
supported MCS.
Default value is 255. MCSMandatory.

18
Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
Ampdu A-mpdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Amsdu A-msdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
ShortGI Short GI function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Stbc STBC function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Ldpc LDPC function. N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 1: 1X1
Mimo MIMO. N/A • 2: 2X2 N/A
• 3: 3X3
• 4: 4X4
Boolean:
Greenap Green ap function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
SmartAnten Smart antenna
na function.
N/A • true—Enable. N/A
• false—Disable.
Enumeration: Effective only when
SmartAntenna is
SmartAnten Smart antenna • 1: Auto
N/A enabled.
naPolicy policy. • 2: High-availability
• 3: High-throughput

802.11n Boolean:
Protection protection N/A • true—Enable. N/A
function. • false—Disable.
Boolean:
Client11nOn Client dot11n only
N/A • true—Enable. N/A
ly function.
• false—Disable.
Boolean:
• true—Enable. N/A
BandwidthA
Bandwidth • false—Disable.
autoswitch N/A
utoswitch The column is only for
function.
2.4GHz radio mode, and
AP/RadioOfManualAP/Ban
dwidth must be 2..

19
AP/Radio11ac
This table contains radio 802.11ac information.

XML structure
<AP>
<Radio11ac>
<Dot11ac>
<ApName></ApName>
<RadioID></RadioID>
<VHTNSSMulticast></VHTNSSMulticast>
<VHTMCSMulticast></VHTMCSMulticast>
<VHTNSSMandatory></VHTNSSMandatory>
<VHTNSSSupported></VHTNSSSupported>
<Client11acOnly></Client11acOnly>
</Dot11ac>
</Radio11ac>
</AP>

Table description
Item Description
Feature name AP
Table name Radio11ac
Table type Multi-instance table
Row name Dot11ac
Restrictions The table is only for 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Unsigned short. The VHTNSSMulticast
The NSS for
VHTNSSMu Value range: 0 to 8. must be smaller than or
multicast N/A
lticast equal to the
VHT-MCS Default value is 0. VHTNSSMandatory.

20
 Column Column Column Data type and
Remarks
name description type restrictions
The index for Unsigned short.
VHTMCSMu
multicast N/A Value range: 0 to 9, 255. N/A
lticast
VHT-MCS. Default value is 255.
The VHTNSSMandatory
must be smaller than or
The maximum Unsigned short. equal to the
VHTNSSMa NSS for VHTNSSSupported, and
N/A Value range: 0 to 8.
ndatory mandatory the VHTNSSMandatory
VHT-MCS Default value is 0. must be greater than or
equal to the
VHTNSSMulticast.
Unsigned short. The VHTNSSSupported
The maximum
VHTNSSSu Value range: 0 to 8. must be greater than or
NSS for supported N/A
pported equal to the
VHT-MCS. Default value is 0. VHTNSSMandatory.
Boolean:
Client11acO Client dot11ac
N/A • true—Enable. N/A
nly only function.
• false—Disable.

AP/APGroup
This table contains information of AP groups.

XML structure
<AP>
<APGroup>
<Group>
<Name></Name>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
<ProvisionAutoUpgrade></ProvisionAutoUpgrade>
<ProvisionAutoRecover></ProvisionAutoRecover>
<LedMode></LedMode>

21
 </Group>
</APGroup>
</AP>

Table description
Item Description
Feature name AP
Table name APGroup
Table type Multi-instance table
Row name Group
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
Name AP group name. Index N/A
Length: 1 to 31 characters.
Region code of Unsigned short. Conform to ISO 3166
ApName N/A
AP group. stantard.
Boolean:
Whether the
region code of the • true—Support. N/A
RegionLock N/A
AP group is • false—Not support.
locked.
Default value is false.
AP connection Unsigned short.
Priority priority N/A N/A
Value range: 0 to 7.
Whether the AP in Boolean:
this group will be
• true: Switch N/A
forced to switch
Preempt N/A • false: Not switch
the backup tunnel
to active by Default value is false.
priority.
Unsigned short.
The transmit Value range: 0, 5 to 255.
EchoInterval interval of tunnel N/A Unit: seconds N/A
echo messages.
Default value is 10
seconds.
The allowed
maximum number
of echo messges Unsigned short.
which are not
EchoCount N/A Value range: 1 to 20. N/A
received. If the
count is reached, Default value is 3.
the tunnel will be
down.

22
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned short.
The interval to Value range: 1 to 30.
RetransInter
retransmit a N/A N/A
val Unit: seconds
request message.
Default value is 5 seconds.
The allowed
maximum number Unsigned short.
of retransmission Value range: 1 to 20.
RetransCou
attempts. If the N/A N/A
nt Unit: seconds
count is reached,
the tunnel will be Default value is 6.
down.
Unsigned short.
The interval of AP
sending the Value range: 0 to 240.
StatisInterva
statistics N/A Unit: seconds N/A
l
informations to
AC. Default value is 50
seconds.
Whether the AC Boolean:
will upgrade AP’s
• true—Enable N/A
FirmwareUp firmware
N/A
grade automatically if the • false—Disable
software is Default value is disable.
mismatch.
BackupACI The IPv4 backup String, dotted decimal
N/A Example: 1.1.1.1.
Pv4 AC address. notation.
BackupACI The IPv6 backup Hexadecimal string,
N/A Example: 1:1::1:1.
Pv6 AC address. colon-separated.
Which location the String, lowercase.
LocationNa
AP group belongs N/A Length: 1 to 31 characters. N/A
me
to.

The description of String,

Description N/A N/A
APGroup. Length: 1 to 64 cahracters
Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable
Boolean:
Whether to enable
ProvisionAut
oUpgrade
provision N/A • true—Enable N/A
auto-upgrade
• false—Disable
Boolean:
Whether to enable
ProvisionAut
oRecover
provision N/A • true—Enable N/A
auto-recover
• false—Disable
Enumeration:
• 0—Normal
LedMode LED mode N/A • 1—Quiet N/A
• 2—Awake
• 3—Always-on

23
AP/APGroupMACRule
This table contains information of AP groups’ rules of MAC address.

XML structure
<AP>
<APGroupMACRule>
<Rule>
<GroupName></GroupName>
<MacAddress></MacAddress>
</Rule>
</APGroupMACRule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupMACRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
Six groups of two
Example:
MacAddress AP MAC address. Index hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.

AP/APGroupSerialIDRule
This table contains information of AP groups’ rules of serial ID.

XML structure
<AP>
<APGroupSerialIDRule>
<Rule>

24
 <GroupName></GroupName>
<SerialID></SerialID>
<Rule>
</APGroupSerialIDRule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupSerialIDRule
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, uppercase.
SerialID AP serial ID Index Length: 1 to 127 N/A
characters.

AP/APGroupNameRule
This table contains information of AP groups’ rules of AP name.

XML structure
<AP>
<APGroupNameRule>
<Rule>
<GroupName></GroupName>
<APName></APName>
<Rule>
</APGroupNameRule>
</AP>

25
Table description
Item Description
Feature name AP
Table name APGroupNameRule
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, case-sensitive.
APName AP name. Index N/A
Length: 1 to 64 characters.

AP/APGroupIPv4Rule
This table contains information of AP groups’ rules of IPv4 address range.

XML structure
<AP>
<APGroupIPv4Rule>
<Rule>
<GroupName></GroupName>
<IPv4Addr></IPv4Addr>
<IPv4Wildcard></IPv4Wildcard>
<Rule>
</APGroupIPv4Rule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupIPv4Rule
Table type Multi-instance table
Row name Rule

26
 Item Description
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
IPv4 address of String, dotted decimal
IPv4Addr Index Example: 1.1.1.1.
AP. notation.
Wildcard mask for
IPv4Wildcar String, dotted decimal
the IPv4 address Index Example: 255.255.255.0.
d notation.
of AP.

AP/APGroupIPv6Rule
This table contains information of AP groups’ rules of IPv6 address range.

XML structure
<AP>
<APGroupIPv6Rule>
<Rule>
<GroupName></GroupName>
<IPv6Addr></IPv6Addr>
<IPv6Wildcard></IPv6Wildcard>
<Rule>
</APGroupIPv6Rule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupIPv6Rule
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation
Yes
and deletion

27
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
Example: 1:1::1:1.
Source IPv6 Hexadecimal string, This column is available
IPv6Addr Index
address. colon-separated. when the SrcAny column
is false.
Length of the Unsigned integer. This column is available
IPv6Wildcar
source IPv6 Index when the SrcAny column
d Value range: 1 to 128.
address prefix. is false.

AP/APGroupModel
This table contains information of AP group models.

XML structure
<AP>
<APGroupModel>
<Model>
<GroupName></GroupName>
<ModelName></ModelName>
</Model>
</APGroupModel>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupModel
Table type Multi-instance table
Row name Model
Restrictions None
Support for row creation
Yes
and deletion

28
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.

AP/APGroupRadio
This table contains information of AP group radios.

XML structure
<AP>
<APGroupRadio>
<Radio>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<Mode></Mode>
<Bandwidth></Bandwidth>
<Spectrum></Spectrum>
<Status></Status>
<RateMulticast></RateMulticast>
<RateMandatory></RateMandatory>
<RateSupported></RateSupported>
<RateDisabled></RateDisabled>
<Preamble></Preamble>
<BeaconInterval></BeaconInterval>
<PowerLock></PowerLock>
<ChannelAutoLock></ChannelAutoLock>
<Distance></Distance>
<MaxRxDuration></MaxRxDuration>
<FragmentThreshold></FragmentThreshold>
<LongRetryThreshold></LongRetryThreshold>
<ProtectionThreshold></ProtectionThreshold>
<ShortRetryThreshold></ShortRetryThreshold>
<CfgChannel></CfgChannel>
<CfgMaxPower></CfgMaxPower>
</Radio>
</APGroupRadio>
</AP>

29
Table description
Item Description
Feature name AP
Table name APGroupRadio
Table type Multi-instance table
Row name Radio
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode. N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Enumeration:
• 1—20M
• 2—40M
• 3—80M
• 4—160M
• 5—80M + 80M
Bandwidth Radio bandwidth. N/A • 17—5M N/A
• 18—10M
Default value is 1 when the
Mode is 1、2、3、4、6.
Default value is 2 when the
Mode is 5.
Defautl value is 3 when the
Mode is 7.

30
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—Support both
Supported radio 5GHz and 2.4GHz
Spectrum N/A N/A
spectrum. • 2—Support 5GHz only
• 3—Support 2.4GHz
only
Enumeration:
• 0—Disable
Status Radio status. N/A N/A
• 1—Enable
• 2—Inherit
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps The value can have
multi-selections.
RateMultica • 8—18Mbps
Multicast rate. N/A List of enumeration,
st • 9—24Mbps separated by comma
• 10—36Mbps Example: 1, 2.
• 11—48Mbps
• 12—54Mbps
• 13—auto
If this column is not
configured, the multicast
rate will be calculated
automatically.
Default value: auto

31
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps
• 8—18Mbps The value can have
multi-selections.
RateMandat
Mandatory rate. N/A • 9—24Mbps List of enumeration,
ory
• 10—36Mbps separated by comma
• 11—48Mbps Example: 1, 2.
• 12—54Mbps
Default value:
A. 1, 2Mbps(802.11b).
B. 6, 12,
24Mbps(802.11a/802.1
1an)
C. 1, 2, 5.5,
11Mbps(802.11g/802.1
1gn)
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps The value can have
• 8—18Mbps multi-selections, exclude
the one which multicast
RateSupport
Supported rate. N/A • 9—24Mbps rate uses.
ed
• 10—36Mbps List of enumeration,
separated by comma
• 11—48Mbps
Example: 1, 2.
• 12—54Mbps
Default value:
A. 5.5, 11Mbps(802.11b)
B. 9, 18, 24, 36, 48,
54Mbps(802.11a/802.1
1an)
C. 6, 9, 12, 18, 24, 36,
54Mbps(802.11g/802.1
1gn)

32
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
• 5—9Mbps multi-selections, exclude
the one which multicast
RateDisable • 6—11Mbps
Disabled rate. N/A rate uses.
d • 7—12Mbps List of enumeration,
• 8—18Mbps separated by comma
Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Default value: null.
Boolean:
• true—Short. N/A
• false—Long.
Preamble Preamble. N/A
The column is only for
2.4GHz radio mode.
Default value: short.

Unsigned short.
The value range is
BeaconInter Beacon Interval 32~8191.
N/A N/A
val time.
Unit: TU. 1TU = 1024ms
Default value: 100
Enumeration:
• 0—Disable
PowerLock Lock the power. N/A N/A
• 1—Enable
• 2—Inherit
ChanneAuto Lock the channel N/A Boolean: When the value is true,
Lock • true—ChanneAutoLoc the radio automatically
k. selects an optimal
channel, and then locks
• false—ChanneAuto the channel.
UnLock.
When the AC detects
The default value is true.
any radar signals on its
channel, it immediately
selects another channel
(even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
The distance that The value range is 1~40.
Distance N/A N/A
Radio can cover. Unit: km(kilometre).
Default value: 1

33
 Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
Max Reveived The value range is
MaxRxDurat 500~250000.
frame duration N/A N/A
ion
time. Unit: ms.
Default value: 2000
Unsigned short.
The value range is
FragmentTh Fragment 256~2346. And the value
N/A must be an even number. N/A
reshold threshold.
Unit: byte.
Default value: 2346
Unsigned short.
LongRetryT Long retry The value range is 1~15.
N/A N/A
hreshold threshold. Unit: null.
Default value: 4
Unsigned short.
ProtectionT Protection The value range is 0~2346.
N/A N/A
hreshold threshold. Unit: byte.
Default value: 2346
Unsigned short.
ShortRetryT Short retry The value range is 1~15.
N/A N/A
hreshold threshold. Unit: null.
Default value: 7
Unsigned short.
The value range conforms
to
Configured “AP/ChannelDB/Supported
CfgChannel N/A N/A
channel number. ChannelList” column. If this
column is set to zero, the
channel number will be
calculated automatically.
Unsigned short.
Value range: 1 to
CfgMaxPow Configured
N/A “AP/PowerDB/ValidMaxPo N/A
er maximum power.
wer”.
Unit: dBm

AP/APGroupRadio11n
This table contains 802.11n information of AP group radios.

XML structure
<AP>
<APGroupRadio11n>
<Radio11n>

34
 <GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<MCSMulticast></MCSMulticast>
<MCSMandatory></MCSMandatory>
<MCSSupported></MCSSupported>
<Ampdu></Ampdu>
<Amsdu></Amsdu>
<ShortGI></ShortGI>
<Stbc></Stbc>
<Ldpc></Ldpc>
<Mimo></Mimo>
<Greenap></Greenap>
<SmartAntenna></SmartAntenna>
<SmartAntennaPolicy></SmartAntennaPolicy>
<Protection></Protection>
<Client11nOnly></Client11nOnly>
<BandwidthAutoswitch></ BandwidthAutoswitch >
</Radio11n>
</APGroupRadio11n>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupRadio11n
Table type Multi-instance table
Row name Radio11n
Restrictions The table is only for 802.11n and 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.

35
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned short.
The MCSMulticast must
MCSMultica The index for Value range: 0 to 76, and
N/A be smaller than or equal
st multicast MCS. 255. to the MCSMandatory.
Default value is 255.
The MCSMandatory
Unsigned short. must be smaller than or
The maximum equal to the
MCSMandat Value range: 0 to 76, and
index for N/A MCSSupported, and the
ory 255.
mandatory MCS. MCSMandatory must be
Default value is 255. greater than or equal to
the MCSMulticast.
Unsigned short. The MCSSupported
The maximum must be greater than or
MCSSuppor Value range: 0 to 76, and
index for N/A equal to the
ted 255.
supported MCS. MCSMandatory.
Default value is 76.
Boolean:
Ampdu A-mpdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Amsdu A-msdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
ShortGI Short GI function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Stbc STBC function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Ldpc LDPC function. N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 1: 1X1
Mimo MIMO. N/A • 2: 2X2 N/A
• 3: 3X3
• 4: 4X4
Boolean:
Greenap Green ap function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
SmartAnten Smart antenna
na function.
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
Effective only when
SmartAnten Smart antenna • 1: Auto
N/A SmartAntenna is
naPolicy policy. • 2: High-availability enabled.
• 3: High-throughput

36
 Column Column Column Data type and
Remarks
name description type restrictions
802.11n Boolean:
Protection protection N/A • true—Enable. N/A
function. • false—Disable.
Boolean:
Client11nOn Client dot11n only
ly function.
N/A • true—Enable. N/A
• false—Disable.
Boolean:
• true—Enable. N/A
BandwidthA
Bandwidth • false—Disable.
autoswitch N/A
utoswitch The column is only for
function.
2.4GHz radio mode, and
AP/APGroupRadio/Bandwi
dth must be 2.

AP/APGroupRadio11ac
This table contains 802.11ac information of AP group radios.

XML structure
<AP>
<APGroupRadio11ac>
<Radio11ac>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<VHTNSSMulticast></VHTNSSMulticast>
<VHTMCSMulticast></VHTMCSMulticast>
<VHTNSSMandatory></VHTNSSMandatory>
<VHTNSSSupported></VHTNSSSupported>
<Client11acOnly></Client11acOnly>
</Radio11ac>
</APGroupRadio11ac>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupRadio11ac
Table type Multi-instance table
Row name Radio11ac
Restrictions The table is only for 802.11ac radio mode.

37
 Item Description
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Unsigned short. The VHTNSSMulticast
The NSS for
VHTNSSMu Value range: 0 to 8. must be smaller than or
multicast N/A
lticast equal to the
VHT-MCS. Default value is 0. VHTNSSMandatory.

The index for Unsigned short.

VHTMCSMu
multicast N/A Value range: 0 to 9, 255. N/A
lticast
VHT-MCS. Default value is 255.
The VHTNSSMandatory
must be smaller than or
The maximum Unsigned short. equal to the
VHTNSSMa NSS for VHTNSSSupported, and
N/A Value range: 0 to 8.
ndatory mandatory the VHTNSSMandatory
VHT-MCS. Default value is 0. must be greater than or
equal to the
VHTNSSMulticast.
Unsigned short. The VHTNSSSupported
The maximum
VHTNSSSu Value range: 0 to 8. must be greater than or
NSS for supported N/A
pported equal to the
VHT-MCS. Default value is 8. VHTNSSMandatory.
Boolean:
Client11acO Client dot11ac
nly only function.
N/A • true—Enable. N/A
• false—Disable.

AP/APGroupPrvs
This table contains provision information of AP Group.

XML structure
<AP>
<APGroupPrvs>
<Prvs>
<GroupName></GroupName>
<ACHostName></ACHostName>

38
 <ACIPv4></ACIPv4>
<ACIPv6></ACIPv6>
<DnsDomain></DnsDomain>
<DnsServerIPv4></DnsServerIPv4>
<DnsServerIPv6></DnsServerIPv6>
</Prvs>
</APGroupPrvs>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvs
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName GroupName. Index N/A
Length: 1 to 31 characters.
String.
ACHostNam Specify an AC by
N/A Length: 1 to 253 N/A
e its hostname.
characters.
List of string, dotted
Specify an AC by Example: 1.1.1.1,
ACIPv4 N/A decimal notation,
its IPv4 address 1.1.1.2.
Separated by comma.
List of hexadecimal string,
Specify an AC by Example:
ACIPv6 N/A colon-separated,
its IPv6 address 1:1::1:1,1:1::1:2.
Separated by comma.
Specify the String.
DnsDomain domain name N/A N/A
suffix. Length: 1 to 253.

Specify a DNS
DnsServerI String, dotted decimal
server by its IPv4 N/A Example: 1.1.1.1.
Pv4 notation.
address.
Specify a DNS
DnsServerI Hexadecimal string,
server by its IPv6 N/A Example: 1:1::1:1.
Pv6 colon-separated.
address.

39
AP/APGroupPrvsACIPv4
This table contains provision information of AP Group of IPv4 address.

XML structure
<AP>
<APGroupPrvsACIPv4>
<Prvs>
<GroupName></GroupName>
<ACIPv4></ACIPv4>
</Prvs>
</APGroupPrvsACIPv4>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvsACIPv4
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
Specify an AC by String, dotted decimal
ACIPv4 N/A Example: 1.1.1.1.
its IPv4 address. notation.

AP/APGroupPrvsACIPv6
This table contains provision information of AP group of IPv6 address.

XML structure
<AP>
<APGroupPrvsACIPv6>
<Prvs>
<GroupName></GroupName>

40
 <ACIPv6></ACIPv6>
</Prvs>
</APGroupPrvsACIPv6>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvsACIPv6
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName GroupName. Index N/A
Length: 1 to 31 characters.
Example: 1:1::1:1.
Specify an AC by Hexadecimal This column is available
ACIPv6 N/A
its IPv6 address. string,colon-separated. when the SrcAny column
is false.

AP/Location
This table contains the informations of locations.

XML structure
<AP>
<Location>
<Location>
<LocationName></LocationName>
</Location>
</Location>
</AP>

Table description
Item Description
Feature name AP

41
 Item Description
Table name Location
Table type Multi-instance table
Row name Location
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
LocationNa String, lowercase.
Location name. Index N/A
me Length: 1 to 31 characters.

AP/APAuthentication
This table contains the informations of AP authentication.

XML structure
<AP>
<APAuthentication>
<Status></Status>
<Method></Method>
<PermitUnauth></PermitUnauth>
<AuthDomain></AuthDomain>
<AclNumber></AclNumber>
<AclName></AclName>
</APAuthentication>
</AP>

Table description
Item Description
Feature name AP
Table name APAuthentication
Table type Single-instance table
Row name N/A
Restrictions None
Support for row creation
No
and deletion

42
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
The status of AP • true—Enable. N/A
Status N/A
authentication. • false—Disable.
Default value is disable.
Enumeration:
• 1—MAC address.
The authentication
Method
method.
N/A • 2—Serial ID. N/A
Default value is MAC
address.
Boolean:
Whether the
PermitUnaut un-authenticated • true—Allowed. N/A
N/A
h AP is allowed to • false—Not allowed.
join the AC.
Default value is allowed.
The ISP domain of String, case-insensitive.
AuthDomain remote AP N/A N/A
authentication. Length: 1 to 24 characters.

The ACL number Unsigned short. This column is

AclNumber of local AP N/A unavailable when the AC
authentication. Value range: 200 to 299. uses an ACL name.
This column is
The ACL name of unavailable when the AC
String, case-sensitive.
AclName local AP N/A uses an ACL number.
authentication. Length: 1 to 64 characters.
The ACL name should
not be “all”.

AP/LocalAC
This table contains local-ac information.

XML structure
<AP>
<LocalAC>
<AC>
<Name></Name>
<Model></Model>
<CfgSerialID></CfgSerialID>
<EchoInterval></EchoInterval>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<FirmwareUpgrade></FirmwareUpgrade>
</AC>
</LocalAC>
</AP>

43
Table description
Item Description
Feature name AP
Table name LocalAC
Table type Multi-instance table
Row name AC
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Data type and
Column name Column description Remarks
type restrictions
String, N/A.
case-sensitive.
Name Local-ac name. Index
Length: 1 to 64
characters.
Characters will be
automatically convert
case.
Refer to AP/ACDB.
This column is
String, mandatory when the
case-insensitive. row is being created.
Model Local-ac model name. N/A This column is not
Length: 1 to 63
characters. writable when the row
is being deleted,
removed.
This column should not
be changed when the
row is being replaced
or merged.
If this column contains
String, uppercase. lowercase character, it
Configured Local-ac
CfgSerialID N/A Length: 1 to 63 will be converted to
serial ID.
characters. uppercase
automatically.
Unsigned short.
The transmit interval of Value range: 0, 5 to
EchoInterval N/A N/A
tunnel echo messages. 255.
Unit: seconds

The interval to Unsigned short.

RetransInterval retransmit a request N/A Value range: 3 to 8 N/A
message. Unit: seconds

44
 Column Data type and
Column name Column description Remarks
type restrictions
The allowed maximum
number of Unsigned short.
retransmission
RetransCount N/A Value range: 2 to 5. N/A
attempts. If the count is
reached, the tunnel will Unit: seconds
be down.
Whether the AC will Boolean:
upgrade AP’s firmware • true—Enable.
FirmwareUpgrade N/A N/A
automatically if the
software is mismatch. • false—Disable.

AP/ContainerTopology
This table contains information about all PoE ports on the container (such as SPM and WT).

XML structure
<AP>
<ContainerTopology>
<Container>
<ContainerName></ContainerName>
<PoePort></PoePort>
<PoeStatus></PoeStatus>
</Container>
</ContainerTopology>
</AP>

Table description
Item Description
Feature name AP
Table name ContainerTopology
Table type Multi-instance table
Row name Container
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContainerNa String, case-sensitive.
Container name Index N/A
me Length: 1 to 64 characters.

45
 Column Column Column Data type and
Remarks
name description type restrictions
Port on the
PoePort Index Unsigned short. See AP/APDB/.
container
Boolean:
PoeStatus PoE port status N/A • true—Enable N/A
• false—Disable

AP/Container
This table contains information about containers.

XML structure
<AP>
<Container>
<AP>
<Name></Name>
<Model></Model>
<CfgMacAddress></CfgMacAddress>
</AP>
</Container>
</AP>

Table description
Item Description
Feature name AP
Table name Container
Table type Multi-instance table
Row name AP
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name Index N/A
Length: 1 to 64 characters.
String, case-insensitive.
Model AP model name N/A N/A
Length: 1 to 63 characters.

46
Column Column Column Data type and
Remarks
name description type restrictions
Six groups of two
CfgMacAddr Configured AP Example:
N/A hexadecimal digits,
ess MAC address 00-0c-af-e3-5d-c0.
hyphen-separated.

47
Contents
AP ································································································1
AP/APSummary ························································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
AP/GlobalCfg ···························································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 8
AP/ManualAP ························································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
AP/APRunningCfg···················································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
AP/RunAP ······························································································································ 15
XML structure ··················································································································· 15
Table description ··············································································································· 16
Columns ·························································································································· 17
AP/APHistory ·························································································································· 19
XML structure ··················································································································· 19
Table description ··············································································································· 19
Columns ·························································································································· 20
AP/RadioOfManualAP··············································································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 21
Columns ·························································································································· 21
AP/RadioRunningCfg ················································································································ 26
XML structure ··················································································································· 26
Table description ··············································································································· 26
Columns ·························································································································· 27
AP/Radio11n ·························································································································· 31
XML structure ··················································································································· 31
Table description ··············································································································· 32
Columns ·························································································································· 32
AP/Radio11ac ························································································································· 34
XML structure ··················································································································· 34
Table description ··············································································································· 34
Columns ·························································································································· 34
AP/RadioRunningCfg11n ··········································································································· 35
XML structure ··················································································································· 35
Table description ··············································································································· 36
Columns ·························································································································· 36
AP/RadioRunningCfg11ac ········································································································· 37
XML structure ··················································································································· 37
Table description ··············································································································· 38
Columns ·························································································································· 38
AP/RadioOfRunAP ··················································································································· 39
XML structure ··················································································································· 39
Table description ··············································································································· 39
Columns ·························································································································· 40
AP/PrvsOfManualAP ················································································································ 41
XML structure ··················································································································· 41
Table description ··············································································································· 41
Columns ·························································································································· 42

1
AP/PrvsOfManualAPACIPv4 ······································································································ 43
XML structure ··················································································································· 43
Table description ··············································································································· 43
Columns ·························································································································· 44
AP/PrvsOfManualAPACIPv6 ······································································································ 44
XML structure ··················································································································· 44
Table description ··············································································································· 44
Columns ·························································································································· 45
AP/APDB ······························································································································· 45
XML structure ··················································································································· 45
Table description ··············································································································· 45
Columns ·························································································································· 46
AP/APDBVersion ····················································································································· 46
XML structure ··················································································································· 46
Table description ··············································································································· 46
Columns ·························································································································· 47
AP/RadioDB ··························································································································· 47
XML structure ··················································································································· 47
Table description ··············································································································· 48
Columns ·························································································································· 48
AP/RegionDB ·························································································································· 51
XML structure ··················································································································· 51
Table description ··············································································································· 51
Columns ·························································································································· 51
AP/AntennaDB ························································································································ 52
XML structure ··················································································································· 52
Table description ··············································································································· 52
Columns ·························································································································· 52
AP/ChannelTypeMap ················································································································ 53
XML structure ··················································································································· 53
Table description ··············································································································· 53
Columns ·························································································································· 53
AP/PowerIndex ······················································································································· 56
XML structure ··················································································································· 56
Table description ··············································································································· 56
Columns ·························································································································· 57
AP/ChannelDB ························································································································ 58
XML structure ··················································································································· 58
Table description ··············································································································· 59
Columns ·························································································································· 59
AP/PowerDB ··························································································································· 61
XML structure ··················································································································· 61
Table description ··············································································································· 61
Columns ·························································································································· 62
AP/ChannelReport ··················································································································· 64
XML structure ··················································································································· 64
Table description ··············································································································· 65
Columns ·························································································································· 65
AP/NeighborAPReport ·············································································································· 66
XML structure ··················································································································· 66
Table description ··············································································································· 66
Columns ·························································································································· 67
AP/EdcaRadio ························································································································· 67
XML structure ··················································································································· 67
Table description ··············································································································· 68
Columns ·························································································································· 68
AP/RadioWmm ························································································································ 69
XML structure ··················································································································· 69
Table description ··············································································································· 69
Columns ·························································································································· 70
AP/APGroup ··························································································································· 70
XML structure ··················································································································· 70

2
 Table description ··············································································································· 71
Columns ·························································································································· 71
AP/APGroupMACRule ·············································································································· 72
XML structure ··················································································································· 73
Table description ··············································································································· 73
Columns ·························································································································· 73
AP/APGroupSerialIDRule ·········································································································· 73
XML structure ··················································································································· 73
Table description ··············································································································· 74
Columns ·························································································································· 74
AP/APGroupNameRule ············································································································· 74
XML structure ··················································································································· 74
Table description ··············································································································· 74
Columns ·························································································································· 75
AP/APGroupIPv4Rule ··············································································································· 75
XML structure ··················································································································· 75
Table description ··············································································································· 75
Columns ·························································································································· 75
AP/APGroupIPv6Rule ··············································································································· 76
XML structure ··················································································································· 76
Table description ··············································································································· 76
Columns ·························································································································· 76
AP/APGroupModel ··················································································································· 77
XML structure ··················································································································· 77
Table description ··············································································································· 77
Columns ·························································································································· 77
AP/APGroupRadio ··················································································································· 77
XML structure ··················································································································· 77
Table description ··············································································································· 78
Columns ·························································································································· 79
AP/APGroupRadio11n ·············································································································· 83
XML structure ··················································································································· 83
Table description ··············································································································· 84
Columns ·························································································································· 84
AP/APGroupRadio11ac ············································································································· 85
XML structure ··················································································································· 85
Table description ··············································································································· 86
Columns ·························································································································· 86
AP/APGroupPrvs ····················································································································· 87
XML structure ··················································································································· 87
Table description ··············································································································· 87
Columns ·························································································································· 88
AP/APGroupPrvsACIPv4 ··········································································································· 88
XML structure ··················································································································· 88
Table description ··············································································································· 88
Columns ·························································································································· 89
AP/APGroupPrvsACIPv6 ··········································································································· 89
XML structure ··················································································································· 89
Table description ··············································································································· 89
Columns ·························································································································· 90
AP/APListOfGroup ··················································································································· 90
XML structure ··················································································································· 90
Table description ··············································································································· 90
Columns ·························································································································· 90
AP/Location ···························································································································· 91
XML structure ··················································································································· 91
Table description ··············································································································· 91
Columns ·························································································································· 91
AP/APAuthentication ················································································································ 91
XML structure ··················································································································· 91
Table description ··············································································································· 92
Columns ·························································································································· 92

3
AP/HistorySummary ················································································································· 92
XML structure ··················································································································· 92
Table description ··············································································································· 93
Columns ·························································································································· 93
AP/AllAP ································································································································ 94
XML structure ··················································································································· 94
Table description ··············································································································· 94
Columns ·························································································································· 95
AP/LocalACDB ························································································································ 96
XML structure ··················································································································· 96
Table description ··············································································································· 96
Columns ·························································································································· 96
AP/LocalAC ···························································································································· 96
XML structure ··················································································································· 97
Table description ··············································································································· 97
Columns ·························································································································· 97
AP/ContainerTopology ·············································································································· 98
XML structure ··················································································································· 98
Table description ··············································································································· 99
Columns ·························································································································· 99
AP/Container ·························································································································· 99
XML structure ··················································································································· 99
Table description ············································································································· 100
Columns ························································································································ 100

4
AP
AP/APSummary
This table contains AP global statistics.

XML structure
<AP>
<APSummary>
<ManualApNum></ManualApNum>
<RunApNum></RunApNum>
<OfflineApNum></OfflineApNum>
<UnhealthyApNum></UnhealthyApNum>
<ApGroupNum></ApGroupNum>
<LocationNum></LocationNum>
<NorthIfOutPkt></NorthIfOutPkt>
<NorthIfOutByte></NorthIfOutByte>
<NorthIfInPkt></NorthIfInPkt>
<NorthIfInByte></NorthIfInByte>
<Is5gRadioNum></Is5gRadioNum>
<Is2gRadioNum></Is2gRadioNum>
<AccessModeNum></AccessModeNum>
<SensorModeNum></SensorModeNum>
<HybirdModeNum></HybirdModeNum>
<ChannelBusyLower10PctNum></ChannelBusy10PctNum>
<ChannelBusy10PctNum></ChannelBusy10PctNum>
<ChannelBusy20PctNum></ChannelBusy20PctNum>
<ChannelBusy30PctNum></ChannelBusy30PctNum>
<ChannelBusy40PctNum></ChannelBusy40PctNum>
<ChannelBusy50PctNum></ChannelBusy50PctNum>
<ChannelBusy60PctNum></ChannelBusy60PctNum>
<ChannelBusy70PctNum></ChannelBusy70PctNum>
<ChannelBusy80PctNum></ChannelBusy80PctNum>
<ChannelBusy90PctNum></ChannelBusy90PctNum>
<NoiseFloorLower105Num></NoiseFloorLower105Num>
<NoiseFloor100Num></NoiseFloor100Num>
<NoiseFloor95Num></NoiseFloor95Num>
<NoiseFloor90Num></NoiseFloor90Num>
<NoiseFloor85Num></NoiseFloor85Num>
<NoiseFloor80Num></NoiseFloor80Num>
<NoiseFloor75Num></NoiseFloor75Num>
<NoiseFloor70Num></NoiseFloor70Num>
<NoiseFloorUpper70Num></NoiseFloorUpper70Num>
<Dot11InterfLower10PctNum></Dot11InterfLower10PctNum>
<Dot11Interf10PctNum></Dot11Interf10PctNum>
<Dot11Interf20PctNum></Dot11Interf20PctNum>

1
 <Dot11Interf30PctNum></Dot11Interf30PctNum>
<Dot11Interf40PctNum></Dot11Interf40PctNum>
<Dot11Interf50PctNum></Dot11Interf50PctNum>
<Dot11Interf60PctNum></Dot11Interf60PctNum>
<Dot11Interf70PctNum></Dot11Interf70PctNum>
<Dot11Interf80PctNum></Dot11Interf80PctNum>
<Dot11Interf90PctNum></Dot11Interf90PctNum>
<NonDot11InterfLower10PctNum></NoneDot11InterfLower10PctNum>
<NonDot11Interf10PctNum></NonDot11Interf10PctNum>
<NonDot11Interf20PctNum></NonDot11Interf20PctNum>
<NonDot11Interf30PctNum></NonDot11Interf30PctNum>
<NonDot11Interf40PctNum></NonDot11Interf40PctNum>
<NonDot11Interf50PctNum></NonDot11Interf50PctNum>
<NonDot11Interf60PctNum></NonDot11Interf60PctNum>
<NonDot11Interf70PctNum></NonDot11Interf70PctNum>
<NonDot11Interf80PctNum></NonDot11Interf80PctNum>
<NonDot11Interf90PctNum></NonDot11Interf90PctNum>
<RunSPMNum></RunSPMNum>
<OfflineSPMNum></OfflineSPMNum>
<MaxRunApNum></MaxRunApNum>
<MaxPersistentApNum></MaxPersistentApNum> </APSummary>
</AP>

Table description
Item Description
Feature name AP
Table name APSummary
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Data type and
Column name Column type
description restrictions
Number of manual Unsigned integer.
ManualApNum N/A
APs Value range: 0 to 65535.

Number of running Unsigned integer.

RunApNum N/A
APs Value range: 0 to 65535.
Unsigned integer.
OfflineApNum Number of offline APs N/A
Value range: 0 to 65535.

Number of Unhealthy Unsigned integer.

UnhealthyApNum N/A
APs Value range: 0 to 65535.

2
 Column Data type and
Column name Column type
description restrictions
Unsigned integer.
ApGroupNum Number of AP groups N/A
Value range: 0 to 65535.
Unsigned integer.
LocationNum Number of locations N/A
Value range: 0 to 65535.
Packets count of Unsigned integer.
northbound interface
NorthIfOutPkt N/A Value range: 0 to
with outbound
direction. 4294967295.

Throughput statistics Unsigned integer.

of northbound
NorthIfOutByte N/A Value range: 0 to
interface with
outbound direction. 4294967295.

Packets count of Unsigned integer.

NorthIfInPkt northbound interface N/A Value range: 0 to
with inbound direction. 4294967295.
Throughput statistics Unsigned integer.
of northbound Value range: 0 to
NorthIfInByte N/A
interface with inbound 4294967295.
direction.
Unsigned integer.
Number of radios
Is5gRadioNum N/A Value range: 0 to
which is 5GHz.
4294967295.
Unsigned integer.
Number of radios
Is2.4gRadioNum N/A Value range: 0 to
which is 2.4GHz.
4294967295.
Unsigned integer.
Number of radios in
AccessModeNum N/A Value range: 0 to
access mode.
4294967295.
Unsigned integer.
Number of radios in
SensorModeNum N/A Value range: 0 to
sensor mode.
4294967295.
Unsigned integer.
Number of radios in
HybirdModeNum N/A Value range: 0 to
hybird mode.
4294967295.
Number of radios Unsigned integer.
ChannelBusyLower10PctNum which channel busy is N/A Value range: 0 to
lower than 10% 4294967295.
Number of radios Unsigned integer.
which channel busy is
ChannelBusy10PctNum N/A Value range: 0 to
between 10% and
20% 4294967295.

Number of radios Unsigned integer.

which channel busy is
ChannelBusy20PctNum N/A Value range: 0 to
between 20% and
30% 4294967295.

Number of radios Unsigned integer.

ChannelBusy30PctNum which channel busy is N/A Value range: 0 to
between 30% and 4294967295.

3
 Column Data type and
Column name Column type
description restrictions
40%
Number of radios Unsigned integer.
which channel busy is
ChannelBusy40PctNum N/A Value range: 0 to
between 40% and
50% 4294967295.

Number of radios Unsigned integer.

which channel busy is
ChannelBusy50PctNum N/A Value range: 0 to
between 50% and
60% 4294967295.

Number of radios Unsigned integer.

which channel busy is
ChannelBusy60PctNum N/A Value range: 0 to
between 60% and
70% 4294967295.

Number of radios Unsigned integer.

which channel busy is
ChannelBusy70PctNum N/A Value range: 0 to
between 70% and
80% 4294967295.

Number of radios Unsigned integer.

which channel busy is
ChannelBusy80PctNum N/A Value range: 0 to
between 80% and
90% 4294967295.

Number of radios Unsigned integer.

ChannelBusy90PctNum which channel busy is N/A Value range: 0 to
upper than 90% 4294967295.
Number of radios Unsigned integer.
NoiseFloorLower105Num which noise floor is N/A Value range: 0 to
lower than 105dbm 4294967295.
Number of radios Unsigned integer.
which noise floor is
NoiseFloor100Num N/A Value range: 0 to
between 100dbm and
105dbm 4294967295.

Number of radios Unsigned integer.

which noise floor is
NoiseFloor95Num N/A Value range: 0 to
between 95dbm and
100dbm 4294967295.

Number of radios Unsigned integer.

which noise floor is
NoiseFloor90Num N/A Value range: 0 to
between 90dbm and
95dbm 4294967295.

Number of radios Unsigned integer.

which noise floor is
NoiseFloor85Num N/A Value range: 0 to
between 85dbm and
90dbm 4294967295.

Number of radios Unsigned integer.

which noise floor is
NoiseFloor80Num N/A Value range: 0 to
between 80dbm and
85dbm 4294967295.

Number of radios Unsigned integer.

which noise floor is
NoiseFloor75Num N/A Value range: 0 to
between 75dbm and
80dbm 4294967295.

4
 Column Data type and
Column name Column type
description restrictions
Number of radios Unsigned integer.
which noise floor is
NoiseFloor70Num N/A Value range: 0 to
between 70dbm and
75dbm 4294967295.

Number of radios Unsigned integer.

NoiseFloorUpper70Num which noise floor is N/A Value range: 0 to
upper than 70dbm 4294967295.
Number of radios Unsigned integer.
which 802.11
Dot11InterfLower10PctNum N/A Value range: 0 to
interference is lower
than 10% 4294967295.

Number of radios
which 802.11 Unsigned integer.
Dot11Interf10PctNum interference is N/A Value range: 0 to
between 10% and 4294967295.
20%
Number of radios
which 802.11 Unsigned integer.
Dot11Interf20PctNum interference is N/A Value range: 0 to
between 20% and 4294967295.
30%
Number of radios
which 802.11 Unsigned integer.
Dot11Interf30PctNum interference is N/A Value range: 0 to
between 30% and 4294967295.
40%
Number of radios
which 802.11 Unsigned integer.
Dot11Interf40PctNum interference is N/A Value range: 0 to
between 40% and 4294967295.
50%
Number of radios
which 802.11 Unsigned integer.
Dot11Interf50PctNum interference is N/A Value range: 0 to
between 50% and 4294967295.
60%
Number of radios
which802.11 Unsigned integer.
Dot11Interf60PctNum interference is N/A Value range: 0 to
between 60% and 4294967295.
70%
Number of radios
which802.11 Unsigned integer.
Dot11Interf70PctNum interference is N/A Value range: 0 to
between 70% and 4294967295.
80%
Number of radios
which802.11 Unsigned integer.
Dot11Interf80PctNum interference is N/A Value range: 0 to
between 80% and 4294967295.
90%
Number of radios Unsigned integer.
Dot11Interf90PctNum which802.11 N/A
interference is upper Value range: 0 to

5
 Column Data type and
Column name Column type
description restrictions
than 90% 4294967295.
Number of radios Unsigned integer.
which non-802.11
NonDot11InterfLower10PctNum N/A Value range: 0 to
interference is lower
than 10% 4294967295.

Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf10PctNum interference is N/A Value range: 0 to
between 10% and 4294967295.
20%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf20PctNum interference is N/A Value range: 0 to
between 10% and 4294967295.
20%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf30PctNum interference is N/A Value range: 0 to
between 20% and 4294967295.
30%
NonDot11Interf40PctNum Number of radios Unsigned integer.
which non-802.11 Value range: 0 to
interference is N/A 4294967295.
between 30% and
40%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf50PctNum interference is N/A Value range: 0 to
between 50% and 4294967295.
60%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf60PctNum interference is N/A Value range: 0 to
between 60% and 4294967295.
70%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf70PctNum interference is N/A Value range: 0 to
between 70% and 4294967295.
80%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf80PctNum interference is N/A Value range: 0 to
between 80% and 4294967295.
90%
Number of radios Unsigned integer.
which non-802.11
NonDot11Interf90PctNum N/A Value range: 0 to
interference is upper
than 90% 4294967295.

Number of running Unsigned integer.

RunSPMNum SPMs N/A
Value range: 0 to 65535.
Number of offline Unsigned integer.
OfflineSPMNum SPMs N/A
Value range: 0 to 65535.

6
 Column Data type and
Column name Column type
description restrictions
Max number of Unsigned integer.
MaxRunApNum running APs N/A
Value range: 0 to 65535.
Max number of Unsigned integer.
MaxPersistentApNum persistent APs N/A
Value range: 0 to 65535.

AP/GlobalCfg
This table contains the informations of global.

XML structure
<AP>
<GlobalCfg>
<AutoAp></AutoAp>
<AutoPersistent></AutoPersistent>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<TunnelEncryption></TunnelEncryption>
<MainAPName></MainAPName>
<Gps></Gps>
<LocalAC></LocalAC>
<CentralACIPv4></CentralACIPv4>
<CentralACIPv6></CentralACIPv6>
<ContralAddress></ContralAddress>
<ControlAddressIPv4></ControlAddressIPv4>
<ControlAddressIPv6></ControlAddressIPv6>
</GlobalCfg>
</AP>

Table description
Item Description
Feature name AP

7
 Item Description
Table name GlobalCfg
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Whether an AP Boolean:
can connect the • true—Support. N/A
AutoAp AC without N/A
creating a manual • false—Not support.
AP. Default value is false.

When an auto AP Boolean:

connects the AC , • true—Support. N/A
AutoPersist
whether convert N/A
ent
the AP to manual • false—Not support.
AP automatically. Default value is false.

Region code of Conform to ISO 3166

RegionCode N/A Unsigned short.
AP group. stantard.
Whether the Boolean:
region code of the • true—Support. N/A
RegionLock AC is locked. N/A
• false—Not support.
Default value is false.
AP connection Unsigned short.
Priority priority N/A N/A
Value range: 0 to 7.
Whether the AP in
this group will be Boolean:
forced to switch
Preempt N/A • true: Switch N/A
the backup tunnel
to active by • false: Not switch
priority.
The transmit Unsigned short.
EchoInterval interval of tunnel N/A Value range: 0, 5 to 255. N/A
echo messages.
Unit: seconds
The allowed
maximum number
of echo messges
which are not Unsigned short.
EchoCount N/A N/A
received. If the Value range: 1 to 20.
count is reached,
the tunnel will be
down.
The interval to Unsigned short.
RetransInter retransmit a N/A Value range: 1 to 30. N/A
val request message.
Unit: seconds

8
Column Column Column Data type and
Remarks
name description type restrictions
The allowed
maximum number
of retransmission Unsigned short.
RetransCou
attempts. If the N/A Value range: 1 to 20. N/A
nt
count is reached, Unit: seconds.
the tunnel will be
down.
The interval of AP
sending the Unsigned short.
StatisInterva
statistics N/A Value range: 0 to 240. N/A
l
informations to Unit: seconds.
AC.
Whether the AC
will upgrade AP’s Boolean:
FirmwareUp firmware
grade automatically if the
N/A • true: Enable N/A
software is • false: Disable
mismatch.
BackupACI The IPv4 backup String, dotted decimal
N/A Example: 1.1.1.1.
Pv4 AC address. notation.
BackupACI The IPv6 backup Hexadecimal string,
N/A Example: 1:1::1:1.
Pv6 AC address. colon-separated.
Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable

MainAPNam String, case-sensitive.

AP name. N/A Only for FatAP Type.
e Length: 1 to 64 characters.
Boolean:
Gps Gps. N/A • true—Support. Only for FatAP Type
• false—Not support.
Boolean:
Whether to enable
LocalAC N/A • true—Enable. Only for Local-ac Type
Local ac.
• false—Disable.

CentralACIP The IPv4 Central String, dotted decimal Example: 1.1.1.1.

N/A
v4 AC address. notation. Only for Local-ac Type

CentralACIP The IPv6 Central Hexadecimal string, Example: 1:1::1:1.

N/A
v6 AC address. colon-separated. Only for Local-ac Type

CAPWAP control Boolean:

ControlAddr
ess
address N/A • true—Enable. N/A
configuration. • false—Disable.
Specify an AC
ControlAddr String, dotted decimal
IPv4 address for N/A Example: 1.1.1.1.
essIPv4 notation.
AC rediscovery
Specify an AC
ControlAddr Hexadecimal string,
IPv4 address for N/A Example: 1:1::1:1.
essIPv6 colon-separated.
AC rediscovery

9
AP/ManualAP
This table contains information of manual AP.

XML structure
<AP>
<ManualAP>
<AP>
<Name></Name>
<Model></Model>
<CfgSerialID></CfgSerialID>
<CfgMacAddress></CfgMacAddress>
<RadioNum></RadioNum>
<Status></Status>
<GroupName></GroupName>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
<OfflineTime></OfflineTime>
<OfflineMoment></OfflineMoment>
<ControlAddress></ControlAddress>
<ControlAddressIPv4></ControlAddressIPv4>
<ControlAddressIPv6></ControlAddressIPv6>
<ProvisionAutoUpgrade></ProvisionAutoUpgrade>
<ProvisionAutoRecover></ProvisionAutoRecover>
<ModelType></ModelType>
<LedMode></LedMode>
</AP>
</ManualAP>
</AP>

10
Table description
Item Description
Feature name AP
Table name ManualAP
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name. Index N/A
Length: 1 to 64 characters.
String, case-insensitive.
Model AP model name. N/A N/A
Length: 1 to 63 characters.
String, uppercase.
Configured AP
CfgSerialID N/A Length: 1 to 127 N/A
serial ID.
characters.
Six groups of two
CfgMacAddr Configured AP Example:
N/A hexadecimal digits,
ess MAC address. 00-0c-af-e3-5d-c0.
hyphen-separated.

Number of the Unsigned short.

RadioNum N/A N/A
radio. Value range: 1 to 4.
Enumeration:
• 1—Online
AP associated
Status
status.
N/A • 2—Offline N/A
• 3—Image
downloading
The name of AP String, lowercase.
GroupName group which the N/A N/A
AP belongs to. Length: 1 to 31 characters.

Region code of Conform to ISO 3166

RegionCode N/A Unsigned short.
AP. stantard.

Whether the Boolean:

RegionLock region code of the N/A • true—Support. N/A
AP is locked. • false—Not support.

AP connection Unsigned short.

Priority N/A N/A
priority. Value range: 0 to 7.
Whether the AP
Boolean:
will be forced to
Preempt switch the backup N/A • true: Switch N/A
tunnel to active by
• false: Not switch
priority.

11
Column Column Column Data type and
Remarks
name description type restrictions
The transmit Unsigned short.
EchoInterval interval of tunnel N/A Value range: 0, 5 to 255. N/A
echo messages. Unit: seconds
The allowed
maximum number
of echo messges
which are not Unsigned short.
EchoCount N/A N/A
received. If the Value range: 1 to 20.
count is reached,
the tunnel will be
down.
The interval to Unsigned short.
RetransInter retransmit a N/A Value range: 1 to 30. N/A
val request message.
Unit: seconds.
The allowed
maximum number
of retransmission Unsigned short.
RetransCou
attempts. If the N/A Value range: 1 to 20. N/A
nt
count is reached, Unit: seconds.
the tunnel will be
down.
Unsigned short.
Value range: 0 to 240.
StatisInterva
RetransCount N/A Unit: seconds N/A
l
Default value is 50
seconds.
Whether the AC
will upgrade AP’s Boolean:
FirmwareUp firmware
grade automatically if the
N/A • true—Enable N/A
software is • false—Disable
mismatch.
BackupACI The IPv4 backup String, dotted decimal
N/A Example: 1.1.1.1.
Pv4 AC address. notation.
BackupACI The IPv6 backup Hexadecimal string,
N/A Example: 1:1::1:1.
Pv6 AC address. colon-separated.
Which location the String, lowercase.
LocationNa
AP group belongs N/A Length: 1 to 31 characters. N/A
me
to.

The description of String,

Description N/A N/A
AP. Length: 1 to 64 cahracters.
Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable
Unsigned integer.
The time since the Value range: 0 to
OfflineTime N/A N/A
AP online. 4294967295.
Unit: Second

12
 Column Column Column Data type and
Remarks
name description type restrictions
DateTime.
OfflineMom The time of the AP Example:
N/A Format:
ent offline in last time. 2014-05-07T09:35:07
YYYY-MM-DDTHH:MM:SS

CAPWAP control Boolean:

ControlAddr
ess
address N/A • true—Enable. N/A
configuration • false—Disable.
Specify an AC Example: 1.1.1.1.
ControlAddr String, dotted decimal
IPv4 address for N/A
essIPv4 notation.
AC rediscovery
Specify an AC
ControlAddr Hexadecimal string,
IPv4 address for N/A Example: 1:1::1:1.
essIPv6 colon-separated.
AC rediscovery

Whether to enable Boolean:

ProvisionAut
oUpgrade
provision N/A • true—Enable. N/A
auto-upgrade • false—Disable.

Whether to enable Boolean:

ProvisionAut
oRecover
provision N/A • true—Enable. N/A
auto-recover • false—Disable.
ModelType Model type N/A Enumeration: When the value is 3,
some commands can not
• 1—Normal.
be configurated.
• 2—WT.
• 3—WTU.
Enumeration:
• 0—Normal.
LedMode LED mode N/A • 1—Quiet. N/A
• 2—Awake.
• 3—Always-on.

AP/APRunningCfg
This table contains information of AP running configurations.

XML structure
<AP>
<APRunningCfg>
<AP>
<Name></Name>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>

13
 <RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
</AP>
</APRunningCfg>
</AP>

Table description
Item Description
Feature name AP
Table name APRunningCfg
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name. Index N/A
Length: 1 to 64 characters.
Region code of Conform to ISO 3166
RegionCode N/A Unsigned short.
AP. stantard.
Whether the Boolean:
RegionLock region code of the N/A • true—Support. N/A
AP is locked.
• false—Not support.

AP connection Unsigned short.

Priority N/A N/A
priority. Value range: 0 to 7.
Whether the AP
Boolean:
will be forced to
Preempt switch the backup N/A • true: Switch N/A
tunnel to active by
• false: Not switch
priority.
The transmit Unsigned short.
EchoInterval interval of tunnel N/A Value range: 0, 5 to 255. N/A
echo messages.
Unit: seconds

14
 Column Column Column Data type and
Remarks
name description type restrictions
The allowed
maximum number
of echo messges
which are not Unsigned short.
EchoCount N/A N/A
received. If the Value range: 1 to 20.
count is reached,
the tunnel will be
down.
The interval to Unsigned short.
RetransInter retransmit a N/A Value range: 1 to 30. N/A
val request message.
Unit: seconds.
The allowed
maximum number
of retransmission Unsigned short.
RetransCou
attempts. If the N/A Value range: 1 to 20. N/A
nt
count is reached, Unit: seconds.
the tunnel will be
down.
The interval of AP
sending the Unsigned short.
StatisInterva
statistics N/A Value range: 0 to 240. N/A
l
informations to Unit: seconds.
AC.
Whether the AC
will upgrade AP’s Boolean:
FirmwareUp firmware
grade automatically if the
N/A • true—Enable N/A
software is • false—Disable
mismatch.
BackupACI The IPv4 backup String, dotted decimal
N/A Example: 1.1.1.1.
Pv4 AC address. notation.
BackupACI The IPv6 backup Hexadecimal string,
N/A Example: 1:1::1:1.
Pv6 AC address. colon-separated.
Which location the String, lowercase.
LocationNa
AP group belongs N/A Length: 1 to 31 characters. N/A
me
to.

The description of String,

Description N/A N/A
AP. Length: 1 to 64 cahracters.
Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable

AP/RunAP
This table contains the information of the running AP.

XML structure
<AP>

15
 <RunAP>
<AP>
<Name></Name>
<Model></Model>
<SerialID></SerialID>
<Type></Type>
<MacAddress></MacAddress>
<RadioNum></RadioNum>
<Status></Status>
<Ipv4Address></Ipv4Address>
<Ipv6Address></Ipv6Address>
<PortNumber></PortNumber>
<GroupName></GroupName>
<OnlineTime></OnlineTime>
<HWVer><HWVer>
<SWVer><SWVer>
<BWVer><BWVer>
<TransCtrlPkt></TransCtrlPkt>
<RecvCtrlPkt></RecvCtrlPkt>
<TransDataPkt></TransDataPkt>
<RecvDataPkt></RecvDataPkt>
<EchoReqCnt></EchoReqCnt>
<EchoRespLossCnt></EchoRespLossCnt>
<DiscoveryType></DiscoveryType>
<ConfigFailCnt></ConfigFailCnt>
<LastFailReason></LastFailReason>
<LastRebootReason></LastRebootReason>
<TunnelDownReason></TunnelDownReason>
<ConnectionType></ConnectionType>
<PeerACIPv4Address><PeerACIPv4Address>
<PeerACIPv6Address><PeerACIPv6Address>
<LocationName></LocationName>
<AuthenticatedFlag></AuthenticatedFlag>
<LocalACName><LocalACName>
</AP>
</RunAP>
</AP>

Table description
Item Description
Feature name AP
Table name RunAP
Table type Multi-instance table
Row name AP
Restrictions None

16
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name. Index N/A
Length: 1 to 64 characters.
String, case-insensitive.
Model AP model name. N/A N/A
Length: 1 to 63 characters.
String, uppercase.
SerialID AP serial ID. N/A Length: 1 to 127 N/A
characters.
Enumeration:
Type AP type. N/A • 1—auto N/A
• 2—manual
N/A Six groups of two
Example:
MacAddress AP MAC address. hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.
Number of the Unsigned short.
RadioNum radio. N/A N/A
Value range: 1 to 4.
Enumeration:
AP associated • 1—Online
Status N/A N/A
status.
• 3—Image
downloading
Example: 1.1.1.1.
String, dotted decimal This column is
Ipv4Address AP IPv4 address. N/A
notation. unavailable when the AP
uses an IPv6 address.
Example: 1:1::1:1.
Hexadecimal string, This column is
Ipv6Address AP IPv6 address. N/A
colon-separated. unavailable when the AP
uses an IPv4 address.
Unsigned integer.
PortNumber AP port number. N/A N/A
Value range: 1 to 65535.
The name of AP String, lowercase.
GroupName group which the N/A Length: 1 to 31 characters. N/A
AP belongs to.
Unsigned integer.
AP online Value range: 0 to
OnlineTime N/A N/A
duration. 4294967295.
Unit: Second
Enumeration:
• 1—Ver.A
The version of AP • 2—Ver.B
HWVer N/A N/A
hardware. • 3—Ver.C
• 4—Ver.D
• 5—Ver.E

17
Column Column Column Data type and
Remarks
name description type restrictions
The version of AP String.
SWVer software. N/A N/A
Length: 1 to 31 characters.
The version of AP String.
BWVer bootrom. N/A N/A
Length: 1 to 31 characters.
Count of Unsigned integer.
TransCtrlPkt transmitted control N/A Value range: 0 to N/A
packets. 4294967295.
Unsigned integer.
Count of received
RecvCtrlPkt N/A Value range: 0 to N/A
control packets.
4294967295.
Count of Unsigned integer.
TransDataP transmitted data N/A Value range: 0 to N/A
kt packets. 4294967295.
Unsigned integer.
RecvDataPk Count of received
N/A Value range: 0 to N/A
t data packets.
4294967295.
Unsigned integer.
EchoReqCn Count of echo
N/A Value range: 0 to N/A
t request packets.
4294967295.
Unsigned integer.
EchoRespL Count of lost echo
N/A Value range: 0 to N/A
ossCnt response packets.
4294967295.
Enumeration:
• 1—Unknown
DiscoveryTy By which type the • 2—DHCP
N/A N/A
pe AP find the AC.
• 3—Static
Configuration
• 4—DNS
Unsigned integer.
ConfigFailC Count of failed
N/A Value range: 0 to N/A
nt Configuration.
4294967295.
The cause of
synchronizing String.
LastFailRea
configurations to N/A N/A
son Length: 1 to 31 characters.
the AP failed in
last time.
The cause of the String.
LastReboot
AP rebooting in N/A Length: 1 to 31 characters. N/A
Reason
last time.
The cause of the String.
TunnelDown
tunnel down in last N/A Length: 1 to 31 characters. N/A
Reason
time.
Enumeration:
Connection The connection
N/A • 1—Active N/A
Type type of tunnel.
• 2—Standby

18
 Column Column Column Data type and
Remarks
name description type restrictions
Example: 1.1.1.1.
The IPv4 address
PeerACIPv4 String, dotted decimal This column is
of peer AC that AP N/A
Address notation. unavailable when the AP
is connecting to.
uses an IPv6 address.
Example: 1:1::1:1.
The IPv6 address
PeerACIPv6 Hexadecimal string, This column is
of peer AC that AP N/A
Address colon-separated. unavailable when the AP
is connecting to.
uses an IPv4 address.
Which location the String, lowercase.
LocationNa
AP group belongs N/A Length: 1 to 31 characters. N/A
me
to.
Boolean:
Whether the When AP type is manual
Authenticate
dFlag
auto-ap is N/A • Enable AP, this column is
authenticated. invalid.
• Disable

LocalACNa String, case-sensitive.

Local-ac name. N/A N/A
me Length: 1 to 64 characters.

AP/APHistory
This table contains the information of the AP history.

XML structure
<AP>
<APHistory>
<AP>
<Name></Name>
<LatestIPV4Address></LatestIPV4Address>
<LatestIPV6Address></LatestIPV6Address>
<ConnectCnt></ConnectCnt>
</AP>
</APHistory>
</AP>

Table description
Item Description
Feature name AP
Table name APHistory
Table type Multi-instance table
Row name AP
Restrictions None

19
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name. Index N/A
Length: 1 to 64 characters.
Example: 1.1.1.1.
The latest IPv4
LatestIPV4A String, dotted decimal This column is
address that AP N/A
ddress notation. unavailable when the AP
used.
uses an IPv6 address.
Example: 1:1::1:1.
The latest IPv6
LatestIPV6A Hexadecimal string, This column is
address that AP N/A
ddress colon-separated. unavailable when the AP
used.
uses an IPv4 address.

The count that the Unsigned integer.

ConnectCnt AP connected the N/A Value range: 0 to N/A
AC. 4294967295.

AP/RadioOfManualAP
This table contains radio information of manual AP.

XML structure
<AP>
<RadioOfManualAP>
<Radio>
<ApName></ApName>
<RadioID></RadioID>
<Mode></Mode>
<SupportDot11B></SupportDot11B>
<SupportDot11A></SupportDot11A>
<SupportDot11G></SupportDot11G>
<SupportDot11GN></SupportDot11GN>
<SupportDot11AN></SupportDot11AN>
<SupportDot11GAC></SupportDot11GAC>
<SupportDot11AC></SupportDot11AC>
<Bandwidth></Bandwidth>
<Spectrum></Spectrum>
<Status></Status>
<RateMulticast></RateMulticast>
<RateMandatory></RateMandatory>
<RateSupported></RateSupported>
<RateDisabled></RateDisabled>
<Preamble></Preamble>
<BeaconInterval></BeaconInterval>
<PowerLock></PowerLock>

20
 <ChannelAutoLock></ChannelAutoLock>
<Distance></Distance>
<MaxRxDuration></MaxRxDuration>
<FragmentThreshold></FragmentThreshold>
<LongRetryThreshold></LongRetryThreshold>
<ProtectionThreshold></ProtectionThreshold>
<ShortRetryThreshold></ShortRetryThreshold>
<CfgChannel></CfgChannel>
<CfgMaxPower></CfgMaxPower>
<ProtectionMode></ProtectionMode>
<ValidChannelNum></ValidChannelNum>
<ValidChannelList></ValidChannelList>
</Radio>
</RadioOfManualAP>
</AP>

Table description
Item Description
Feature name AP
Table name RadioOfManualAP
Table type Multi-instance table
Row name Radio
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode. N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Whether a radio Boolean:
SupportDot1 supports 802.11b
1B
N/A • true—Support. N/A
radio mode
• false—Not support.

21
Column Column Column Data type and
Remarks
name description type restrictions
Whether a radio Boolean:
SupportDot1 supports 802.11a
1A
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports 802.11g
1G
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports
1GN 802.11n(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AN 802.11n(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1GAC 802.11ac(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AC 802.11ac(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth. N/A N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M
Enumeration:
• 1—Support both
Supported radio 5GHz and 2.4GHz
Spectrum N/A N/A
spectrum. • 2—Support 5GHz only
• 3—Support 2.4GHz
only
Enumeration:
• 0—Disable
Status Radio status. N/A N/A
• 1—Enable
• 2—Inherit

22
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
The value can have
• 7—12Mbps multi-selections.
RateMultica
Multicast. N/A • 8—18Mbps List of enumeration,
st separated by comma
• 9—24Mbps
Example: 1, 2.
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
• 13—auto
If this column is not
configured, the multicast
rate will be calculated
automatically.
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
The value can have
• 5—9Mbps multi-selections.
RateMandat
Mandatory rate. N/A • 6—11Mbps List of enumeration,
ory separated by comma
• 7—12Mbps
Example: 1, 2.
• 8—18Mbps
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps

23
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateSupport
Supported rate. N/A • 6—11Mbps rate uses.
ed List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateDisable
Disabled rate. N/A • 6—11Mbps rate uses.
d List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Boolean:
• true—Short. N/A
Preamble Preamble. N/A • false—Long.
The column is only for
2.4GHz radio mode.

Unsigned short.
BeaconInter Beacon Interval The value range is
N/A N/A
val time. 32~8191.
Unit: TU. 1TU = 1024ms
Enumeration:
• 0—Disable
PowerLock Lock the power. N/A N/A
• 1—Enable
• 2—Inherit
Unsigned short.
The distance that
Distance N/A The value range is 1~40. N/A
Radio can cover.
Unit: km(kilometre).

24
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
Max Reveived
MaxRxDurat The value range is
frame duration N/A N/A
ion 500~250000.
time.
Unit: ms(millisecond).
Unsigned short.
The value range is
FragmentTh Fragment
N/A 256~2346.And the value N/A
reshold threshold.
must be an even number.
Unit: byte.
Unsigned short.
LongRetryT Long retry
N/A The value range is 1~15. N/A
hreshold threshold.
Unit: null.
Unsigned short.
ProtectionT ProtectionThresho
N/A The value range is 0~2346. N/A
hreshold ld.
Unit: byte.
Unsigned short.
ShortRetryT ShortRetryThresh
N/A The value range is 1~15. N/A
hreshold old.
Unit: null.
When the value is 15, the
radio automatically
selects an optimal
The value range conforms channel, and then locks
to the channel.
Configured AP/ChannelDB/Supported
CfgChannel N/A When the AC detects
channel number. ChannelList” column.
any radar signals on its
And 15 –auto lock、 channel, it immediately
16-auto unlock. selects another channel
(even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
Value range: 1 to
CfgMaxPow Configured
N/A “AP/PowerDB/ValidMaxPo N/A
er maximum power.
wer”.
Unit: dBm
Enumeration:
ProtectionM
ode
Protection mode. N/A • 1—Rts/Cts. N/A
• 2—Cts To Self

ValidChann Number of the Unsigned integer.

N/A N/A
elNum valid channels Value range: 0 to 32.
Number string.
It is a comma-separated list
ValidChann a list of the valid of valid channels. Example:
N/A
elList channels. The string must not end 1,2,3,4,5,6,7,8,9,10,11
with a comma or hyphen,
or include any whitespace

25
AP/RadioRunningCfg
This table contains radio information of radio running configurations.

XML structure
<AP>
<RadioRunningCfg>
<Radio>
<ApName></ApName>
<RadioID></RadioID>
<Mode></Mode>
<SupportDot11B></SupportDot11B>
<SupportDot11A></SupportDot11A>
<SupportDot11G></ SupportDot11G>
<SupportDot11GN></SupportDot11GN>
<SupportDot11AN></SupportDot11AN>
<SupportDot11GAC></SupportDot11GAC>
<SupportDot11AC></SupportDot11AC>
<Bandwidth></Bandwidth>
<Spectrum></Spectrum>
<Status></Status>
<RateMulticast></RateMulticast>
<RateMandatory></RateMandatory>
<RateSupported></RateSupported>
<RateDisabled></RateDisabled>
<Preamble></Preamble>
<BeaconInterval></BeaconInterval>
<PowerLock></PowerLock>
<Distance></Distance>
<MaxRxDuration></MaxRxDuration>
<FragmentThreshold></FragmentThreshold>
<LongRetryThreshold></LongRetryThreshold>
<ProtectionThreshold></ProtectionThreshold>
<ShortRetryThreshold></ShortRetryThreshold>
<CfgChannel></CfgChannel>
<CfgMaxPower></CfgMaxPower>
</Radio>
</RadioRunningCfg>
</AP>

Table description
Item Description
Feature name AP
Table name RadioRunningCfg

26
 Item Description
Table type Multi-instance table
Row name Radio
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode. N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Whether a radio Boolean:
SupportDot1 supports 802.11b
1B
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports 802.11a
1A
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports 802.11g
1G
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports
1GN 802.11n(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AN 802.11n(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1GAC 802.11ac(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AC 802.11ac(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

27
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth. N/A N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M
Enumeration:
• 1—Support both
Supported radio 5GHz and 2.4GHz
Spectrum N/A N/A
spectrum. • 2—Support 5GHz only
• 3—Support 2.4GHz
only
Enumeration:
Status Radio status. N/A • Disable N/A
• Enable
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps The value can have
multi-selections.
RateMultica • 6—11Mbps
Multicast rate. N/A List of enumeration,
st • 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
• 13—auto

28
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
The value can have
• 5—9Mbps multi-selections.
RateMandat
Mandatory rate. N/A • 6—11Mbps List of enumeration,
ory separated by comma
• 7—12Mbps
Example: 1, 2.
• 8—18Mbps
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateSupport
Supported rate. N/A • 6—11Mbps rate uses.
ed List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateDisable
Disabled rate. N/A • 6—11Mbps rate uses.
d List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps

29
Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
• true—Short. N/A
Preamble Preamble. N/A • false—Long.
The column is only for
2.4GHz radio mode.

Unsigned short.
BeaconInter Beacon Interval The value range is
N/A N/A
val time. 32~8191.
Unit: TU. 1TU = 1024ms
Enumeration:
PowerLock Lock the power. N/A • Disable N/A
• Enable
Lo Boolean: When
ck • true—ChanneAutoLoc the value
th k. is true,
e the radio
ch • false—ChanneAuto automati
an UnLock. cally
ne The default selects
l value is true. an
optimal
channel,
and then
locks the
channel.
When the AC
detects any
radar signals
on its
channel, it
immediately
selects
another
channel (even
if the channel
auto lock is
true) and
locks the new
channel.
Unsigned short.
The distance that
Distance N/A The value range is 1~40. N/A
Radio can cover.
Unit: km(kilometre).
Unsigned integer.
Max Reveived The value range is
MaxRxDurat
frame duration N/A 500~250000. N/A
ion
time.
Unit: ms(millisecond).
Unsigned short.
The value range is
FragmentTh Fragment
N/A 256~2346. And the value N/A
reshold threshold.
must be an even number.
Unit: byte.

30
 Column Column Column Data type and
Remarks
name description type restrictions
Unsigned short.
LongRetryT LongRetryThresh
N/A The value range is 1~15. N/A
hreshold old.
Unit: null.
Unsigned short.
ProtectionT ProtectionThresho
N/A The value range is 0~2346. N/A
hreshold ld.
Unit: byte.
Unsigned short.
ShortRetryT ShortRetryThresh
N/A The value range is 1~15. N/A
hreshold old.
Unit: null.
When the value is 15, the
radio automatically
selects an optimal
The value range conforms channel, and then locks
to the channel.
Configured AP/ChannelDB/Supported
CfgChannel N/A When the AC detects
channel number. ChannelList” column.
any radar signals on its
And 15 –auto lock、 channel, it immediately
16-auto unlock. selects another channel
(even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
Value range: 1 to
CfgMaxPow Configured
N/A “AP/PowerDB/ValidMaxPo N/A
er maximum power.
wer”.
Unit: dBm

AP/Radio11n
This table contains radio 802.11n information.

XML structure
<AP>
<Radio11n>
<Dot11n>
<ApName></ApName>
<RadioID></RadioID>
<MCSMulticast></MCSMulticast>
<MCSMandatory></MCSMandatory>
<MCSSupported></MCSSupported>
<Ampdu></Ampdu>
<Amsdu></Amsdu>
<ShortGI></ShortGI>
<Stbc></Stbc>
<Ldpc></Ldpc>
<Mimo></Mimo>

31
 <Greenap></Greenap>
<SmartAntenna></SmartAntenna>
<SmartAntennaPolicy></SmartAntennaPolicy>
<Protection></Protection>
<Client11nOnly></Client11nOnly>
<BandwidthAutoswitch></ BandwidthAutoswitch >
</Dot11n>
</Radio11n>
</AP>

Table description
Item Description
Feature name AP
Table name Radio11n
Table type Multi-instance table
Row name Dot11n
Restrictions The table is only for 802.11n and 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Unsigned short.
The MCSMulticast must
MCSMultica The index for Value range: 0 to 76, and
N/A be smaller than or equal
st multicast MCS. 255.
to the MCSMandatory.
Default value is 255.
Unsigned short. The MCSMandatory
Value range: 0 to 76, and must be smaller than or
The maximum 255. equal to the
MCSMandat
index for N/A MCSSupported, and the
ory Default value is 255.
mandatory MCS. MCSMandatory must be
greater than or equal to
the MCSMulticast.
Unsigned short. The MCSSupported
The maximum must be greater than or
MCSSuppor Value range: 0 to 76, and
index for N/A equal to the
ted 255.
supported MCS. MCSMandatory.
Default value is 255.

32
Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
Ampdu A-mpdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Amsdu A-msdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
ShortGI Short GI function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Stbc STBC function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Ldpc LDPC function. N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 1: 1X1
Mimo Mimo. N/A • 2: 2X2 N/A
• 3: 3X3
• 4: 4X4
Boolean:
Greenap Green ap function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
SmartAnten Smart antenna
na function.
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
Effective only when
SmartAnten Smart antenna • 1: Auto
N/A SmartAntenna is
naPolicy policy. • 2: High-availability enabled.
• 3: High-throughput

802.11n Boolean:
Protection protection N/A • true—Enable. N/A
function. • false—Disable.
Boolean:
Client11nOn Client dot11n only
N/A • true—Enable. N/A
ly function.
• false—Disable.
Boolean:
• true—Enable. N/A
BandwidthA
Bandwidth • false—Disable.
autoswitch N/A
utoswitch The column is only for
function.
2.4GHz radio mode, and
AP/RadioOfManualAP/Ban
dwidth must be 2..

33
AP/Radio11ac
This table contains radio 802.11ac information.

XML structure
<AP>
<Radio11ac>
<Dot11ac>
<ApName></ApName>
<RadioID></RadioID>
<VHTNSSMulticast></VHTNSSMulticast>
<VHTMCSMulticast></VHTMCSMulticast>
<VHTNSSMandatory></VHTNSSMandatory>
<VHTNSSSupported></VHTNSSSupported>
<Client11acOnly></Client11acOnly>
</Dot11ac>
</Radio11ac>
</AP>

Table description
Item Description
Feature name AP
Table name Radio11ac
Table type Multi-instance table
Row name Dot11ac
Restrictions The table is only for 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Unsigned short. The VHTNSSMulticast
The NSS for
VHTNSSMu Value range: 0 to 8. must be smaller than or
multicast N/A
lticast equal to the
VHT-MCS. Default value is 0. VHTNSSMandatory.

34
 Column Column Column Data type and
Remarks
name description type restrictions
The index for Unsigned short.
VHTMCSMu
multicast N/A Value range: 0 to 9, 255. N/A
lticast
VHT-MCS. Default value is 255.
The VHTNSSMandatory
must be smaller than or
The maximum Unsigned short. equal to the
VHTNSSMa NSS for VHTNSSSupported, and
N/A Value range: 0 to 8.
ndatory mandatory the VHTNSSMandatory
VHT-MCS. Default value is 0. must be greater than or
equal to the
VHTNSSMulticast.
Unsigned short. The VHTNSSSupported
The maximum
VHTNSSSu Value range: 0 to 8. must be greater than or
NSS for supported N/A
pported equal to the
VHT-MCS. Default value is 0. VHTNSSMandatory.
Boolean:
Client11acO Client dot11ac
N/A • true—Enable. N/A
nly only function.
• false—Disable.

AP/RadioRunningCfg11n
This table contains radio 802.11n information of radio running configurations.

XML structure
<AP>
<RadioRunningCfg11n>
<Dot11n>
<ApName></ApName>
<RadioID></RadioID>
<MCSMulticast></MCSMulticast>
<MCSMandatory></MCSMandatory>
<MCSSupported></MCSSupported>
<Ampdu></Ampdu>
<Amsdu></Amsdu>
<ShortGI></ShortGI>
<Stbc></Stbc>
<Ldpc></Ldpc>
<Mimo></Mimo>
<Greenap></Greenap>
<SmartAntenna></SmartAntenna>
<SmartAntennaPolicy></SmartAntennaPolicy>
<Protection></Protection>
<Client11nOnly></Client11nOnly>
<BandwidthAutoswitch></BandwidthAutoswitch >
</Dot11n>
</RadioRunningCfg11n>

35
 </AP>

Table description
Item Description
Feature name AP
Table name RadioRunningCfg11n
Table type Multi-instance table
Row name Dot11n
Restrictions The table is only for 802.11n and 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Unsigned short. The MCSMulticast must
MCSMultica The index for be smaller than or equal
N/A Value range: 0 to 76, and
st multicast MCS. to the MCSMandatory.
255.
The MCSMandatory
must be smaller than or
The maximum Unsigned short. equal to the
MCSMandat
index for N/A Value range: 0 to 76, and MCSSupported, and the
ory
mandatory MCS. 255. MCSMandatory must be
greater than or equal to
the MCSMulticast.

Unsigned short. The MCSSupported

The maximum
MCSSuppor must be greater than or
index for N/A Value range: 0 to 76, and
ted equal to the
supported MCS. 255. MCSMandatory.
Boolean:
Ampdu A-mpdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Amsdu A-msdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
ShortGI Short GI function. N/A • true—Enable. N/A
• false—Disable.

36
 Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
Stbc STBC function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Ldpc LDPC function. N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 1: 1X1
Mimo MIMO. N/A • 2: 2X2 N/A
• 3: 3X3
• 4: 4X4
Boolean:
Greenap Green ap function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
SmartAnten Smart antenna
na function.
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
Effective only when
SmartAnten Smart antenna • 1: Auto
N/A SmartAntenna is
naPolicy policy. • 2: High-availability enabled.
• 3: High-throughput
802.11n Boolean:
Protection protection N/A • true—Enable. N/A
function.
• false—Disable.
Boolean:
Client11nOn Client dot11n only
ly function.
N/A • true—Enable. N/A
• false—Disable.
Boolean:
• true—Enable. N/A
BandwidthA
Bandwidth • false—Disable.
autoswitch N/A
utoswitch The column is only for
function.
2.4GHz radio mode, and
AP/ RadioRunningCfg/
Bandwidth must be 2..

AP/RadioRunningCfg11ac
This table contains radio 802.11ac information of radio running configurations.

XML structure
<AP>
<RadioRunningCfg11ac>
<Dot11ac>

37
 <ApName></ApName>
<RadioID></RadioID>
<VHTNSSMulticast></VHTNSSMulticast>
<VHTMCSMulticast></VHTMCSMulticast>
<VHTNSSMandatory></VHTNSSMandatory>
<VHTNSSSupported></VHTNSSSupported>
<Client11acOnly></Client11acOnly>
</Dot11ac>
</RadioRunningCfg11ac>
</AP>

Table description
Item Description
Feature name AP
Table name RadioRunningCfg11ac
Table type Multi-instance table
Row name Dot11ac
Restrictions The table is only for 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
The VHTNSSMulticast
The NSS for Unsigned short.
VHTNSSMu must be smaller than or
multicast N/A
lticast Value range: 0 to 8. equal to the
VHT-MCS.
VHTNSSMandatory.
The index for Unsigned short.
VHTMCSMu
multicast N/A N/A
lticast Value range: 0 to 9, 255.
VHT-MCS.
The VHTNSSMandatory
must be smaller than or
The maximum equal to the
VHTNSSMa NSS for Unsigned short. VHTNSSSupported, and
N/A
ndatory mandatory Value range: 0 to 8. the VHTNSSMandatory
VHT-MCS. must be greater than or
equal to the
VHTNSSMulticast.

38
 Column Column Column Data type and
Remarks
name description type restrictions
The VHTNSSSupported
The maximum Unsigned short.
VHTNSSSu must be greater than or
NSS for supported N/A
pported Value range: 0 to 8. equal to the
VHT-MCS.
VHTNSSMandatory.
Boolean:
Client11acO Client dot11ac
N/A • true—Enable. N/A
nly only function.
• false—Disable.

AP/RadioOfRunAP
This table contains radio information of running AP.

XML structure
<AP>
<RadioOfRunAP>
<Radio>
<ApName></ApName>
<RadioID></RadioID>
<Mode></Mode>
<Bandwidth></Bandwidth>
<Status></Status>
<Channel></Channel>
<SecondaryOffSet></SecondaryOffSet>
<MaxPower></MaxPower>
<BasicBSSID></BasicBSSID>
<TxPower></TxPower>
<NoiseFloor></NoiseFloor>
<ChannelBusy></ChannelBusy>
</Radio>
</RadioOfRunAP>
</AP>

Table description
Item Description
Feature name AP
Table name RadioOfRunAP
Table type Multi-instance table
Row name Radio
Restrictions None

39
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode. N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth. N/A N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M
Enumeration:
Status Radio status. N/A • enable N/A
• disable
Unsigned short.
The value range is related
Channel Channel number. N/A to AP model, radio mode, N/A
antenna type and region
code.
Enumeration:
SecondaryO Secondary • 0: None
N/A N/A
ffSet channel offset. • 1: Above
• 2: Below
Unsigned short.
The value range is related
to AP model, radio mode,
MaxPower Maximum power. N/A N/A
antenna type, channel
number and region code.
Unit: dBm
Six groups of two
Example:
BasicBSSID Basic BSSID. N/A hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.

40
 Column Column Column Data type and
Remarks
name description type restrictions
TxPower Tx power. N/A Unsigned short. N/A
String, Length: 1 to 7
NoiseFloor Noise floor. N/A N/A
characters.
ChannelBus Channel usage.
N/A Unsigned short. N/A
y

AP/PrvsOfManualAP
This table contains provision information of manual AP.

XML structure
<AP>
<PrvsOfManualAP>
<Prvs>
<ApName></ApName>
<ACHostName></ACHostName>
<ACIPv4></ACIPv4>
<ACIPv6></ACIPv6>
<DnsDomain></DnsDomain>
<DnsServerIPv4></DnsServerIPv4>
<DnsServerIPv6></DnsServerIPv6>
<GatewayIPv4></GatewayIPv4>
<GatewayIPv6></GatewayIPv6>
<IPv4Address></IPv4Address>
<IPv6Address></IPv6Address>
<Dot1xSupplAnonyIdent></Dot1xSupplAnonyIdent>
<Dot1xSupplEapMethod></Dot1xSupplEapMethod>
<Dot1xSupplEnable></Dot1xSupplEnable>
<Dot1xSupplPasswdCiper></Dot1xSupplPasswdCiper>
<Dot1xSupplPasswdSimple></Dot1xSupplPasswdSimple>
<Dot1xSupplUsername></Dot1xSupplUsername>
</Prvs>
</PrvsOfManualAP>
</AP>

Table description
Item Description
Feature name AP
Table name PrvsOfManualAP
Table type Multi-instance table
Row name Prvs

41
 Item Description
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
String.
ACHostNam Specify an AC by
N/A Length: 1 to 253 N/A
e its hostname.
characters.
List of string, dotted
Specify an AC by Example: 1.1.1.1,
ACIPv4 N/A decimal notation,
its IPv4 address. 1.1.1.2.
Separated by comma.
List of hexadecimal string,
Specify an AC by Example:
ACIPv6 N/A colon-separated,
its IPv6 address. 1:1::1:1,1:1::1:2.
Separated by comma.
Specify the String.
DnsDomain domain name N/A N/A
suffix. Length: 1 to 253.

Specify a DNS
DnsServerI String, dotted decimal
server by its IPv4 N/A Example: 1.1.1.1.
Pv4 notation.
address.
Specify a DNS
DnsServerI Hexadecimal string,
server by its IPv6 N/A Example: 1:1::1:1.
Pv6 colon-separated.
address.
Specify a gateway
GatewayIPv String, dotted decimal
by its IPv4 N/A Example: 1.1.1.1.
4 notation.
address.
Specify a gateway
GatewayIPv Hexadecimal string,
by its IPv6 N/A Example: 1:1::1:1.
6 colon-separated.
address
Specify an IP
address that the
IPv4Addres String, dotted decimal
AP uses to N/A Example: 1.1.1.1.
s notation.
establish a
CAPWAP tunnel.
Specify an IPv6
address that the
IPv6Addres Hexadecimal string,
AP uses to N/A Example: 1:1::1:1.
s colon-separated.
establish a
CAPWAP tunnel.
Specify an String.
Dot1xSuppl anonymous
N/A Length: 1 to 253 N/A
AnonyIdent identifier for the
supplicant. characters.

42
 Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—md5
Specify an EAP • 2—peap-gtc
Dot1xSuppl
authentication N/A N/A
EapMethod
method. • 3—peap-mschapv2
• 4—ttls-gtc
• 5—ttls-mschapv2
Boolean:
Dot1xSuppl Enable the 802.1X
Enable supplicant feature.
N/A • true—Enable. N/A
• false—Disable.
Specify a String.
Dot1xSuppl
ciphertext
PasswdCipe N/A Length: 1 to 201 N/A
password for the
r characters.
802.1X supplicant.
Dot1xSuppl Specify a plaintext String.
PasswdSim password for the N/A Length: 1 to 127 N/A
ple 802.1X supplicant. characters.
Specify a String.
Dot1xSuppl username for the N/A Length: 1 to 253 N/A
Username 802.1X supplicant. characters.

AP/PrvsOfManualAPACIPv4
This table contains provision information of manual AP of IPv4 address.

XML structure
<AP>
<PrvsOfManualAPACIPv4>
<Prvs>
<ApName></ApName>
<ACIPv4></ACIPv4>
</Prvs>
</PrvsOfManualAPACIPv4>
</AP>

Table description
Item Description
Feature name AP
Table name PrvsOfManualAPACIPv4
Table type Multi-instance table
Row name Prvs
Restrictions None

43
 Item Description
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Specify an AC by String, dotted decimal
ACIPv4 N/A Example: 1.1.1.1.
its IPv4 address. notation.

AP/PrvsOfManualAPACIPv6
This table contains provision information of manual AP of IPv6 address.

XML structure
<AP>
<PrvsOfManualAPACIPv6>
<Prvs>
<ApName></ApName>
<ACIPv6></ACIPv6>
</Prvs>
</PrvsOfManualAPACIPv6>
</AP>

Table description
Item Description
Feature name AP
Table name PrvsOfManualAPACIPv6
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

44
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Example: 1:1::1:1.
Specify an AC by Hexadecimal string, This column is available
ACIPv6 N/A
its IPv6 address. colon-separated. when the SrcAny column
is false.

AP/APDB
This table contains AP model information.

XML structure
<AP>
<APDB>
<Model>
<ModelName></ModelName>
<RadioNum></RadioNum>
<DefaultRegionCode></DefaultRegionCode>
<StartPoePort></StartPoePort>
<EndPoePort></EndPoePort>
<ModelType></ModelType>
</Model>
</APDB>
</AP>

Table description
Item Description
Feature name AP
Table name APDB
Table type Multi-instance table
Row name Model
Restrictions None

45
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-insensitive.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.
Radio’s number of Unsigned short.
RadioNum AP model N/A N/A
Value range: 1 to 4.
DefaultRegi Default region Conform to ISO 3166
N/A Unsigned short.
onCode code of AP model. stantard.
StartPoePor
Start PoE port. N/A Unsigned char. N/A
t
EndPoePort End PoE port. N/A Unsigned char. N/A
Enumeration:
When the value is 3,
• 1—Normal
ModelType Model type. N/A some command can not
• 2—WT
be configurated.
• 3—WTU

AP/APDBVersion
This table contains apdb version of AP model.

XML structure
<AP>
<APDBVersion>
<Model>
<ModelName></ModelName>
<HardwareVersion></HardwareVersion>
<SoftwareVersion></SoftwareVersion>
</Model>
</APDBVersion>
</AP>

Table description
Item Description
Feature name AP
Table name APDBVersion
Table type Multi-instance table
Row name Model
Restrictions None

46
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, uppercase. Refer to
ModelName AP model name. Index
Length: 1 to 63 characters. APDB/ModelName.

Enumeration:
• 1—Ver.A
• 2—Ver.B
HardwareVe The version of
Index • 3—Ver.C N/A
rsion Hardware.
• 4—Ver.D
• 5—Ver.E
• 6—Ver.F
SoftwareVer The version of String
sion Software. N/A N/A
Length:1 to 31.

AP/RadioDB
This table contains radio information of AP model.

XML structure
<AP>
<RadioDB>
<Radio>
<ModelName></ModelName>
<RadioID></RadioID>
<DefaultRadioMode></DefaultRadioMode>
<SupportDot11B></SupportDot11B>
<SupportDot11A></SupportDot11A>
<SupportDot11G></SupportDot11G>
<SupportDot11GN></SupportDot11GN>
<SupportDot11AN></SupportDot11AN>
<SupportDot11GAC></SupportDot11GAC>
<SupportDot11AC></SupportDot11AC>
<Spectrum></Spectrum>
<DefaultAntennaType></DefaultAntennaType>
<Aifsn></Aifsn>
<Ecwmin></Ecwmin>
<Ecwmax></Ecwmax>
<TxOpLimit></TxOpLimit>
<SupportBandwidth></SupportBandwidth>
<SupportMCS></SupportMCS>
<SupportVHTMCS></SupportVHTMCS>
<ShortGI20M></ShortGI20M>
<ShortGI40M></ShortGI40M>

47
 <ShortGI80M></ShortGI80M>
<ShortGI160M></ShortGI160M>
<SUBeamformer></SUBeamformer>
<MUBeamformer></MUBeamformer>
<Ldpc></Ldpc>
<TxStbc></TxStbc>
<RxStbc></RxStbc>
<VHTLdpc></VHTLdpc>
<VHTTxStbc></VHTTxStbc>
<VHTRxStbc></VHTRxStbc>
</Radio>
</RadioDB>
</AP>

Table description
Item Description
Feature name AP
Table name RadioDB
Table type Multi-instance table
Row name Radio
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, uppercase.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
DefaultRadi Default radio • 3—802.11g
N/A N/A
oMode mode. • 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Whether a radio Boolean:
SupportDot1 supports 802.11b
1B
N/A • true—Support. N/A
radio mode
• false—Not support.

48
Column Column Column Data type and
Remarks
name description type restrictions
Whether a radio Boolean:
SupportDot1
1A
supports 802.11a N/A • true—Support. N/A
radio mode. • false—Not support.

Whether a radio Boolean:

SupportDot1
1G
supports 802.11g N/A • true—Support. N/A
radio mode. • false—Not support.
Whether a radio Boolean:
SupportDot1 supports
1GN 802.11n(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AN 802.11n(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1GAC 802.11ac(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AC 802.11ac(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Enumeration:
• 1—Support both
Supported radio 5GHz and 2.4GHz
Spectrum N/A N/A
spectrum. • 2—Support 5GHz only
• 3—Support 2.4GHz
only
DefaultAnte Default antenna String, case-insensitive.
nnaType type of radio. N/A N/A
Length: 1 to 80 characters.
ArbitrationInter Unsigned integer. Value
Aifsn Frame Spacing N/A range is 1 to 15, and is N/A
Number restricted by chipset.
Unsigned integer. Value
Exponent form of
Ecwmin N/A range is 0 to 10, and is N/A
CWmin
restricted by chipset.
Unsigned integer. Value
Exponent form of
Ecwmax N/A range is 1 to 10, and is N/A
CWmax
restricted by chipset.
Unsigned integer. Value
Transmission range is 0 to 32767 and is
TxOpLimit N/A N/A
oppurtunity limit restricted by chipset. Unit is
millisecond.

49
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—20M
• 2—40M
Supported • 3—80M
SupportBan
channel N/A N/A
dwidth
bandwidth • 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M

SupportMC Unsigned short.

Supported MCS N/A N/A
S Value range: 0 to 76.

SupportVHT Supported Unsigned short.

N/A N/A
MCS VHT-MCS Value range: 1 to 8.
Boolean:
Supported short
ShortGI20M
GI for 20MHz
N/A • true—Support. N/A
• false—Not support.
Boolean:
Supported short
ShortGI40M
GI for 40MHz
N/A • true—Support. N/A
• false—Not support.
Boolean:
Supported short
ShortGI80M
GI for 80MHz
N/A • true—Support. N/A
• false—Not support.
Boolean:
ShortGI160 Supported short
M GI for 160MHz
N/A • true—Support. N/A
• false—Not support.
Boolean:
SUBeamfor Supported
mer SU-Beamformer
N/A • true—Support. N/A
• false—Not support.
Boolean:
MUBeamfor Supported
mer MU-Beamformer
N/A • true—Support. N/A
• false—Not support.
Boolean:
Ldpc Supported ldpc N/A • true—Support. N/A
• false—Not support.
Boolean:
TxStbc Supported TxStbc N/A • true—Support. N/A
• false—Not support.
Boolean:
RxStbc Supported RxStbc N/A • true—Support. N/A
• false—Not support.
Boolean:
Supported VHT
VHTLdpc
ldpc
N/A • true—Support. N/A
• false—Not support.

50
 Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
Supported VHT
VHTTxStbc
TxStbc
N/A • true—Support. N/A
• false—Not support.
Boolean:
Supported VHT
VHTRxStbc
RxStbc
N/A • true—Support. N/A
• false—Not support.

AP/RegionDB
This table contains valid region list of AP models.

XML structure
<AP>
<RegionDB>
<Region>
<ModelName></ModelName>
<RegionCode></RegionCode>
<SupportedRadioList></SupportedRadioList>
</Region>
</RegionDB>
</AP>

Table description
Item Description
Feature name AP
Table name RegionDB
Table type Multi-instance table
Row name Region
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Region code of Conform to ISO 3166
RegionCode N/A Unsigned short.
AP. stantard.

51
 Column Column Column Data type and
Remarks
name description type restrictions
Number string.
It is a comma-separated list
Supported radio Example:
SupportedR of supported radio IDs.
list of current N/A
adioList The string must not end 1,2
region.
with a comma or hyphen,
or include any whitespace

AP/AntennaDB
This table contains valid antenna types of AP models.

XML structure
<AP>
<AntennaDB>
<Antenna>
<ModelName></ModelName>
<RadioID></RadioID>
<AntennaType></AntennaType>
</Antenna>
</AntennaDB>
</AP>

Table description
Item Description
Feature name AP
Table name AntennaDB
Table type Multi-instance table
Row name Antenna
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.

AntennaTyp Antenna type of String, case-insensitive.

Index N/A
e radio Length: 1 to 80 characters.

52
AP/ChannelTypeMap
This table contains channel type of radios.

XML structure
<AP>
<ChannelTypeMap>
<ChannelMap>
<RadioMode></RadioMode>
<Bandwidth></Bandwidth>
<Channel></Channel>
<ChannelType></ChannelType>
</ChannelMap>
</ChannelTypeMap>
</AP>

Table description
Item Description
Feature name AP
Table name ChannelTypeMap
Table type Multi-instance table
Row name ChannelMap
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
RadioMode Radio mode Index N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)

53
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth Index N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M
Conform to IEEE 802.11
protocol , ISO 3166
Legal channel
Channel Index Unsigned short. stantard and the related
number.
national and regional
laws and regulations.

54
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—802.11b
• 2—802.11g
• 3—802.11n(2.4GHz)
in 20M mode
• 4—802.11n(2.4GHz)
in 40M mode
• 5—802.11gac(2.4GHz
) in 20M mode
• 6—802.11gac(2.4GHz
) in 40M mode
• 7—802.11a(36 to 64)
• 8—802.11a(100 to
144)
• 9—802.11a(149 to
165)
• 10—802.11n(5GHz)
(36 to 64) in 20M
mode
• 11—802.11n(5GHz)
(100 to 144) in 20M
mode
• 12—802.11n(5GHz)
(149 to 165) in 20M
mode
Type of spectrum, • 13—802.11n(5GHz)
ChannelTyp (36 to 64) in 40M
bandwidth and N/A N/A
e mode
channel range.
• 14—802.11n(5GHz)
(100 to 144) in 40M
mode
• 15—802.11n(5GHz)
(149 to 165) in 40M
mode
• 16—802.11ac (36 to
64) in 20M mode
• 17—802. 11ac (100 to
144) in 20M mode
• 18—802. 11ac (149 to
165) in 20M mode
• 19—802.11ac (36 to
64) in 40M mode
• 20—802. 11ac (100 to
144) in 40M mode
• 21—802. 11ac (149 to
165) in 40M mode
• 22—802.11ac (36 to
64) in 80M mode
• 23—802. 11ac (100 to
144) in 80M mode
• 24—802. 11ac (149 to
165) in 80M mode
• 25—802.11ac (36 to
64) in 160M mode

55
 Column Column Column Data type and
Remarks
name description type restrictions
• 26—802. 11ac (100 to
144) in 160M mode
• 27—802. 11ac (149 to
165) in 160M mode
• 28—802. 11ac (36 to
64) in 8080M mode
• 29—802. 11ac (100 to
144) in 8080M mode
• 30—802. 11ac (149 to
165) in 8080M mode

AP/PowerIndex
This table contains valid power index of AP models.

XML structure
<AP>
<PowerIndex>
<Index>
<ModelName></ModelName>
<RadioID></RadioID>
<RadioMode></RadioMode>
<AntennaType></AntennaType>
<RegionCode></RegionCode>
<ChannelType></ChannelType>
<PowerIndex></PowerIndex>
<PowerSubIndex></PowerSubIndex>
</Index>
</PowerIndex>
</AP>

Table description
Item Description
Feature name AP
Table name PowerIndex
Table type Multi-instance table
Row name Index
Restrictions None

56
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
RadioMode Radio mode Index N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
AntennaTyp Antenna type of String, case-insensitive.
e radio. Index N/A
Length: 1 to 80 characters.
Unsigned short. Refer to
Region code of
RegionCode Index AP/RegionDB/RegionCo
AP.
de.
Enumeration:
• 1—802.11b
• 2—802.11g
• 3—802.11n(2.4GHz)
in 20M mode
• 4—802.11n(2.4GHz)
in 40M mode
• 5—802.11gac in 20M
mode
• 6—802.11gac in 40M
mode
• 7—802.11a(36 to 64)
• 8—802.11a(100 to
Type of spectrum, 144) Refer to AP/
ChannelTyp
e
bandwidth and Index • 9—802.11a(149 to ChannelTypeMap/Chann
channel range. 165) elType.
• 10—802.11n(5GHz)
(36 to 64) in 20M
mode
• 11—802.11n(5GHz)
(100 to 144) in 20M
mode
• 12—802.11n(5GHz)
(149 to 165) in 20M
mode
• 13—802.11n(5GHz)
(36 to 64) in 40M
mode
• 14—802.11n(5GHz)
(100 to 144) in 40M

57
 Column Column Column Data type and
Remarks
name description type restrictions
mode
• 15—802.11n(5GHz)
(149 to 165) in 40M
mode
• 16—802.11ac (36 to
64) in 20M mode
• 17—802. 11ac (100 to
144) in 20M mode
• 18—802. 11ac (149 to
165) in 20M mode
• 19—802.11ac (36 to
64) in 40M mode
• 20—802. 11ac (100 to
144) in 40M mode
• 21—802. 11ac (149 to
165) in 40M mode
• 22—802.11ac (36 to
64) in 80M mode
• 23—802. 11ac (100 to
144) in 80M mode
• 24—802. 11ac (149 to
165) in 80M mode
• 25—802.11ac (36 to
64) in 160M mode
• 26—802. 11ac (100 to
144) in 160M mode
• 27—802. 11ac (149 to
165) in 160M mode
• 28—802. 11ac (36 to
64) in 8080M mode
• 29—802. 11ac (100 to
144) in 8080M mode
• 30—802. 11ac (149 to
165) in 8080M mode
Enumeration:
The index value of
PowerIndex
power table
N/A • 1—System script N/A
• 2—Userscript
The sub-index
PowerSubIn
value of power N/A Unsigned short. N/A
dex
table

AP/ChannelDB
This table contains valid channel list of AP models.

XML structure
<AP>
<ChannelDB>
<Channel>
<PowerIndex></PowerIndex>

58
 <ChannelType></ChannelType>
<PowerSubIndex></PowerSubIndex>
<SupportedChannelList></SupportedChannelList>
</Channel>
</ChannelDB>
</AP>

Table description
Item Description
Feature name AP
Table name ChannelDB
Table type Multi-instance table
Row name Channel
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration: Refer to
The index value of AP/PowerIndex/PowerIn
PowerIndex
power table
Index • 1—System script
dex
• 2—Userscript

59
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—802.11b
• 2—802.11g
• 3—802.11n(2.4GHz)
in 20M mode
• 4—802.11n(2.4GHz)
in 40M mode
• 5—802.11gac in 20M
mode
• 6—802.11gac in 40M
mode
• 7—802.11a(36 to 64)
• 8—802.11a(100 to
144)
• 9—802.11a(149 to
165)
• 10—802.11n(5GHz)
(36 to 64) in 20M
mode
• 11—802.11n(5GHz)
(100 to 144) in 20M
mode
• 12—802.11n(5GHz)
(149 to 165) in 20M
mode
Type of spectrum, • 13—802.11n(5GHz) Refer to AP/
ChannelTyp (36 to 64) in 40M
bandwidth and Index ChannelTypeMap/Chann
e mode
channel range. elType.
• 14—802.11n(5GHz)
(100 to 144) in 40M
mode
• 15—802.11n(5GHz)
(149 to 165) in 40M
mode
• 16—802.11ac (36 to
64) in 20M mode
• 17—802. 11ac (100 to
144) in 20M mode
• 18—802. 11ac (149 to
165) in 20M mode
• 19—802.11ac (36 to
64) in 40M mode
• 20—802. 11ac (100 to
144) in 40M mode
• 21—802. 11ac (149 to
165) in 40M mode
• 22—802.11ac (36 to
64) in 80M mode
• 23—802. 11ac (100 to
144) in 80M mode
• 24—802. 11ac (149 to
165) in 80M mode
• 25—802.11ac (36 to
64) in 160M mode

60
 Column Column Column Data type and
Remarks
name description type restrictions
• 26—802. 11ac (100 to
144) in 160M mode
• 27—802. 11ac (149 to
165) in 160M mode
• 28—802. 11ac (36 to
64) in 8080M mode
• 29—802. 11ac (100 to
144) in 8080M mode
• 30—802. 11ac (149 to
165) in 8080M mode
The sub-index Refer to
PowerSubIn
value of power Index Unsigned short. AP/PowerIndex/PowerS
dex
table ubIndex
Number string.
It is a comma-separated list
Supported Example:
SupportedC of supported channels.
channel list of N/A
hannelList The string must not end 1,2,3
current model.
with a comma or hyphen,
or include any whitespace

AP/PowerDB
This table contains valid power values of AP models.

XML structure
<AP>
<PowerDB>
<Power>
<PowerIndex></PowerIndex>
<ChannelType></ChannelType>
<PowerSubIndex></PowerSubIndex>
<Channel></Channel>
<ValidMaxPower></ValidMaxPower>
</Power>
</PowerDB>
</AP>

Table description
Item Description
Feature name AP
Table name PowerDB
Table type Multi-instance table
Row name Power
Restrictions None

61
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration: Refer to
The index value of
PowerIndex
power table
Index • 1—System script AP/PowerIndex/PowerIn
• 2—User script dex

62
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—802.11b
• 2—802.11g
• 3—802.11n(2.4GHz)
in 20M mode
• 4—802.11n(2.4GHz)
in 40M mode
• 5—802.11gac in 20M
mode
• 6—802.11gac in 40M
mode
• 7—802.11a(36 to 64)
• 8—802.11a(100 to
144)
• 9—802.11a(149 to
165)
• 10—802.11n(5GHz)
(36 to 64) in 20M
mode
• 11—802.11n(5GHz)
(100 to 144) in 20M
mode
• 12—802.11n(5GHz)
(149 to 165) in 20M
mode
Type of spectrum, • 13—802.11n(5GHz) Refer to AP/
ChannelTyp (36 to 64) in 40M
bandwidth and Index ChannelTypeMap/Chann
e mode
channel range. elType.
• 14—802.11n(5GHz)
(100 to 144) in 40M
mode
• 15—802.11n(5GHz)
(149 to 165) in 40M
mode
• 16—802.11ac (36 to
64) in 20M mode
• 17—802. 11ac (100 to
144) in 20M mode
• 18—802. 11ac (149 to
165) in 20M mode
• 19—802.11ac (36 to
64) in 40M mode
• 20—802. 11ac (100 to
144) in 40M mode
• 21—802. 11ac (149 to
165) in 40M mode
• 22—802.11ac (36 to
64) in 80M mode
• 23—802. 11ac (100 to
144) in 80M mode
• 24—802. 11ac (149 to
165) in 80M mode
• 25—802.11ac (36 to
64) in 160M mode

63
 Column Column Column Data type and
Remarks
name description type restrictions
• 26—802. 11ac (100 to
144) in 160M mode
• 27—802. 11ac (149 to
165) in 160M mode
• 28—802. 11ac (36 to
64) in 8080M mode
• 29—802. 11ac (100 to
144) in 8080M mode
• 30—802. 11ac (149 to
165) in 8080M mode
The sub-index Refer to
PowerSubIn
value of power Index Unsigned short. AP/PowerIndex/PowerS
dex
table ubIndex
Refer to
Legal channel
Channel Index Unsigned short. AP/ChannelDB/Supporte
number.
dChannelList.
Legal maximum Unsigned short. Conform to IEEE 802.11
power. The upper The value range is related protocol , ISO 3166
ValidMaxPo limit of stantard and the related
N/A to AP model, radio mode,
wer configurable national and regional
antenna type, channel
maximum power. number and region code. laws and regulations.

AP/ChannelReport
This table contains the fileds which carry the channel reports of the Ap.

XML structure
<AP>
<ChannelReport>
<Channel>
<ApName></ApName>
<RadioID></RadioID>
<Channel></Channel>
<NeighborCount></NeighborCount>
<Load></Load>
<Utilization></Utilization>
<Interference></Interference>
<PacketErr></PacketErr>
<Retry></Retry>
<RadarStatus><RadarStatus>
</Channel>
</ChannelReport>
</AP>

64
Table description
Item Description
Feature name AP
Table name ChannelReport
Table type Multi-instance table
Row name Channel
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
Refer to
Legal channel
Channel Index Unsigned short. AP/ChannelDB/Supporte
number.
dChannelList.
Neighbour
NeighborCo
number of the N/A Unsigned integer. N/A
unt
legal channels.
Percentage of the
time for
transmitting all Unsigned integer.
packets on the
Load N/A Value range: 0 to 100. N/A
channel to the
total time for Unit: %.
scanning the
channel.
Percentage of the
time for
transmitting Unsigned integer.
Utilization packets of the N/A Value range: 0 to 100. N/A
BSS to the total Unit: %.
time for scanning
the channel.
Percentage of the
time for
transmitting Unsigned integer.
Interference packets of other N/A Value range: 0 to 100. N/A
BSSs to the total Unit: %.
time for scanning
the channel.

Packet error rate Unsigned integer.

PacketErr of the legal N/A Value range: 0 to 100. N/A
channel. Unit: %.

65
 Column Column Column Data type and
Remarks
name description type restrictions
Retransmission Unsigned integer.
Retry rate of the legal N/A Value range: 0 to 100. N/A
channel. Unit: %.
Boolean:
Radar detection • true—Radar is N/A
RadarStatus status at the legal N/A detected.
channel. • false—Radar is not
detected.

AP/NeighborAPReport
This table contains the fileds which carry the information of the Ap’s current neighbors.

XML structure
<AP>
<NeighborAPReport>
<Neighbor>
<ApName></ApName>
<RadioID></RadioID>
<MacAddress></MacAddress>
<Channel></Channel>
<Interference></Interference>
<SignalStrength></SignalStrength>
<NeighborType></NeighborType>
</Neighbor>
</NeighborAPReport>
</AP>

Table description
Item Description
Feature name AP
Table name NeighborAPReport
Table type Multi-instance table
Row name Neighbor
Restrictions None

66
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
If the neighbor is
unmanaged AP, this
column is MAC address;
Six groups of two or if the neighbor is
MacAddress MAC address Index hexadecimal digits, managed AP, it is basic
hyphen-separated. BSSID.
Example:
00-0c-af-e3-5d-c0.
Unsigned short.
Channel number
where the The value range is related
Channel N/A to AP model, radio mode, N/A
neighbor is
discovered. antenna type and country
code.
Percentage of the
time for
transmitting Unsigned integer.
packets of the
Interference N/A Value range: 0 to 100. N/A
neighbor to the
total time for Unit: %.
scanning the
channel.
An indication of the total
channel power (signal,
noise, and interference)
SignalStren Strength of signal Unsigned integer. of a received frame
N/A
gth received. Unit: dBm. measured on the
channel and at the
antenna connector used
to receive the frame.

Boolean:
Management N/A
NeighborTy • true—Managed
status of the N/A
pe neighbor.
neighbor.
• false—UnManaged
neighbor.

AP/EdcaRadio
This table contains radio EDCA information.

XML structure
<AP>
<EdcaRadio>

67
 <EdcaPara>
<ApName></ApName>
<RadioID></RadioID>
<AccessCategory></AccessCategory>
<Noack></Noack>
<CfgAifsn></CfgAifsn>
<CfgEcwmin></CfgEcwmin>
<CfgEcwmax></CfgEcwmax>
<CfgTxOpLimit></CfgTxOpLimit>
</EdcaPara>
</EdcaRadio>
</AP>

Table description
Item Description
Feature name AP
Table name EdcaRadio
Table type Multi-instance table
Row name EdcaPara
Restrictions None
Support for row creation and deletion No

Columns
Column Column
Column description Data type and restrictions Remarks
name type
String, case-sensitive. N/A.
ApName AP name. Index
Length:1to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
A label for the common set of
enhanced distributed channel Enumeration:
access
• 0—BK.
parameters that are used by
AccessCategory
a WMM STA to conten d for
Index • 1—BE. N/A
the channel in order to • 2—VI.
transmit MSDUs with • 3—VO.
certain priorities..
Whehter acknowledgement is Boolean:
Noack required. N/A • true—Not required. N/A
• false—Required.
ArbitrationInter Frame The value range conforms to
CfgAifsn N/A N/A
Spacing Number. “AP/RadiolDB/Aifsn” column.

68
 Column Column
Column description Data type and restrictions Remarks
name type
The value range conforms to
CfgEcwmin Exponent form of CWmin. N/A “AP/RadiolDB/Ecwmin” N/A
column.
The value range conforms to
CfgEcwmax Exponent form of CWmax. N/A “AP/RadiolDB/Ecwmax” N/A
column.
The value range conforms to
Transmission oppurtunity
CfgTxOpLimit N/A “AP/RadiolDB/TxOpLimit” N/A
limit.
column.

AP/RadioWmm
This table contains radio WMM information.

XML structure
<AP>
<RadioWmm>
<Wmm>
<ApName></ApName>
<RadioID></RadioID>
<Status></Status>
</Wmm>
</RadioWmm>
</AP>

Table description
Item Description
Feature name AP
Table name RadioWmm
Table type Multi-instance table
Row name Wmm
Restrictions None
Support for row creation
No
and deletion

69
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Boolean:
WMM status of
Status
radio.
N/A • true—Enable. N/A
• false—Disable.

AP/APGroup
This table contains information of AP groups.

XML structure
<AP>
<APGroup>
<Group>
<Name></Name>
<RuleNum></RuleNum>
<ModelNum></ModelNum>
<APNum></APNum>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
<ProvisionAutoUpgrade></ProvisionAutoUpgrade>
<ProvisionAutoRecover></ProvisionAutoRecover>
<LedMode></LedMode>
</Group>
</APGroup>
</AP>

70
Table description
Item Description
Feature name AP
Table name APGroup
Table type Multi-instance table
Row name Group
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
Name AP group name Index N/A
Length: 1 to 31 characters.

AP group Number of rules in Unsigned short.

the AP group N/A N/A
name Value range: 0 to 5.
Number of models Unsigned short.
ModelNum in the AP group N/A N/A
Value range: 0 to 65535.
Number of APs in Unsigned short.
APNum the AP group N/A N/A
Value range: 0 to 65535.
Region code of Conform to ISO 3166
RegionCode N/A Unsigned short.
AP group. stantard.
Whether the Boolean:
region code of the • true—Support.
RegionLock N/A N/A
AP group is
locked. • false—Not support.

AP connection Unsigned short.

Priority priority N/A N/A
Value range: 0 to 7.
Whether the AP in
this group will be Boolean:
forced to switch
Preempt N/A • true: Switch N/A
the backup tunnel
to active by • false: Not switch.
priority.
The transmit Unsigned short.
EchoInterval interval of tunnel N/A Value range: 0, 5 to 255. N/A
echo messages.
Unit: seconds
The allowed
maximum number
of echo messges
which are not Unsigned short.
EchoCount N/A N/A
received. If the Value range: 1 to 20.
count is reached,
the tunnel will be
down.

71
 Column Column Column Data type and
Remarks
name description type restrictions
The interval to Unsigned short.
RetransInter
retransmit a N/A Value range: 1 to 30. N/A
val
request message. Unit: seconds
The allowed
maximum number
of retransmission Unsigned short.
RetransCou
attempts. If the N/A Value range: 1 to 20. N/A
nt
count is reached, Unit: seconds
the tunnel will be
down.
The interval of AP
sending the Unsigned short.
StatisInterva
statistics N/A Value range: 0 to 240. N/A
l
informations to Unit: seconds
AC.
Whether the AC
will upgrade AP’s Boolean:
FirmwareUp firmware
grade automatically if the
N/A • true—Enable N/A
software is • false—Disable
mismatch.
BackupACI The IPv4 backup String, dotted decimal
N/A Example: 1.1.1.1.
Pv4 AC address. notation.
BackupACI The IPv6 backup Hexadecimal string,
N/A Example: 1:1::1:1.
Pv6 AC address. colon-separated.
Which location the String, lowercase.
LocationNa
AP group belongs N/A N/A
me Length: 1 to 31 characters.
to.

The description of String,

Description N/A N/A
APGroup. Length: 1 to 64 cahracters
Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable
Whether to enable Boolean:
ProvisionAut provision
oUpgrade
N/A • true—Enable. N/A
auto-upgrade
• false—Disable.
Whether to enable Boolean:
ProvisionAut provision
oRecover
N/A • true—Enable. N/A
auto-recover
• false—Disable.
Enumeration:
• 0—Normal
LedMode LED mode N/A • 1—Quiet N/A
• 2—Awake
• 3—Always-on

AP/APGroupMACRule
This table contains information of AP groups’ rules of MAC address.

72
XML structure
<AP>
<APGroupMACRule>
<Rule>
<GroupName></GroupName>
<MacAddress></MacAddress>
</Rule>
</APGroupMACRule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupMACRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
Six groups of two
Example:
MacAddress AP MAC address Index hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.

AP/APGroupSerialIDRule
This table contains information of AP groups’ rules of serial ID.

XML structure
<AP>
<APGroupSerialIDRule>
<Rule>
<GroupName></GroupName>
<SerialID></SerialID>
<Rule>
</APGroupSerialIDRule>
</AP>

73
Table description
Item Description
Feature name AP
Table name APGroupSerialIDRule
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, uppercase.
SerialID AP serial ID Index Length: 1 to 127 N/A
characters.

AP/APGroupNameRule
This table contains information of AP groups’ rules of AP name.

XML structure
<AP>
<APGroupNameRule>
<Rule>
<GroupName></GroupName>
<APName></APName>
<Rule>
</APGroupNameRule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupNameRule
Table type Multi-instance table
Row name Rule
Restrictions None

74
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-sensitive.
APName AP name Index N/A
Length: 1 to 64 characters.

AP/APGroupIPv4Rule
This table contains information of AP groups’ rules of IPv4 address range.

XML structure
<AP>
<APGroupIPv4Rule>
<Rule>
<GroupName></GroupName>
<IPv4Addr></IPv4Addr>
<IPv4Wildcard></IPv4Wildcard>
<Rule>
</APGroupIPv4Rule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupIPv4Rule
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
IPv4 address of String, dotted decimal
IPv4Addr Index Example: 1.1.1.1.
AP. notation.

75
 Column Column Column Data type and
Remarks
name description type restrictions
Wildcard mask for
IPv4Wildcar String, dotted decimal
the IPv4 address Index Example: 255.255.255.0.
d notation.
of AP.

AP/APGroupIPv6Rule
This table contains information of AP groups’ rules of IPv6 address range.

XML structure
<AP>
<APGroupIPv6Rule>
<Rule>
<GroupName></GroupName>
<IPv6Addr></IPv6Addr>
<IPv6Wildcard></IPv6Wildcard>
<Rule>
</APGroupIPv6Rule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupIPv6Rule
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
Example: 1:1::1:1.
Source IPv6 Hexadecimal string, This column is available
IPv6Addr Index
address. colon-separated. when the SrcAny column
is false.
Length of the Unsigned integer. This column is available
IPv6Wildcar
source IPv6 Index when the SrcAny column
d Value range: 1 to 128.
address prefix. is false.

76
AP/APGroupModel
This table contains information of AP group models.

XML structure
<AP>
<APGroupModel>
<Model>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioNum></RadioNum>
</Model>
</APGroupModel>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupModel
Table type Multi-instance table
Row name Model
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.

Number of the Unsigned short.

RadioNum N/A N/A
radio Value range: 1 to 4.

AP/APGroupRadio
This table contains information of AP group radios.

XML structure
<AP>
<APGroupRadio>

77
 <Radio>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<Mode></Mode>
<SupportDot11B></SupportDot11B>
<SupportDot11A></SupportDot11A>
<SupportDot11G></ SupportDot11G>
<SupportDot11GN></SupportDot11GN>
<SupportDot11AN></SupportDot11AN>
<SupportDot11AC></SupportDot11AC>
<Bandwidth></Bandwidth>
<Spectrum></Spectrum>
<Status></Status>
<RateMulticast></RateMulticast>
<RateMandatory></RateMandatory>
<RateSupported></RateSupported>
<RateDisabled></RateDisabled>
<Preamble></Preamble>
<BeaconInterval></BeaconInterval>
<PowerLock></PowerLock>
<Distance></Distance>
<MaxRxDuration></MaxRxDuration>
<FragmentThreshold></FragmentThreshold>
<LongRetryThreshold></LongRetryThreshold>
<ProtectionThreshold></ProtectionThreshold>
<ShortRetryThreshold></ShortRetryThreshold>
<CfgChannel></CfgChannel>
<CfgMaxPower></CfgMaxPower>
</Radio>
</APGroupRadio>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupRadio
Table type Multi-instance table
Row name Radio
Restrictions None

78
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)

Whether a radio Boolean:

SupportDot1
1B
supports 802.11b N/A • true—Support. N/A
radio mode • false—Not support.
Whether a radio Boolean:
SupportDot1 supports 802.11a
1A
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports 802.11g
1G
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports
1GN 802.11n(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AN 802.11n(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AC 802.11ac(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth N/A N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M

79
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—Support both
Supported radio 5GHz and 2.4GHz
Spectrum N/A N/A
spectrum • 2—Support 5GHz only
• 3—Support 2.4GHz
only
Enumeration:
• 0—Disable
Status Radio status N/A N/A
• 1—Enable
• 2—Inherit
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps
• 8—18Mbps
RateMultica • 9—24Mbps
Multicast rate N/A N/A
st • 10—36Mbps
• 11—48Mbps
• 12—54Mbps
• 13—auto
The value range conforms
to
“AP/RadioOfManualAP/Cfg
RateMandatory” column. If
this column is not
configured, the multicast
rate will be calculated
automatically.

80
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps
• 8—18Mbps
RateMandat
Mandatory rate N/A • 9—24Mbps The value can have
ory multi-selections.
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Default value:
A. 1, 2Mbps(802.11b).
B. 6, 12,
24Mbps(802.11a/802.1
1an)
C. 1, 2, 5.5,
11Mbps(802.11g/802.1
1gn)
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps
• 8—18Mbps The value can have
RateSupport
Supported rate N/A • 9—24Mbps multi-selections, exclude
ed the one which multicast
• 10—36Mbps
rate uses.
• 11—48Mbps
• 12—54Mbps
Default value:
A. 5.5, 11Mbps(802.11b)
B. 9, 18, 24, 36, 48,
54Mbps(802.11a/802.1
1an)
C. 6, 9, 12, 18, 24, 36,
54Mbps(802.11g/802.1
1gn)

81
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
The value can have
RateDisable • 6—11Mbps multi-selections, exclude
Disabled rate N/A
d • 7—12Mbps the one which multicast
rate uses.
• 8—18Mbps
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps

Boolean:
• true—Short. N/A
Preamble Preamble N/A • false—Long.
The column is only for
2.4GHz radio mode.

Unsigned short.
BeaconInter Beacon Interval The value range is
N/A N/A
val time 32~8191.
Unit: TU. 1TU = 1024ms
Boolean:
PowerLock Lock the power N/A • true—Enable. N/A
• false—Disable.
Unsigned short.
The distance that
Distance N/A The value range is 1~40. N/A
Radio can cover
Unit: km(kilometre).
Unsigned integer.
Max Reveived The value range is
MaxRxDurat
frame duration N/A 500~250000. N/A
ion
time
Unit: ms.
Unsigned short.
The value range is
FragmentTh Fragment
N/A 256~2346. And the value N/A
reshold threshold
must be an even number.
Unit: byte.
Unsigned short.
LongRetryT Long retry
N/A The value range is 1~15. N/A
hreshold threshold
Unit: null.
Unsigned short.
ProtectionT Protection
N/A The value range is 0~2346. N/A
hreshold threshold
Unit: byte.

82
 Column Column Column Data type and
Remarks
name description type restrictions
Unsigned short.
ShortRetryT Short retry
N/A The value range is 1~15. N/A
hreshold threshold
Unit: null.
When the value is 15, the
radio automatically
selects an optimal
The value range conforms channel, and then locks
to the channel.
Configured AP/ChannelDB/Supported
CfgChannel N/A When the AC detects
channel number ChannelList” column.
any radar signals on its
And 15 –auto lock、 channel, it immediately
16-auto unlock. selects another channel
(even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
Value range: 1 to
CfgMaxPow Configured
N/A “AP/PowerDB/ValidMaxPo N/A
er maximum power
wer”.
Unit: dBm

AP/APGroupRadio11n
This table contains 802.11n information of AP group radios.

XML structure
<AP>
<APGroupRadio11n>
<Radio11n>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<MCSMulticast></MCSMulticast>
<MCSMandatory></MCSMandatory>
<MCSSupported></MCSSupported>
<Ampdu></Ampdu>
<Amsdu></Amsdu>
<ShortGI></ShortGI>
<Stbc></Stbc>
<Ldpc></Ldpc>
<Mimo></Mimo>
<Greenap></Greenap>
<SmartAntenna></SmartAntenna>
<SmartAntennaPolicy></SmartAntennaPolicy>
<Protection></Protection>
<Client11nOnly></Client11nOnly>
<BandwidthAutoswitch></ BandwidthAutoswitch >

83
 </Radio11n>
</APGroupRadio11n>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupRadio11n
Table type Multi-instance table
Row name Radio11n
Restrictions The table is only for 802.11n and 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
Unsigned short.
The MCSMulticast must
MCSMultica The index for Value range: 0 to 76, and
N/A be smaller than or equal
st multicast MCS. 255. to the MCSMandatory.
Default value is 255.
The MCSMandatory
Unsigned short. must be smaller than or
The maximum equal to the
MCSMandat Value range: 0 to 76, and
index for N/A MCSSupported, and the
ory 255.
mandatory MCS. MCSMandatory must be
Default value is 255. greater than or equal to
the MCSMulticast.
Unsigned short. The MCSSupported
The maximum
MCSSuppor Value range: 0 to 76, and must be greater than or
index for N/A
ted 255. equal to the
supported MCS.
Default value is 76. MCSMandatory.

Boolean:
Ampdu A-mpdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Amsdu A-msdu function. N/A • true—Enable. N/A
• false—Disable.

84
 Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
ShortGI Short GI function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Stbc STBC function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Ldpc LDPC function. N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 1: 1X1
Mimo MIMO. N/A • 2: 2X2 N/A
• 3: 3X3
• 4: 4X4
Boolean:
Greenap Green ap function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
SmartAnten Smart antenna
na function
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
Effective only when
SmartAnten Smart antenna • 1: Auto
N/A SmartAntenna is
naPolicy policy • 2: High-availability enabled.
• 3: High-throughput
802.11n Boolean:
Protection protection N/A • true—Enable. N/A
function.
• false—Disable.
Boolean:
Client11nOn Client dot11n only
ly function.
N/A • true—Enable. N/A
• false—Disable.
Boolean:
• true—Enable. N/A
BandwidthA
Bandwidth • false—Disable.
autoswitch N/A
utoswitch The column is only for
function
2.4GHz radio mode, and
AP/APGroupRadio/Bandwi
dth must be 2.

AP/APGroupRadio11ac
This table contains 802.11ac information of AP group radios.

XML structure
<AP>

85
 <APGroupRadio11ac>
<Radio11ac>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<VHTNSSMulticast></VHTNSSMulticast>
<VHTMCSMulticast></VHTMCSMulticast>
<VHTNSSMandatory></VHTNSSMandatory>
<VHTNSSSupported></VHTNSSSupported>
<Client11acOnly></Client11acOnly>
</Radio11ac>
</APGroupRadio11ac>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupRadio11ac
Table type Multi-instance table
Row name Radio11ac
Restrictions The table is only for 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
The VHTNSSMulticast
The NSS for Unsigned short.
VHTNSSMu must be smaller than or
multicast N/A
lticast Value range: 0 to 8. equal to the
VHT-MCS.
VHTNSSMandatory.
The index for Unsigned short.
VHTMCSMu
multicast N/A Value range: 0 to 9, 255. N/A
lticast
VHT-MCS.

86
 Column Column Column Data type and
Remarks
name description type restrictions
The VHTNSSMandatory
must be smaller than or
The maximum equal to the
VHTNSSMa NSS for Unsigned short. VHTNSSSupported, and
N/A
ndatory mandatory Value range: 0 to 8. the VHTNSSMandatory
VHT-MCS. must be greater than or
equal to the
VHTNSSMulticast.
The VHTNSSSupported
The maximum Unsigned short.
VHTNSSSu must be greater than or
NSS for supported N/A
pported Value range: 0 to 8. equal to the
VHT-MCS.
VHTNSSMandatory.
Boolean:
Client11acO Client dot11ac
nly only function.
N/A • true—Enable. N/A
• false—Disable.

AP/APGroupPrvs
This table contains provision information of AP Group.

XML structure
<AP>
<APGroupPrvs>
<Prvs>
<GroupName></GroupName>
<ACHostName></ACHostName>
<ACIPv4></ACIPv4>
<ACIPv6></ACIPv6>
<DnsDomain></DnsDomain>
<DnsServerIPv4></DnsServerIPv4>
<DnsServerIPv6></DnsServerIPv6>
</Prvs>
</APGroupPrvs>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvs
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
No
and deletion

87
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String.
ACHostNam Specify an AC by
N/A Length: 1 to 253 N/A
e its hostname.
characters.
List of string, dotted
Specify an AC by Example: 1.1.1.1,
ACIPv4 N/A decimal notation,
its IPv4 address. 1.1.1.2.
Separated by comma.
List of hexadecimal string,
Specify an AC by Example:
ACIPv6 N/A colon-separated,
its IPv6 address. 1:1::1:1,1:1::1:2.
Separated by comma.
Specify the String.
DnsDomain domain name N/A N/A
suffix. Length: 1 to 253.

Specify a DNS
DnsServerI String, dotted decimal
server by its IPv4 N/A Example: 1.1.1.1.
Pv4 notation.
address.
Specify a DNS
DnsServerI Hexadecimal string,
server by its IPv6 N/A Example: 1:1::1:1.
Pv6 colon-separated.
address.

AP/APGroupPrvsACIPv4
This table contains provision information of AP Group of IPv4 address.

XML structure
<AP>
<APGroupPrvsACIPv4>
<Prvs>
<GroupName></GroupName>
<ACIPv4></ACIPv4>
</Prvs>
</APGroupPrvsACIPv4>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvsACIPv4
Table type Multi-instance table

88
 Item Description
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, dotted decimal
GroupName AP group name Index Example: 1.1.1.1.
notation.
List of string, dotted
Specify an AC by Example: 1.1.1.1,
ACIPv4 N/A decimal notation,
its IPv4 address. 1.1.1.2.
Separated by comma.

AP/APGroupPrvsACIPv6
This table contains provision information of AP group of IPv6 address.

XML structure
<AP>
<APGroupPrvsACIPv6>
<Prvs>
<GroupName></GroupName>
<ACIPv6></ACIPv6>
</Prvs>
</APGroupPrvsACIPv6>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvsACIPv6
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

89
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
Example: 1:1::1:1.
Specify an AC by Hexadecimal This column is available
ACIPv6 N/A
its IPv6 address. string, colon-separated. when the SrcAny column
is false.

AP/APListOfGroup
This table contains the AP list of AP groups.

XML structure
<AP>
<APListOfGroup>
<AP>
<GroupName></GroupName>
<ApName></ApName>
</AP>
</APListOfGroup>
</AP>

Table description
Item Description
Feature name AP
Table name APListOfGroup
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-sensitive.
ApName AP name Index N/A
Length: 1 to 64 characters.

90
AP/Location
This table contains the informations of locations.

XML structure
<AP>
<Location>
<Location>
<LocationName></LocationName>
</Location>
</Location>
<AP>

Table description
Item Description
Feature name AP
Table name Location
Table type Multi-instance table
Row name Location
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
LocationNa String, lowercase.
Location name Index N/A
me Length: 1 to 31 characters.

AP/APAuthentication
This table contains the informations of AP authentication.

XML structure
<AP>
<APAuthentication>
<Status></Status>
<Method></Method>
<PermitUnauth></PermitUnauth>
<AuthDomain></AuthDomain>
<AclNumber></AclNumber>
<AclName></AclName>
</APAuthentication>

91
 </AP>

Table description
Item Description
Feature name AP
Table name APAuthentication
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
The status of AP
Status
authentication.
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
The authentication
Method
method
N/A • 1—MAC address. N/A
• 2—Serial ID.
Whether the Boolean:
PermitUnaut un-authenticated • true—Allowed.
N/A N/A
h AP is allowed to
join the AC. • false—Not allowed.

The ISP domain of String, case-insensitive.

AuthDomain remote AP N/A N/A
authentication. Length: 1 to 24 characters.

The ACL number Unsigned short. This column is

AclNumber of local AP N/A unavailable when the AC
authentication. Value range: 200 to 299. uses an ACL name.
This column is
The ACL name of unavailable when the AC
String, case-sensitive.
AclName local AP N/A uses an ACL number.
authentication. Length: 1 to 64 characters.
The ACL name should
not be “all”.

AP/HistorySummary
This table contains information of history summary.

XML structure
<AP>
<HistorySummary>
<Record>
<Date></Date>

92
 <Time></Time>
<ManualApNum></ManualApNum>
<RunApNum></RunApNum>
<OfflineApNum></OfflineApNum>
<UnhealthyApNum></UnhealthyApNum>
<ApGroupNum></ApGroupNum>
<LocationNum></LocationNum>
<NorthIfOutPkt></NorthIfOutPkt>
<NorthIfOutByte></NorthIfOutByte>
<NorthIfInPkt></NorthIfInPkt>
<NorthIfInByte></NorthIfInByte>
</Record>
</HistorySummary>
</AP>

Table description
Item Description
Feature name AP
Table name HistorySummary
Table type Multi-instance table
Row name Record
Restrictions None

Columns
Column Column Column Data type and Remarks
name description type restrictions
Format: YYYY-MM-DD.
The date of the
Date Index Value range: 1970-01-01 to N/A
record,
2100-12-31.
Format: hh:mm.
The time of the
Time Index Value range: 00:00 to N/A
record.
23:59.
ManualApN Number of manual Unsigned integer.
um APs N/A N/A
Value range: 0 to 65535.
Number of running Unsigned integer.
Index APs N/A N/A
Value range: 0 to 65535.
OfflineApNu Number of offline Unsigned integer.
m APs N/A N/A
Value range: 0 to 65535.
UnhealthyA Number of Unsigned integer.
pNum Unhealthy APs N/A N/A
Value range: 0 to 65535.
ApGroupNu Number of AP Unsigned integer.
m groups N/A N/A
Value range: 0 to 65535.

93
 LocationNu Number of Unsigned integer.
m locations N/A N/A
Value range: 0 to 65535.
Packets count of
northbound Unsigned integer.
NorthIfOutP
interface with N/A Value range: 0 to N/A
kt
outbound 4294967295.
direction.
Throughput
statistics of Unsigned integer.
NorthIfOutB northbound
N/A Value range: 0 to N/A
yte interface with
outbound 4294967295.
direction.
Packets count of Unsigned integer.
northbound
NorthIfInPkt N/A Value range: 0 to N/A
interface with
inbound direction. 4294967295.

Throughput
statistics of Unsigned integer.
NorthIfInByt
northbound N/A Value range: 0 to N/A
e
interface with 4294967295.
inbound direction.

AP/AllAP
This table contains the information of all APs.

XML structure
<AP>
<AllAP>
<AP>
<LocationName></LocationName>
<Name></Name>
<Type></Type>
<Status></Status>
<GroupName></GroupName>
<SerialID></SerialID>
<MacAddress></MacAddress>
<Ipv4Address></Ipv4Address>
<Ipv6Address></Ipv6Address>
<OnlineTime></OnlineTime> </AP>
</AllAP>
</AP>

Table description
Item Description
Feature name AP

94
 Item Description
Table name AllAP
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
LocationNa Which location the String, lowercase.
Index N/A
me AP belongs to. Length: 1 to 31 characters.
String, case-sensitive.
Name AP name Index N/A
Length: 1 to 64 characters.
Enumeration:
• 1—Online
AP associated
Status N/A • 2—Offline N/A
status
• 3—Image
downloading
Enumeration:
Type AP type N/A • 1—auto N/A
• 2—manual
The name of AP String, lowercase.
GroupName group which the N/A N/A
AP belongs to. Length: 1 to 31 characters.

String, uppercase.
SerialID AP serial ID. N/A Length: 1 to 127 N/A
characters.
N/A Six groups of two
Example:
MacAddress AP MAC address. hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.
Example: 1.1.1.1.
String, dotted decimal This column is
Ipv4Address AP IPv4 address. N/A
notation. unavailable when the AP
uses an IPv6 address.
Example: 1:1::1:1.
Hexadecimal string, This column is
Ipv6Address AP IPv6 address. N/A
colon-separated. unavailable when the AP
uses an IPv4 address.
Unsigned integer.
AP online Value range: 0 to
OnlineTime N/A N/A
duration. 4294967295.
Unit: Second

95
AP/LocalACDB
This table contains local-ac model information.

XML structure
<AP>
<LocalACDB>
<Model>
<ModelName></ModelName>
<HardwareVersion></HardwareVersion>
<SoftwareVersion></SoftwareVersion>
</Model>
</LocalACDB>
</AP>

Table description
Item Description
Feature name AP
Table name LocalACDB
Table type Multi-instance table
Row name Model
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Local-ac model String, case-insensitive.
ModelName name Index N/A
Length: 1 to 63 characters.
Enumeration:
• 1—Ver.A
• 2—Ver.B
HardwareVe The version of
Index • 3—Ver.C N/A
rsion Hardware.
• 4—Ver.D
• 5—Ver.E
• 6—Ver.F
SoftwareVer The version of String
sion Software. N/A N/A
Length:1 to 31.

AP/LocalAC
This table contains information of local-ac.

96
XML structure
<AP>
<LocalAC>
<AC>
<Name></Name>
<Model></Model>
<CfgSerialID></CfgSerialID>
<Status></Status>
<EchoInterval></EchoInterval>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<FirmwareUpgrade></FirmwareUpgrade>
<Ipv4Address></Ipv4Address>
<Ipv6Address></Ipv6Address>
</AC>
</LocalAC>
</AP>

Table description
Item Description
Feature name AP
Table name LocalAC
Table type Multi-instance table
Row name AC
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name Local-ac name Index N/A
Length: 1 to 64 characters.
Local-ac model String, case-insensitive.
Model name N/A N/A
Length: 1 to 63 characters.
Configured String, uppercase.
CfgSerialID Local-ac serial ID N/A N/A
Length: 1 to 63 characters.
Enumeration:
Local-ac • 1—Online
Status N/A N/A
associated status • 2—Offline
• 3—Image downloading

97
 Column Column Column Data type and
Remarks
name description type restrictions
The transmit Unsigned short.
EchoInterval interval of tunnel N/A Value range: 0, 5 to 255. N/A
echo messages. Unit: seconds

The interval to Unsigned short.

RetransInter
retransmit a N/A Value range: 3 to 8 N/A
val
request message. Unit: seconds
The allowed
maximum number
of retransmission Unsigned short.
RetransCou
attempts. If the N/A Value range: 2 to 5. N/A
nt
count is reached, Unit: seconds
the tunnel will be
down.
Whether the AC
will upgrade AP’s Boolean:
FirmwareUp firmware
grade automatically if the
N/A • true—Enable. N/A
software is • false—Disable.
mismatch.
Example: 1.1.1.1.
Local AC IPv4 String, dotted decimal This column is
Ipv4Address N/A
address notation. unavailable when the AC
uses an IPv6 address.
Example: 1:1::1:1.
Local AC IPv6 Hexadecimal string, This column is
Ipv6Address N/A unavailable when the
address colon-separated.
ACuses an IPv4
address.

AP/ContainerTopology
This table contains information about all PoE ports on the container and units (such as WAP and
WTU) connected to the container (such as SPM and WT).

XML structure
<AP>
<ContainerTopology>
<Container>
<ContainerName></ContainerName>
<PoePort></PoePort>
<PoeStatus></PoeStatus>
<UnitName></UnitName>
</Container>
</ContainerTopology>
</AP>

98
Table description
Item Description
Feature name AP
Table name ContainerTopology
Table type Multi-instance table
Row name Container
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContainerNa String, case-sensitive.
me Container name Index N/A
Length: 1 to 64 characters.
Port on the
PoePort Index Unsigned short. See AP/APDB/.
container
Boolean:
PoeStatus PoE port status N/A • true—Enable. N/A
• false—Disable.
String, case-sensitive.
UnitName Unit name N/A N/A
Length: 1 to 64 characters.

AP/Container
This table contains information about containers.

XML structure
<AP>
<Container>
<AP>
<Name></Name>
<Model></Model>
<CfgMacAddress></CfgMacAddress>
<APNum></APNum>
<Status></Status>
<Ipv4Address></Ipv4Address>
<Ipv6Address></Ipv6Address>
<OnlineTime></OnlineTime>
<LastDownReason></LastDownReason>
<LastRebootReason></LastRebootReason>
<OfflineMoment></OfflineMoment>
</AP>

99
 </Container>
</AP>

Table description
Item Description
Feature name AP
Table name Container
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name Index N/A
Length: 1 to 64 characters.
String, case-insensitive.
Model AP model name N/A N/A
Length: 1 to 63 characters.
Six groups of two
CfgMacAddr Configured AP Example:
N/A hexadecimal digits,
ess MAC address 00-0c-af-e3-5d-c0.
hyphen-separated.
Number of APs Unsigned integer.
APNum connected to the N/A Value range: 0 to 65535. N/A
container
Enumeration:
AP association • 1—Online.
Status N/A N/A
status • 2—Image
downloading.
Example: 1.1.1.1.
String, dotted decimal This column is
Ipv4Address AP IPv4 address N/A
notation. unavailable when the AP
uses an IPv6 address.
Example: 1:1::1:1.
Hexadecimal string, This column is
Ipv6Address AP IPv6 address N/A
colon-separated. unavailable when the AP
uses an IPv4 address.
Unsigned integer.
Time since the AP Value range: 0 to
OnlineTime N/A N/A
came online. 4294967295.
Unit: Second
Cause of the String.
LastDownR
tunnel down the N/A N/A
eason Length: 1 to 31 characters.
last time.

100
Column Column Column Data type and
Remarks
name description type restrictions
Cause of the AP String.
LastReboot
rebooting in last N/A Length: 1 to 31 characters. N/A
Reason
time.
DateTime.
OfflineMom The time of the AP Example:
N/A Format:
ent offline in last time. 2014-05-07T09:35:07
YYYY-MM-DDTHH:MM:SS

101
Contents
AppProfile·······················································································1
AppProfile/Profiles ····················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
AppProfile
AppProfile/Profiles
This table contains application profile information.

XML structure
<AppProfile>
<Profiles>
<Profile>
<ProfileName></ProfileName>
</Profile>
</Profiles>
</AppProfile>

Table description
Item Description
Feature name AppProfile
Table name Profiles
Table type Multi-instance table
Row name Profile
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String: case-insensitive.
Name of the
Length: 1 to 100 characters.
ProfileName application Index N/A
profile Only numbers, letters, and
underscores (_) are allowed.

1
Contents
AppProfile·······················································································1
AppProfile/Profiles ····················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
AppProfile
AppProfile/Profiles
This table contains application profile information.

XML structure
<AppProfile>
<Profiles>
<Profile>
<ProfileName></ProfileName>
</Profile>
</Profiles>
</AppProfile>

Table description
Item Description
Feature name AppProfile
Table name Profiles
Table type Multi-instance table
Row name Profile
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String: case-insensitive.
Name of the
Length: 1 to 100 characters.
ProfileName application Index N/A
profile Only numbers, letters, and
underscores (_) are allowed.

1
Contents
AppProxy ·······················································································1
AppProxy/MoveBeforeRules········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AppProxy/ImportCertificates ········································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AppProxy/DeleteCertificates ········································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
AppProxy/CommitWhiteLists ········································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4

i
AppProxy
AppProxy/MoveBeforeRules
This table is used to move a rule to before another rule.

XML structure
<AppProxy>
<MoveBeforeRules>
<Rule>
<ID></ID>
<DestID></DestID>
</Rule>
</MoveBeforeRules>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name MoveBeforeRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ID of the rule to Unsigned integer.
ID N/A N/A
be moved Value range: 1 to 65535
ID of the
Unsigned integer. When the value is
reference rule
DestID N/A 65536, the rule is
before which the Value range: 1 to 65536 placed after all rules.
rule is placed

AppProxy/ImportCertificates
This table is used to import the certificate for SSL server in SSL decryption.

1
XML structure
<AppProxy>
<ImportCertificates>
<ImportCertificate>
<FileName></FileName>
<Trust></Trust>
<Password></Password>
</ImportCertificate>
</ImportCertificates>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name ImportCertificates
Table type Multi-instance table
Row name ImportCertificate
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
File name of the String, case-insensitive.
FileName Index N/A
certificate Length: 1 to 255 characters.
Enumeration:
Credibility of the • 0—untrust.
Trust N/A N/A
certificate • 1—trust.
• 2—untrust and trust.

Password of the String, case-insensitive.

Password N/A N/A
certificate Length: 1 to 31 characters.

AppProxy/DeleteCertificates
This table is used to delete the imported certificate.

XML structure
<AppProxy>
<DeleteCertificates>
<FileName></FileName>
</DeleteCertificates>

2
 </AppProxy>

Table description
Item Description
Feature name AppProxy
Table name DeleteCertificates
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
File name of the String, case-insensitive.
FileName Index. N/A
certificate Length: 1 to 255 characters.

AppProxy/CommitWhiteLists
This table contains information about committing SSL whitelist.

XML structure
<AppProxy>
<CommitWhiteLists>
<Commit></Commit>
</CommitWhiteLists>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name CommitWhiteLists
Table type Single-instance table
Row name None
Restrictions None

3
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Action of
Commit committing SSL N/A This column must be empty. N/A
whitelist

4
Contents
AppProxy ·······················································································1
AppProxy/PolicyRules ················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AppProxy/RuleSrcAddrs ·············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AppProxy/RuleDestAddrs ············································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
AppProxy/RuleSrcSecZones ········································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
AppProxy/RuleDestSecZones······································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6
AppProxy/RuleUsers ·················································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7
AppProxy/RuleUserGrps ············································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8
AppProxy/RuleServGrps·············································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ···························································································································· 9
AppProxy/WhiteListHostNames ···································································································· 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
AppProxy/WhiteListPredefine ····································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 10
Columns ·························································································································· 11
AppProxy/WhiteListPredefineChromeHsts ····················································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 12
AppProxy/TrustCertificate ·········································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 12

i
AppProxy
AppProxy/PolicyRules
This table contains proxy rule information.

XML structure
<AppProxy>
<PolicyRules>
<Rule>
<ID></ID>
<RuleName></RuleName>
<Action></Action>
<Enable></Enable>
</Rule>
</PolicyRules>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name PolicyRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
When creating a rule, if the
ID is set to 0, the device will
Unsigned integer.
ID Rule ID Index automatically assign an ID.
Value range: 0 to 65536.
The value 65536 is
reserved for default rule.
The value cannot be
“default”.
String, case-insensitive.
RuleName Rule name N/A When operating the default
Length: 1 to 63 characters.
rule, this column cannot be
specified.
Action Action for the N/A Enumeration: N/A

1
 Column Column Column Data type and
Remarks
name description type restrictions
rule • 1—No proxy.
• 2—SSL decrypt.
• 3—TCP proxy.
Enumeration: When operating the default
Enabling status
Enable
of the rule
N/A • 0—Disabled. rule, this column cannot be
• 1—Enabled. set to 0.

AppProxy/RuleSrcAddrs
This table contains source address object group information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleSrcAddrs>
<SrcAddr>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
</SrcAddr>
</RuleSrcAddrs>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleSrcAddrs
Table type Multi-instance table
Row name SrcAddr
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

2
 Column Column Column Data type and
Remarks
name description type restrictions
Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.

Data Members include:

NameList Object group list N/A
structure • NameItem
Name of the String, case-insensitive.
NameItem source address N/A The value cannot be “any”.
object group Length: 0 to 31 characters.

AppProxy/RuleDestAddrs
This table contains destination address object group information for an existing app-proxy policy
rule.

XML structure
<AppProxy>
<RuleDestAddrs>
<DestAddr>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
</DestAddr>
</RuleDestAddrs>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleDestAddrs
Table type Multi-instance table
Row name DestAddr
Restrictions None
Support for row creation and deletion Yes

3
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.

Data Members include:

NameList Object group list N/A
structure • NameItem
Name of the
destination String, case-insensitive.
NameItem N/A The value cannot be “any”.
address object Length: 0 to 31 characters.
group

AppProxy/RuleSrcSecZones
This table contains source security zone information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleSrcSecZones>
<SrcSecZone>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
</SrcSecZone>
</RuleSrcSecZones>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleSrcSecZones
Table type Multi-instance table
Row name SrcSecZone
Restrictions None
Support for row creation and deletion Yes

4
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.

Data Members include:

NameList Zone list N/A
structure • NameItem
Name of the String, case-insensitive. The value cannot be
NameItem source security N/A
Length: 0 to 31 characters. “any”.
zone

AppProxy/RuleDestSecZones
This table contains destination security zone information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleDestSecZones>
<DestSecZone>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
<DestSecZone>
</RuleDestSecZones>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleDestSecZones
Table type Multi-instance table
Row name DestSecZone
Restrictions None
Support for row creation and deletion Yes

5
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.

Data Members include:

ZoneList Zone list N/A
structure • NameItem
Name of the String, case-insensitive. The value cannot be
NameItem destination N/A
Length: 0 to 31 characters. “any”.
security zone

AppProxy/RuleUsers
This table contains user information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleUsers>
<User>
<ID></ID>
<IsIncrement></IsIncrement>
<UserList>
<UserName></UserName>
<DomainName></DomainName>
</UserList>
</User>
</RuleUsers>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleUsers
Table type Multi-instance table
Row name User
Restrictions None
Support for row creation and deletion Yes

6
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.
Members include:
Data
UserList User list
structure • UserName N/A
• DomainName
The user name cannot
String, case-sensitive. be a, al, or all, and it
UserName Name of the user N/A cannot contain any of the
Length: 1 to 55 characters. following characters: \ | / :
* ? < > @.
The domain name
cannot contain any of the
following characters: \ |
String, case-sensitive. / ?: * ? < > @, and it
Name of the
DomainName N/A cannot be d, de, def,
domain Length: 0 to 255 characters. defa, defau, defaul,
default, i, if, if-, if-u, if-un,
if-unk, if-unkn, if-unkno,
if-unknow, or if-unknown.

AppProxy/RuleUserGrps
This table contains user group information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleUserGrps>
<UserGrp>
<ID></ID>
<IsIncrement></IsIncrement>
<UserGrpList>
<UserGrpName></UserGrpName>
<DomainName></DomainName>
</UserGrpList>
</UserGrp>
</RuleUserGrps>
</AppProxy>

7
Table description
Item Description
Feature name AppProxy
Table name RuleUserGrps
Table type Multi-instance table
Row name UserGrp
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.
Members include:
Data
UserGrpList User group list
structure • UserGrpName N/A
• DomainName

UserGrpNam Name of the String, case-insensitive.

N/A N/A
e user group Length: 1 to 200 characters.
The domain name cannot
contain any of the following
characters: \ | / ?: * ? < > @,
DomainNam Name of the String, case-sensitive. and it cannot be d, de, def,
N/A
e domain Length: 0 to 255 characters. defa, defau, defaul, default,
i, if, if-, if-u, if-un, if-unk,
if-unkn, if-unkno, if-unknow,
or if-unknown.

AppProxy/RuleServGrps
This table contains service object group information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleServGrps>
<ServGrp>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>

8
 <NameItem></NameItem>
</NameList>
</ServGrp>
</RuleServGrps>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleServGrps
Table type Multi-instance table
Row name ServGrp
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.

Service group Data Members include:

NameList N/A
list structure • NameItem
Name of the String, case-insensitive.
NameItem service object N/A The value cannot be “any”.
group Length: 0 to 31 characters.

AppProxy/WhiteListHostNames
This table contains information of user-defined host name whitelist.

XML structure
<AppProxy>
<WhiteListHostNames>
<HostName>
<Name></Name>
</HostName>
</WhiteListHostNames>
</AppProxy>

9
Table description
Item Description
Feature name AppProxy
Table name WhiteListHostNames
Table type Multi-instance table
Row name HostName
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Colum Data type and
Remarks
name description n type restrictions
String, case-insensitive. The host name may contain
Name Host name Index
Length: 1 to 63 characters. space.

AppProxy/WhiteListPredefine
This table contains information of pre-defined host name whitelist.

XML structure
<AppProxy>
<WhiteListPredefine>
<HostName>
<Type></Type>
<Name></Name>
<Enable></Enable>
</HostName>
</WhiteListPredefine>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name WhiteListPredefine
Table type Multi-instance table
Row name HostName
Restrictions None

10
 Item Description
Support for row creation and deletion No

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Whether the host Enumeration:
name belongs to
Type
the pre-define
Index • 1—Not in chrome-HSTS. N/A
chrome-HSTS list • 2—in chrome-HSTS.

String, case-insensitive. The host name may

Name Host name Index
Length: 1 to 63 characters. contain spaces.

Enumeration:
Enabling status of
Enable
the host name
N/A • 0—Disable. N/A
• 1—Enable.

AppProxy/WhiteListPredefineChromeHsts
This table contains the state information of chrome-HSTS in pre-defined host name whitelist.

XML structure
<AppProxy>
<WhiteListPredefineChromeHsts>
<Enable></Enable>
</WhiteListPredefineChromeHsts>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name WhiteListPredefineChromeHsts
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

11
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enabling status Boolean:
of host names in
Enable
chrome-HSTS
N/A • true—Enabled N/A
whitelist • false—Disabled

AppProxy/TrustCertificate
This table contains credibility information of certificates.

XML structure
<AppProxy>
<TrustCertificates>
<TrustCertificate>
<FileName></FileName>
<Trust></Trust>
</TrustCertificate>
</TrustCertificates>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name TrustCertificates
Table type Multi-instance table
Row name TrustCertificate
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
File name of the String, case-insensitive.
FileName Index N/A
certificate Length: 1 to 63 characters
Enumeration:
Credibility type of • 0—untrust.
Trust N/A N/A
the certificate • 1—trust.
• 2—trust&untrust.

12
13
Contents
AppProxy ·······················································································1
AppProxy/GetRules ···················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
AppProxy/QueryRules················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
AppProxy/RuleSrcAddrs ·············································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7
AppProxy/RuleDestAddrs ············································································································ 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 8
AppProxy/RuleSrcSecZones ········································································································ 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 9
AppProxy/RuleDestSecZones······································································································· 9
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ·························································································································· 10
AppProxy/RuleUsers ················································································································ 10
XML structure ··················································································································· 10
Table description ··············································································································· 10
Columns ·························································································································· 11
AppProxy/RuleUserGrps ··········································································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 12
Columns ·························································································································· 12
AppProxy/RuleServGrps············································································································ 12
XML structure ··················································································································· 12
Table description ··············································································································· 13
Columns ·························································································································· 13
AppProxy/WhiteListHostNames ·································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
AppProxy/WhiteListPredefine ····································································································· 14
XML structure ··················································································································· 14
Table description ··············································································································· 14
Columns ·························································································································· 15
AppProxy/WhiteListPredefineChromeHsts ····················································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 15
Columns ·························································································································· 16
AppProxy/TrustCertificate ·········································································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 16
Columns ·························································································································· 16
AppProxy/Certificates ··············································································································· 17
XML structure ··················································································································· 17
Table description ··············································································································· 17
Columns ·························································································································· 17

i
AppProxy/Specifications ············································································································ 18
XML structure ··················································································································· 18
Table description ··············································································································· 18
Columns ·························································································································· 18

ii
AppProxy
AppProxy/GetRules
This table contains information about proxy rules.

XML structure
<AppProxy>
<GetRules>
<Rule>
<ID></ID>
<Name></Name>
<Action></Action>
<SrcZoneList>
<SrcZoneItem></SrcZoneItem>
</SrcZoneList>
<DestZoneList>
<DestZoneItem></DestZoneItem>
</DestZoneList>
<SrcAddrList>
<SrcAddrItem></SrcAddrItem>
</SrcAddrList>
<DestAddrList>
<DestAddrItem></DestAddrItem>
</DestAddrList>
<ServGrpList>
<ServGrpItem></ServGrpItem>
</ServGrpList>
<UserList>
<UserItem></UserItem>
<DomainItem></DomainItem>
</UserList>
<UserGrpList>
<UserGrpItem></UserGrpItem>
<DomainItem></DomainItem>
</UserGrpList>
<Enable></Enable>
<AllRulesCount></AllRulesCount>
</Rule>
</GetRules>
</AppProxy>

1
Table description
Item Description
Feature name AppProxy
Table name GetRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer. The value 65536 is
ID Rule ID Index
Value range: 1 to 65536 reserved for default rule.

String, case-insensitive.
Name Rule name N/A N/A
Length: 1 to 63 characters.
Enumeration:
Action for the • 1—No proxy.
Action N/A N/A
rule • 2—SSL decrypt.
• 3—TCP proxy.

Data Members include:

SrcZoneList Source zone list N/A
structure • SrcZoneItem
Name of the String, case-insensitive.
SrcZoneItem source security N/A N/A
zone Length: 0 to 31 characters.

Destination zone Data Members include:

DestZoneList N/A
list structure • DestZoneItem
Name of the String, case-insensitive.
DestZoneItem destination N/A N/A
security zone Length: 0 to 31 characters.

Source address Data Members include:

SrcAddrList N/A
list structure • SrcAddrItem
Name of the String, case-insensitive.
SrcAddrItem source address N/A N/A
object group Length: 0 to 31 characters.

Destination Data Members include:

DestAddrList N/A
address list structure • DestAddrItem
Name of the
destination String, case-insensitive.
DestAddrItem N/A N/A
address object Length: 0 to 31 characters.
group

Data Members include:

ServGrpList Service group list N/A
structure • ServGrpItem
ServGrpItem Name of the N/A String, case-insensitive. N/A

2
 Column Column Column Data type and
Remarks
name description type restrictions
service object Length: 0 to 31 characters.
group
Members include:
Data
UserList User list
structure • UserItem N/A
• DomainItem
The user name cannot be
String, case-sensitive. a, al, or all, and it cannot
UserItem Name of the user N/A contain any of the
Length: 0 to 55 characters. following characters: \ | / :
* ? < > @.
The domain name cannot
contain any of the
following characters: \ |
String, case-insensitive. / ?: * ? < > @, and it
Name of the
DomainItem N/A cannot be d, de, def,
domain Length: 0 to 255 characters. defa, defau, defaul,
default, i, if, if-, if-u, if-un,
if-unk, if-unkn, if-unkno,
if-unknow, or if-unknown.
Members include:
Data
UserGrpList User group list
structure • UserGrpItem N/A
• DomainItem

Name of the user String, case-insensitive.

UserGrpItem N/A N/A
group Length: 0 to 200 characters.
The domain name cannot
contain any of the
following characters: \ |
String, case-insensitive. / ?: * ? < > @, and it
Name of the
DomainItem N/A cannot be d, de, def,
domain Length: 0 to 255 characters. defa, defau, defaul,
default, i, if, if-, if-u, if-un,
if-unk, if-unkn, if-unkno,
if-unknow, or if-unknown.
Enumeration:
Enabling status
Enable
of the rule
N/A • 0—Disabled. N/A
• 1—Enabled.
AllRulesCoun Total number of
N/A Unsigned integer.
t rules

AppProxy/QueryRules
This table contains information about proxy rules.

XML structure
<AppProxy>
<QueryRules>
<Rule>
<ID></ID>

3
 <Name></Name>
<Action></Action>
<SrcZoneList>
<SrcZoneItem></SrcZoneItem>
</SrcZoneList>
<DestZoneList>
<DestZoneItem></DestZoneItem>
</DestZoneList>
<SrcAddrList>
<SrcAddrItem></SrcAddrItem>
</SrcAddrList>
<DestAddrList>
<DestAddrItem></DestAddrItem>
</DestAddrList>
<ServGrpList>
<ServGrpItem></ServGrpItem>
</ServGrpList>
<UserList>
<UserItem></UserItem>
<DomainItem></DomainItem>
</UserList>
<UserGrpList>
<UserGrpItem></UserGrpItem>
<DomainItem></DomainItem>
</UserGrpList>
<Enable></Enable>
<AllRulesCount></AllRulesCount>
</Rule>
</QueryRules>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name QueryRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ID Rule ID Index Unsigned integer. The value 65536 is
reserved for the default

4
Column Column Column Data type and
Remarks
name description type restrictions
Value range: 1 to 65536 rule.

String, case-insensitive.
Name Rule name N/A N/A
Length: 1 to 63 characters.
Enumeration:
Action for the • 1—No proxy.
Action N/A N/A
rule • 2—SSL decrypt.
• 3—TCP proxy.

Data Members include:

SrcZoneList Source zone list N/A
structure • SrcZoneItem
Name of the String, case-insensitive.
SrcZoneItem source security N/A N/A
zone Length: 0 to 31 characters.

Destination zone Data Members include:

DestZoneList N/A
list structure • DestZoneItem
Name of the String, case-insensitive.
DestZoneItem destination N/A N/A
security zone Length: 0 to 31 characters.

Source address Data Members include:

SrcAddrList N/A
list structure • SrcAddrItem
Name of the String, case-insensitive.
SrcAddrItem source address N/A N/A
object group Length: 0 to 31 characters.

Destination Data Members include:

DestAddrList N/A
address list structure • DestAddrItem
Name of the
destination String, case-insensitive.
DestAddrItem N/A N/A
address object Length: 0 to 31 characters.
group

Data Members include:

ServGrpList Service group list N/A
structure • ServGrpItem
Name of the String, case-insensitive.
ServGrpItem service object N/A N/A
group Length: 0 to 31 characters.

Members include:
Data
UserList User list
structure • UserItem N/A
• DomainItem
The user name cannot be
String, case-sensitive. a, al, or all, and it cannot
UserItem Name of the user N/A contain any of the
Length: 0 to 55 characters. following characters: \ | / :
* ? < > @.
The domain name cannot
contain any of the
Name of the String, case-insensitive. following characters: \ |
DomainItem N/A / ?: * ? < > @, and it
domain Length: 0 to 255 characters. cannot be d, de, def,
defa, defau, defaul,
default, i, if, if-, if-u, if-un,

5
 Column Column Column Data type and
Remarks
name description type restrictions
if-unk, if-unkn, if-unkno,
if-unknow, or if-unknown.
Members include:
Data
UserGrpList User group list
structure • UserGrpItem N/A
• DomainItem

Name of the user String, case-insensitive.

UserGrpItem N/A N/A
group Length: 0 to 200 characters.
The domain name cannot
contain any of the
following characters: \ |
String, case-insensitive. / ?: * ? < > @, and it
Name of the
DomainItem N/A cannot be d, de, def,
domain Length: 0 to 255 characters. defa, defau, defaul,
default, i, if, if-, if-u, if-un,
if-unk, if-unkn, if-unkno,
if-unknow, or if-unknown.
Enumeration:
Enabling status
Enable
of the rule
N/A • 0—Disabled. N/A
• 1—Enabled.
AllRulesCoun Total number of
N/A Unsigned integer.
t rules

AppProxy/RuleSrcAddrs
This table contains source address object group information for an app-proxy policy rule.

XML structure
<AppProxy>
<RuleSrcAddrs>
<SrcAddr>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
</SrcAddr>
</RuleSrcAddrs>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleSrcAddrs

6
 Item Description
Table type Multi-instance table
Row name SrcAddr
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. This value is always false.
data • false—No.

Data Members include:

NameList Object group list N/A
structure • NameItem
Name of the String, case-insensitive.
NameItem source address N/A The value cannot be “any”.
object group Length: 1 to 31 characters.

AppProxy/RuleDestAddrs
This table contains destination address object group information for an app-proxy policy rule.

XML structure
<AppProxy>
<RuleDestAddrs>
<DestAddr>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
</DestAddr>
</RuleDestAddrs>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleDestAddrs
Table type Multi-instance table

7
 Item Description
Row name DestAddr
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. This value is always false.
data • false—No.

Data Members include:

NameList Object group list N/A
structure • NameItem
Name of the
destination String, case-insensitive.
NameItem N/A The value cannot be “any”.
address object Length: 1 to 31 characters.
group

AppProxy/RuleSrcSecZones
This table contains source security zone information for an app-proxy policy rule.

XML structure
<AppProxy>
<RuleSrcSecZones>
<SrcSecZone>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
</SrcSecZone>
</RuleSrcSecZones>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleSrcSecZones
Table type Multi-instance table

8
 Item Description
Row name SrcSecZone
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. This value is always false.
data • false—No.

Data Members include:

NameList Zone list N/A
structure • NameItem
Name of the String, case-insensitive.
NameItem source security N/A The value cannot be “any”.
zone Length: 1 to 31 characters.

AppProxy/RuleDestSecZones
This table contains destination security zone information for an app-proxy policy rule.

XML structure
<AppProxy>
<RuleDestSecZones>
<DestSecZone>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
<DestSecZone>
</RuleDestSecZones>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleDestSecZones
Table type Multi-instance table
Row name DestSecZones

9
 Item Description
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. This value is always false.
data • false—No.

Data Members include:

NameList Zone list N/A
structure • NameItem
Name of the String, case-insensitive.
NameItem destination N/A The value cannot be “any”.
security zone Length: 1 to 31 characters.

AppProxy/RuleUsers
This table contains user information for an app-proxy policy rule.

XML structure
<AppProxy>
<RuleUsers>
<User>
<ID></ID>
<IsIncrement></IsIncrement>
<UserList>
<UserName></UserName>
<DomainName></DomainName>
</UserList>
</User>
</RuleUsers>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleUsers
Table type Multi-instance table
Row name User

10
 Item Description
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. This value is always false.
data • false—No.
Members include:
Data
UserList User list
structure • UserName N/A
• DomainName
The user name cannot be
Name of the String, case-sensitive. a, al, or all, and it cannot
UserName N/A
user Length: 1 to 55 characters. contain any of the following
characters: \ | / : * ? < > @.
The domain name cannot
contain any of the following
characters: \ | / ?: * ? < >
Name of the String, case-sensitive. @, and it cannot be d, de,
DomainName N/A
domain Length: 0 to 255 characters. def, defa, defau, defaul,
default, i, if, if-, if-u, if-un,
if-unk, if-unkn, if-unkno,
if-unknow, or if-unknown.

AppProxy/RuleUserGrps
This table contains user group information for an app-proxy policy rule.

XML structure
<AppProxy>
<RuleUserGrps>
<UserGrp>
<ID></ID>
<IsIncrement></IsIncrement>
<UserGrpList>
<UserGrpName></UserGrpName>
<DomainName></DomainName>
</UserGrpList>
</UserGrp>
</RuleUserGrps>
</AppProxy>

11
Table description
Item Description
Feature name AppProxy
Table name RuleUserGrps
Table type Multi-instance table
Row name UserGrp
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. This value is always false.
data • false—No.
Members include:
Data
UserGrpList UserGrp list
structure • UserGrpName N/A
• DomainName

UserGrpNam Name of the String, case-insensitive.

N/A N/A
e user group Length: 1 to 200 characters.
The domain name cannot
contain any of the following
characters: \ | / ?: * ? < >
DomainNam Name of the String, case-sensitive. @, and it cannot be d, de,
N/A
e domain Length: 0 to 255 characters. def, defa, defau, defaul,
default, i, if, if-, if-u, if-un,
if-unk, if-unkn, if-unkno,
if-unknow, or if-unknown.

AppProxy/RuleServGrps
This table contains service object group information for an app-proxy policy rule.

XML structure
<AppProxy>
<RuleServGrps>
<ServGrp>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>

12
 </NameList>
</ServGrp>
</RuleServGrps>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleServGrps
Table type Multi-instance table
Row name ServGrp
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. This value is always false.
data • false—No.

Service group Data Members include:

NameList N/A
list structure • NameItem
Name of the String, case-insensitive.
NameItem service object N/A The value cannot be “any”.
group Length: 1 to 31 characters.

AppProxy/WhiteListHostNames
This table contains information of user-defined host name whitelist.

XML structure
<AppProxy>
<WhiteListHostNames>
<HostName>
<Name></Name>
<RowCount></RowCount>
</HostName>
</WhiteListHostNames>
</AppProxy>

13
Table description
Item Description
Feature name AppProxy
Table name WhiteListHostNames
Table type Multi-instance table
Row name HostName
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-insensitive.
Name Host name Index N/A
Length: 1 to 63 characters.
Number of host
RowCount N/A Unsigned integer. N/A
name items

AppProxy/WhiteListPredefine
This table contains information of pre-defined host name whitelist.

XML structure
<AppProxy>
<WhiteListPredefine>
<HostName>
<Type></Type>
<Name></Name>
<Enable></Enable>
<RowCount></RowCount>
</HostName>
</WhiteListPredefine>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name WhiteListPredefine
Table type Multi-instance table
Row name HostName

14
 Item Description
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Whether the
host name Enumeration:

Type
belongs to the
Index • 1—Not in N/A
pre-define chrome-HSTS.
chrome-HSTS • 2—In chrome-HSTS.
list
String, case-insensitive.
Name Host name Index N/A
Length: 1 to 63 characters.
Enumeration:
Enabling status
Enable
of the host name
N/A • 0—Disabled. N/A
• 1—Enabled.
Number of the
RowCount N/A Unsigned integer. N/A
host name items

AppProxy/WhiteListPredefineChromeHsts
This table contains the state information of chrome-HSTS in pre-defined host name whitelist.

XML structure
<AppProxy>
<WhiteListPredefineChromeHsts>
<Enable></Enable>
</WhiteListPredefineChromeHsts>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name WhiteListPredefineChromeHsts
Table type Single-instance table
Row name None
Restrictions None

15
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enabling status Boolean:
of host names in
Enable
chrome-HSTS
N/A • true—Enabled N/A
whitelist • false—Disabled

AppProxy/TrustCertificate
This table contains credibility information of certificates.

XML structure
<AppProxy>
<TrustCertificates>
<TrustCertificate>
<FileName></FileName>
<Trust></Trust>
</TrustCertificate>
</TrustCertificates>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name TrustCertificates
Table type Multi-instance table
Row name TrustCertificate
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
File name of String, case-insensitive.
FileName Index N/A
certificate Length: 1 to 63 characters
Enumeration:
Credibility type • 0—untrust.
Trust N/A N/A
of the certificate • 1—trust.
• 2—untrust&trust.

16
AppProxy/Certificates
This table contains certificates information.

XML structure
<AppProxy>
<Certificates>
<Certificate>
<Name></Name>
<Trust></Trust>
<Issuer></Issuer>
<Subject></Subject>
<StartDate></StartDate>
<EndDate></EndDate>
<Version></Version>
<Serialnumber></Serialnumber>
<Extend></Extend>
</Certificate>
</Certificates>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name Certificates
Table type Multi-instance table
Row name Certificate
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
File name of CA String, case-insensitive.
Name Index N/A
certificate. Length: 1 to 255 characters.
Enumeration:
Credibility type of • 0—untrust.
Trust N/A N/A
the certificate. • 1—trust.
• 2—untrust&trust.
Publisher of the
Issuer N/A String N/A
certificate
Holder of the
Subject N/A String N/A
certificate

17
 Column Column Column Data type and
Remarks
name description type restrictions
The effective date
StartDate N/A String N/A
of certificate
Expiration date of
EndDate N/A String N/A
the certificate
Version of the
Version N/A Unsigned integer N/A
certificate
Serial number of
Serialnumber N/A String N/A
the certificate
Extended
Extend information of the N/A String N/A
certificate

AppProxy/Specifications
This table contains specification information.

XML structure
<Specifications>
<RuleSrcAddrLimit></RuleSrcAddrLimit>
<RuleDestAddrLimit></RuleDestAddrLimit>
<RuleServGrpsLimit></RuleServGrpLimit>
<RuleSrcSecZonesLimit></RuleSrcSecZonesLimit>
<RuleDestSecZonesLimit></RuleDestSecZonesLimit>
<RuleUsersLimit></RuleUsersLimit>
<RuleUserGrpsLimit></RuleUserGrpsLimit>
</Specifications>

Table description
Item Description
Feature name AppProxy
Table name Specifications
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
RuleSrcAddrLi Number limit of N/A Unsigned integer. N/A
mit source address

18
Column Column Column Data type and
Remarks
name description type restrictions
object groups in a
rule
Number limit of
RuleDestAddr destination
N/A Unsigned integer. N/A
Limit address object
groups in a rule
Number limit of
RuleServGrps
service object N/A Unsigned integer. N/A
Limit
groups in a rule
Number limit of
RuleSrcSecZo
source security N/A Unsigned integer. N/A
nesLimit
zones in a rule
Number limit of
RuleDestSecZ destination
N/A Unsigned integer. N/A
onesLimit security zones in
a rule
RuleUsersLimi Number limit of
N/A Unsigned integer. N/A
t users in a rule
Number limit of
RuleUserGrps
user groups in a N/A Unsigned integer. N/A
Limit
rule

19
Contents
AppProxy ·······················································································2
AppProxy/MoveBeforeRules········································································································· 2
AppProxy/ImportCertificates ········································································································· 2
AppProxy/CommitWhiteLists ········································································································ 3
AppProxy/RuleSrcAddrs ·············································································································· 3
AppProxy/RuleDestAddrs ············································································································ 3
AppProxy/RuleSrcSecZones ········································································································ 3
AppProxy/RuleDestSecZones······································································································· 4
AppProxy/RuleUsers ·················································································································· 4
AppProxy/RuleUserGrps ············································································································· 4
AppProxy/RuleServGrps·············································································································· 5
AppProxy/WhiteListHostNames ···································································································· 5
AppProxy/WhiteListPredefine ······································································································· 5
AppProxy/WhiteListPredefineChromeHsts ······················································································· 5
AppProxy/PolicyRules ················································································································· 6

i
AppProxy
AppProxy/MoveBeforeRules
Message Explanation
The default rule cannot be moved. The default rule cannot be moved before any user-defined rules.
默认规则不能移动。 默认规则不能被移动到任何自定义规则之前。

The rule to be removed doesn't exist. The rule to be moved does not exist and processing fails.
要移动的规则不存在。 将要移动的规则不存在，处理失败。

The two rule IDs cannot be the same. The rule to be moved and the target rule cannot be the same rule.
要移动的规则与目标规则是同一个规则。 要移动的规则和目标规则不能是同一个规则

AppProxy/ImportCertificates
Message Explanation
Certificate file does not exist. The certificate file to import does not exist.
证书文件不存在。 要导入的证书文件不存在。

Invalid password. The input password does not match the imported certificate.
无效密码。 输入的密码与导入的证书不匹配。

The column Trust cannot be empty. Trust column must be specified when importing a certificate.
Trust列不能为空。 导入证书时必须制定trust列。

Failed to parse the certificate. Imported certificate is invalid and the parsing fails.
导入的证书解析失败。 导入的证书不合法，导致解析失败

The certificate verification fails because the imported certificate

Failed to verify the certificate.
expires or other reasons.
导入的证书验证失败。
导入的证书过期或由于其他原因导致验证失败。

The certificate file does not have a key pair. The imported certificate must contain a key pair.
导入的证书不含密钥对。 导入的证书必须包含密钥对。

The certificate file does not have a root certificate. The imported certificate must contain the root certificate.
导入的证书不包含根证书。 导入的证书必须包含根证书。

The certificate and the public key do not match. The imported certificate and public key do not match.
导入的证书公钥不匹配。 导入的证书和公钥不匹配。

An SSL decryption certificate with the same name Certificate cannot be imported if it has the same name with a
already exists. certificate on the device.
该证书已存在。 不能导入文件名同名的证书。

2
AppProxy/CommitWhiteLists
Message Explanation
Failure to compile the whitelist due to insufficient memory or other
Failed to submit the SSL whitelist settings.
reasons.
提交白名单失败。
由于内存不足或其他原因导致编译白名单失败，。

A whitelist is being submitted. The next submission can be

Activating the SSL whitelist settings. Please wait...
processed only after the submission is completed.
正在提交白名单，请稍等。
正在提交白名单，需要等提交完之后，才可以处理下一次提交。

AppProxy/RuleSrcAddrs
Message Explanation
Object group type not supported. The specified object group must be of the address type.
对象组类型不支持。 引用的对象组必须是地址类型的。

Maximum number of source IP address object A maximum of 64 source address object groups can be used in
groups in the rule already reached. one rule.
引用的源地址对象组已达上限。 规则下最多引用64个源地址对象组。

The specified address object group does not exist. Please create
The object group does not exist.
the address object group before using it.
对象组不存在。
引用的地址对象组不存在，需要先创建地址对象组才可以引用。

AppProxy/RuleDestAddrs
Message Explanation
Object group type not supported. The specified object group must be of the address type.
对象组类型不支持。 引用的对象组必须是地址类型的。

Maximum number of destination IP address object A maximum of 64 destination address object groups can be used
groups in the rule already reached. in one rule.
引用的目的地址对象组已达上限。 规则下最多引用64个目的地址对象组。

The specified address object group does not exist. Please create
The object group does exist.
the address object group before using it.
对象组不存在。
引用的地址对象组不存在，需要先创建地址对象组才可以引用。

AppProxy/RuleSrcSecZones
Message Explanation
Maximum number of source security zones in the
A maximum of 16 source security zones can be used in one rule.
rule already reached.
规则下最多引用16个源安全域。
引用的源安全域已达上限。

Configuration succeeded but the source security Configuration succeeded, but it does not take effect because the
zone does not exist. source security zone does not exist.
引用的源安全域不存在。 配置成功了，但是源安全域不存在，配置不生效。

3
AppProxy/RuleDestSecZones
Message Explanation
Maximum number of destination security Maximum 16 destination security zones referenced under
zones in the rule already reached. rules.
引用的源安全域已达上限。 规则下最多引用16个目的安全域。

Configuration succeeded but the destination Configuration succeeded, but it does not take effect
security zone does not exist. because the destination security zone does not exist.
引用的源安全域不存在。 配置成功了，但是源安全域不存在，配置不生效。

AppProxy/RuleUsers
Message Explanation
Configuration succeeded but the user doesn't Configuration succeeded, but it does not take effect
exist. because the user does not exist.
引用的用户不存在。 配置成功了，但是用户不存在，配置不生效。

Maximum number of users in the rule already

A maximum of 64 users can be specified in a rule.
reached.
规则下最多引用64个用户。
引用的用户已达上限。

The user name cannot be a, al, or all and

cannot contain the following special Input username is not valid. Please enter a new one
characters:\r\n\\ | / : * ? < > @. according to the prompt message.
用户名不能包含 \\, |, /, :, *, ?, <, >, @,且不能为 输入的用户名不合法，按照提示输入。
a、al、和all。

The domain name cannot contain the Input domain name is not valid. Please enter a new one
following characters: \r\n\\ | / : * ? < > @. according to the prompt message.
域名不能包含 /, \\, |, :, *, ?, <, >, @。 输入的域名不合法，按照提示输入。

AppProxy/RuleUserGrps
Message Explanation
Configuration succeeded but the user groups Configuration succeeded, but it does not take effect
do not exist. because the user groups do not exist.
引用的用户组不存在。 配置成功了，但是用户组不存在，配置不生效。

Maximum number of user groups in the rule A maximum of 64 user groups can be specified by a under
already reached. rule.
引用的用户组已达上限。 规则下最多引用64个用户组。

The domain name cannot contain the Input domain name is not valid. Please enter a new one
following characters: \r\n\\ | / : * ? < > @. according to the prompt message.

4
域名不能包含 /, \\, |, :, *, ?, <, >, @。 输入的域名不合法，按照提示输入。

AppProxy/RuleServGrps
Message Explanation
Incorrect object group type. The specified object group must be of the service type.
对象组类型不支持。 引用的对象组必须是服务类型的。

Maximum number of service object groups in A maximum of 64 service object groups can be specified
the rule already reached. in a rule.
引用的服务已达上限。 规则下最多引用64个服务对象组。

The specified service object group does not exist. Please

The object group does not exist. create the service object group before using it.
对象组不存在。 引用的服务对象组不存在，需要先创建服务对象组才可以引
用。

AppProxy/WhiteListHostNames
Message Explanation
Maximum number of user-defined
A maximum of 1000 items can be created in user-defined
hostnames on the SSL hostname whitelist
hostname whitelist.
already reached.
自定义域名白名单最多1000个。
域名白名单已达上限。

AppProxy/WhiteListPredefine
Message Explanation
The hostname is not on the pre-defined SSL The specified domain name is not on the pre-defined
hostname whitelist. whitelist.
预定义白名单中不存在指定的域名。 指定的域名不在预定义白名单里。

To disable the Chrome-HSTS whitelist entry,

you must first turn on the Chrome-HSTS
whitelist by using the app-proxy ssl whitelist Chrome HSTS whitelist is already disabled.
predefined-hostname chrome-hsts enable Chrome HSTS列表已经去使能了，不需要再去使能。
command.
Chrome HSTS列表已经禁用。

AppProxy/WhiteListPredefineChromeHsts
Message Explanation
To activate the setting, execute app-proxy ssl After modifying the whitelist, please submit the whitelist

5
whitelist activate. to make it take effect.
白名单列表已修改，请提交。 修改白名单列表之后，需要提交白名单才能生效。

AppProxy/PolicyRules
Message Explanation
When creating a rule, the specified ID is already used. A
The rule ID is already used by another new ID can be manually specified or automatically
application proxy policy rule. assigned without specifying an ID at the time of creation.
规则已经存在。 创建规则时，指定的ID已经被占用了，需要换一个ID或者创
建时不指定ID，自动分配。

When creating a rule, a rule with the specified name

The rule name is already used by another already exists, but the ID is inconsistent with the ID of an
application proxy policy rule. existing rule.
规则名称已存在。 创建规则时，已有指定名称的规则，但是ID跟已存在的规则
的ID不一致。

Maximum number of application proxy policy

A maximum of 1024 rules can be created.
rules already reached.
最多只能创建1024个代理策略规则。
规则个数已达上限。

Invalid name. Rule name cannot be default.

无效的规则名称。 规则名称不能是default。

The default rule is automatically created at startup and

The default rule cannot delete.
cannot be deleted.
默认策略不能删除。
默认策略在进程启动时自动创建，不能删除。

The default rule cannot be enabled. It can only be

The default rule cannot be disabled.
modified.
默认策略不能禁用。
默认策略不能去使能，只能修改动作。

6
Contents
APR ······························································································1
APR/ClearApplicationStatistics ····································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
APR
APR/ClearApplicationStatistics
This table contains APR statistics information.

XML structure
<APR>
<ClearApplicationStatistics>
<Statistic>
<IfIndex></IfIndex>
<Clear></Clear>
</Statistic>
</ClearApplicationStatistics>
</APR>

Table description
Item Description
Feature name APR
Table name ClearApplicationStatistics
Table type Multi-instance table
Row name Statistic
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
This column can only
be 3 layer interface
IfIndex Interface index Index Unsigned integer. except loopback, NULL,
FC, FCB and encrypt
interface.
Clear Resets counters. N/A This column must be empty. N/A

1
Contents
APR ······························································································1
APR/GeneralPortMappings ·········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 2
APR/Ipv4PortMappings ··············································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
APR/Ipv6PortMappings ··············································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6
APR/Ipv4SubnetPortMappings······································································································ 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 9
APR/Ipv6SubnetPortMappings···································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
APR/ Ipv4ACLPortMappings ····································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 13
Columns ·························································································································· 13
APR/ Ipv6ACLPortMappings ····································································································· 14
XML structure ··················································································································· 14
Table description ··············································································································· 15
Columns ·························································································································· 15
APR/Applications ····················································································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 17
Columns ·························································································································· 17
APR/AppGroups ······················································································································ 17
XML structure ··················································································································· 17
Table description ··············································································································· 18
Columns ·························································································································· 18
APR/AppGroupMembers ··········································································································· 18
XML structure ··················································································································· 18
Table description ··············································································································· 19
Columns ·························································································································· 19
APR/ AppGroupMembersIncGrp ································································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 21
APR/StatisticOnInterfaces·········································································································· 21
XML structure ··················································································································· 21
Table description ··············································································································· 21
Columns ·························································································································· 22

i
APR
APR/GeneralPortMappings
This table contains informations about port mappings.

XML structure
<APR>
<GeneralPortMappings>
<PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<AppName></AppName>
</PortMapping>
</GeneralPortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name GeneralPortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None

1
Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
a packet matches a
general port mapping,
APR recognizes the
packet as the specified
application protocol's
packet.
Unsigned integer. If two port mappings
PortNumber Port number Index
Value range: 0 to 65535. are configured with the
same port number and
transport layer protocol,
but with different
application protocols,
the most recent
configuration takes
effect.
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
• 6—TCP. that have the specified
port are recognized as
Transport layer • 17—UDP.
L4ProtocolID Index the specified
portocol ID • 33—DCCP. application protocol's
• 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.
Support for row creation and deletion Yes

2
APR/Ipv4PortMappings
This table contains informations about IPv4 address-based host-port mappings.

XML structure
<APR>
<Ipv4PortMappings>
<PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<VRF></VRF>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
<AppName></AppName>
</PortMapping>
</Ipv4PortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name Ipv4PortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None
Support for row creation and deletion Yes

3
Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets destined for the
specified IP address or
IP subnet, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer. If two port mappings
PortNumber Port number Index
Value range: 0 to 65535. are configured with the
same port number,
transport layer protocol,
and IP address or IP
address ranges, but
with different
application protocols,
the most recent
configuration takes
effect.
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
• 6—TCP. that have the specified
port are recognized as
Transport layer • 17—UDP.
L4ProtocolID Index the specified
portocol ID • 33—DCCP. application protocol's
• 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.
If you configure a
String, case-sensitive. mapping for the public
VRF VRF. Index
Length: 1 to 31 characters. network, do not specify
this option.

4
 Column Column Column
Data type and restrictions Remarks
name description type
Example: 1.1.1.1.
To specify only one IP
address, provide only
the start IP address. To
specify a range of IP
addresses, provide
both the start and end
IP addresses, and
make sure the end IP
StartIpv4Addr Start IPv4
Index String, dotted decimal notation. address is bigger than
ess address
the start IP address.
No overlapping of IP
addresses is tolerable
for the host-port
mappings configured
with the same
application protocol,
port number, and
transport layer protocol.
EndIpv4Addre End IPv4 Example: 1.1.1.6. This
Index String, dotted decimal notation.
ss address index can be null.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/Ipv6PortMappings
This table contains informations about IPv6 address-based host-port mappings.

XML structure
<APR>
<Ipv6PortMappings>
<PortMapping>
<PortNumber></PortNumber>

5
 <L4ProtocolID></L4ProtocolID>
<VRF></VRF>
<StartIpv6Address></StartIpv6Address>
<EndIpv6Address></EndIpv6Address>
<AppName></AppName>
</PortMapping>
</Ipv6PortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name Ipv6PortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets destined for the
specified IP address or
IP subnet, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer. If two port mappings
PortNumber Port number Index
Value range: 0 to 65535. are configured with the
same port number,
transport layer protocol,
and IP address or IP
address ranges, but
with different
application protocols,
the most recent
configuration takes
effect.

6
Column Column Column
Data type and restrictions Remarks
name description type
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
• 6—TCP. that have the specified
port are recognized as
Transport layer • 17—UDP.
L4ProtocolID Index the specified
portocol ID • 33—DCCP. application protocol's
• 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.
If you configure a
String, case-sensitive. mapping for the public
VRF VRF. Index
Length: 1 to 31 characters. network, do not specify
this option.
Example: 1:1::1:1.
To specify only one IP
address, provide only
the start IP address. To
specify a range of IP
addresses, provide
both the start and end
IP addresses, and
make sure the end IP
StartIpv6Addr Start IPv6 Hexadecimal string,
Index address is bigger than
ess address colon-separated.
the start IP address.
No overlapping of IP
addresses is tolerable
for the host-port
mappings configured
with the same
application protocol,
port number, and
transport layer protocol.
EndIpv6Addre End IPv6 Hexadecimal string, Example: 1:1::1:6. This
Index
ss address colon-separated.. index can be null.

7
 Column Column Column
Data type and restrictions Remarks
name description type
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/Ipv4SubnetPortMappings
This table contains informations about IPv4 subnet-based host-port mappings.

XML structure
<APR>
<Ipv4SubnetPortMappings>
<PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<VRF></VRF>
<Ipv4Address></Ipv4Address>
<Ipv4PrefixLength></Ipv4PrefixLength>
<AppName></AppName>
</PortMapping>
</Ipv4SubnetPortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name Ipv4SubnetPortMappings
Table type Multi-instance table

8
 Row name PortMapping
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets destined for the
specified subnet, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer.
PortNumber Port number Index If two port mappings
Value range: 0 to 65535.
are configured with the
same port number,
transport layer protocol,
and subnet, but with
different application
protocols, the most
recent configuration
takes effect.
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
• 6—TCP. that have the specified
port are recognized as
Transport layer • 17—UDP.
L4ProtocolID Index the specified
portocol ID • 33—DCCP. application protocol's
• 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.
If you configure a
String, case-sensitive. mapping for the public
VRF VRF. Index
Length: 1 to 31 characters. network, do not specify
this option.

9
 Column Column Column
Data type and restrictions Remarks
name description type
Example: 1.1.1.1.
APR uses a very
precise method to
match the packets. If
multiple subnet-based
mappings are applied to
Ipv4Address IPv4 address Index String, dotted decimal notation. packets and these
subnets overlap, APR
matches the packets
destined for the
overlapped segment
with the port mapping of
the subnet that has the
smallest range.
Length of the Unsigned integer.
Ipv4PrefixLen
IPv4 address Index N/A
gth Value range: 1 to 32.
mask.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/Ipv6SubnetPortMappings
This table contains informations about IPv6 subnet-based host-port mappings.

XML structure
<APR>
<Ipv6SubnetPortMappings>
<PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<VRF></VRF>
<Ipv6Address></Ipv6Address>

10
 <Ipv6PrefixLength></Ipv6PrefixLength>
<AppName></AppName>
</PortMapping>
</Ipv6SubnetPortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name Ipv6SubnetPortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets destined for the
specified subnet, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer.
PortNumber Port number Index If two port mappings
Value range: 0 to 65535.
are configured with the
same port number,
transport layer protocol,
and subnet, but with
different application
protocols, the most
recent configuration
takes effect.
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
• 6—TCP. that have the specified
port are recognized as
Transport layer • 17—UDP.
L4ProtocolID Index the specified
portocol ID • 33—DCCP. application protocol's
• 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.

11
 Column Column Column
Data type and restrictions Remarks
name description type
If you configure a
String, case-sensitive. mapping for the public
VRF VRF. Index
Length: 1 to 31 characters. network, do not specify
this option.
Example: 1:1::1:1.
APR uses a very
precise method to
match the packets. If
multiple subnet-based
mappings are applied to
Hexadecimal string, packets and these
Ipv6Address IPv6 address Index
colon-separated. subnets overlap, APR
matches the packets
destined for the
overlapped segment
with the port mapping of
the subnet that has the
smallest range.
Length of the Unsigned integer.
Ipv6PrefixLen
IPv6 address Index N/A
gth Value range: 1 to 128.
prefix.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/ Ipv4ACLPortMappings
This table contains informations about IPv4 ACL-based host-port mappings.

XML structure
<APR>
<Ipv4ACLPortMappings>
<PortMapping>
<PortNumber></PortNumber>

12
 <L4ProtocolID></L4ProtocolID>
<ACLNumber></ACLNumber>
<AppName></AppName>
</PortMapping>
</Ipv4ACLPortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name Ipv4ACLPortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets matching the
specified ACL, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer.
PortNumber Port number Index If two port mappings
Value range: 0 to 65535.
are configured with the
same port number,
transport layer protocol,
and ACL, but with
different application
protocols, the most
recent configuration
takes effect.

13
 Column Column Column
Data type and restrictions Remarks
name description type
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
Transport layer • 6—TCP. that have the specified
portocol ID port are recognized as
• 17—UDP.
L4ProtocolID specified to the Index the specified
application layer • 33—DCCP. application protocol's
protocol • 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.
If the destination port of
the packet that matches
against the specified
ACL maps with an
Unsigned integer. application layer
ACLNumber ACL number Index
Value range: 2000 to 2999. protocol, the packet is
recognized as the
corresponding
application layer
protocol packet.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/ Ipv6ACLPortMappings
This table contains informations about IPv6 ACL-based host-port mappings.

XML structure
<APR>
<Ipv6ACLPortMappings>

14
 <PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<ACLNumber></ACLNumber>
<AppName></AppName>
</PortMapping>
</Ipv6ACLPortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name Ipv6ACLPortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets matching the
specified ACL, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer.
PortNumber Port number Index If two port mappings
Value range: 0 to 65535.
are configured with the
same port number,
transport layer protocol,
and ACL, but with
different application
protocols, the most
recent configuration
takes effect.

15
 Column Column Column
Data type and restrictions Remarks
name description type
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
Transport layer • 6—TCP. that have the specified
portocol ID port are recognized as
• 17—UDP.
L4ProtocolID specified to the Index the specified
application layer • 33—DCCP. application protocol's
protocol • 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.
If the destination port of
the packet that matches
against the specified
ACL maps with an
Unsigned integer. application layer
ACLNumber ACL number Index
Value range: 2000 to 2999. protocol, the packet is
recognized as the
corresponding
application layer
protocol packet.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/Applications
This table contains informations about pre-defined and user-defined applications.

XML structure
<APR>
<Applications>

16
 <Application>
<Type></Type>
<AppName></AppName>
<SecRisk></SecRisk>

</Application>
</Applications>
</APR>

Table description
Item Description
Feature name APR
Table name Applications
Table type Multi-instance table
Row name Application
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Type of the Enumeration:
Type application layer Index • 0—pre-defined. N/A
protocol • 1—user-defined.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
Application layer String, case-insensitive. and "other".
AppName Index
protocol name Length: 1 to 63 characters. The application layer
protocol name must be
standard and can be
identified by the
equipment.
Application layer Unsigned integer.
SecRisk protocol security N/A 32 N/A
risk Value range: 0 to 2 - 1.

APR/AppGroups
This table contains informations about the user-defined application groups.

XML structure
<APR>

17
 <AppGroups>
<GroupInfo>
<GroupName></GroupName>
<Description></Description>
</GroupInfo>
</AppGroups>
</APR>

Table description
Item Description
Feature name APR
Table name AppGroups
Table type Multi-instance table
Row name GroupInfo
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Valid characters include
digits, letters, hyphens
(-), and underlines (_).
Predefined or Names, such as
user-defined String, case-insensitive.
GroupName Index "invalid" or "other" are
application group Length: 1 to 63 characters. not allowed.
name
You can create up to
65536 application
groups on the device.
Blank space can be
included in Description.
Description for String, case-sensitive.
Description the application N/A The default description
group Length: 1 to 127 characters. of the user-defined
application group is
"User defined group".

APR/AppGroupMembers
This table contains the application protocols included in an user-defined application group.

XML structure
<APR>
<AppGroupMembers>
<GroupMember>

18
 <GroupName></GroupName>
<AppName></AppName>
</GroupMember>
</AppGroupMembers>
</APR>

Table description
Item Description
Feature name APR
Table name AppGroupMembers
Table type Multi-instance table
Row name GroupMember
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Valid characters include
digits, letters, hyphens
(-), and underlines (_).
User-defined Names, such as
String, case-insensitive.
GroupName application group Index "invalid" or "other" are
name Length: 1 to 63 characters. not allowed.
You can create up to
65536 application
groups on the device.

19
 Column Column Column
Data type and restrictions Remarks
name description type
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
Predefined or equipment.
user-defined A maximum of 65535
application String, case-insensitive. user-defined application
AppName protocol name Index protocols can be added
which is added to Length: 1 to 63 characters.
to an application group.
the application
group If you add a nonexistent
application protocol to
the application group,
the system first creates
the protocol before
adding it to the
application group.
Whether the device can
recognize the packets
of this protocol depends
on your configuration.

APR/ AppGroupMembersIncGrp
This table contains the application groups included in an application group.

XML structure
<APR>
<AppGroupMembersIncGrp>
<GroupMember>
<GroupName></GroupName>
<IncGrpName></IncGrpName>
</GroupMember>
</AppGroupMembersIncGrp>
</APR>

Table description
Item Description
Feature name APR
Table name AppGroupMembersIncGrp

Table type Multi-instance table

20
 Row name GroupMember
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Valid characters include
digits, letters, hyphens
(-), and underlines (_).
Names, such as
Application String, case-insensitive.
GroupName Index "invalid" or "other" are
group name Length: 1 to 63 characters. not allowed.
You can create up to
65536 application
groups on the device.
Valid characters include
digits, letters, hyphens
Application (-), and underlines (_).
group name Names, such as
String, case-insensitive.
IncGrpName which is added to Index "invalid" or "other" are
the application Length: 1 to 63 characters. not allowed.
group You can create up to
65536 application
groups on the device.

APR/StatisticOnInterfaces
This table contains the interfaces where statistic is enabled.

XML structure
<APR>
<StatisticOnInterfaces>
<Interface>
<IfIndex></IfIndex>
<Direction></Direction>
<EnableStatistic></EnableStatistic>
</Interface>
</StatisticOnInterfaces>
</APR>

Table description
Item Description
Feature name APR

21
 Table name StatisticOnInterfaces
Table type Multi-instance table
Row name Interface
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
This column can only
be 3 layer interface
IfIndex Interface index Index Unsigned integer. except loopback, NULL,
FC, FCB and encrypt
interface.
• Enumeration:
The direction of
Direction Index • 0—Inbound. N/A
the interface
• 1—Outbound.

Whether enable • Boolean:

EnableStatisti
statistic for the N/A • true—YES. N/A
c
interface • false—NO (default).

22
Contents
APR ······························································································1
APR/PredefinedPortMappings ······································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
APR/GeneralPortMappings ·········································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
APR/Ipv4PortMappings ··············································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
APR/Ipv6PortMappings ··············································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 7
Columns ···························································································································· 7
APR/Ipv4SubnetPortMappings······································································································ 9
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ·························································································································· 10
APR/Ipv6SubnetPortMappings···································································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 12
APR/ Ipv4ACLPortMappings ····································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
APR/ Ipv6ACLPortMappings ····································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 16
Columns ·························································································································· 16
APR/Applications ····················································································································· 17
XML structure ··················································································································· 17
Table description ··············································································································· 18
Columns ·························································································································· 18
APR/AppGroups ······················································································································ 19
XML structure ··················································································································· 19
Table description ··············································································································· 19
Columns ·························································································································· 19
APR/AppGroupMembers ··········································································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 20
APR/StatisticOnInterfaces·········································································································· 21
XML structure ··················································································································· 21
Table description ··············································································································· 21
Columns ·························································································································· 22
APR/ApplicationStatistics··········································································································· 22
XML structure ··················································································································· 22
Table description ··············································································································· 23
Columns ·························································································································· 23
APR/AppSubCategorys ············································································································· 24
XML structure ··················································································································· 24
Table description ··············································································································· 24
Columns ·························································································································· 24

i
APR/SecurityRisks ··················································································································· 25
XML structure ··················································································································· 25
Table description ··············································································································· 25
Columns ·························································································································· 25
APR/RiskLevels ······················································································································· 26
XML structure ··················································································································· 26
Table description ··············································································································· 26
Columns ·························································································································· 26

ii
APR
APR/PredefinedPortMappings
This table contains informations about predefined port mappings.

XML structure
<APR>
<PredefinedPortMappings>
<PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<AppName></AppName>
</PortMapping>
</PredefinedPortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name PredefinedPortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
PortNumber Port number Index N/A
Value range: 0 to 65535.
Enumeration:
• 6—TCP.
Transport layer • 17—UDP.
L4ProtocolID Index N/A
protocol ID. • 33—DCCP.
• 132—SCTP.
• 136—UDP-Lite.

1
 Column Column Column
Data type and restrictions Remarks
name description type
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
Application layer but can't be "invalid"
protocol name String, case-insensitive. and "other".
AppName N/A
using the port Length: 1 to 63 characters. The application layer
mapping. protocol name must be
standard and can be
identified by the
equipment.

APR/GeneralPortMappings
This table contains informations about port mappings.

XML structure
<APR>
<GeneralPortMappings>
<PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<AppName></AppName>
</PortMapping>
</GeneralPortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name GeneralPortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None

2
Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
a packet matches a
general port mapping,
APR recognizes the
packet as the specified
application protocol's
packet.
Unsigned integer. If two port mappings
PortNumber Port number Index
Value range: 0 to 65535. are configured with the
same port number and
transport layer protocol,
but with different
application protocols,
the most recent
configuration takes
effect.
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
• 6—TCP. that have the specified
port are recognized as
Transport layer • 17—UDP.
L4ProtocolID Index the specified
portocol ID • 33—DCCP. application protocol's
• 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

3
APR/Ipv4PortMappings
This table contains informations about IPv4 address-based host-port mappings.

XML structure
<APR>
<Ipv4PortMappings>
<PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<VRF></VRF>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
<AppName></AppName>
</PortMapping>
</Ipv4PortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name Ipv4PortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None

4
Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets destined for the
specified IP address or
IP subnet, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer. If two port mappings
PortNumber Port number Index
Value range: 0 to 65535. are configured with the
same port number,
transport layer protocol,
and IP address or IP
address ranges, but
with different
application protocols,
the most recent
configuration takes
effect.
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
• 6—TCP. that have the specified
port are recognized as
Transport layer • 17—UDP.
L4ProtocolID Index the specified
portocol ID • 33—DCCP. application protocol's
• 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.
If you configure a
String, case-sensitive. mapping for the public
VRF VRF. Index
Length: 1 to 31 characters. network, do not specify
this option.

5
 Column Column Column
Data type and restrictions Remarks
name description type
Example: 1.1.1.1.
To specify only one IP
address, provide only
the start IP address. To
specify a range of IP
addresses, provide
both the start and end
IP addresses, and
make sure the end IP
StartIpv4Addr Start IPv4
Index String, dotted decimal notation. address is bigger than
ess address
the start IP address.
No overlapping of IP
addresses is tolerable
for the host-port
mappings configured
with the same
application protocol,
port number, and
transport layer protocol.
EndIpv4Addre End IPv4 Example: 1.1.1.6. This
Index String, dotted decimal notation.
ss address index can be null.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/Ipv6PortMappings
This table contains informations about IPv6 address-based host-port mappings.

XML structure
<APR>
<Ipv6PortMappings>
<PortMapping>
<PortNumber></PortNumber>

6
 <L4ProtocolID></L4ProtocolID>
<VRF></VRF>
<StartIpv6Address></StartIpv6Address>
<EndIpv6Address></EndIpv6Address>
<AppName></AppName>
</PortMapping>
</Ipv6PortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name Ipv6PortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets destined for the
specified IP address or
IP subnet, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer. If two port mappings
PortNumber Port number Index
Value range: 0 to 65535. are configured with the
same port number,
transport layer protocol,
and IP address or IP
address ranges, but
with different
application protocols,
the most recent
configuration takes
effect.

7
Column Column Column
Data type and restrictions Remarks
name description type
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
• 6—TCP. that have the specified
port are recognized as
Transport layer • 17—UDP.
L4ProtocolID Index the specified
portocol ID • 33—DCCP. application protocol's
• 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.
If you configure a
String, case-sensitive. mapping for the public
VRF VRF. Index
Length: 1 to 31 characters. network, do not specify
this option.
Example: 1:1::1:1.
To specify only one IP
address, provide only
the start IP address. To
specify a range of IP
addresses, provide
both the start and end
IP addresses, and
make sure the end IP
StartIpv6Addr Start IPv6 Hexadecimal string,
Index address is bigger than
ess address colon-separated.
the start IP address.
No overlapping of IP
addresses is tolerable
for the host-port
mappings configured
with the same
application protocol,
port number, and
transport layer protocol.
EndIpv6Addre End IPv6 Hexadecimal string, Example: 1:1::1:6. This
Index
ss address colon-separated.. index can be null.

8
 Column Column Column
Data type and restrictions Remarks
name description type
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/Ipv4SubnetPortMappings
This table contains informations about IPv4 subnet-based host-port mappings.

XML structure
<APR>
<Ipv4SubnetPortMappings>
<PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<VRF></VRF>
<Ipv4Address></Ipv4Address>
<Ipv4PrefixLength></Ipv4PrefixLength>
<AppName></AppName>
</PortMapping>
</Ipv4SubnetPortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name Ipv4SubnetPortMappings
Table type Multi-instance table

9
 Row name PortMapping
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets destined for the
specified subnet, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer.
PortNumber Port number Index If two port mappings
Value range: 0 to 65535.
are configured with the
same port number,
transport layer protocol,
and subnet, but with
different application
protocols, the most
recent configuration
takes effect.
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
• 6—TCP. that have the specified
port are recognized as
Transport layer • 17—UDP.
L4ProtocolID Index the specified
portocol ID • 33—DCCP. application protocol's
• 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.
If you configure a
String, case-sensitive. mapping for the public
VRF VRF. Index
Length: 1 to 31 characters. network, do not specify
this option.
Example: 1.1.1.1.
APR uses a very
precise method to
match the packets. If
multiple subnet-based
mappings are applied to
Ipv4Address IPv4 address Index String, dotted decimal notation. packets and these
subnets overlap, APR
matches the packets
destined for the
overlapped segment
with the port mapping of
the subnet that has the
smallest range.

10
 Column Column Column
Data type and restrictions Remarks
name description type
Length of the Unsigned integer.
Ipv4PrefixLen
IPv4 address Index N/A
gth Value range: 1 to 32.
mask.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/Ipv6SubnetPortMappings
This table contains informations about IPv6 subnet-based host-port mappings.

XML structure
<APR>
<Ipv6SubnetPortMappings>
<PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<VRF></VRF>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
<AppName></AppName>
</PortMapping>
</Ipv6SubnetPortMappings>
</APR>

Table description
Item Description
Feature name APR

11
 Table name Ipv6SubnetPortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets destined for the
specified subnet, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer.
PortNumber Port number Index If two port mappings
Value range: 0 to 65535.
are configured with the
same port number,
transport layer protocol,
and subnet, but with
different application
protocols, the most
recent configuration
takes effect.
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
• 6—TCP. that have the specified
port are recognized as
Transport layer • 17—UDP.
L4ProtocolID Index the specified
portocol ID • 33—DCCP. application protocol's
• 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.
If you configure a
String, case-sensitive. mapping for the public
VRF VRF. Index
Length: 1 to 31 characters. network, do not specify
this option.

12
 Column Column Column
Data type and restrictions Remarks
name description type
Example: 1:1::1:1.
APR uses a very
precise method to
match the packets. If
multiple subnet-based
mappings are applied to
Hexadecimal string, packets and these
Ipv6Address IPv6 address Index
colon-separated. subnets overlap, APR
matches the packets
destined for the
overlapped segment
with the port mapping of
the subnet that has the
smallest range.
Length of the Unsigned integer.
Ipv6PrefixLen
IPv6 address Index N/A
gth Value range: 1 to 128.
prefix.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/ Ipv4ACLPortMappings
This table contains informations about IPv4 ACL-based host-port mappings.

XML structure
<APR>
<Ipv4ACLPortMappings>
<PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<ACLNumber></ACLNumber>
<AppName></AppName>

13
 </PortMapping>
</Ipv4ACLPortMappings>
</APR>

Table description
Item Description
Feature name APR
Table name Ipv4ACLPortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets matching the
specified ACL, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer.
PortNumber Port number Index If two port mappings
Value range: 0 to 65535.
are configured with the
same port number,
transport layer protocol,
and ACL, but with
different application
protocols, the most
recent configuration
takes effect.
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
Transport layer • 6—TCP. that have the specified
portocol ID port are recognized as
• 17—UDP.
L4ProtocolID specified to the Index the specified
application layer • 33—DCCP. application protocol's
protocol • 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.

14
 Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
the packet that matches
against the specified
ACL maps with an
Unsigned integer. application layer
ACLNumber ACL number Index
Value range: 2000 to 2999. protocol, the packet is
recognized as the
corresponding
application layer
protocol packet.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/ Ipv6ACLPortMappings
This table contains informations about IPv6 ACL-based host-port mappings.

XML structure
<APR>
<Ipv6ACLPortMappings>
<PortMapping>
<PortNumber></PortNumber>
<L4ProtocolID></L4ProtocolID>
<ACLNumber></ACLNumber>
<AppName></AppName>
</PortMapping>
</Ipv6ACLPortMappings>
</APR>

15
Table description
Item Description
Feature name APR
Table name Ipv6ACLPortMappings
Table type Multi-instance table
Row name PortMapping
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
these packets matches
a port mapping for
packets matching the
specified ACL, APR
recognizes them as the
specified application
protocol's packets.
Unsigned integer.
PortNumber Port number Index If two port mappings
Value range: 0 to 65535.
are configured with the
same port number,
transport layer protocol,
and ACL, but with
different application
protocols, the most
recent configuration
takes effect.
This index can be null.
If no transport layer
protocol is specified, all
the transport layer
Enumeration: protocol packets and
Transport layer • 6—TCP. that have the specified
portocol ID port are recognized as
• 17—UDP.
L4ProtocolID specified to the Index the specified
application layer • 33—DCCP. application protocol's
protocol • 132—SCTP. packets.
• 136—UDP-Lite. A mapping with the
transport layer protocol
specified has a higher
priority than one without
it.

16
 Column Column Column
Data type and restrictions Remarks
name description type
If the destination port of
the packet that matches
against the specified
ACL maps with an
Unsigned integer. application layer
ACLNumber ACL number Index
Value range: 2000 to 2999. protocol, the packet is
recognized as the
corresponding
application layer
protocol packet.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
String, case-insensitive. equipment. It can be
Application layer
AppName N/A predefined port
protocol name Length: 1 to 63 characters. mapping application
name or the application
name which doesn't
exist, but the user
defined application will
be created at the same
time.
This column is
affirmatively chosen
item.

APR/Applications
This table contains informations about pre-defined and user-defined applications.

XML structure
<APR>
<Applications>
<Application>
<Type></Type>
<AppName></AppName>
<AppID></AppID>
<L5AppID></L5AppID>
<AppSubCategoryID></AppSubCategoryID>
<IsTunnel></IsTunnel>
<IsEncrypted></IsEncrypted>
<SecRisk></SecRisk>

<RiskLevel></RiskLevel>
</Application>

17
 </Applications>
</APR>

Table description
Item Description
Feature name APR
Table name Applications
Table type Multi-instance table
Row name Application
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Type of the Enumeration:
Type application layer Index • 0—pre-defined. N/A
protocol • 1—user-defined.
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
Application layer String, case-insensitive. and "other".
AppName Index
protocol name Length: 1 to 63 characters. The application layer
protocol name must be
standard and can be
identified by the
equipment.

Application layer Unsigned integer.

AppID N/A 32 N/A
protocol ID Value range: 0 to 2 - 1.

Application layer Unsigned integer.

L5AppID N/A 32 N/A
5 protocol ID Value range: 0 to 2 - 1.

AppSubCateg Identify a Unsigned integer.

N/A 32 N/A
oryID subCategory Value range: 1 to 2 - 1.

Whether or not Boolean:

IsTunnel the protocol is a N/A • true—YES N/A
tunnel protocol • false—NO (default).
Whether or not Boolean:
the protocol is a
IsEncrypted
cryptographic
N/A • true—YES N/A
protocol • false—NO (default).

Application layer Unsigned integer.

SecRisk protocol security N/A 32 N/A
risk Value range: 0 to 2 - 1.

Application layer Unsigned integer.

RiskLevel N/A 16 N/A
protocol risk level Value range: 1 to 2 - 1.

18
APR/AppGroups
This table contains informations about the application groups.

XML structure
<APR>
<AppGroups>
<GroupInfo>
<GroupName></GroupName>
<GroupID></GroupID>
<Type></Type>
<Description></Description>
</GroupInfo>
</AppGroups>
</APR>

Table description
Item Description
Feature name APR
Table name AppGroups
Table type Multi-instance table
Row name GroupInfo
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Valid characters include
digits, letters, hyphens
(-), and underlines (_).
Predefined or Names, such as
user-defined String, case-insensitive.
GroupName Index "invalid" or "other" are
application group Length: 1 to 63 characters. not allowed.
name
You can create up to
65536 application
groups on the device.

Application Unsigned integer.

GroupID N/A 32 N/A
group ID Value range: 0 to 2 - 1.
• Enumeration:
Application
Type N/A • 0—pre-defined. N/A
group type
• 1—user-defined.

19
 Column Column Column
Data type and restrictions Remarks
name description type
Blank space can be
included in Description.
Description for String, case-sensitive.
Description the application N/A The default description
group Length: 1 to 127 characters. of the user-defined
application group is
"User defined group".

APR/AppGroupMembers
This table contains the application protocols included in an application group.

XML structure
<APR>
<AppGroupMembers>
<GroupMember>
<GroupName></GroupName>
<AppName></AppName>
</GroupMember>
</AppGroupMembers>
</APR>

Table description
Item Description
Feature name APR
Table name AppGroupMembers
Table type Multi-instance table
Row name GroupMember
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Valid characters include
digits, letters, hyphens
(-), and underlines (_).
Predefined or Names, such as
user-defined String, case-insensitive.
GroupName Index "invalid" or "other" are
application group Length: 1 to 63 characters. not allowed.
name
You can create up to
65536 application
groups on the device.

20
 Column Column Column
Data type and restrictions Remarks
name description type
Valid characters include
digits, letters, hyphens
(-), and underlines (_),
but can't be "invalid"
and "other".
The application layer
protocol name must be
standard and can be
identified by the
Predefined or equipment.
user-defined A maximum of 65535
application String, case-insensitive. user-defined application
AppName protocol name Index protocols can be added
which is added to Length: 1 to 63 characters.
to an application group.
the application
group If you add a nonexistent
application protocol to
the application group,
the system first creates
the protocol before
adding it to the
application group.
Whether the device can
recognize the packets
of this protocol depends
on your configuration.

APR/StatisticOnInterfaces
This table contains the interfaces where statistic is enabled.

XML structure
<APR>
<StatisticOnInterfaces>
<Interface>
<IfIndex></IfIndex>
<Direction></Direction>
<EnableStatistic></EnableStatistic>
</Interface>
</StatisticOnInterfaces>
</APR>

Table description
Item Description
Feature name APR
Table name StatisticOnInterfaces
Table type Multi-instance table

21
 Row name Interface
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
This column can only
be 3 layer interface
IfIndex Interface index Index Unsigned integer. except loopback, NULL,
FC, FCB and encrypt
interface.
• Enumeration:
The direction of
Direction Index • 0—Inbound. N/A
the interface
• 1—Outbound.

Whether enable • Boolean:

EnableStatisti
statistic for the N/A • true—YES. N/A
c
interface • false—NO (default).

APR/ApplicationStatistics
This table contains the statistics for the specified application protocols on the interface.

XML structure
<APR>
<ApplicationStatistics>
<Statistic>
<IfIndex></IfIndex>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<AppName></AppName>
<InPackets></InPackets>
<InBytes></InBytes>
<InPPS></InPPS>
<InBPS></InBPS>
<OutPackets></OutPackets>
<OutBytes></OutBytes>
<OutPPS></OutPPS>
<OutBPS></OutBPS>
</Statistic>
</ApplicationStatistics>
</APR>

22
Table description
Item Description
Feature name APR
Table name ApplicationStatistics
Table type Multi-instance table
Row name Statistic
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
This column can only
be 3 layer interface
IfIndex Interface index Index Unsigned integer. except loopback, NULL,
FC, FCB and encrypt
interface.
ID of the member Unsigned integer.
Chassis where the entity Index N/A
resides Value range: 0 to 65534.

Slot ID of the Unsigned integer.

Slot Index N/A
entity Value range: 0 to 65534.
Unsigned integer.
CPUID CPU ID Index N/A
Value range: 0 to 7.
The application protocol
Application String, case-insensitive. name must be standard
AppName Index
protocol name Length: 1 to 63 characters. and can be identified by
the equipment.
Number of Unsigned integer.
InPackets packets received N/A N/A
by the interface Value range: 0 to 264 - 1.

Number of bytes Unsigned integer.

InBytes received by the N/A N/A
interface Value range: 0 to 264 - 1.

Packets received Unsigned integer.

InPPS per second by N/A N/A
the interface Value range: 0 to 232 - 1.

Bytes received Unsigned integer.

InBPS per second by N/A 32 N/A
the interface Value range: 0 to 2 - 1.

Number of
packets sent by Unsigned integer.
OutPackets N/A 64 N/A
the interface by Value range: 0 to 2 - 1.
the interface
Number of bytes Unsigned integer.
OutBytes sent by the N/A 64 N/A
interface Value range: 0 to 2 - 1.

23
 Column Column Column
Data type and restrictions Remarks
name description type
Packets sent per Unsigned integer.
OutPPS second by the N/A 32 N/A
interface Value range: 0 to 2 - 1.

Bytes sent per Unsigned integer.

OutBPS second by the N/A 32 N/A
interface Value range: 0 to 2 - 1.

APR/AppSubCategorys
This table contains informations about the application categorys.

XML structure
<APR>
<AppSubCategorys>
<AppSubCategoryEntry>
<ID></ID>
<Name></Name>
</AppSubCategoryEntry>
</AppSubCategorys>
</APR>

Table description
Item Description
Feature name APR
Table name AppSubCategorys
Table type Multi-instance table
Row name AppSubCategoryEntry
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Application Unsigned integer.
ID Index N/A
category ID Value range: 0 to 232 - 1.

24
 Column Column Column
Data type and restrictions Remarks
name description type
Valid characters include
digits, letters, hyphens
(-), and underlines (_).
Predefined Names, such as
String, case-insensitive.
Name application N/A "invalid" or "other" are
category name Length: 1 to 63 characters. not allowed.
You can create up to
65536 application
groups on the device.

APR/SecurityRisks
This table contains informations about the application security risk.

XML structure
<APR>
<SecurityRisks>
<SecurityRisk>
<RiskID></RiskID>
<RiskName></RiskName>
<RiskValue></RiskValue>
</SecurityRisk>
</SecurityRisks>
</APR>

Table description
Item Description
Feature name APR
Table name SecurityRisks
Table type Multi-instance table
Row name SecurityRisk
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Application layer Unsigned integer.
RiskID protocol security Index 16 N/A
risk ID Value range: 0 to 2 - 1.

25
 Column Column Column
Data type and restrictions Remarks
name description type
Application layer String, case-insensitive.
RiskName protocol security N/A N/A
risk name Length: 1 to 63 characters.

Unsigned integer.
RiskValue Risk value N/A 16 N/A
Value range: 0 to 2 - 1.

APR/RiskLevels
This table contains informations about the application risk level.

XML structure
<APR>
<RiskLevels>
<RiskLevel>
<Level></Level>
<Boundary></Boundary>
</RiskLevel>
</RiskLevels>
</APR>

Table description
Item Description
Feature name APR
Table name RiskLevels
Table type Multi-instance table
Row name RiskLevel
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Application layer Unsigned integer.
Level Index 16 N/A
protocol risk level Value range: 1 to 2 - 1.

The boundary Unsigned integer.

Boundary N/A 16 N/A
value of the level Value range: 0 to 2 - 1.

26
Contents
APR ······························································································1
APR/GeneralPortMappings ·········································································································· 1
APR/Ipv4PortMappings ··············································································································· 1
APR/Ipv6PortMappings ··············································································································· 2
APR/Ipv4SubnetPortMappings······································································································ 3
APR/Ipv6SubnetPortMappings······································································································ 3
APR/Ipv4ACLPortMappings ········································································································· 4
APR/Ipv6ACLPortMappings ········································································································· 4
APR/Applications ······················································································································· 5
APR/AppGroups ························································································································ 5
APR/AppGroupMembers ············································································································· 5
APR/AppGroupMembersIncGrp ···································································································· 6

i
APR
APR/GeneralPortMappings
Message Explanation
The specified IP address range overlaps with an When adding a port mapping, the specified IP address range
existing IP address range. overlaps with an existing IP address range.

指定的网段地址与已有网段地址重叠。 新增端口映射时，指定的网段地址与已有网段地址重叠。

Maximum number of port mappings already When adding a port mapping, the number of port mappings
reached. reached the limit.

端口映射条目个数已达到最大值。 新增端口映射时，端口映射条目个数已达到最大值。

When adding a port mapping, an application layer protocol is

An application layer protocol is required.
required.
应用层协议为必选配置项。
新增端口映射时，应用层协议为必选配置项。

Maximum number of user-defined applications When adding a port mapping, the maximum number of
already reached. user-defined applications has been already reached.

自定义应用数量达到最大值。 新增端口映射时，自定义应用数量达到最大值。

The application is being used by a group and

The application is being used by a group and cannot be deleted.
cannot be deleted.
删除端口映射时，应用已经被应用组引用无法删除。
此应用已被应用组引用无法删除。

APR/Ipv4PortMappings
Message Explanation
The specified IP address range overlaps with an When adding a port mapping, the specified IP address range
existing IP address range. overlaps with an existing IP address range.

指定的网段地址与已有网段地址重叠。 新增端口映射时，指定的网段地址与已有网段地址重叠。

End IP address cannot be smaller than start IP Invalid configuration because the end IP address is lower than
address. start IP address.

结束地址不能小于起始地址。 结束地址小于起始地址，则为无效地址。

Maximum number of port mappings already When adding a port mapping, number of port mappings reached
reached. the limit.

端口映射条目个数已达到最大值。 新增端口映射时，端口映射条目个数已达到最大值。

1
 When adding a port mapping, an application layer protocol is
An application layer protocol is required.
required.
应用层协议为必选配置项。
新增端口映射时，应用层协议为必选配置项。

Maximum number of user-defined applications When adding a port mapping, maximum number of user-defined
already reached. applications has been already reached.

自定义应用数量达到最大值。 新增端口映射时，自定义应用数量达到最大值。

The application is being used by a group and

The application is being used by a group, and cannot be deleted.
cannot be deleted.
删除端口映射时，应用已经被应用组引用无法删除。
此应用已被应用组引用无法删除。

APR/Ipv6PortMappings
Message Explanation
The specified IP address range overlaps with an When adding a port mapping, the specified IP address range
existing IP address range. overlaps with an existing IP address range.

指定的网段地址与已有网段地址重叠。 新增端口映射时，指定的网段地址与已有网段地址重叠。

End IP address cannot be smaller than start IP Invalid configuration because the end IP address is lower than
address. start IP address.

结束地址不能小于起始地址。 结束地址小于起始地址，则为无效地址。

Maximum number of port mappings already When adding a port mapping, the number of port mappings
reached. reached the maximum.

端口映射条目个数已达到最大值。 新增端口映射时，端口映射条目个数已达到最大值。

When adding a port mapping, an application layer protocol is

An application layer protocol is required.
required.
应用层协议为必选配置项。
新增端口映射时，应用层协议为必选配置项。

Maximum number of user-defined applications When adding a port mapping, maximum number of user-defined
already reached. applications has been already reached.

自定义应用数量达到最大值。 新增端口映射时，自定义应用数量达到最大值。

The application is being used by a group and

The application is being used by a group and cannot be deleted.
cannot be deleted.
删除端口映射时，应用已经被应用组引用无法删除。
此应用已被应用组引用无法删除。

2
APR/Ipv4SubnetPortMappings
Message Explanation
The specified IP address range overlaps with an When adding a port mapping, the specified IP address range
existing IP address range. overlaps with an existing IP address range.

指定的网段地址与已有网段地址重叠。 新增端口映射时，指定的网段地址与已有网段地址重叠。

When adding a port mapping, the number of port mappings

Number of port mappings exceeded the limit.
reached the maximum.
端口映射条目个数已达到最大值。
新增端口映射时，端口映射条目个数已达到最大值。

When adding a port mapping, an application layer protocol is

An application layer protocol is required.
required.
应用层协议为必选配置项。
新增端口映射时，应用层协议为必选配置项。

Maximum number of user-defined applications When adding a port mapping, maximum number of user-defined
already reached. applications has been already reached.

自定义应用数量达到最大值。 新增端口映射时，自定义应用数量达到最大值。

The application is being used by a group and

The application is being used by a group and cannot be deleted.
cannot be deleted.
删除端口映射时，应用已经被应用组引用无法删除。
此应用已被应用组引用无法删除。

APR/Ipv6SubnetPortMappings
Message Explanation
The specified IP address range overlaps with an When adding a port mapping, the specified IP address range
existing IP address range. overlaps with an existing IP address range.

指定的网段地址与已有网段地址重叠。 新增端口映射时，指定的网段地址与已有网段地址重叠。

When adding a port mapping, the number of port mappings

Number of port mappings exceeded the limit.
reached the maximum.
端口映射条目个数已达到最大值。
新增端口映射时，端口映射条目个数已达到最大值。

When adding a port mapping, an application layer protocol is

An application layer protocol is required.
required.
应用层协议为必选配置项。
新增端口映射时，应用层协议为必选配置项。

Maximum number of user-defined applications When adding a port mapping, maximum number of user-defined
already reached. applications has been already reached.

自定义应用数量达到最大值。 新增端口映射时，自定义应用数量达到最大值。

3
The application is being used by a group and
The application is being used by a group and cannot be deleted.
cannot be deleted.
删除端口映射时，应用已经被应用组引用无法删除。
此应用已被应用组引用无法删除。

APR/Ipv4ACLPortMappings
Message Explanation
When adding a port mapping, the specified IP
The specified IP address range overlaps with an
address range overlaps with an existing IP address
existing IP address range.
range.
指定的网段地址与已有网段地址重叠。
新增端口映射时，指定的网段地址与已有网段地址重叠。

When adding a port mapping, the number of port mappings

Number of port mappings exceeded the limit.
reached the maximum.
端口映射条目个数已达到最大值。
新增端口映射时，端口映射条目个数已达到最大值。

When adding a port mapping, an application layer protocol is

An application layer protocol is required.
required.
应用层协议为必选配置项。
新增端口映射时，应用层协议为必选配置项。

Maximum number of user-defined applications When adding a port mapping, maximum number of user-defined
already reached. applications has been already reached.

自定义应用数量达到最大值。 新增端口映射时，自定义应用数量达到最大值。

The application is being used by a group and

The application is being used by a group and cannot be deleted.
cannot be deleted.
删除端口映射时，应用已经被应用组引用无法删除。
此应用已被应用组引用无法删除。

APR/Ipv6ACLPortMappings
Message Explanation
The specified IP address range overlaps with an When adding a port mapping, the specified IP address range
existing IP address range. overlaps with an existing IP address range.

指定的网段地址与已有网段地址重叠。 新增端口映射时，指定的网段地址与已有网段地址重叠。

When adding a port mapping, the number of port mappings

Number of port mappings exceeded the limit.
reached the maximum.
端口映射条目个数已达到最大值。
新增端口映射时，端口映射条目个数已达到最大值。

An application layer protocol is required. When adding a port mapping, an application layer protocol is

4
应用层协议为必选配置项。 required.

新增端口映射时，应用层协议为必选配置项。

Maximum number of user-defined applications When adding a port mapping, maximum number of user-defined
already reached. applications has been already reached.

自定义应用数量达到最大值。 新增端口映射时，自定义应用数量达到最大值。

The application is being used by a group and

The application is being used by a group and cannot be deleted.
cannot be deleted.
删除端口映射时，应用已经被应用组引用无法删除。
此应用已被应用组引用无法删除。

APR/Applications
Message Explanation
The specified application does not exist. No custom applications are specified.

该应用不存在。 没有指定的自定义应用。

APR/AppGroups
Message Explanation
Cannot modify the configuration of pre-defined When configuring application groups, you cannot modify the
application groups. configuration of pre-defined application groups.

预定义应用组不能修改。 配置应用组时，预定义应用组不能修改。

Maximum number of user-defined application The maximum number of user-defined application groups is
groups already reached. reached and no application groups can be created.

自定义应用组数量达到最大值。 创建自定义应用组时，数量已达到最大值。

APR/AppGroupMembers
Message Explanation
Can't modify the configuration of pre-defined When configuring application groups, you cannot modify the
application groups. configuration of pre-defined application groups.

预定义应用组不能修改。 配置应用组时，预定义应用组不能修改。

5
APR/AppGroupMembersIncGrp
Message Explanation
Can't modify the configuration of pre-defined When configuring application groups, you cannot modify the
application groups. configuration of pre-defined application groups.

预定义应用组不能修改。 配置应用组时，预定义应用组不能修改。

6
Contents
APT·······························································································1
APT/SandboxTryConnect ············································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
APT
APT/SandboxTryConnect
This table contains APT try connect sandbox.

XML structure
<APT>
<SandboxTryConnect>
<Try></Try>
</SandboxTryConnect>
</APT>

Table description
Item Description
Feature name APT
Table name SandboxTryConnect
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Try connect
Try N/A This column must be empty. N/A
sandbox.

1
Contents
APT·······························································································1
APT/Policies ····························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
APT/PolicyInProfile····················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
APT/LoginSandbox ···················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4

i
APT
APT/Policies
This table contains the APT policy information.

XML structure
<APT>
<Policies>
<Policy>
<PolicyName></PolicyName>
<PolicyDescription></PolicyDescription>
<Application></Application>
<Direction></Direction>
<FileTypeList>
<FileType></FileType>
</FileTypeList>
</Policy>
</Policies>
</APT>

Table description
Item Description
Feature name APT
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-insensitive.
PolicyName Policy name Index N/A
Length: 1 to 31 characters.

PolicyDescriptio String, case-insensitive.

Policy description N/A N/A
n Length: 1 to 255 characters.
Enumeration:
Application
Application N/A • 1—HTTP. N/A
protocol type
• 2—HTTPS.

1
 Column Column Column
Data type and restrictions Remarks
name description type
• 4—FTP.
• 8—SMTP.
• 16—POP3.
• 32—IMAP.
• 64—NFS.
• 128—SMB.
Enumeration:
File transfer • 0—Both. (Default.)
Direction N/A N/A
direction • 1—Upload.
• 2—Download.

Data Members include:

FileTypeList File type list N/A
structure • FileType
String, case-insensitive.
FileType File type name N/A N/A
Length: 1 to 8 characters.

APT/PolicyInProfile
This table contains application of APT policies to the profile.

XML structure
<APT>
<PolicyInProfile>
<Profile>
<ProfileName></ProfileName>
<PolicyName></PolicyName>
</Profile>
</PolicyInProfile>
</APT>

Table description
Item Description
Feature name APT
Table name PolicyInProfile
Table type Multi-instance table
Row name Profile
Restrictions None
Support for row creation and deletion Yes

2
Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-insensitive.
ProfileName Profile name Index N/A
Length: 1 to 100 characters.
String, case-insensitive.
PolicyName Policy name N/A N/A
Length: 1 to 31 characters.

APT/LoginSandbox
This table contains sandbox login configuration information.

XML structure
<APT>
<LoginSandbox>
<Enable></Enable>
<IpAddress></IpAddress>
<Protocol></Protocol>
<Username></Username>
<Password></Password>
<EXE></EXE>
<ZIP></ZIP>
<OFFICE></OFFICE>
<PDF></PDF>
<PICTURE></PICTURE>
<WEB></WEB>
<VIDEO></VIDEO>
<OTHER></OTHER>
<CacheSize></CacheSize>
<STATE></STATE>
</LoginSandbox>
</APT>

Table description
Item Description
Feature name APT
Table name LoginSandbox
Table type Single-instance table
Row name N/A
Restrictions None
Support for row creation and deletion No

3
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
Enabling status
Enable
of sandbox
N/A • true N/A
• false

IP address of the String, case-insensitive.

IpAddress N/A Example: h3c.com.
sandbox Length: 1 to 64 characters.
• Enumeration:
Type of file
Protocol N/A • 0—HTTP. N/A
transfer protocol
• 1—HTTPS.

Sandbox String, case-insensitive.

Username N/A N/A
username Length: 5 to 12 characters.
String, case-sensitive.
Password Password N/A N/A
Length: 6 to 32 characters.
Maximum size of Unsigned short.
EXE exe file that can N/A N/A
be transferred Value range: 0 to 10240.

Maximum size of Unsigned short.

ZIP zip file that can N/A N/A
be transferred Value range: 0 to 10240.

Maximum size of
office file that Unsigned short.
OFFICE N/A N/A
can be Value range: 0 to 2048.
transferred
Maximum size of Unsigned short.
PDF pdf file that can N/A N/A
be transferred Value range: 0 to 2048.

Maximum size of
picture file that Unsigned short.
PICTURE N/A N/A
can be Value range: 0 to 500.
transferred
Maximum size of Unsigned short.
WEB web file that can N/A N/A
be transferred Value range: 0 to 500.

Maximum size of
video file that Unsigned short.
VIDEO N/A N/A
can be Value range: 0 to 102400.
transferred
Maximum size of Unsigned short.
OTHER other file that can N/A N/A
be transferred Value range: 0 to 102400.

Maximum cache Unsigned int.

size for the
CacheSize N/A Value range: 100000 to N/A
blacklist and
whitelist 200000.

Boolean:
State of sandbox
STATE
connection
N/A • true N/A
• false

4
5
Contents
APT·······························································································1
APT/Policies ····························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
APT/PolicyInProfile····················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
APT/LoginSandbox ···················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4

i
APT
APT/Policies
This table contains the APT policy information.

XML structure
<APT>
<Policies>
<Policy>
<PolicyName></PolicyName>
<PolicyDescription></PolicyDescription>
<Application></Application>
<Direction></Direction>
<FileTypeList>
<FileType></FileType>
</FileTypeList>
</Policy>
</Policies>
</APT>

Table description
Item Description
Feature name APT
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-insensitive.
PolicyName Policy name Index N/A
Length: 1 to 31 characters.

PolicyDescriptio String, case-insensitive.

Policy description N/A N/A
n Length: 1 to 255 characters.
Enumeration:
Application • 1—HTTP.
Application N/A N/A
protocol type • 2—HTTPS.
• 4—FTP.

1
 Column Column Column
Data type and restrictions Remarks
name description type
• 8—SMTP.
• 16—POP3.
• 32—IMAP.
• 64—NFS.
• 128—SMB.
Enumeration:
File transfer • 0—Both.
Direction N/A N/A
direction • 1—Upload.
• 2—Download.

Data Members include:

FileTypeList File type list N/A
structure • FileType
String, case-insensitive.
FileType File type name N/A N/A
Length: 1 to 8 characters.

APT/PolicyInProfile
This table contains application of APT policies to the profile.

XML structure
<APT>
<PolicyInProfile>
<Profile>
<ProfileName></ProfileName>
<PolicyName></PolicyName>
</Profile>
</PolicyInProfile>
</APT>

Table description
Item Description
Feature name APT
Table name PolicyInProfile
Table type Multi-instance table
Row name Profile
Restrictions None

2
Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-insensitive.
ProfileName Profile name Index N/A
Length: 1 to 100 characters.
String, case-insensitive.
PolicyName Policy name N/A N/A
Length: 1 to 31 characters.

APT/LoginSandbox
This table contains sandbox login configuration information.

XML structure
<APT>
<LoginSandbox>
<Enable></Enable>
<IpAddress></IpAddress>
<Protocol></Protocol>
<Username></Username>
<Password></Password>
<EXE></EXE>
<ZIP></ZIP>
<OFFICE></OFFICE>
<PDF></PDF>
<PICTURE></PICTURE>
<WEB></WEB>
<VIDEO></VIDEO>
<OTHER></OTHER>
<CacheSize></CacheSize>
<STATE></STATE>
</LoginSandbox>
</APT>

Table description
Item Description
Feature name APT
Table name LoginSandbox
Table type Single-instance table
Row name N/A
Restrictions None

3
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enabling status Boolean:
Enable of sandbox N/A • true N/A
• false

IP address of the String, case-insensitive.

IpAddress N/A Example: h3c.com.
sandbox Length: 1 to 64 characters.
Enumeration:
Type of file
Protocol
transfer protocol
N/A • 0—HTTP. N/A
• 1—HTTPS.

Sandbox String, case-insensitive.

Username N/A N/A
username Length: 5 to 12 characters.
String, case-sensitive.
Password Password N/A N/A
Length: 6 to 32 characters.
Maximum size of Unsigned short.
EXE exe file that can N/A N/A
be transferred Value range: 0 to 10240.

Maximum size of Unsigned short.

ZIP zip file that can N/A N/A
be transferred Value range: 0 to 10240.

Maximum size of
office file that Unsigned short.
OFFICE N/A N/A
can be Value range: 0 to 2048.
transferred
Maximum size of Unsigned short.
PDF pdf file that can N/A N/A
be transferred Value range: 0 to 2048.

Maximum size of
picture file that Unsigned short.
PICTURE N/A N/A
can be Value range: 0 to 500.
transferred
Maximum size of Unsigned short.
WEB web file that can N/A N/A
be transferred Value range: 0 to 500.

Maximum size of
video file that Unsigned short.
VIDEO N/A N/A
can be Value range: 0 to 102400.
transferred
Maximum size of Unsigned short.
OTHER other file that can N/A N/A
be transferred Value range: 0 to 102400.

Maximum cache Unsigned int.

size for the
CacheSize N/A Value range: 100000 to N/A
blacklist and
whitelist 200000.

Boolean:
State of sandbox
STATE
connection
N/A • true N/A
• false

4
5
Contents
ARP ······························································································1
ARP/ArpScan ···························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ARP/ArpFixup ··························································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
ARP/ArpClearByType ················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
ARP/ArpClearByIfIndex ··············································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
ARP/ArpClearTable ···················································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
ARP/ArpSnoopingClearByVLAN ··································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
ARP/ArpSnoopingClearByIP ········································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 7
Columns ···························································································································· 7
ARP/ArpRateLimitAllIf ················································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8

i
ARP
ARP/ArpScan
This table is used to enable ARP automatic scanning in a specific Ipv4 address range.

XML structure
<ARP>
<ArpScan>
<Scan>
<IfIndex></IfIndex>
<Ipv4AddressStart></Ipv4AddressStart>
<Ipv4AddressEnd></Ipv4AddressEnd>
</Scan>
</ArpScan>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpScan

Table type Multi-instance table

Row name Scan

This table supports interface types:

Layer 3 Ethernet interface/subinterface

Restrictions
Layer 3 aggregate interface/subinterface

VLAN interface

Columns

Column Column Column Data type and

Remarks
name description type restrictions
IfIndex Interface Index Index Unsigned integer. N/A

1
 Column Column Column Data type and
Remarks
name description type restrictions
If no address range is
specified, the device only
scans neighbors on the
network where the
primary IP address of the
The start IPv4 interface resides.
Ipv4Address String, dotted decimal
address of the N/A The start IP address and
Start notation.
scanning range end IP address must be
on the same network as
the primary IP address or
manually configured
secondary IP addresses
of the interface.

The end IPv4 Must be specified if the

Ipv4Address String, dotted decimal
address of the N/A Ipv4AddressStart
End notation.
scanning range column is specified.

ARP/ArpFixup
This table is used to change the existing dynamic ARP entries into static ARP entries.

XML structure
<ARP>
<ArpFixup>
<Fixup>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
</Fixup>
</ArpFixup>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpFixup

2
 Table type Multi-instance table

Row name Fixup

Restrictions Only Layer 3 interface is supported.

Columns

Column Column
Column type Data type and restrictions
name description
IfIndex Interface Index Index Unsigned integer.

Ipv4Address IPv4 address Index String, dotted decimal notation.

ARP/ArpClearByType
This table is used to clear ARP entries according to ARP entry type.

XML structure
<ARP>
<ArpClearByType>
<ArpType></ArpType>
</ArpClearByType>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpClearByType

Table type Single-instance table

Row name None

Restrictions None

3
Columns

Column Column
Column type Data type and restrictions
name description
Enumeration:

• 0—Dynamic.
ArpType ARP entry type N/A • 1—Static.
• 2—Multiport.
• 3—All.

ARP/ArpClearByIfIndex
This table is used to clear dynamic ARP entries according to interface index.

XML structure
<ARP>
<ArpClearByIfIndex>
<ClearByIfIndex>
<IfIndex></IfIndex>
</ClearByIfIndex>
</ArpClearByIfIndex>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpClearByIfIndex

Table type Multi-instance table

Row name ClearByIfIndex

This table supports interface types:

Layer 2 Ethernet interface/Layer 2 aggregate interface view

Restrictions Layer 3 Ethernet interface/subinterface view

Layer 3 aggregate interface/aggregate subinterface view

S-channel interface/S-channel aggregate interface view

4
Columns

Column Column
Column type Data type and restrictions
name description
IfIndex Interface Index Index Unsigned integer.

ARP/ArpClearTable
This table is used to clear ARP entries by an IP address and an interface index.

XML structure
<ARP>
<ArpClearTable>
<ClearEntry>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
</ClearEntry>
</ArpClearTable>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpClearTable

Table type Multi-instance table

Row name ClearEntry

Restrictions Only Layer 3 interface is supported.

Columns

Column Column
Column type Data type and restrictions
name description
IfIndex Interface Index Index Unsigned integer.

Ipv4Address IPv4 address Index String, dotted decimal notation.

5
ARP/ArpSnoopingClearByVLAN
This table is used to clear dynamic ARP Snnoping entries according to VLAN..

XML structure
<ARP>
<ArpSnoopingClearByVLAN>
<ClearByVLAN>
<VLANID></VLANID>
</ClearByVLAN>
</ArpSnoopingClearByVLAN>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpSnoopingClearByVLAN

Table type Multi-instance table

Row name ClearByVLAN

Restrictions None

Columns

Column Column
Column type Data type and restrictions
name description
VLANID VLAN ID Index Unsigned integer.

ARP/ArpSnoopingClearByIP
This table is used to clear dynamic ARP Snnoping entries according to Ipv4 address.

XML structure
<ARP>
<ArpSnoopingClearByIP>

6
 <ClearByIP>
<Ipv4Address></Ipv4Address>
</ClearByIP>
</ArpSnoopingClearByIP>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpSnoopingClearByIP

Table type Multi-instance table

Row name ClearByIP

Restrictions None

Columns

Column Column
Column type Data type and restrictions
name description
Ipv4Address IPv4 address Index String, dotted decimal notation.

ARP/ArpRateLimitAllIf
This table is used to config ARP rate limit on all layer 2 physical interface and layer 2 aggregate
interface.

XML structure
<ARP>
<ArpRateLimitAllIf>
<RateLimitAllIf>
<RateLimitEnable></RateLimitEnable>
<RateLimitNum></RateLimitNum>
</RateLimitAllIf>
</ArpRateLimitAllIf>
</ARP>

7
Table description

Item Description
Feature name ARP

Table name ArpRateLimitAllIf

Table type Multi-instance table

Row name RateLimitAllIf

Restrictions None

Columns

Column Column
Column type Data type and restrictions
name description

Whether the rate Boolean:

RateLimitEn
limit function is N/A • true (default) N/A
able
enable. • false

The value of
uiRateLimitLowerLimit
and
uiRateLimitUpperLimit

Unsigned integer. depend on the device

RateLimitNu Set the rate limit Value range: model.

N/A
m number uiRateLimitLowerLimit to The default value of
uiRateLimitUpperLimit. RateLimitNum depends
on the device model.

RateLimitNum can be
configured only when
RateLimitEnable is true.

8
Contents
ARP ······························································································1
ARP/ArpConfig ···························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
ARP/ArpGratuitous ······················································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 3
Columns ······························································································································ 3
ARP/ArpLearnLimit······················································································································· 3
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 4
ARP/ArpGratuitousInterval ············································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 6
Columns ······························································································································ 6
ARP/ArpProxy ····························································································································· 6
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 7
ARP/ArpAttackProtect ··················································································································· 8
XML structure ······················································································································· 8
Table description ··················································································································· 9
Columns ······························································································································ 9
ARP/ArpRateLimit ······················································································································ 11
XML structure ····················································································································· 11
Table description ················································································································· 11
Columns ···························································································································· 11
ARP/ArpRateLimitLog ················································································································· 12
XML structure ····················································································································· 12
Table description ················································································································· 13
Columns ···························································································································· 13
ARP/ArpSourceMACExclude········································································································ 13
XML structure ····················································································································· 13
Table description ················································································································· 14
Columns ···························································································································· 14
ARP/ArpAuthorized ···················································································································· 14
XML structure ····················································································································· 14
Table description ················································································································· 15
Columns ···························································································································· 15
ARP/ArpDetection ······················································································································ 16
XML structure ····················································································································· 16
Table description ················································································································· 16
Columns ···························································································································· 16
ARP/ArpDetectionTrust ··············································································································· 17
XML structure ····················································································································· 17
Table description ················································································································· 17
Columns ···························································································································· 17
ARP/ArpFilterSource ·················································································································· 18
XML structure ····················································································································· 18
Table description ················································································································· 18
Columns ···························································································································· 19
ARP/ArpFilterBinding ·················································································································· 19
XML structure ····················································································································· 20
Table description ················································································································· 20
Columns ···························································································································· 20

i
ARP/ArpSnooping ······················································································································ 21
XML structure ····················································································································· 21
Table description ················································································································· 21
Columns ···························································································································· 22
ARP/ArpInterface ······················································································································· 22
XML structure ····················································································································· 22
Table description ················································································································· 22
Columns ···························································································································· 23
ARP/ArpVsiConfig ······················································································································ 23
XML structure ····················································································································· 23
Table description ················································································································· 24
Columns ···························································································································· 24
ARP/ArpRouteAdvertise ·············································································································· 25
XML structure ····················································································································· 25
Table description ················································································································· 25
Columns ···························································································································· 26
ARP/ArpVsiFeature ···················································································································· 26
XML structure ····················································································································· 26
Table description ················································································································· 26
Columns ···························································································································· 27
ARP/ArpVsiDetectionTrust ··········································································································· 27
XML structure ····················································································································· 27
Table description ················································································································· 28
Columns ···························································································································· 28

ii
ARP
ARP/ArpConfig
This table contains ARP configuration information.

XML structure
<ARP>
<ArpConfig>
<Config>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<MacAddress></MacAddress>
<VLANID></VLANID>
<PortIndex></PortIndex>
<ArpType></ArpType>
</Config>
</ArpConfig>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpConfig

Table type Multi-instance table

Row name Config

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Some versions support
VrfIndex Index of the VRF Index Unsigned integer.
VRF name. For relevant

1
 Column Column Column Data type and
Remarks
name description type restrictions
information, see the XSD
document of your
product.

0 means public network

String, dotted decimal

Ipv4Address IPv4 address Index N/A
notation.

Six groups of two

MacAddress MAC address N/A hexadecimal digits, Required.
hyphen-separated.

It must be configured
together with the
Unsigned integer. PortIndex column when
VLANID VLAN ID N/A
Value range: 1 to 4094. ArpType is static.

It must be specified when

ArpType is multiport.

It must be configured
together with the VLANID
column when ArpType is
PortIndex Port index N/A Unsigned integer. static.

It must not be specified

when ArpType is
multiport.

Required.
Enumeration:
If the multiport type is
ArpType ARP entry type N/A • 1—Static.
supported depends on
• 2—Multiport.
the device model.

ARP/ArpGratuitous
This table contains gratuitous ARP packets enable information.

XML structure
<ARP>
<ArpGratuitous>
<LearnEnable></LearnEnable>
<SendEnable></SendEnable>

2
 </ArpGratuitous>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpGratuitous

Table type Single-instance table

Row name None

Restrictions None

Support for row creation and deletion No

Columns

Column Column
Column type Data type and restrictions
name description
Whether the
learning of Boolean:
LearnEnable gratuitous ARP N/A • true (default)
packets function is • false
enabled

Whether the
function of sending
gratuitous ARP
packets upon Boolean:
SendEnable receiving ARP N/A • true
requests whose • false (default)
target IP address
is on a different
subnet is enabled.

ARP/ArpLearnLimit
This table contains the information of maximum number of dynamic ARP entries that an interface
can learn.

3
XML structure
<ARP>
<ArpLearnLimit>
<LearnLimit>
<IfIndex></IfIndex>
<LearnMaxNum></LearnMaxNum>
<LearnAlarmThreshold></LearnAlarmThreshold>
</LearnLimit>
</ArpLearnLimit>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpLearnLimit

Table type Multi-instance table

Row name LearnLimit

This table supports interface types:

Layer 2 Ethernet interface/Layer 2 aggregate interface

Layer 3 Ethernet interface/subinterface

Restrictions
Layer 3 aggregate interface/aggregate subinterface

S-channel interface/S-channel aggregate interface

VLAN interface

Support for row creation and deletion No

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Some versions support
interface name. For
IfIndex Interface Index Index Unsigned integer. relevant information, see
the XSD

document of your

4
 Column Column Column Data type and
Remarks
name description type restrictions
product. For information
about IfIndex, see IfMgr
in Ifmgr

NETCONF XML API

Configuration Reference.

0 means the interface is

disabled from learning

The maximum dynamic ARP entries.

number of Unsigned integer. The value of

LearnMaxN
dynamic ARP N/A Value range: 0 to LearnMaxNumLimit
um
entries that an LearnMaxNumLimit. depends on the device
interface can learn model.

The default setting varies

with device models.

To disable the threashold

LearnAlarm Alarm threshold in Unsigned integer. alarming, set the value to
N/A
Threshold percentage Value range: 0 to 100. 0.

The default setting is 0.

ARP/ArpGratuitousInterval
This table contains the information of periodic sending of gratuitous ARP packets and set the
sending interval on an interface.

XML structure
<ARP>
<ArpGratuitousInterval>
<GratuitousInterval>
<IfIndex></IfIndex>
<Interval></Interval>
</GratuitousInterval>
</ArpGratuitousInterval>
</ARP>

5
Table description

Item Description
Feature name ARP

Table name ArpGratuitousInterval

Table type Multi-instance table

Row name GratuitousInterval

This table supports interface types:

Layer 3 Ethernet interface/subinterface

Restrictions
Layer 3 aggregate interface/subinterface

VLAN interface

Support for row creation and deletion No

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
IfIndex Interface Index Index Unsigned integer. your product. For
information about IfIndex,
see IfMgr in Ifmgr
NETCONF XML API
Configuration Reference.

The interval at Unsigned integer. 0 means disable the

which gratuitous Value range: 0, 200 to interface from
Interval N/A
ARP packets are 200000 ms. periodically sending
sent Default: 0. gratuitous ARP packets.

ARP/ArpProxy
This table contains ARP proxy enable and local ARP proxy enable information.

6
XML structure
<ARP>
<ArpProxy>
<Proxy>
<IfIndex></IfIndex>
<ProxyEnable></ProxyEnable>
<LocalProxyEnable></LocalProxyEnable>
<LocalStartIpv4Address></LocalStartIpv4Address>
<LocalEndIpv4Address></LocalEndIpv4Address>
</Proxy>
</ArpProxy>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpProxy

Table type Single-instance table

Row name Proxy

This table supports interface types:

Layer 3 Ethernet interface/subinterface

Restrictions
Layer 3 aggregate interface/aggregate subinterface

VLAN interface

Support for row creation and deletion No

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Some versions support
interface name. For
relevant information, see
IfIndex Interface Index Index Unsigned integer. the XSD document of
your product. For
information about IfIndex,
see IfMgr in Ifmgr

7
 Column Column Column Data type and
Remarks
name description type restrictions
NETCONF XML API
Configuration Reference.

Whether proxy Boolean:

ProxyEnable ARP is enabled on N/A • true N/A
the interface • false (default)

Whether local
Boolean:
LocalProxyE proxy ARP is N/A
N/A • true
nable enabled on the
• false (default)
interface

LocalStartIpv4Address

and
LocalEndIpv4Address
must be configured
Start IPv4 address
together.
LocalStartIp of the specified String, dotted decimal
N/A LocalStartIpv4Address
v4Address address range for notation.
local proxy ARP and
LocalEndIpv4Address
can be configured only
when local proxy ARP on
the interface is enabled.

End IPv4 address

LocalEndIpv of the specified String, dotted decimal
N/A N/A
4Address address range for notation.
local proxy ARP

ARP/ArpAttackProtect
This table contains ARP attack protect information.

XML structure
<ARP>
<ArpAttackProtect>
<ResolvingRouteEnable></ResolvingRouteEnable>
<SourceSuppressionEnable></SourceSuppressionEnable>
<SourceSuppressionLimitNum></SourceSuppressionLimitNum>
<SourceMACDetectType></SourceMACDetectType>
<SourceMACAgeTime></SourceMACAgeTime>

8
 <SourceMACThresholdValue></SourceMACThresholdValue>
<ValidCheckEnable></ValidCheckEnable>
<ActiveACKType></ActiveACKType>
<DetectionValidateSrcMAC></DetectionValidateSrcMAC>
<DetectionValidateDstMAC></DetectionValidateDstMAC>
<DetectionValidateIP></DetectionValidateIP>
</ArpAttackProtect>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpAttackProtect

Table type Single-instance table

Row name None

Restrictions None

Support for row creation and deletion No

Columns

Column Column Column Data type and

Remarks
name description type restrictions
The default value of
Whether the Boolean:
ResolvingRo ResolvingRouteEnable
resolving route N/A • true
uteEnable depends on the device
function is enabled • false
model.

Whether the ARP

SourceSupp Boolean:
suppression
ressionEnab N/A • true N/A
original address
le • false (default)
function is enabled

SourceSupp Set the source Unsigned integer.

ressionLimit suppression limit N/A Value range: 2 to 1024. N/A

Num number Default: 10.

Set the attack

Unsigned integer.
SourceMAC detection function
N/A • 0—Disabled (default). N/A
DetectType of fixed source
• 1—Filter.
MAC address and

9
Column Column Column Data type and
Remarks
name description type restrictions
select the mode • 2—Monitor.

Set the fixed

source mac Unsigned integer.
SourceMAC
address aging N/A Value range: 60 to 6000. N/A
AgeTime
time of arp attack Default: 300.
detection entries

The value of
uiSourceMinThreshold
and
Set the fixed Unsigned integer.
uiSourceMaxThreshold
SourceMAC source mac Unsigned integer.
depend on the device
ThresholdVa address threshold N/A Value range: model.
lue of ARP attack uiSourceMinThreshold to
The default value of
detection entries uiSourceMaxThreshold.
SourceMACThresholdVa
lue depends on the
device model.

Whether the
source mac Boolean:
ValidCheck
address N/A • true N/A
Enable
consistency check • false (default)
function is enabled

Unsigned integer.

ActiveACKT Enable ARP active • 0—Disabled (default).

N/A N/A
ype acknowledgement • 1—Loose.
• 2—Strict.

Whether the
DetectionVal effective checks Boolean:
idateSrcMA on the source mac N/A • true N/A
C address function is • false (default)
enabled

Whether the
DetectionVal effective checks Boolean:
idateDstMA on the destination N/A • true N/A
C mac address • false (default)
function is enabled

DetectionVal Whether the Boolean:

N/A N/A
idateIP effective checks • true

10
 Column Column Column Data type and
Remarks
name description type restrictions
on the IP address • false (default)
is enabled

ARP/ArpRateLimit
This table contains ARP rate limit information.

XML structure
<ARP>
<ArpRateLimit>
<RateLimit>
<IfIndex></IfIndex>
<RateLimitEnable></RateLimitEnable>
<RateLimitNum></RateLimitNum>
</RateLimit>
</ArpRateLimit>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpRateLimit

Table type Single-instance table

Row name RateLimit

This table supports interface types:

Restrictions
Layer 2 Ethernet interface/Layer 2 aggregate interface

Support for row creation and deletion No

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Some versions support
IfIndex Interface index. Index Unsigned integer.
interface name. For

11
 Column Column Column Data type and
Remarks
name description type restrictions
relevant information, see
the XSD document of
your product. For
information about IfIndex,
see IfMgr in Ifmgr
NETCONF XML API
Configuration Reference.

Whether the rate Boolean:

RateLimitEn
limit function is N/A • true (default) N/A
able
enabled • false

The value of
uiRateLimitLowerLimit
and
uiRateLimitUpperLimit

Unsigned integer. depend on the device

RateLimitNu Set the rate limit model.

Value range:
N/A
m number uiRateLimitLowerLimit to The default value of
uiRateLimitUpperLimit. RateLimitNum depends
on the device model.

RateLimitNum can be
configured only when
RateLimitEnable is true.

ARP/ArpRateLimitLog
This table contains ARP rate limit log information.

XML structure
<ARP>
<ArpRateLimitLog>
<LogEnable></LogEnable>
<LogInterval></LogInterval>
</ArpRateLimitLog>
</ARP>

12
Table description

Item Description
Feature name ARP

Table name ArpRateLimitLog

Table type Single-instance table

Row name None

Restrictions None

Support for row creation and deletion No

Columns

Column Column Column Data type and

Remarks
name description type restrictions

Whether the rate Boolean:

LogEnable limit log function is N/A • true N/A
enabled • false(default)

Set the interval of Unsigned integer.

LogInterval sending report or N/A Value range: 1 to 86400. N/A

log Default: 60.

ARP/ArpSourceMACExclude
This table contains protective source mac address information.

XML structure
<ARP>
<ArpSourceMACExclude>
<SourceMACExclude>
<MacAddress></MacAddress>
</SourceMACExclude>
</ArpSourceMACExclude>
</ARP>

13
Table description

Item Description
Feature name ARP

Table name ArpSourceMACExclude

Table type Multi-instance table

Row name SourceMACExclude

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Column Data type and

Remarks
name description type restrictions
The maximum number of
protective source mac
Six groups of two
address that can be
MacAddress MAC address Index hexadecimal digits,
configured depends on
hyphen-separated.
the device model.

ARP/ArpAuthorized
This table contains the authorized ARP information.

XML structure
<ARP>
<ArpAuthorized>
<Authorized>
<IfIndex></IfIndex>
<Enable></Enable>
</Authorized>
</ArpAuthorized>
</ARP>

14
Table description

Item Description
Feature name ARP

Table name ArpAuthorized

Table type Single-instance table

Row name Authorized

This table supports interface types:

Layer 3 Ethernet interface/subinterface

Restrictions
Layer 3 aggregate interface/aggregate subinterface

VLAN interface

Support for row creation and deletion No

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Layer 3 Ethernet
interface/subinterface

Layer 3 aggregate
interface/aggregate
subinterface

VLAN interface

Some versions support

IfIndex Interface index. Index Unsigned integer.
interface name. For
relevant information, see
the XSD document of
your product. For
information about IfIndex,
see IfMgr in Ifmgr
NETCONF XML API
Configuration Reference.

Whether Boolean:
Enable authorized ARP is N/A • true N/A
enabled • false (default)

15
ARP/ArpDetection
This table contains configuration information about ARP attack detection.

XML structure
<ARP>
<ArpDetection>
<Detect>
<VLANID></VLANID>
<DetectionEnable></DetectionEnable>
<RestrictedForwardingEnable></RestrictedForwardingEnable>
</Detect>
</ArpDetection>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpDetection

Table type Multi-instance table

Row name Detect

Restrictions None

Support for row creation and deletion No

Columns

Column
Column description Column type Data type and restrictions
name
Unsigned integer.
VLANID VLAN ID Index
Value range: 1 to 4094

Boolean:
DetectionEn Whether ARP attack
N/A • true
able detection is enabled
• false (default)

RestrictedF
Whether ARP restricted N/A Boolean:
orwardingEn

16
 Column
Column description Column type Data type and restrictions
name
able forwarding is enabled • true
• false (default)

ARP/ArpDetectionTrust
This table contains information about ARP trusted interfaces.

XML structure
<ARP>
<ArpDetectionTrust>
<Interface>
<IfIndex></IfIndex>
<TrustEnable></TrustEnable>
</Interface>
</ArpDetectionTrust>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpDetectionTrust

Table type Multi-instance table

Row name Interface

This table supports interface types:

Restrictions Layer 2 Ethernet interface

Layer 2 aggregate interface

Support for row creation and deletion No

Columns

Column Column Column Data type and

Remarks
name description type restrictions
IfIndex Interface index Index Unsigned integer. Layer 2 Ethernet

17
 Column Column Column Data type and
Remarks
name description type restrictions
interface

Layer 2 aggregate
interface

Some versions support

interface name. For
relevant information, see
the XSD document of
your product. For
information about IfIndex,
see IfMgr in Ifmgr
NETCONF XML API
Configuration Reference.

Whether the
interface is Boolean:
TrustEnable configured as an N/A • true N/A
ARP trusted • false
interface

ARP/ArpFilterSource
This table contains information about ARP gateway protection and the protected gateway IP
address.

XML structure
<ARP>
<ArpFilterSource>
<FilterSource>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
</FilterSource>
</ArpFilterSource>
</ARP>

Table description

Item Description
Feature name ARP

18
 Item Description
Table name ArpFilterSource

Table type Multi-instance table

Row name FilterSource

This table supports interface types:

Restrictions Layer 2 Ethernet interface

Layer 2 aggregate interface

Support for row creation and deletion Yes

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Layer 2 Ethernet
interface

Layer 2 aggregate
interface

Some versions support

interface name. For
relevant information, see
IfIndex Interface index Index Unsigned integer.
the XSD

document of your
product. For information
about IfIndex, see IfMgr
in Ifmgr

NETCONF XML API

Configuration Reference.

The protected
String, dotted decimal
Ipv4Address gateway IP Index N/A
notation.
address

ARP/ArpFilterBinding
This table contains the information about restricting arp packet by source IP address and source
mac address.

19
XML structure
<ARP>
<ArpFilterBinding>
<FilterBinding>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
<MacAddress></MacAddress>
</FilterBinding>
</ArpFilterBinding>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpFilterBinding

Table type Multi-instance table

Row name FilterBinding

This table supports interface types:

Restrictions Layer 2 Ethernet interface

Layer 2 aggregate interface

Support for row creation and deletion Yes

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Layer 2 Ethernet
interface.

Layer 2 aggregate
interface.

IfIndex Interface index Index Unsigned integer. Some versions support

interface name. For
relevant information, see
the XSD document of
your product. For
information about IfIndex,

20
 Column Column Column Data type and
Remarks
name description type restrictions
see IfMgr in Ifmgr
NETCONF XML API
Configuration Reference.

The permitted IP String, dotted decimal

Ipv4Address Index N/A
address notation.

Six groups of two You cannot specify a

MacAddress MAC address N/A hexadecimal digits, MAC address when you
hyphen-separated. remove or delete a rule.

ARP/ArpSnooping
This table contains information about ARP snooping.

XML structure
<ARP>
<ArpSnooping>
<Snooping>
<VLANID></VLANID>
<SnoopingEnable></SnoopingEnable>
</Snooping>
</ArpSnooping>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpSnooping

Table type Multi-instance table

Row name Snooping

Restrictions None

Support for row creation and deletion No

21
Columns

Column name Column description Column type Data type and restrictions
Unsigned integer.
VLANID VLAN ID Index
Value range: 1 to 4094

Boolean:
Whether ARP snooping is
SnoopingEnable N/A • true
enabled
• false (default)

ARP/ArpInterface
This table contains ARP interface information.

XML structure
<ARP>
<ArpInterface>
<Interface>
<IfIndex></IfIndex>
<ModeUNI></ModeUNI>
</Interface>
</ArpInterface>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpInterface

Table type Multi-instance table

Row name Interface

Restrictions VLAN interfaces

Support for row creation and deletion No

22
Columns

Column Column Data type and

Column type Remarks
name description restrictions
Only VLAN interfaces
are supported.

Some versions support

interface name. For
relevant information,
see the XSD document
IfIndex Interface index Index Unsigned integer.
of your product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Boolean:

• true—Customer-
Configure a port as Whether the ModeUNI
side port.
ModeUNI a customer-side N/A is supported depends
• false—Network-
port on the device model.
side port
(default).

ARP/ArpVsiConfig
This table contains ARP VSI configuration information.

XML structure
<ARP>
<ArpVsiConfig>
<VsiConfig>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<MacAddress></MacAddress>
<VsiIfIndex></VsiIfIndex>
<PortIndex></PortIndex>
<SrvID></SrvID>
<VsiName></VsiName>
</VsiConfig>
</ArpVsiConfig>

23
 </ARP>

Table description

Item Description
Feature name ARP

Table name ArpVsiConfig

Table type Multi-instance table

Row name VsiConfig

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Some versions support
VRF name. For relevant
information, see the XSD
VrfIndex Index of the VRF Index Unsigned integer.
document of your
product.

0 means public network.

String, dotted decimal

Ipv4Address IPv4 address Index N/A
notation.

Six groups of two

MacAddress MAC address N/A hexadecimal digits, Required.
hyphen-separated.

VSI interface The VSI interface must

VsiIfIndex N/A Unsigned integer.
index be bound to the VSI.

The port can only be a

Layer 2 Ethernet
PortIndex Port index N/A Unsigned integer.
interface or a Tunnel
interface.

This field must be

Service instance Unsigned integer.
SrvID N/A configured when the port
ID Value range: 1 to 4096.
is a Layer 2 Ethernet

24
 Column Column Column Data type and
Remarks
name description type restrictions
interface. It must be
deleted when the port is
a Tunnel interface.

You must create a VSI

String,
VsiName VSI name N/A first before you merge,
Length: 1 to 31 characters.
replace or create ARPs.

ARP/ArpRouteAdvertise
This table contains the information about ARP direct route advertisement.

XML structure
<ARP>
<ArpRouteAdvertise>
<RouteAdvertise>
<IfIndex></IfIndex>
<Enable></Enable>
</RouteAdvertise>
</ArpRouteAdvertise>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpRouteAdvertise

Table type Multi-instance table

Row name RouteAdvertise

This table supports interface types:

Restrictions VE-L3VPN interface

VSI interface

Support for row creation and deletion No

25
Columns

Column Column Column Data type and

Remarks
name description type restrictions
VE-L3VPN interface

VSI interface

Some versions support

interface name. For
relevant information, see
IfIndex Interface index. Index Unsigned integer. the XSD document of
your product. For
information about IfIndex,
see Appendix in Ifmgr
NETCONF XML API
Configuration Reference.

Whether ARP
Boolean:
direct route
Enable N/A • true N/A
advertisement is
• false (default)
enabled

ARP/ArpVsiFeature
This table contains ARP configuration information for VSIs.

XML structure
<ARP>
<ArpVsiFeature>
<VsiFeature>
<VsiName></VsiName>
<SnoopingEnable></SnoopingEnable>
<DetectionEnable></DetectionEnable>
</VsiFeature>
</ArpVsiFeature>
</ARP>

Table description

Item Description
Feature name ARP

26
 Item Description
Table name ArpVsiFeature

Table type Multi-instance table

Row name VsiFeature

Restrictions None

Support for row creation and deletion No

Columns

Column Column Column Data type and

Remarks
name description type restrictions
String,
VsiName VSI name Index N/A
Length: 1 to 31 characters.

Whether ARP Boolean:

SnoopingEna
snooping is enabled N/A • true—Enabled. N/A
ble
for the VSI • false—Disabled.

Whether ARP Boolean:

DetectionEna
attack detection is N/A • true—Enabled. N/A
ble
enabled for the VSI • false—Disabled.

ARP/ArpVsiDetectionTrust
This table contains ARP trusted AC configuration information for Ethernet service instances.

XML structure
<ARP>
<ArpVsiDetectionTrust>
<SRV>
<IfIndex></IfIndex>
<SrvID></SrvID>
<TrustEnable></TrustEnable>
</SRV>
</ArpVsiDetectionTrust>
</ARP>

27
Table description

Item Description
Feature name ARP

Table name ArpVsiDetectionTrust

Table type Multi-instance table

Row name SRV

Restrictions None

Support for row creation and deletion No

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
IfIndex Interface index Index Unsigned integer.
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Ethernet service Unsigned integer.

SrvID Index N/A
instance ID Value range: 1 to 4096.

Whether the
Ethernet service Boolean:
TrustEnable instance is N/A • true—Yes. N/A
configured as an • false—No.
ARP trusted AC

28
Contents
ARP ······························································································1
ARP/ArpTable ····························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
ARP/ArpConfig ···························································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 3
ARP/ArpGratuitous ······················································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4
ARP/ArpLearnLimit······················································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 5
Columns ······························································································································ 5
ARP/ArpGratuitousInterval ············································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 6
ARP/ArpProxy ····························································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 8
ARP/ArpAttackProtect ··················································································································· 8
XML structure ······················································································································· 8
Table description ··················································································································· 9
Columns ······························································································································ 9
ARP/ArpRateLimit ······················································································································ 10
XML structure ····················································································································· 10
Table description ················································································································· 11
Columns ···························································································································· 11
ARP/ArpRateLimitLog ················································································································· 11
XML structure ····················································································································· 12
Table description ················································································································· 12
Columns ···························································································································· 12
ARP/ArpSourceMACExclude········································································································ 12
XML structure ····················································································································· 12
Table description ················································································································· 13
Columns ···························································································································· 13
ARP/ArpSourceMACAttackEntry ··································································································· 13
XML structure ····················································································································· 13
Table description ················································································································· 14
Columns ···························································································································· 14
ARP/ArpAuthorized ···················································································································· 15
XML structure ····················································································································· 15
Table description ················································································································· 15
Columns ···························································································································· 16
ARP/ArpDetection ······················································································································ 16
XML structure ····················································································································· 16
Table description ················································································································· 16
Columns ···························································································································· 17
ARP/ArpDetectionTrust ··············································································································· 17
XML structure ····················································································································· 17
Table description ················································································································· 17
Columns ···························································································································· 18

i
ARP/ArpFilterSource ·················································································································· 18
XML structure ····················································································································· 18
Table description ················································································································· 18
Columns ···························································································································· 19
ARP/ArpFilterBinding ·················································································································· 19
XML structure ····················································································································· 19
Table description ················································································································· 20
Columns ···························································································································· 20
ARP/ArpSpecification·················································································································· 20
XML structure ····················································································································· 20
Table description ················································································································· 21
Columns ···························································································································· 21
ARP/ ArpSnoopingEntry ·············································································································· 22
XML structure ····················································································································· 22
Table description ················································································································· 23
Columns ···························································································································· 23
ARP/ArpSnooping ······················································································································ 24
XML structure ····················································································································· 24
Table description ················································································································· 24
Columns ···························································································································· 25
ARP/ArpInterface ······················································································································· 25
XML structure ····················································································································· 25
Table description ················································································································· 25
Columns ···························································································································· 26
ARP/ArpVsiConfig ······················································································································ 26
XML structure ····················································································································· 26
Table description ················································································································· 27
Columns ···························································································································· 27
ARP/ArpRouteAdvertise ·············································································································· 28
XML structure ····················································································································· 28
Table description ················································································································· 28
Columns ···························································································································· 28
ARP/ArpVsiFeature ···················································································································· 29
XML structure ····················································································································· 29
Table description ················································································································· 29
Columns ···························································································································· 29
ARP/ArpVsiDetectionTrust ··········································································································· 30
XML structure ····················································································································· 30
Table description ················································································································· 30
Columns ···························································································································· 31

ii
ARP
ARP/ArpTable
This table contains ARP table information.

XML structure
<ARP>
<ArpTable>
<ArpEntry>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
<MacAddress></MacAddress>
<VLANID></VLANID>
<PortIndex></PortIndex>
<VrfIndex></VrfIndex>
<ArpType></ArpType>
</ArpEntry>
</ArpTable>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpTable

Table type Multi-instance table

Row name ArpEntry

Restrictions Only Layer 3 interface is supported.

Columns

Column Column
Column type Data type and restrictions
name description
IfIndex Interface Index Index Unsigned integer.

Ipv4Address IPv4 address Index String, dotted decimal notation.

1
 Column Column
Column type Data type and restrictions
name description
Six groups of two hexadecimal digits,
MacAddress MAC address N/A
hyphen-separated.

Unsigned integer.
VLANID VLAN ID N/A
Value range: 1 to 4094.

PortIndex Port index N/A Unsigned integer.

VrfIndex Index of the VRF N/A Unsigned integer.

Enumeration:

• 0—Dynamic.
• 1—Static.
ArpType ARP entry type N/A
• 2—Multiport.
• 3—Rule.
• 4—Openflow.

ARP/ArpConfig
This table contains ARP configuration information.

XML structure
<ARP>
<ArpConfig>
<Config>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<MacAddress></MacAddress>
<VLANID></VLANID>
<PortIndex></PortIndex>
<ArpType></ArpType>
</Config>
</ArpConfig>
</ARP>

Table description

Item Description
Feature name ARP

2
 Item Description
Table name ArpConfig

Table type Multi-instance table

Row name Config

Restrictions None

Columns

Column Column
Column type Data type and restrictions
name description
VrfIndex Index of the VRF Index Unsigned integer.

Ipv4Address IPv4 address Index String, dotted decimal notation.

Six groups of two hexadecimal digits,

MacAddress MAC address N/A
hyphen-separated.

Unsigned integer.
VLANID VLAN ID N/A
Value range: 1 to 4094.

PortIndex Port index N/A Unsigned integer.

Enumeration:
ArpType ARP entry type N/A • 1—Static.
• 2—Multiport.

ARP/ArpGratuitous
This table contains gratuitous ARP packets enable information.

XML structure
<ARP>
<ArpGratuitous>
<LearnEnable></LearnEnable>
<SendEnable></SendEnable>
</ArpGratuitous>
</ARP>

3
Table description

Item Description
Feature name ARP

Table name ArpGratuitous

Table type Single-instance table

Row name None

Restrictions None

Columns

Column Column
Column type Data type and restrictions
name description
Whether the
learning of Boolean:
LearnEnable gratuitous ARP N/A • true
packets function is • false
enable.

Whether the
function of sending
gratuitous ARP
packets upon Boolean:
SendEnable receiving ARP N/A • true
requests whose • false
target IP address
is on a different
subnet is enable.

ARP/ArpLearnLimit
This table contains the information of maximum number of dynamic ARP entries that an interface
can learn.

XML structure
<ARP>
<ArpLearnLimit>

4
 <LearnLimit>
<IfIndex></IfIndex>
<LearnMaxNum></LearnMaxNum>
<LearnAlarmThreshold></LearnAlarmThreshold>
</LearnLimit>
</ArpLearnLimit>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpLearnLimit

Table type Multi-instance table

Row name LearnLimit

This table supports interface types:

Layer 2 Ethernet interface/Layer 2 aggregate interface

Layer 3 Ethernet interface/subinterface

Restrictions
Layer 3 aggregate interface/aggregate subinterface

S-channel interface/S-channel aggregate interface

VLAN interface

Columns

Column Column Column Data type and

Remarks
name description type restrictions
IfIndex Interface Index Index Unsigned integer. N/A

0 means the inte

The maximum disabled from le
number of Unsigned integer. dynamic ARP en
LearnMaxN
dynamic ARP N/A Value range: 0 to The value of
um
entries that an LearnMaxNumLimit. LearnMaxNumL
interface can learn depends on the
model.

LearnAlarm Alarm threshold in Unsigned integer. To disable the th

N/A
Threshold percentage Value range: 0 to 100. alarming, set the

5
 0.

ARP/ArpGratuitousInterval
This table contains the information of periodic sending of gratuitous ARP packets and set the
sending interval on an interface.

XML structure
<ARP>
<ArpGratuitousInterval>
<GratuitousInterval>
<IfIndex></IfIndex>
<Interval></Interval>
</GratuitousInterval>
</ArpGratuitousInterval>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpGratuitousInterval

Table type Multi-instance table

Row name GratuitousInterval

This table supports interface types:

Layer 3 Ethernet interface/subinterface

Restrictions
Layer 3 aggregate interface/subinterface

VLAN interface

Columns

Column Column Column Data type and

Remarks
name description type restrictions
IfIndex Interface Index Index Unsigned integer. N/A

The interval at 0 means disable the

Interval N/A Unsigned integer.
which gratuitous interface from

6
 Column Column Column Data type and
Remarks
name description type restrictions
ARP packets are Value range: 0, 200 to periodically sending
sent 200000ms. gratuitous ARP packets.

ARP/ArpProxy
This table contains ARP proxy enable and local ARP proxy enable information.

XML structure
<ARP>
<ArpProxy>
<Proxy>
<IfIndex></IfIndex>
<ProxyEnable></ProxyEnable>
<LocalProxyEnable></LocalProxyEnable>
<LocalStartIpv4Address></LocalStartIpv4Address>
<LocalEndIpv4Address></LocalEndIpv4Address>
</Proxy>
</ArpProxy>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpProxy

Table type Single-instance table

Row name Proxy

This table supports interface types:

Layer 3 Ethernet interface/subinterface

Restrictions
Layer 3 aggregate interface/aggregate subinterface

VLAN interface

7
Columns

Column Column Column Data type and

Remarks
name description type restrictions
IfIndex Interface Index Index Unsigned integer. N/A

Whether proxy Boolean:

ProxyEnable ARP is enabled on N/A • true N/A
the interface • false

Whether local
Boolean:
LocalProxyE proxy ARP is N/A
N/A • true
nable enabled on the
• false
interface

Start IPv4 address

of the
LocalStartIp String, dotted decimal
specified address N/A N/A
v4Address notation.
range for local
proxy ARP

End IPv4 address

LocalEndIpv of the specified String, dotted decimal
N/A N/A
4Address address range for notation.
local proxy ARP

ARP/ArpAttackProtect
This table contains ARP attack protect information.

XML structure
<ARP>
<ArpAttackProtect>
<ResolvingRouteEnable></ResolvingRouteEnable>
<SourceSuppressionEnable></SourceSuppressionEnable>
<SourceSuppressionLimitNum></SourceSuppressionLimitNum>
<SourceMACDetectType></SourceMACDetectType>
<SourceMACAgeTime></SourceMACAgeTime>
<SourceMACThresholdValue></SourceMACThresholdValue>
<ValidCheckEnable></ValidCheckEnable>
<ActiveACKType></ActiveACKType>
<DetectionValidateSrcMAC></DetectionValidateSrcMAC>
<DetectionValidateDstMAC></DetectionValidateDstMAC>

8
 <DetectionValidateIP></DetectionValidateIP>
</ArpAttackProtect>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpAttackProtect

Table type Single-instance table

Row name None

Restrictions None

Columns

Column Column Column Data type and

Remarks
name description type restrictions

Whether the Boolean:

ResolvingRo
resolving route N/A • true N/A
uteEnable
function is enabled • false

Whether the ARP

SourceSupp Boolean:
suppression
ressionEnab N/A • true N/A
original address
le • false
function is enabled

SourceSupp Set the source

Unsigned integer.
ressionLimit suppression limit N/A N/A
Value range: 2 to 1024.
Num number

Set the attack

Unsigned integer.
detection function
SourceMAC • 0—Disabled.
of fixed source N/A N/A
DetectType • 1—Filter.
mac address and
select the mode • 2—Monitor.

Set the fixed

source mac
SourceMAC Unsigned integer.
address aging N/A N/A
AgeTime Value range: 60 to 6000.
time of ARP attack
detection entries

9
 Column Column Column Data type and
Remarks
name description type restrictions
Set the fixed
source mac
SourceMAC
address
ThresholdVa N/A Unsigned integer. N/A
threshold of ARP
lue
attack detection
entries

Whether the
source mac Boolean:
ValidCheck
address N/A • true N/A
Enable
consistency check • false
function is enabled

Unsigned integer.

ActiveACKT Enable ARP active • 0—Disabled.

N/A N/A
ype acknowledgement • 1—Loose.
• 2—Strict.

Whether the
DetectionVal effective checks Boolean:
idateSrcMA on the source mac N/A • true N/A
C address function is • false
enabled

Whether the
DetectionVal effective checks Boolean:
idateDstMA on the destination N/A • true N/A
C mac address • false
function is enabled

Whether the
Boolean:
DetectionVal effective checks
N/A • true N/A
idateIP on the IP address
• false
function is enabled

ARP/ArpRateLimit
This table contains ARP rate limit information.

XML structure
<ARP>

10
 <ArpRateLimit>
<RateLimit>
<IfIndex></IfIndex>
<RateLimitEnable></RateLimitEnable>
<RateLimitNum></RateLimitNum>
</RateLimit>
</ArpRateLimit>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpRateLimit

Table type Single-instance table

Row name RateLimit

This table supports interface types:

Restrictions
Layer 2 Ethernet interface/Layer 2 aggregate interface

Columns

Column Column Column Data type and

Remarks
name description type restrictions
IfIndex Interface index. Index Unsigned integer. N/A

Whether the rate Boolean:

RateLimitEn
limit function is N/A • true N/A
able
enabled • false

The value of
Unsigned integer. uiRateLimitLowerLimit
RateLimitNu Set the rate limit Value range: and
N/A
m number uiRateLimitLowerLimit to uiRateLimitUpperLimit
uiRateLimitUpperLimit. depend on the device
model.

ARP/ArpRateLimitLog
This table contains ARP rate limit log information.

11
XML structure
<ARP>
<ArpRateLimitLog>
<LogEnable></LogEnable>
<LogInterval></LogInterval>
</ArpRateLimitLog>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpRateLimitLog

Table type Single-instance table

Row name None

Restrictions None

Columns

Column Column Column Data type and

Remarks
name description type restrictions

Whether the rate Boolean:

LogEnable limit log function is N/A • true N/A
enabled • false

Set the interval of

Unsigned integer.
LogInterval sending report or N/A N/A
Value range: 1 to 86400.
log

ARP/ArpSourceMACExclude
This table contains protective source mac address information.

XML structure
<ARP>
<ArpSourceMACExclude>

12
 <SourceMACExclude>
<MacAddress></MacAddress>
</SourceMACExclude>
</ArpSourceMACExclude>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpSourceMACExclude

Table type Multi-instance table

Row name SourceMACExclude

Restrictions None

Columns

Column Column Column Data type and

Remarks
name description type restrictions
The MAX number of
protective source mac
Six groups of two
address that can be
MacAddress MAC address Index hexadecimal digits,
configured depends on
hyphen-separated.
the device model.

ARP/ArpSourceMACAttackEntry
This table contains the information about the ARP attack detection entries of fixed source MAC
address.

XML structure
<ARP>
<ArpSourceMACAttackEntry>
<Entry>
<DeviceNode>
<Chassis></Chassis>
<Slot></Slot>

13
 <CPUID></CPUID>
</DeviceNode>
<VLANID></VLANID>
<MacAddress></MacAddress>
<IfIndex></IfIndex>
<AgeTime></AgeTime>
</Entry>
</ArpSourceMACAttackEntry>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpSourceMACAttackEntry

Table type Multi-instance table

Row name Entry

Restrictions None

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Members include:

The information of Data • Chassis

DeviceNode N/A
Device Node structure • Slot
• CPUID

Unsigned integer.
Chassis Chassis number Index N/A
Value range: 0 to 65535.

Unsigned integer.
Slot Slot number Index N/A
Value range: 0 to 65535.

Unsigned integer.
CPUID CPU ID Index N/A
Value range: 0 to 7.

Unsigned integer. 65535 means the

VLANID VLAN ID Index Value range: 1 to interface is layer 3
4094,65535. Ethernet interface

14
 Column Column Column Data type and
Remarks
name description type restrictions
Six groups of two
MacAddress MAC address Index hexadecimal digits, N/A
hyphen-separated.

IfIndex Interface index. N/A Unsigned integer. N/A

The remaining
aging time of ARP
AgeTime N/A AgeTime N/A
attack defense
policy entry

ARP/ArpAuthorized
This table contains the authorized ARP information.

XML structure
<ARP>
<ArpAuthorized>
<Authorized>
<IfIndex></IfIndex>
<Enable></Enable>
</Authorized>
</ArpAuthorized>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpAuthorized

Table type Single-instance table

Row name Authorized

This table supports interface types:

Layer 3 Ethernet interface/subinterface

Restrictions
Layer 3 aggregate interface/aggregate subinterface

VLAN interface

15
Columns

Column Column Column Data type and

Remarks
name description type restrictions
Layer 3 Ethernet
interface/subinterface

Layer 3 aggregate
IfIndex Interface index. Index Unsigned integer.
interface/aggregate
subinterface

VLAN interface

Whether Boolean:
Enable authorized ARP is N/A • true N/A
enabled • false

ARP/ArpDetection
This table contains information about ARP attack detection.

XML structure
<ARP>
<ArpDetection>
<Detect>
<VLANID></VLANID>
<DetectionEnable></DetectionEnable>
<RestrictedForwardingEnable></RestrictedForwardingEnable>
</Detect>
</ArpDetection>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpDetection

Table type Multi-instance table

Row name Detect

Restrictions None

16
Columns

Column
Column description Column type Data type and restrictions
name
Unsigned integer.
VLANID VLAN ID Index
Value range: 1 to 4094

Boolean:
DetectionEn Whether ARP attack detection is
N/A • true
able enabled
• false

RestrictedF Boolean:
Whether ARP restricted forwarding
orwardingEn N/A • true
is enabled
able • false

ARP/ArpDetectionTrust
This table contains information about ARP trusted interfaces.

XML structure
<ARP>
<ArpDetectionTrust>
<Interface>
<IfIndex></IfIndex>
<TrustEnable></TrustEnable>
</Interface>
</ArpDetectionTrust>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpDetectionTrust

Table type Multi-instance table

Row name Interface

Restrictions This table supports interface types:

17
 Item Description
Layer 2 Ethernet interface

Layer 2 aggregate interface

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Layer 2 Ethernet
interface
IfIndex Interface index. Index Unsigned integer.
Layer 2 aggregate
interface

Whether the
interface is Boolean:
TrustEnable configured as an N/A • true N/A
ARP trusted • false
interface

ARP/ArpFilterSource
This table contains information about ARP gateway protection and the protected gateway IP
address.

XML structure
<ARP>
<ArpFilterSource>
<FilterSource>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
</FilterSource>
</ArpFilterSource>
</ARP>

Table description

Item Description
Feature name ARP

18
 Item Description
Table name ArpFilterSource

Table type Multi-instance table

Row name FilterSource

This table supports interface types:

Restrictions Layer 2 Ethernet interface

Layer 2 aggregate interface

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Layer 2 Ethernet
interface.
IfIndex Interface index Index Unsigned integer.
Layer 2 aggregate
interface.

The protected
String, dotted decimal
Ipv4Address gateway IP Index N/A
notation.
address

ARP/ArpFilterBinding
This table contains the information about restricting ARP packet by source IP address and source
MAC address.

XML structure
<ARP>
<ArpFilterBinding>
<FilterBinding>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
<MacAddress></MacAddress>
</FilterBinding>
</ArpFilterBinding>
</ARP>

19
Table description

Item Description
Feature name ARP

Table name ArpFilterBinding

Table type Multi-instance table

Row name FilterBinding

This table supports interface types:

Restrictions Layer 2 Ethernet interface

Layer 2 aggregate interface

Columns

Column Column Column

Data type and restrictions
name description type
IfIndex Interface index. Index Unsigned integer.

The permitted IP
Ipv4Address Index String, dotted decimal notation.
address

Six groups of two hexadecimal digits,

MacAddress MAC address N/A
hyphen-separated.

ARP/ArpSpecification
This table contains ARP specification information.

XML structure
<ARP>
<ArpSpecification>
<SupportMultiport></SupportMultiport>
<RateLimitDefault></RateLimitDefault>
<RateLimitLowerLimit></RateLimitLowerLimit>
<RateLimitUpperLimit></RateLimitUpperLimit>
<SMACDefaultThreshold></SMACDefaultThreshold>
<SMACMinThreshold></SMACMinThreshold>
<SMACMaxThreshold></SMACMaxThreshold>
<SupportDetection></SupportDetection>

20
 <SupportFilter></SupportFilter>
<SupportSnooping></SupportSnooping>
<IntervalDefault></IntervalDefault>
<LearnMaxNumLimit></LearnMaxNumLimit>
<LearnMaxNumDefault></LearnMaxNumDefault>
<SupportModeUNI></SupportModeUNI>
</ArpSpecification>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpSpecification

Table type Single-instance table

Row name N/A

Restrictions None

Columns

Column Column Column Data type and

Remarks
name description type restrictions

Whether the Boolean:

SupportMulti
multiport ARP N/A • true N/A
port
entry is supported • false

RateLimitDe The default limit of

N/A Unsigned integer. N/A
fault rate

RateLimitLo The lower limit of 0 means that ARP rate

N/A Unsigned integer.
werLimit rate limit isn't supported.

RateLimitUp The upper limit of 0 means that ARP rate

N/A Unsigned integer.
perLimit rate limit isn't supported.

SMACDefau The default of

N/A Unsigned integer. N/A
ltThreshold threshold

SMACMinTh The minimum of

N/A Unsigned integer. N/A
reshold threshold.

SMACMaxT The maximum of N/A Unsigned integer. N/A

21
 Column Column Column Data type and
Remarks
name description type restrictions
hreshold threshold

Whether ARP Boolean:

SupportDete
detection is N/A • true N/A
ction
supported • false

Boolean:
SupportFilte Whether ARP filter
N/A • true N/A
r is supported
• false

Whether ARP Boolean:

SupportSno
snooping is N/A • true N/A
oping
supported • false

IntervalDefa The default of Unsigned integer.

N/A N/A
ult interval Value range: 0 to 200000.

LearnMaxN The limit of max

N/A Unsigned integer. N/A
umLimit learn number

LearnMaxN The default of max

N/A Unsigned integer. N/A
umDefault learn number

Whether the ARP

Boolean:
SupportMod customer-side port
N/A • true N/A
eUNI feature is
• false
supported

ARP/ ArpSnoopingEntry
This table contains information about ARP snooping entries.

XML structure
<ARP>
<ArpSnoopingEntry>
<SnoopingEntry>
<DeviceNode>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</DeviceNode>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>

22
 <VLANID></VLANID>
<MacAddress></MacAddress>
<Status></Status>
<AgeTime></AgeTime>
</SnoopingEntry>
</ArpSnoopingEntry>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpSnoopingEntry

Table type Multi-instance table

Row name SnoopingEntry

Restrictions None

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Members include:

The information of Data • Chassis

DeviceNode N/A
Device Node structure • Slot
• CPUID

Unsigned integer.
Chassis Chassis number Index N/A
Value range: 0 to 65535.

Unsigned integer.
Slot Slot number Index N/A
Value range: 0 to 65535.

Unsigned integer.
CPUID CPU ID Index N/A
Value range: 0 to 7.

Layer 2 Ethernet
interface
IfIndex Interface index Index Unsigned integer.
Layer 2 aggregate
interface

Ipv4Address IPv4 address Index String, dotted decimal N/A

23
 Column Column Column Data type and
Remarks
name description type restrictions
notation.

Unsigned integer.
VLANID VLAN ID N/A N/A
Value range: 1 to 4094.

Six groups of two

MacAddress MAC address N/A hexadecimal digits, N/A
hyphen-separated.

Enumeration:

• 1—Valid.
Status State of an entry N/A N/A
• 2—Invalid.
• 3—Collision.

The remaining
aging time of ARP
AgeTime N/A AgeTime N/A
attack defense
policy entry

ARP/ArpSnooping
This table contains information about ARP snooping.

XML structure
<ARP>
<ArpSnooping>
<Snooping>
<VLANID></VLANID>
<SnoopingEnable></SnoopingEnable>
</Snooping>
</ArpSnooping>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpSnooping

Table type Multi-instance table

24
 Item Description
Row name Snooping

Restrictions None

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Unsigned integer.
VLANID VLAN ID Index N/A
Value range: 1 to 4094

Whether ARP Boolean:

SnoopingEn
snooping is N/A • true N/A
able
enabled • false

ARP/ArpInterface
This table contains ARP interface information.

XML structure
<ARP>
<ArpInterface>
<Interface>
<IfIndex></IfIndex>
<ModeUNI></ModeUNI>
</Interface>
</ArpInterface>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpInterface

Table type Multi-instance table

Row name Interface

25
 Item Description
Restrictions VLAN interfaces

Columns

Column Data type and

Column name Column description Remarks
type restrictions
Only VLAN
IfIndex Interface index Index Unsigned integer. interfaces are
supported.

Boolean:

• true—Customer-si
Configure a port as a
ModeUNI N/A de port. N/A
customer-side port
• false—Network-si
de port.

ARP/ArpVsiConfig
This table contains ARP VSI configuration information.

XML structure
<ARP>
<ArpVsiConfig>
<VsiConfig>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<MacAddress></MacAddress>
<VsiIfIndex></VsiIfIndex>
<PortIndex></PortIndex>
<SrvID></SrvID>
<VsiName></VsiName>
</VsiConfig>
</ArpVsiConfig>
</ARP>

26
Table description

Item Description
Feature name ARP

Table name ArpVsiConfig

Table type Multi-instance table

Row name VsiConfig

Restrictions None

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Some versions support
VRF name. For relevant
information, see the XSD
VrfIndex Index of the VRF Index Unsigned integer. document of your
product.
0 means public network.

String, dotted decimal

Ipv4Address IPv4 address Index N/A
notation.

Six groups of two

MacAddress MAC address N/A hexadecimal digits, N/A
hyphen-separated.

VSI interface
VsiIfIndex N/A Unsigned integer. N/A
index

The port can only be a

Layer 2 Ethernet
PortIndex Port index N/A Unsigned integer.
interface or a Tunnel
interface.

This field cannot be

displayed when the port
Service instance Unsigned integer. is a Tunnel interface. It is
SrvID N/A
ID Value range: 1 to 4096. displayed when the port
is a Layer 2 Ethernet
interface.

VsiName VSI name N/A String, N/A

27
 Column Column Column Data type and
Remarks
name description type restrictions
Length: 1 to 31 characters.

ARP/ArpRouteAdvertise
This table contains the information about ARP direct route advertisement.

XML structure
<ARP>
<ArpRouteAdvertise>
<RouteAdvertise>
<IfIndex></IfIndex>
<Enable></Enable>
</RouteAdvertise>
</ArpRouteAdvertise>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpRouteAdvertise

Table type Multi-instance table

Row name RouteAdvertise

This table supports interface types:

Restrictions VE-L3VPN interface

VSI interface

Columns

Column Column Column Data type and

Remarks
name description type restrictions
VE-L3VPN interface
IfIndex Interface index. Index Unsigned integer.
VSI interface

Enable Whether ARP N/A Boolean: N/A

28
 Column Column Column Data type and
Remarks
name description type restrictions
direct route • true
advertisement is • false
enabled

ARP/ArpVsiFeature
This table contains ARP configuration information for VSIs.

XML structure
<ARP>
<ArpVsiFeature>
<VsiFeature>
<VsiName></VsiName>
<SnoopingEnable></SnoopingEnable>
<DetectionEnable></DetectionEnable>
</VsiFeature>
</ArpVsiFeature>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpVsiFeature

Table type Multi-instance table

Row name VsiFeature

Restrictions None

Columns

Column Column Column Data type and

Remarks
name description type restrictions
String,
VsiName VSI name Index N/A
Length: 1 to 31 characters.

SnoopingEn Whether ARP N/A Boolean: N/A

29
 Column Column Column Data type and
Remarks
name description type restrictions
able snooping is enabled • true—Enabled.
for the VSI • false—Disabled
(default).

Boolean:
Whether ARP attack
DetectionEn • true—Enabled.
detection is enabled N/A N/A
able • false—Disabled
for the VSI
(default).

ARP/ArpVsiDetectionTrust
This table contains ARP trusted AC configuration information for Ethernet service instances.

XML structure
<ARP>
<ArpVsiDetectionTrust>
<SRV>
<IfIndex></IfIndex>
<SrvID></SrvID>
<TrustEnable></TrustEnable>
</SRV>
</ArpVsiDetectionTrust>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpVsiDetectionTrust

Table type Multi-instance table

Row name SRV

Restrictions None

30
Columns

Column Column Column Data type and

Remarks
name description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
IfIndex Interface index Index Unsigned integer. your product. For
information about IfIndex,
see IfMgr in Ifmgr
NETCONF XML API
Configuration Reference.

Ethernet service Unsigned integer.

SrvID Index N/A
instance ID Value range: 1 to 4096.

Whether the
Ethernet service Boolean:
TrustEnable instance is N/A • true—Yes. N/A
configured as an • false—No (Default).
ARP trusted AC

31
Contents
ARP ······························································································1
ARP/ArpTable ··························································································································· 1
ARP/ArpConfig ·························································································································· 1
ARP/ArpLearnLimit····················································································································· 2
ARP/ArpGratuitousInterval ··········································································································· 2
ARP/ArpProxy ··························································································································· 3
ARP/ArpAttackProtect ················································································································· 3
ARP/ArpRateLimit ······················································································································ 3
ARP/ArpSourceMACExclude ········································································································ 4
ARP/ArpDetection ······················································································································ 4
ARP/ArpFilterSource ·················································································································· 4
ARP/ArpFilterBinding ·················································································································· 4
ARP/ArpSnooping ······················································································································ 5
ARP/ArpVsiConfig ······················································································································ 5
ARP/ArpScan ···························································································································· 6
ARP/ArpFixup ··························································································································· 6
ARP/ArpClearTable ···················································································································· 7

i
ARP
ARP/ArpTable
Message Explanation
Invalid IP address. Invalid IP address configuration
非法的IP地址。 无效的 IP 地址配置

ARP/ArpConfig
Message Explanation
The VPN-Instance does not exist when set the
VPN-Instance does not exist.
configuration.
该VPN不存在。
配置时对应 VPN 不存在

Invalid MAC address. Invalid MAC address configuration.

非法的MAC地址。 非法的 MAC 地址配置。

The VLAN doesn't exist. The VLAN does not exist when set the configuration.
该VLAN不存在。 配置时 VLAN 不存在

The VLAN interface does not exist when set the

Please create the VLAN interface first.
configuration.
请先创建相应的VLAN接口。
配置时 VLAN 接口不存在

Invalid IP address. Invalid IP address configuration

非法的IP地址。 无效的 IP 地址配置

Can't set S-channel subinterface as the Do not support set S-channel subinterface as the output
output interface. interface.
不支持S通道子接口。 不支持 S 通道子接口。

The port doesn't belong to the VLAN, or the The port doesn't belong to the VLAN, or the VLAN is not
VLAN is not permitted on the port. permitted on the port.
端口不属于指定VLAN或Trunk类型的端口不允 端口不属于指定 VLAN 或 Trunk 类型的端口不允许指定
许指定VLAN内的报文通过。 VLAN 内的报文通过。

The VPN instance of the configured entry is The VPN instance of the configured entry is different from
different from that of the interface. that of the interface.
配置表项的VRF与接口的VRF不相同。 配置表项的 VRF 与接口的 VRF 不相同。

1
The multiport ARP entry contains invalid The ARP entry does not have vlans or have port
parameters. interfaces.
多端口参数非法。 没有配置 VLAN 或者接口

Configuration items don't meet the Invalid configuration, please modify configuration under
requirements. guidance.
不符合配置要求。 无效配置，请按照配置说明修改

Maximum number of ARP entries already Maximum number of ARP entries already reached,p
reached. Please check configuration or specifications
已到达ARP表项的上限。 已到达 ARP 表项的上限,请检查配置或者设备规格

The Ethernet service instance doesn't exist,when set the

The Ethernet service instance doesn't exist.
configuration.
以太网服务实例不存在。
以太网服务实例不存在。

The Ethernet interface and Ethernet service The Ethernet interface and Ethernet service instance are
instance are not mapped to the VSI. not mapped to the VSI,please check configuration.

以太接口和以太网服务实例与VSI未关联。 以太接口和以太网服务实例与VSI未关联,请检查配置

Failed to configure the static ARP entry

Failed to configure the static ARP entry because it has the
because it has the same IP address and
same IP address and output interface as an existing
output interface as an existing remote static
remote static ARP entry.
ARP entry.
不能配置该静态ARP，因为它与远端已存在的静态ARP表项
不能配置该静态ARP，因为它与远端已存在的
有相同IP地址和出接口。
静态ARP表项有相同IP地址和出接口。

ARP/ArpLearnLimit
Message Explanation
Configuration items don't meet the Invalid configuration, please modify configuration under
requirements. guidance.
不符合配置要求。 无效配置，请按照配置说明修改

ARP/ArpGratuitousInterval
Message Explanation
Maximum number of interfaces enabled with the feature
Maximum number of interfaces enabled with
already reached, please modify configuration under
the feature already reached.
guidance.
可用接口个数超过上限。
可用接口个数超过上限,请按照配置说明修改

2
ARP/ArpProxy
Message Explanation
Configuration items don't meet the Invalid configuration, please modify configuration under
requirements. guidance.
不符合配置要求。 无效配置，请按照配置说明修改

Invalid start IPv4 address. Invalid start IPv4 address.

非法的IPv4开始地址。 非法的IPv4开始地址。

Invalid end IPv4 address. Invalid end IPv4 address.

非法的IPv4结束地址。 非法的IPv4结束地址。

Start IPv4 address must be lower than or Start IPv4 address must be lower than or equal to end
equal to end IPv4 address. IPv4 address, please modify configuration under guidance.
IPv4开始地址必须低于或者等于IPv4结束地 IPv4开始地址必须低于或者等于IPv4结束地址。，请按照配
址。 置说明修改

ARP/ArpAttackProtect
Message Explanation
Configuration items don't meet the Invalid configuration, please modify configuration under
requirements. guidance.
不符合配置要求。 无效配置，请按照配置说明修改

ARP/ArpRateLimit
Message Explanation
Failed to set the maximum number of The device returned failed when set the maximun number
dynamic ARP entries. of dynamic ARP entries.
指定ARP最大动态表项数失败。 指定 ARP 最大动态表项数失败。

Configuration items don't meet the Invalid configuration, please modify configuration under
requirements. guidance.
不符合配置要求。 无效配置，请按照配置说明修改

The value is out of range. Invalid configuration, please modify configuration under
参数值超出范围。 guidance.

3
 无效配置，请按照配置说明修改

ARP/ArpSourceMACExclude
Message Explanation
Maximum number of protected MAC Maximum number of protected MAC addresses already
addresses already reached. reached,please check configuration or specifications
受保护的MAC的个数达到上限。 受保护的MAC的个数达到上限,请检查配置或者设备规格

ARP/ArpDetection
Message Explanation
The VLAN doesn't exist. The VLAN does not exist when set the configuration.
该VLAN不存在。 配置时 VLAN 不存在

ARP/ArpFilterSource
Message Explanation
Maximum number of protected gateway IP addresses
Maximum number of protected gateway IP already reached, Please check configuration or
addresses already reached. specifications
可配置的被保护网关IP地址超过上限。 可配置的被保护网关IP地址超过上限,请检查配置或者设备
规格

Configuration failed. Please disable ARP

filtering first. Please disable ARP filtering first.

配置ARP网关保护功能失败。需要先关闭ARP 配置ARP网关保护功能需要先关闭ARP过滤保护功能。
过滤保护功能。

ARP/ArpFilterBinding
Message Explanation
Configuration items don't meet the Invalid configuration, please modify configuration under
requirements. guidance.
不符合配置要求。 无效配置，请按照配置说明修改

Maximum number of permitted IP-to-MAC bindings

Maximum number of permitted IP-to-MAC
already reached, please modify configuration under

4
bindings already reached. guidance.
可配置的IP地址和MAC地址超过上限。 可配置的IP地址和MAC地址超过上限,请按照配置说明修改

Configuration failed. Please disable ARP Please disable ARP gateway protection first, please
gateway protection first. modify configuration under guidance.
配置ARP过滤保护功能失败。需要先关闭ARP 配置ARP过滤保护需要先关闭ARP网关保护功能,请按照配
网关保护功能。 置说明修改

ARP/ArpSnooping
Message Explanation
The VLAN doesn't exist. The VLAN does not exist when set the configuration.
该VLAN不存在。 配置时 VLAN 不存在

ARP/ArpVsiConfig
Message Explanation
The VPN-Instance does not exist when set the
VPN-Instance does not exist.
configuration.
该VRF不存在。
配置时对应 VPN 不存在

Invalid MAC address. Invalid MAC address configuration.

非法的MAC地址。 非法的 MAC 地址配置。

Invalid IP address. Invalid IP address configuration

非法的IP地址。 无效的 IP 地址配置

The VPN instance of the configured entry is different from

The VPN instance of the configured entry is
that of the interface., please modify configuration under
different from that of the interface.
guidance.
配置表项的VRF与接口的VRF不相同。
配置表项的VRF与接口的VRF不相同。请按照配置说明修改

Configuration items don't meet the Invalid configuration, please modify configuration under
requirements. guidance.
不符合配置要求。 无效配置，请按照配置说明修改

Maximum number of ARP entries already Maximum number of ARP entries already reached,please
reached. check configuration or specifications.
已到达ARP表项的上限。 已到达 ARP 表项的上限,请检查配置或者设备规格

The VSI doesn't exist. The VSI does not exist when set the configuration.

指定的VSI不存在。 配置时VSI不存在

5
The VSI interface is not associated with the The VSI interface is not associated with the VSI, please
VSI. check configuration .
指定的VSI虚接口与VSI未绑定。 指定的VSI虚接口与VSI未绑定。请检查配置。

The Ethernet service instance doesn't exist, please check

The Ethernet service instance doesn't exist.
configuration.
以太网服务实例不存在。
以太网服务实例不存在,请检查配置

The Ethernet interface and Ethernet service The Ethernet interface and Ethernet service instance are
instance are not mapped to the VSI. not mapped to the VSI, please check configuration.
以太接口和以太网服务实例与VSI未关联。 以太接口和以太网服务实例与VSI未关联，请检查配置

ARP/ArpScan
Message Explanation
Invalid IP address. Invalid IP address configuration.
非法的IP地址。 非法的 IP 地址配置。

Start IP address must be lower than or equal to end IP

Start IP address must be lower than or equal
address, please modify configuration under guidance.
to end IP address.
起始IP地址必须低于或者等于终止IP地址,请按照配置说明
起始IP地址必须低于或者等于终止IP地址。
修改

The interface is down or has no IP address configured,

The interface is down or has no IP address
please modify configuration under guidance.
configured.
扫描接口处于关闭状态或者未配置 IP 地址，请按照配置说
扫描接口处于关闭状态或者未配置IP地址。
明修改

The start and end IP addresses must be on the same

The start and end IP addresses must be on
subnet as the interface IP address, please modify
the same subnet as the interface IP address.
configuration under guidance.
起始IP地址和终止IP地址必须与扫描接口IP地
起始 IP 地址和终止 IP 地址必须与扫描接口 IP 地址在相同的
址在相同的网段。
网段,请按照配置说明修改

ARP scanning is interrupted. ARP scanning is interrupted,please try again.

扫描表项过程中断。 扫描表项过程中断,请再试一次

ARP/ArpFixup
Message Explanation
Maximum number of ARP entries already Maximum number of ARP entries already reached，
reached. please modify configuration under guidance.

6
已到达ARP表项的上限。 已到达 ARP 表项的上限，请检查配置或者设备规格

ARP/ArpClearTable
Message Explanation
Invalid IP address. Invalid IP address configuration
非法的IP地址。 无效的 IP 地址配置

7
Contents
ARPSYNC ······················································································1
ARPSYNC/ARPTable ················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
ARPSYNC
ARPSYNC/ARPTable
This table is used to clear all ARP table synchronization informations.

XML structure
<ARPSYNC>
<ClearARPTable>
<Clear></Clear>
</ClearARPTable>
</ARPSYNC>

Table description
Item Description
Feature name ARPSYNC
Table name ClearARPTable
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Clears all ARP
table This column must be
Clear N/A N/A
synchronizatio empty.
n informations

1
Contents
ARPSYNC ······················································································1
ARPSYNC/ARPConfig ················································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ARPSYNC/ServerList ················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3

i
ARPSYNC
ARPSYNC/ARPConfig
This table contains ARP table synchronization information.

XML structure
<ARPSYNC>
<ARPConfig>
<ARPEnable>
<Enable></Enable>
<Interval></Interval>
<Timeout></Timeout>
</ARPEnable>
</ARPConfig>
</ARPSYNC>

Table description
Item Description
Feature name ARPSYNC
Table name ARPConfig
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ARP table Members include:
synchronizati Data • Enable
ARPEnable N/A
on structure • Interval
information.
• Timeout

Whether to Boolean:
Enable enable the N/A • true—Enable. N/A
rule. • false—Disable.
ARP table
synchronizati Unassigned integer.
Interval N/A N/A.
on request Value range: 5 to 30 seconds.
interval.

1
 Column Column Column
Data type and restrictions Remarks
name description type
Request Unassigned integer.
Timeout N/A N/A.
timeout. Value range: 1 to 5 seconds.

ARPSYNC/ServerList
This table contains SNMP server information.

XML structure
<ARPSYNC>
<ServerList>
<ServerConfigInfo>
<Index></Index>
<SNMPVersion></SNMPVersion>
<IPAddress></IPAddress>
<CommunityName></CommunityName>
<UserName></UserName>
<SecurityParam>
<AuthProtocol></AuthProtocol>
<AuthKey></AuthKey>
<PrivProtocol></PrivProtocol>
<PrivKey></PrivKey>
</SecurityParam>
</ServerConfigInfo>
</ServerList>
</ARPSYNC>

Table description
Item Description
Feature name ARPSYNC
Table name ServerList
Table type Multi-instance table
Row name ServerConfigInfo
Restrictions None
Support for row creation and deletion Yes

2
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unassigned integer. To create an SNMP
Index Index number Index server, set this column
Value range: 0 to 64. to 64.
Enumeration:
SNMP
SNMPVersion
version.
N/A • 2—v2c. N/A
• 3—v3.
IP address of
IPv4: String, dotted decimal IPv4 address example:
IPAddress the SNMP N/A
notation. 1.1.1.1.
server.
SNMP v2c String, case-insensitive.
CommunityNa Applicable only when
community N/A
me Length: 1 to 32 characters. ‘SNMP version’ is ‘v2c’.
name.

SNMP v3 String, case-insensitive. Applicable only when

UserName N/A
user name. Length: 1 to 32 characters. ‘SNMP version’ is ‘v3’.

Applicable only when

Members include: ‘SNMP version’ is ‘v3’.

Security • AuthProtocol
Data
SecurityParam parameters
structure • AuthKey ‘PrivProtocol’ and
of this user. ‘PrivKey’ must be
• PrivProtocol
specified with
• PrivKey ‘AuthProtocol’ and
‘AuthKey’ together.
Enumeration:
Authenticatio • 0—NoAuth.
AuthProtocol N/A N/A
n algorithm • 1—SHA.
• 2—MD5.
Plaintext key string.
Authenticatio String.
AuthKey N/A Must be specified with
n key Length: 8 to 64 characters.
AuthProtocol.
Enumeration:
Encryption
• 0—NoPriv.
PrivProtocol algorithm for N/A N/A
privacy • 1—AES128.
• 2—DES56.
Plaintext key string.
String.
PrivKey Privacy key N/A Must be specified with
Length: 8 to 64 characters.
PrivProtocol.

3
Contents
ARPSYNC ······················································································1
ARPSYNC/ARPConfig ················································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ARPSYNC/ServerList ················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
ARPSYNC/ARPTable ················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4

i
ARPSYNC
ARPSYNC/ARPConfig
This table contains ARP table synchronization information.

XML structure
<ARPSYNC>
<ARPConfig>
<ARPEnable>
<Enable></Enable>
<Interval></Interval>
<Timeout></Timeout>
</ARPEnable>
</ARPConfig>
</ARPSYNC>

Table description
Item Description
Feature name ARPSYNC
Table name ARPConfig
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ARP table Members include:
synchronizati Data • Enable
ARPEnable N/A
on structure • Interval
information.
• Timeout

Whether to Boolean:
Enable enable the N/A • true—Enable. N/A
rule. • false—Disable.
ARP table
synchronizati Unassigned integer.
Interval N/A N/A
on request Value range: 5 to 30 seconds.
interval.
Request
Timeout N/A Unassigned integer. N/A
timeout.

1
 Value range: 1 to 5 seconds.

ARPSYNC/ServerList
This table contains SNMP server information.

XML structure
<ARPSYNC>
<ServerList>
<ServerConfigInfo>
<Index></Index>
<SNMPVersion></SNMPVersion>
<IPAddress></IPAddress>
<CommunityName></CommunityName>
<UserName></UserName>
<SecurityParam>
<AuthProtocol></AuthProtocol>
<AuthKey></AuthKey>
<PrivProtocol></PrivProtocol>
<PrivKey></PrivKey>
</SecurityParam>
</ServerConfigInfo>
</ServerList>
</ARPSYNC>

Table description
Item Description
Feature name ARPSYNC
Table name ServerList
Table type Multi-instance table
Row name ServerConfigInfo
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unassigned integer. To create an SNMP
Index Index number Index server, set this column
Value range: 0 to 64. to 64.

SNMP Enumeration:
SNMPVersion N/A N/A
version. • 2—v2c.

2
 • 3—v3.
IP address of
IPv4: String, dotted decimal IPv4 address example:
IPAddress the SNMP N/A
notation 1.1.1.1.
server.
SNMP v2c String, case-insensitive.
CommunityNa Applicable only when
community N/A
me Length: 1 to 32 characters. ‘SNMP version’ is ‘v2c’.
name.

SNMP v3 String, case-insensitive. Applicable only when

UserName N/A
user name. Length: 1 to 32 characters. ‘SNMP version’ is ‘v3’.

Applicable only when

‘SNMP version’ is ‘v3’.
Members include:
Security • AuthProtocol.
Data
SecurityParam parameters • AuthKey. ‘PrivProtocol’ and
structure
of this user. • PrivProtocol. ‘PrivKey’ must be
specified with
• PrivKey. ‘AuthProtocol’ and
‘AuthKey’ together.
Enumeration:
Authenticatio • 0—NoAuth.
AuthProtocol N/A N/A
n algorithm. • 1—SHA.
• 2—MD5.
Plaintext key string.
Authenticatio String.
AuthKey N/A Must be specified with
n key. Length: 8 to 64 characters.
‘AuthProtocol’.
Enumeration:
Encryption
• 0—NoPriv.
PrivProtocol algorithm for N/A N/A
privacy. • 1—AES128.
• 2—DES56.
Plaintext key string.
String.
PrivKey Privacy key. N/A Must be specified with
Length: 8 to 64 characters.
‘PrivProtocol.

ARPSYNC/ARPTable
This table contains ARP table synchronization information.

XML structure
<ARPSYNC>
<ARPTable>
<ARPTableInfo>
<Index></Index>
<IPAddr></IPAddr>
<MACAddr></MACAddr>
<Aging></Aging>
<Count></Count>
</ARPTableInfo>
</ARPTable>

3
 </ARPSYNC>

Table description
Item Description
Feature name ARPSYNC
Table name ARPTable
Table type Multi-instance table
Row name ARPTableInfo
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unassigned integer.
Index Index number Index N/A
Value range: 0 to 65534.
IPv4: String, dotted decimal
IPAddr IP address N/A N/A
notation.
Six groups of two
Example:
MACAddr MAC address N/A hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.
Unassigned integer.
Aging Aging time N/A Value range: 1 to 20 N/A
minutes.
Total number
Count N/A Unassigned integer. N/A
of ARP entries

4
Contents
ASPF·····························································································1
ASPF/Policies ··························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ASPF/DetectL4Protocols ············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
ASPF/DetectAppProtocols ··········································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
ASPF/AspfOnInterfaces ·············································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5
ASPF/AspfOnInterZones ············································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7

i
ASPF
ASPF/Policies
This table contains ASPF policy configurations.

XML structure
<ASPF>
<Policies>
<Policy>
<PolicyNumber></PolicyNumber>
<ICMPErrDrop></ICMPErrDrop>
<TCPSynCheck></TCPSynCheck>
</Policy>
</Policies>
</ASPF>

Table description
Item Description
Feature name ASPF
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ASPF policy Unsigned integer.
PolicyNumber Index N/A
number. Value range: 1 to 256.
Whether enable
ICMP error Boolean:
ICMPErrDrop message check N/A • true—YES. N/A
and drop faked • false—NO(default).
messages.

1
 Column Column Column
Data type and restrictions Remarks
name description type
TCP SYN check checks
the first packet to
Boolean: establish a TCP
TCPSynChec Whether enable connection whether it is
k TCP SYN check.
N/A • true—YES a SYN packet. If the
• false—NO(default). first packet is not a SYN
packet, ASPF drops the
packet.

ASPF/DetectL4Protocols
This table contains the transport layer protocols inspected by ASPF policies.

XML structure
<ASPF>
<DetectL4Protocols>
<Protocol>
<PolicyNumber></PolicyNumber>
<ProtocolID></ProtocolID>
<EnableDetect></EnableDetect>
</Protocol>
</DetectL4Protocols>
</ASPF>

Table description
Item Description
Feature name ASPF
Table name DetectL4Protocols
Table type Multi-instance table
Row name Protocol
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ASPF policy Unsigned integer.
PolicyNumber Index N/A
number. Value range: 1 to 256.
The detected Unsigned integer. • 1—TCP.
ProtocolID transport layer Index
protocol ID. Value range: 1 to 8. • 2—UDP.

2
 Column Column Column
Data type and restrictions Remarks
name description type
• 3—UDP-Lite.
• 4—ICMP.
• 5—ICMPv6.
• 6—SCTP.
• 7—DCCP.
• 8—RAWIP.
Boolean:
Whether enable
EnableDetect
detection.
N/A • true—YES N/A
• false—NO(default).

ASPF/DetectAppProtocols
This table contains the application layer protocols inspected by ASPF policies.

XML structure
<ASPF>
<DetectAppProtocols>
<Protocol>
<PolicyNumber></PolicyNumber>
<ProtocolID></ProtocolID>
<EnableDetect></EnableDetect>
<IllegalPacketAction></IllegalPacketAction>
</Protocol>
</DetectAppProtocols>
</ASPF>

Table description
Item Description
Feature name ASPF
Table name DetectAppProtocols
Table type Multi-instance table
Row name Protocol
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
PolicyNumber ASPF policy Index Unsigned integer. N/A

3
 Column Column Column
Data type and restrictions Remarks
name description type
number. Value range: 1 to 256.
• 1—FTP.
• 2—GTP.
• 3—H323.
• 4—RTSP.
• 5—SIP.
• 6—TFTP.
• 7—ILS.
• 8—MGCP.
• 9—NBT.
The detected Unsigned integer. • 10—PPTP.
ProtocolID application layer Index • 11—RSH.
protocol ID. Value range: 1 to 17.
• 12—SCCP.
• 13—SQLNET.
• 14—XDMCP.
• 15—HTTP.
• 16—SMTP.
• 17—DNS.
Support for HTTP，
SMTP and DNS
depends on the device
model.
Boolean:
Whether enable
EnableDetect
detection.
N/A • true—YES N/A
• false—NO(default).
Only the following
application support the
configuration:
• 1—FTP.
Enumeration:
• 3—H323.
• 0—None.
• 5—SIP.
IllegalPacket Action for illegal • 1—Drop illegal packets.
N/A • 12—SCCP.
Action packets. • 2—Log illegal packets.
• 15—HTTP.
• 3—Drop and log illegal
• 16—SMTP.
packets.
• 17—DNS.
Support for this column
depends on the device
model.

ASPF/AspfOnInterfaces
This table contains ASPF policies applied to the interfaces.

XML structure
<ASPF>
<AspfOnInterfaces>
<Interface>

4
 <IfIndex></IfIndex>
<InPolicyNumber></InPolicyNumber>
<OutPolicyNumber></OutPolicyNumber>
</Interface>
</AspfOnInterfaces>
</ASPF>

Table description
Item Description
Feature name ASPF
Table name AspfOnInterfaces
Table type Multi-instance table
Row name Interface
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
This column can only
be the index of local
VA, global VA or 3 layer
interface except
loopback, NULL, FC,
FCB and encrypt
interface.
To inspect the traffic
through an interface,
you must apply a
Interface configured ASPF policy
IfIndex Index Unsigned integer.
index to that interface.
Make sure a connection
initiation packet and the
response packet pass
through the same
interface, because an
ASPF stores and
maintains the
application layer
protocol status based
on interfaces.
ASPF policy Up to one ASPF policy
InPolicyNumb applied to the Unsigned integer. can be applied to the
N/A
er inbound direction Value range: 1 to 256. inbound direction of an
of the interface. interface.

ASPF policy Up to one ASPF policy

OutPolicyNu applied to the Unsigned integer. can be applied to the
N/A
mber outbound Value range: 1 to 256. outbound direction of
direction of the an interface.

5
 Column Column Column
Data type and restrictions Remarks
name description type
This column can only
be the index of local
VA, global VA or 3 layer
interface except
loopback, NULL, FC,
FCB and encrypt
interface.
To inspect the traffic
through an interface,
you must apply a
Interface configured ASPF policy
IfIndex Index Unsigned integer.
index to that interface.
Make sure a connection
initiation packet and the
response packet pass
through the same
interface, because an
ASPF stores and
maintains the
application layer
protocol status based
on interfaces.
interface.

ASPF/AspfOnInterZones
This table contains ASPF policies applied to the inter-Zones.

XML structure
<ASPF>
<AspfOnInterZones>
<InterZone>
<ZonePair>
<SourceZone></SourceZone>
<DestinationZone></DestinationZone>
</ZonePair>
<PolicyNumber></PolicyNumber>
</InterZone>
</AspfOnInterZones>
</ASPF>

Table description
Item Description
Feature name ASPF
Table name AspfOnInterZones
Table type Multi-instance table
Row name InterZone

6
 Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Members include:
Inter-Zone Data
ZonePair • SourceZone. N/A
information. structure.
• DestinationZone.

String, case-insensitive. Characters ">" , ">>"

Source zone
SourceZone Index and "|" can't be
name. Length: 1 to 31 characters.
included.

String, case-insensitive. Characters ">" , ">>"

DestinationZo Destination zone
Index and "|" can't be
ne name. Length: 1 to 31 characters.
included.

ASPF policy Unsigned integer.

PolicyNumber N/A N/A
number. Value range: 1 to 256.

7
Contents
ASPF·····························································································1
ASPF/Policies ··························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ASPF/DetectL4Protocols ············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
ASPF/DetectAppProtocols ··········································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
ASPF/AspfOnInterfaces ·············································································································· 4
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
ASPF/AspfOnInterZones ············································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 7
Columns ···························································································································· 7
ASPF/Specification····················································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8

i
ASPF
ASPF/Policies
This table contains ASPF policy configurations.

XML structure
<ASPF>
<Policies>
<Policy>
<PolicyNumber></PolicyNumber>
<ICMPErrDrop></ICMPErrDrop>
<TCPSynCheck></TCPSynCheck>
</Policy>
</Policies>
</ASPF>

Table description
Item Description
Feature name ASPF
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ASPF policy Unsigned integer.
PolicyNumber Index N/A
number. Value range: 1 to 256.
Whether enable
ICMP error Boolean:
ICMPErrDrop message check N/A • true—YES. N/A
and drop faked • false—NO(default).
messages.

1
 Column Column Column
Data type and restrictions Remarks
name description type
TCP SYN check checks
the first packet to
Boolean: establish a TCP
TCPSynChec Whether enable connection whether it is
k TCP SYN check.
N/A • true—YES a SYN packet. If the
• false—NO(default). first packet is not a SYN
packet, ASPF drops the
packet.

ASPF/DetectL4Protocols
This table contains the transport layer protocols inspected by ASPF policies.

XML structure
<ASPF>
<DetectL4Protocols>
<Protocol>
<PolicyNumber></PolicyNumber>
<ProtocolID></ProtocolID>
<ProtocolName></ProtocolName>
<EnableDetect></EnableDetect>
</Protocol>
</DetectL4Protocols>
</ASPF>

Table description
Item Description
Feature name ASPF
Table name DetectL4Protocols
Table type Multi-instance table
Row name Protocol
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ASPF policy Unsigned integer.
PolicyNumber Index N/A
number. Value range: 1 to 256.

The detected • 1—TCP.

Unsigned integer.
ProtocolID transport layer Index • 2—UDP.
protocol ID. Value range: 1 to 8.
• 3—UDP-Lite.

2
 Column Column Column
Data type and restrictions Remarks
name description type
• 4—ICMP.
• 5—ICMPv6.
• 6—SCTP.
• 7—DCCP.
• 8—RAWIP.
The detected String, case-insensitive.
ProtocolNam
transport layer N/A N/A
e Length: 1 to 63 characters.
protocol name.
Boolean:
Whether enable
EnableDetect
detection.
N/A • true—YES N/A
• false—NO(default).

ASPF/DetectAppProtocols
This table contains the application layer protocols inspected by ASPF policies.

XML structure
<ASPF>
<DetectAppProtocols>
<Protocol>
<PolicyNumber></PolicyNumber>
<ProtocolID></ProtocolID>
<ProtocolName></ProtocolName>
<EnableDetect></EnableDetect>
<IllegalPacketAction></IllegalPacketAction>
</Protocol>
</DetectAppProtocols>
</ASPF>

Table description
Item Description
Feature name ASPF
Table name DetectAppProtocols
Table type Multi-instance table
Row name Protocol
Restrictions None

3
Columns
Column Column Column
Data type and restrictions Remarks
name description type
ASPF policy Unsigned integer.
PolicyNumber Index N/A
number. Value range: 1 to 256.
• 1—FTP.
• 2—GTP.
• 3—H323.
• 4—RTSP.
• 5—SIP.
• 6—TFTP.
• 7—ILS.
• 8—MGCP.
• 9—NBT.
The detected Unsigned integer. • 10—PPTP.
ProtocolID application layer Index • 11—RSH.
protocol ID. Value range: 1 to 17.
• 12—SCCP.
• 13—SQLNET.
• 14—XDMCP.
• 15—HTTP.
• 16—SMTP.
• 17—DNS.
Support for HTTP，
SMTP and DNS
depends on the device
model.
The detected String, case-insensitive.
ProtocolNam
application layer N/A N/A
e Length: 1 to 63 characters.
protocol name.
Boolean:
Whether enable
EnableDetect
detection.
N/A • true—YES N/A
• false—NO(default).
Only the following
application support the
configuration:
• 1—FTP.
Enumeration:
• 3—H323.
• 0—None.
• 5—SIP.
IllegalPacket Action for illegal • 1—Drop illegal packets.
N/A • 12—SCCP.
Action packets. • 2—Log illegal packets. • 15—HTTP.
• 3—Drop and log illegal • 16—SMTP.
packets.
• 17—DNS.
Support for this column
depends on the device
model.

ASPF/AspfOnInterfaces
This table contains ASPF policies applied to the interfaces.

4
XML structure
<ASPF>
<AspfOnInterfaces>
<Interface>
<IfIndex></IfIndex>
<InPolicyNumber></InPolicyNumber>
<OutPolicyNumber></OutPolicyNumber>
</Interface>
</AspfOnInterfaces>
</ASPF>

Table description
Item Description
Feature name ASPF
Table name AspfOnInterfaces
Table type Multi-instance table
Row name Interface
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
This column can only
be the index of local
VA, global VA or 3 layer
interface except
loopback, NULL, FC,
FCB and encrypt
interface.
To inspect the traffic
through an interface,
you must apply a
Interface configured ASPF policy
IfIndex Index Unsigned integer.
index to that interface.
Make sure a connection
initiation packet and the
response packet pass
through the same
interface, because an
ASPF stores and
maintains the
application layer
protocol status based
on interfaces.

InPolicyNumb ASPF policy Unsigned integer. Up to one ASPF policy

applied to the N/A can be applied to the
er Value range: 1 to 256.
inbound direction inbound direction of an

5
 Column Column Column
Data type and restrictions Remarks
name description type
This column can only
be the index of local
VA, global VA or 3 layer
interface except
loopback, NULL, FC,
FCB and encrypt
interface.
To inspect the traffic
through an interface,
you must apply a
Interface configured ASPF policy
IfIndex Index Unsigned integer.
index to that interface.
Make sure a connection
initiation packet and the
response packet pass
through the same
interface, because an
ASPF stores and
maintains the
application layer
protocol status based
on interfaces.
of the interface. interface.
ASPF policy
Up to one ASPF policy
applied to the Unsigned integer.
OutPolicyNu can be applied to the
outbound N/A
mber Value range: 1 to 256. outbound direction of
direction of the
an interface.
interface.

ASPF/AspfOnInterZones
This table contains ASPF policies applied to the inter-Zones.

XML structure
<ASPF>
<AspfOnInterZones>
<InterZone>
<ZonePair>
<SourceZone></SourceZone>
<DestinationZone></DestinationZone>
</ZonePair>
<PolicyNumber></PolicyNumber>
</InterZone>
</AspfOnInterZones>
</ASPF>

6
Table description
Item Description
Feature name ASPF
Table name AspfOnInterZones
Table type Multi-instance table
Row name InterZone
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Members include:
Inter-Zone Data
ZonePair • SourceZone. N/A
information. structure.
• DestinationZone.

String, case-insensitive. Characters ">" , ">>"

Source zone
SourceZone Index and "|" can't be
name. Length: 1 to 31 characters.
included.

String, case-insensitive. Characters ">" , ">>"

DestinationZo Destination zone
Index and "|" can't be
ne name. Length: 1 to 31 characters.
included.

ASPF policy Unsigned integer.

PolicyNumber N/A N/A
number. Value range: 1 to 256.

ASPF/Specification
This table contains specification information of the current device.

XML structure
<ASPF>
<Specification>
<InterfaceApply></InterfaceApply>
<ZonePairApply></ZonePairApply>
<DetectAppAction></DetectAppAction>
<DetectDCCP></DetectDCCP>
<DetectDNS></DetectDNS>
<DetectFTP></DetectFTP>
<DetectGTP></DetectGTP>
<DetectH323></DetectH323>
<DetectHTTP></DetectHTTP>
<DetectICMP></DetectICMP>
<DetectICMPv6></DetectICMPv6>

7
 <DetectILS></DetectILS>
<DetectMGCP></DetectMGCP>
<DetectNBT></DetectNBT>
<DetectPPTP></DetectPPTP>
<DetectRAWIP></DetectRAWIP>
<DetectRSH></DetectRSH>
<DetectRTSP></DetectRTSP>
<DetectSCCP></DetectSCCP>
<DetectSCTP></DetectSCTP>
<DetectSIP></DetectSIP>
<DetectSMTP></DetectSMTP>
<DetectSQLNET></DetectSQLNET>
<DetectTCP></DetectTCP>
<DetectTFTP></DetectTFTP>
<DetectUDP></DetectUDP>
<DetectUDPLite></DetectUDPLite>
<DetectXDMCP></DetectXDMCP>
</Specification>
</ASPF>

Table description
Item Description
Feature name ASPF
Table name Specification
Table type Single-instance table
Row name N/A
Restrictions None.

Columns
Column Data type and
Column name Column description Remarks
type restrictions
Boolean:
Support apply an ASPF
InterfaceApply N/A • true N/A
policy to interfaces.
• false
Boolean:
Support apply an ASPF
ZonePairApply
policy to security zone pairs.
N/A • true N/A
• false

Whether support set illegal Boolean:

DetectAppAction packet’s action of application N/A • true N/A
layer protocol. • false

Whether support DCCP Boolean:

DetectDCCP transport layer protocol N/A • true N/A
detection. • false

8
 Column Data type and
Column name Column description Remarks
type restrictions
Whether support DNS Boolean:
DetectDNS application layer N/A • true N/A
protocol detection. • false

Whether support FTP Boolean:

DetectFTP application layer N/A • true N/A
protocol detection. • false

Whether support GTP Boolean:

DetectGTP application layer N/A • true N/A
protocol detection. • false

Whether support H323 Boolean:

DetectH323 application layer N/A • true N/A
protocol detection. • false

Whether support HTTP Boolean:

DetectHTTP application layer N/A • true N/A
protocol detection. • false

Whether support ICMP Boolean:

DetectICMP transport layer protocol N/A • true N/A
detection. • false

Whether support ICMPv6 Boolean:

DetectICMPv6 transport layer protocol N/A • true N/A
detection. • false

Whether support ILS Boolean:

DetectILS application layer N/A • true N/A
protocol detection. • false

Whether support MGCP Boolean:

DetectMGCP application layer N/A • true N/A
protocol detection. • false

Whether support NBT Boolean:

DetectNBT application layer N/A • true N/A
protocol detection. • false

Whether support PPTP Boolean:

DetectPPTP application layer N/A • true N/A
protocol detection. • false

Whether support RAWIP Boolean:

DetectRAWIP transport layer protocol N/A • true N/A
detection. • false

Whether support RSH Boolean:

DetectRSH application layer N/A • true N/A
protocol detection. • false

Whether support RTSP Boolean:

DetectRTSP application layer N/A • true N/A
protocol detection. • false

DetectSCCP Whether support SCCP N/A

Boolean:
N/A
application layer • true

9
 Column Data type and
Column name Column description Remarks
type restrictions
protocol detection. • false

Whether support SCTP Boolean:

DetectSCTP transport layer protocol N/A • true N/A
detection. • false

Whether support SIP Boolean:

DetectSIP application layer N/A • true N/A
protocol detection. • false

Whether support SMTP Boolean:

DetectSMTP application layer N/A • true N/A
protocol detection. • false

Whether support SQLNET Boolean:

DetectSQLNET application layer N/A • true N/A
protocol detection. • false

Whether support TCP Boolean:

DetectTCP transport layer protocol N/A • true N/A
detection. • false

Whether support TFTP Boolean:

DetectTFTP application layer N/A • true N/A
protocol detection. • false

Whether support UDP Boolean:

DetectUDP transport layer protocol N/A • true N/A
detection. • false

Whether support Boolean:

DetectUDP-Lite UDP-Lite transport layer N/A • true N/A
protocol detection. • false

Whether support XDMCP Boolean:

DetectXDMCP application layer N/A • true N/A
protocol detection. • false

10
Contents
ATK·······························································································1
ATK/ClearInterfaceAttackStatistics ································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ATK/ClearLocalAttackStatistics ····································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
ATK/ClearZoneAttackStatistics ····································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
ATK/Blacklist/IPv4Blacklists ········································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
ATK/Blacklist/IPv6Blacklists ········································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
ATK/Blacklist/ClearItems ············································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
ATK/Blacklist/IPv4DstBlacklists ····································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
ATK/Blacklist/IPv6DstBlacklists ····································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7
ATK/Blacklist/ClearDstItems ········································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8
ATK/Blacklist/ClearStatistics········································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ···························································································································· 9
ATK/ClientVerify/ClearProtectHostStatistics ····················································································· 9
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ·························································································································· 10
ATK/ClientVerify/ClearTrustClients ······························································································ 10
XML structure ··················································································································· 10
Table description ··············································································································· 10
Columns ·························································································································· 11

i
ATK
ATK/ClearInterfaceAttackStatistics
This table is used to clear interface ATK statistics.

XML structure
<ATK>
<ClearInterfaceAttackStatistics>
<Statistics>
<IfIndex></IfIndex>
<Clear></Clear>
</Statistics>
</ClearInterfaceAttackStatistics>
</ATK>

Table description
Item Description
Feature name ATK
Table name ClearInterfaceAttackStatistics
Table type Multi-instance table
Row name Statistics
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
IfIndex Interface index Index Unsigned integer.
Clear interface This column must be
Clear N/A
statistics empty.

ATK/ClearLocalAttackStatistics
This table is used to clear local ATK statistics.

1
XML structure
<ATK>
<ClearLocalAttackStatistics>
<Clear></Clear>
</ClearLocalAttackStatistics>
</ATK>

Table description
Item Description
Feature name ATK
Table name ClearLocalAttackStatistics
Table type Single-instance table
Row name N/A
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
Clear local This column must be
Clear N/A
statistics empty.

ATK/ClearZoneAttackStatistics
This table is used to clear ATK statistics for a security zone.

XML structure
<ATK>
<ClearZoneAttackStatistics >
<Statistics>
<ZoneID></ZoneID>
<Clear></Clear>
</Statistics>
</ClearZoneAttackStatistics >
</ATK>

Table description
Item Description
Feature name ATK
Table name ClearZoneAttackStatistics

2
 Item Description
Table type Multi-instance table
Row name Statistics
Restrictions None

Columns
Column Column
Column name Data type and restrictions
description type
ZoneID Security zone ID Index Unsigned integer.

Clear ATK
Clear N/A This column must be empty.
statistics

ATK/Blacklist/IPv4Blacklists
This table is used to clear ipv4blacklist.

XML structure
<ATK>
<Blacklist>
<IPv4Blacklists>
<Item>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<DSLitePeer></DSLitePeer>
<Clear></Clear>
</Item>
</IPv4Blacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4Blacklists
Table type Multi-instance table
Row name Item
Restrictions None.

3
Columns
Column Column Data type and
Column name Remarks
description type restrictions
VrfIndex Vpn index Index Unsigned integer. N/A
Ipv4Address Ip address Index Ipv4 address. N/A
In DS-Lite network, this
parameter refers to B4
DSLitePeer Ip address Index Ipv6 address addresses.
Leave it empty in other
circumstances.
Clear local This column must be
Clear N/A N/A
statistics empty.

ATK/Blacklist/IPv6Blacklists
This table is used to clear ipv6blacklist.

XML structure
<ATK>
<Blacklist>
<IPv6Blacklists>
<Item>
<VrfIndex></VrfIndex>
<Ipv6Address></Ipv6Address>
<Clear></Clear>
</Item>
</IPv6Blacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6Blacklists
Table type Multi-instance table
Row name Item
Restrictions None.

4
Columns
Column Column Data type and
Column name
description type restrictions
VrfIndex Vpn index Index Unsigned integer.
Ipv6Address Ip address Index Ipv6 address.
Clear local This column must be
Clear N/A
statistics empty.

ATK/Blacklist/ClearItems
This table is used to clear blacklist items.

XML structure
<ATK>
<Blacklist>
<ClearItems>
<Item>
<AddrFamily></AddrFamily>
<Clear></Clear>
</Item>
</ClearItems>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name ClearItems
Table type Multi-instance table
Row name item
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
Enumeration:
AddrFamily Address familly Index • 2—IPv4.
• 10—IPv6.

5
 Column Column Data type and
Column name
description type restrictions
Clear blacklist This column must be
Clear N/A
items empty.

ATK/Blacklist/IPv4DstBlacklists
This table is used to clear IPv4 destination blacklist.

XML structure
<ATK>
<Blacklist>
<IPv4DstBlacklists>
<Item>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<Clear></Clear>
</Item>
</IPv4DstBlacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4DstBlacklists
Table type Multi-instance table
Row name Item
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
VrfIndex Vpn index Index Unsigned integer. N/A
Ipv4Address Ip address Index IPv4 address. N/A
Clear local This column must be
Clear N/A N/A
statistics empty.

6
ATK/Blacklist/IPv6DstBlacklists
This table is used to clear IPv6 destination blacklist.

XML structure
<ATK>
<Blacklist>
<IPv6DstBlacklists>
<Item>
<VrfIndex></VrfIndex>
<Ipv6Address></Ipv6Address>
<Clear></Clear>
</Item>
</IPv6DstBlacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6DstBlacklists
Table type Multi-instance table
Row name Item
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
VrfIndex Vpn index Index Unsigned integer.
Ipv6Address Ip address Index IPv6 address.
Clear local This column must be
Clear N/A
statistics empty.

ATK/Blacklist/ClearDstItems
This table is used to clear destination blacklist items.

XML structure
<ATK>

7
 <Blacklist>
<ClearDstItems>
<Item>
<AddrFamily></AddrFamily>
<Clear></Clear>
</Item>
</ClearDstItems>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name ClearDstItems
Table type Multi-instance table
Row name item
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
Enumeration:
AddrFamily Address familly Index • 2—IPv4.
• 10—IPv6.
Clear blacklist This column must be
Clear N/A
items empty.

ATK/Blacklist/ClearStatistics
This table is used to clear blacklist statistics.

XML structure
<ATK>
<Blacklist>
<ClearStatistics>
<Clear></Clear>
</ClearStatistics>
</Blacklist>
</ATK>

8
Table description
Item Description
Feature name ATK
Table name ClearStatistics
Table type Single-instance table
Row name N/A
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
Clear blacklist This column must be
Clear N/A
statistics empty.

ATK/ClientVerify/ClearProtectHostStatistics
This table is used to clear client verification protected hosts’ statistics.

XML structure
<ATK>
<ClientVerify>
<ClearProtectHostStatistics>
<Statistics>
<VerifyType></VerifyType>
<AddrFamily></AddrFamily>
<Clear></Clear>
</Statistics>
</ClearProtectHostStatistics>
</ClientVerify>
</ATK>

Table description
Item Description
Feature name ATK
Table name ClearProtectHostStatistics
Table type Multi-instance table
Row name Statistics
Restrictions None.

9
Columns
Column Column Data type and
Column name
description type restrictions
Enumeration:
• 0—TCP proxy
• 1—DNS client
verification.
VerifyType Verification type Index • 2—HTTP client
verification.
• 3—DNS reply
verification.
• 4—SIP client
verification.
Enumeration:
AddrFamily Address familly Index • 2—IPv4.
• 10—IPv6.
Clear protected This column must be
Clear N/A
hosts’ statistics empty.

ATK/ClientVerify/ClearTrustClients
This table is used to clear client verification authenticated clients.

XML structure
<ATK>
<ClientVerify>
<ClearTrustClients>
<Client>
<VerifyType></VerifyType>
<AddrFamily></AddrFamily>
<Clear></Clear>
</Client>
</ClearTrustClients>
</ClientVerify>
</ATK>

Table description
Item Description
Feature name ATK
Table name ClearTrustClients
Table type Multi-instance table

10
 Item Description
Row name Client
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
Enumeration:
• 0—TCP proxy
• 1—DNS client
verification.
VerifyType Verification type Index • 2—HTTP client
verification.
• 3—DNS reply
verification.
• 4—SIP client
verification.
Enumeration:
AddrFamily Address familly Index • 2—IPv4.
• 10—IPv6.
This column must be
Clear Clear trust clients N/A
empty.

11
Contents
ATK·······························································································1
ATK/Policies ····························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ATK/PolicyInterfaces ·················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
ATK/PolicyZones ······················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
ATK/PolicyLocal ························································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
ATK/IPv4Exempts ······················································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
ATK/IPv6Exempts ······················································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6
ATK/Scan/Policies ····················································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 7
Columns ···························································································································· 7
ATK/Flood/DefaultConfigs············································································································ 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ···························································································································· 9
ATK/Flood/IPv4ProtectHosts ······································································································ 10
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 11
ATK/Flood/IPv6ProtectHosts ······································································································ 13
XML structure ··················································································································· 13
Table description ··············································································································· 13
Columns ·························································································································· 13
ATK/Flood/LearnItems ·············································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 15
Columns ·························································································································· 15
ATK/Signature/Detects ·············································································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 16
Columns ·························································································································· 17
ATK/Signature/LargeICMPLength································································································ 19
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 20
ATK/Signature/LevelActions ······································································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 21
Columns ·························································································································· 21

i
ATK/Signature/LogAggregate ····································································································· 22
XML structure ··················································································································· 22
Table description ··············································································································· 22
Columns ·························································································································· 22
ATK/Blacklist/IPv4Blacklists ······································································································· 22
XML structure ··················································································································· 22
Table description ··············································································································· 23
Columns ·························································································································· 23
ATK/Blacklist/IPv6Blacklists ······································································································· 23
XML structure ··················································································································· 23
Table description ··············································································································· 24
Columns ·························································································································· 24
ATK/Blacklist/IPv4DstBlacklists ··································································································· 24
XML structure ··················································································································· 24
Table description ··············································································································· 25
Columns ·························································································································· 25
ATK/Blacklist/IPv6DstBlacklists ··································································································· 25
XML structure ··················································································································· 25
Table description ··············································································································· 26
Columns ·························································································································· 26
ATK/Blacklist/InterfaceSwitches ·································································································· 26
XML structure ··················································································································· 26
Table description ··············································································································· 27
Columns ·························································································································· 27
ATK/Blacklist/ZoneSwitches ······································································································· 27
XML structure ··················································································································· 27
Table description ··············································································································· 27
Columns ·························································································································· 28
ATK/Blacklist/GlobalConfigs ······································································································· 28
XML structure ··················································································································· 28
Table description ··············································································································· 28
Columns ·························································································································· 29
ATK/Whitelist/IPv4ObjItems ······································································································· 29
XML structure ··················································································································· 29
Table description ··············································································································· 29
Columns ·························································································································· 29
ATK/Whitelist/IPv6ObjItems ······································································································· 30
XML structure ··················································································································· 30
Table description ··············································································································· 30
Columns ·························································································································· 30
ATK/Whitelist/InterfaceSwitches ·································································································· 31
XML structure ··················································································································· 31
Table description ··············································································································· 31
Columns ·························································································································· 31
ATK/Whitelist/ZoneSwitches······································································································· 32
XML structure ··················································································································· 32
Table description ··············································································································· 32
Columns ·························································································································· 32
ATK/Whitelist/GlobalSwitches ····································································································· 33
XML structure ··················································································································· 33
Table description ··············································································································· 33
Columns ·························································································································· 33
ATK/ClientVerify/Switches ········································································································· 33
XML structure ··················································································································· 33
Table description ··············································································································· 34
Columns ·························································································································· 34
ATK/ClientVerify/ZoneSwitches··································································································· 35
XML structure ··················································································································· 35
Table description ··············································································································· 35
Columns ·························································································································· 36
ATK/ClientVerify/IPv4ProtectHosts ······························································································ 36
XML structure ··················································································································· 36

ii
 Table description ··············································································································· 37
Columns ·························································································································· 37
ATK/ClientVerify/IPv6ProtectHosts ······························································································ 37
XML structure ··················································································································· 38
Table description ··············································································································· 38
Columns ·························································································································· 38
ATK/TopStatisticsSwitch············································································································ 39
XML structure ··················································································································· 39
Table description ··············································································································· 39
Columns ·························································································································· 39

iii
ATK
ATK/Policies
This table is used to operate ATK policies.

XML structure
<ATK>
<Policies>
<Policy>
<PolicyName></PolicyName>
</Policy>
</Policies>
</ATK>

Table description
Item Description
Feature name ATK
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None.
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.

ATK/PolicyInterfaces
This table is used to operate ATK policy appliances on interfaces.

XML structure
<ATK>
<PolicyInterfaces>

1
 <Apply>
<IfIndex></IfIndex>
<PolicyName></PolicyName>
</Apply>
</PolicyInterfaces>
</ATK>

Table description
Item Description
Feature name ATK
Table name PolicyInterfaces
Table type Multi-instance table
Row name Apply
Restrictions None.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
IfIndex Interface index Index Unsigned integer. N/A

Name of Attack String.

PolicyName N/A Case insensitive
Defense policy Length: 1 to 31 characters.

ATK/PolicyZones
This table is used to apply an attack defense policy to a security zone.

XML structure
<ATK>
<PolicyZones>
<Apply>
<ZoneID></ZoneID>
<PolicyName></PolicyName>
</Apply>
</PolicyZones>
</ATK>

2
Table description
Item Description
Feature name ATK
Table name PolicyZones
Table type Multi-instance table
Row name Apply
Restrictions None
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
ZoneID Security zone ID Index Unsigned integer. N/A
Case insensitive.
Valid characters
Attack defense String. include letters,
PolicyName N/A
policy name Length: 1 to 31 characters. digits,
underscores (_),
and hyphens (-).

ATK/PolicyLocal
This table is used to operate local ATK policy appliance.

XML structure
<ATK>
<PolicyLocal>
<PolicyName></PolicyName>
</PolicyLocal>
</ATK>

Table description
Item Description
Feature name ATK
Table name PolicyLocal
Table type Single-instance table
Row name N/A
Restrictions None.
Support for row creation and deletion No

3
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName N/A Case insensitive
Defense policy Length: 1 to 31 characters.

ATK/IPv4Exempts
This table contains IPv4 exemption information

XML structure
<ATK>
<IPv4Exempts>
<Exempt>
<PolicyName></PolicyName>
<AclNum></AclNum>
<AclName></AclName>
</Exempt>
</IPv4Exempts>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4Exempts
Table type Multi-instance table
Row name Exempt
Restrictions None.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
Unsigned integer. AclNum and
AclNum Acl number N/A
Value range: 2000 to 3999 AclName are

4
 Column Column Data type and
Column name Remarks
description type restrictions
mutual exclusive
and only one of
them can be set
in a single
message.
AclNum and
AclName are
String. mutual exclusive
AclName Acl name N/A and only one of
Length: 1 to 63 characters. them can be set
in a single
message.

ATK/IPv6Exempts
This table contains IPv6 exemption information

XML structure
<ATK>
<IPv6Exempts>
<Exempt>
<PolicyName></PolicyName>
<AclNum></AclNum>
<AclName></AclName>
</Exempt>
</IPv6Exempts>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6Exempts
Table type Multi-instance table
Row name Exempt
Restrictions None.
Support for row creation and deletion No

5
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
AclNum and
AclName are
Unsigned integer. mutual exclusive
AclNum Acl number N/A and only one of
Value range: 2000 to 3999 them can be set
in a single
message.
AclNum and
AclName are
String. mutual exclusive
AclName Acl name N/A and only one of
Length: 1 to 63 characters. them can be set
in a single
message.

ATK/Scan/Policies
This table contains scan policy information.

XML structure
<ATK>
<Scan>
<Policies>
<Policy>
<PolicyName></PolicyName>
<Level></Level>
<UserDefinedCfg>
<PortScanEnable></PortScanEnable>
<PortScanThreshold></PortScanThreshold>
<IPSweepEnable></IPSweepEnable>
<IPSweepThreshold></IPSweepThreshold>
<Period></Period>
</UserDefinedCfg>
<Log></Log>
<Drop></Drop>
<BlockSource>
<Enable></Enable>
<BlockTime></BlockTime>
</BlockSource>
</Policy>
</Policies>

6
 </Scan>
</ATK>

Table description
Item Description
Feature name ATK
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String,case-insensitive.
PolicyName Index N/A
Defense policy Length: 1 to 31 characters.
Enumeration:
• 0—Don’t detect. UserDefinedCfg
• 1—Low sensibility. and its members
Level Scan detect level N/A • 2—Middle sensibility. are available
only in scan
• 3—High sensibility.
detect level 4.
• 4—User defined
sensibility.
Members include:
• PortScanEnable
Custom scan
Data • PortScanThreshold
UserDefinedCfg detection N/A
configuration.
struct • IPSweepEnable
• IPSweepThreshold
Period

Port scan Boolean:

PortScanEnable detection N/A • true. Default is false.
switch. • false.

Signed integer. Value must be

Port scan
set if
PortScanThreshold detection N/A Value range: 1 to PortScanEnable
threshold. 1000000000 pps. is true.
Boolean:
IP sweep
IPSweepEnable
detection switch.
N/A • true. Default is false.
• false.

Signed integer. Value must be

IP sweep
set if
IPSweepThreshold detection N/A Value range: 1 to IPSweepEnable is
threshold. 1000000000 pps. true.

7
 Column Column Data type and
Column name Remarks
description type restrictions
Signed integer. Default detection
Period Detection cycle. N/A Value range: 1 to cycle is 10
1000000000 seconds. seconds.

Boolean:
Log Log switch N/A • true Default is false.
• false
Default is false.
Drop and
Boolean: BlockSource are
Drop packet mutually
Drop
switch
N/A • true exclusive and
• false only one of them
can be set in a
single message.
Drop and
BlockSource are
Members include: mutually
Block source Data
BlockSource
configs struct • Enable exclusive and
• BlockTime only one of them
can be set in a
single message.
Boolean:
Block source
Enable
switch.
N/A • true Default is false.
• false
Default is 10
minutes. When
Source block Unsigned integer, value and only when
BlockTime N/A
duration. range 1 to 1000 minutes. Enable is true,
this column is
useful.

ATK/Flood/DefaultConfigs
This table contains flood default configurations.

XML structure
<ATK>
<Flood>
<DefaultConfigs>
<Config>
<PolicyName></PolicyName>
<MainType></MainType>
<SubType></SubType>
<Log></Log>
<Drop></Drop>
<ClientVerify></ClientVerify>
<Threshold></Threshold>

8
 <MonitorPort></MonitorPort>
<NonSpecificSwitch></NonSpecificSwitch>
</Config>
</DefaultConfigs>
</Flood>
</ATK>

Table description
Item Description
Feature name ATK
Table name DefaultConfigs
Table type Multi-instance table
Row name Config
Restrictions None.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
Enumeration:
• 0—Transport layer
Maintype Main flood type Index flood. N/A
• 1—Application layer
flood.
Enumeration, value range
varies according to
MainType.

For transport layer flood:

• 0—SYN flood.
• 1—ACK flood.
• 2—SYN-ACK flood.
• 3—RESET flood.
SubType Sub flood type Index N/A
• 4—FIN flood.
• 5—UDP flood.
• 6—ICMP flood.
• 7—ICMPv6 flood.

For application layer flood:

• 0—DNS flood.
• 1—HTTP flood.
• 2—DNS reply flood.

9
 Column Column Data type and
Column name Remarks
description type restrictions
• 3—SIP flood.
Boolean:
Log Log switch N/A • true Default is false.
• false
Boolean:
Drop packet
Drop
switch
N/A • true Default is false.
• false
Boolean:
Client verification
ClientVerify
switch
N/A • true Default is false.
• false
Flood detect Signed integer, value Default value is
Threshold N/A
threshold range: 1 to 1000000 pps. 1000
Support
Application layer
only for now.
For http flood,
default
monitored port is
80.
For DNS flood,
default
monitored port is
53.
For DNS reply
flood, default
Port range string, port monitored port is
Monitor service value range: 1 to 65535.
MonitorPort N/A 53.
port range
For SIP flood,
default
monitored port is
5060.
For example,
"80,8000-8080"
can be set as
default
monitored ports
for http flood
detecting.
At most specify a
maximum of 32
port items.
Default value is
Non specific Boolean: false which
NonSpecificSwitch protect hosts N/A • true means only
detect switch • false detect protect
hosts.

ATK/Flood/IPv4ProtectHosts
This table contains IPv4 flood protect hosts information.

10
XML structure
<ATK>
<Flood>
<IPv4ProtectHosts>
<Host>
<PolicyName></PolicyName>
<MainType></MainType>
<SubType></SubType>
<VrfName></VrfName>
<Ipv4Address></Ipv4Address>
<Threshold></Threshold>
<Log></Log>
<Drop></Drop>
<ClientVerify></ClientVerify>
<MonitorPort></MonitorPort>
</Host>
</IPv4ProtectHosts>
</Flood>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4ProtectHosts
Table type Multi-instance table
Row name Host
Restrictions None.
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
Enumeration:
• 0—Transport layer
Maintype Main flood type Index flood. N/A
• 1—Application layer
flood.
Enumeration, value range
SubType Sub flood type Index varies according to N/A
MainType.

11
 Column Column Data type and
Column name Remarks
description type restrictions

For transport layer flood:

• 0—SYN flood.
• 1—ACK flood.
• 2—SYN-ACK flood.
• 3—RESET flood.
• 4—FIN flood.
• 5—UDP flood.
• 6—ICMP flood.
• 7—ICMPv6 flood.

For application layer flood:

• 0—DNS flood.
• 1—HTTP flood.
• 2—DNS reply flood.
• 3—SIP flood.
Case sensitive,
String. empty
VrfName Vrf name Index
Length: 0 to 31 characters. represents public
vrf.
IPv4 protected
Ipv4Address Index IPv4 address. N/A
host address
Flood detect Signed integer, value
Threshold N/A N/A
threshold range: 1 to 1000000 pps.
No default value.
Boolean: Should be
configured along
Log Log switch N/A • true with drop and
• false clientverify
column.
No default value.
Boolean: Should be
Drop packet configured along
Drop
switch
N/A • true with log and
• false clientverify
column.
No default value.
Boolean: Should be
Client verification
ClientVerify
switch
N/A • true configured along
• false with log and drop
column.
Support
Application layer
Monitor service Port range string, port only for now.
MonitorPort N/A
port range value range: 1 to 65535. At most specify a
maximum of 24
port items.

12
ATK/Flood/IPv6ProtectHosts
This table contains IPv6 flood protect hosts information.

XML structure
<ATK>
<Flood>
<IPv6ProtectHosts>
<Host>
<PolicyName></PolicyName>
<MainType></MainType>
<SubType></SubType>
<VrfName></VrfName>
<Ipv6Address></Ipv6Address>
<Threshold></Threshold>
<Log></Log>
<Drop></Drop>
<ClientVerify></ClientVerify>
<MonitorPort></MonitorPort>
</Host>
</IPv6ProtectHosts>
</Flood>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6ProtectHosts
Table type Multi-instance table
Row name Host
Restrictions None.
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
Enumeration:
Maintype Main flood type Index • 0—Transport layer N/A
flood.
• 1—Application layer

13
 Column Column Data type and
Column name Remarks
description type restrictions
flood.
Enumeration, value range
varies according to
MainType.

For transport layer flood:

• 0—SYN flood.
• 1—ACK flood.
• 2—SYN-ACK flood.
• 3—RESET flood.
SubType Sub flood type Index • 4—FIN flood. N/A
• 5—UDP flood.
• 6—ICMP flood.
• 7—ICMPv6 flood.

For application layer flood:

• 0—DNS flood.
• 1—HTTP flood.
• 2—DNS reply flood.
• 3—SIP flood.
Case sensitive,
String. empty
VrfName Vrf name Index
Length: 0 to 31 characters. represents public
vrf.
IPv6 protected
Ipv6Address Index IPv6 address. N/A
host address
Flood detect Signed integer, value
Threshold N/A N/A
threshold range: 1 to 1000000 pps.
No default value.
Boolean: Should be
configured along
Log Log switch N/A • true with drop and
• false clientverify
column.
No default value.
Boolean: Should be
Drop packet configured along
Drop
switch
N/A • true with log and
• false clientverify
column.
No default value.
Boolean: Should be
Client verification
ClientVerify
switch
N/A • true configured along
• false with log and drop
column.
Support
Application layer
Monitor service Port range string, port only for now.
MonitorPort N/A
port range value range: 1 to 65535. At most specify a
maximum of 24
port items.

14
ATK/Flood/LearnItems
This table contains flow threshold learning information.

XML structure
<ATK>
<Flood>
<LearnItems>
<Item>
<PolicyName></PolicyName>
<Status></Status>
<TimeValue></TimeValue>
<Mode></Mode>
<IntervalValue></IntervalValue>
<AutoApply></AutoApply>
<Scope></Scope>
</Item>
</LearnItems>
</Flood>
</ATK>

Table description
Item Description
Feature name ATK
Table name LearnItems
Table type Multi-instance table
Row name Item
Restrictions None
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of the String, case-insensitive.
PolicyName attack defense Index N/A
policy Length: 1 to 31 characters.

Boolean:
Status Learning switch N/A • true Default is false.
• false
TimeValue Time value N/A Unsigned integer. Default is 1440

15
 Column Column Data type and
Column name Remarks
description type restrictions
Value range: 1 to 1200000 minutes.
minutes.
Enumeration:
Mode Learning mode N/A • 0—Single. N/A
• 1—Cycle.
When and only
when mode is
Unsigned integer, value
Interval value for cycle, this
IntervalValue N/A range: 1 to 1200000
cycle mode column is useful.
minutes.
Default is 1440
minutes.
Boolean:
Auto application
AutoApply
switch
N/A • true Default is false.
• false
Only when
Unsigned integer. AutoApply is
Deviation of study
Scope N/A true, this column
result Value range: 0 to 4000. is useful. Default
is 50.

ATK/Signature/Detects
This table contains signature detects’ information.

XML structure
<ATK>
<Signature>
<Detects>
<Detect>
<PolicyName></PolicyName>
<MainType></MainType>
<SubType></SubType>
<Log></Log>
<Drop></Drop>
</Detect>
</Detects>
</Signature>
</ATK>

Table description
Item Description
Feature name ATK
Table name Detects

16
 Item Description
Table type Multi-instance table
Row name Detect
Restrictions None.
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
Enumeration:
• 0—Named single
packet attack.
• 1—IP option single
packet attack.
• 2—ICMP single
packet attack.
Maintype
Main signature
Index • 3—ICMPv6 single N/A
type packet attack.
• 4—IPv6 extend
header attack.
• 5—IPv6 extend
header abnormal
attack.
• 6—IPv6 extend
header exceed attack.
Enumeration, value range
varies according to
MainType.

For named single packet

attack:
• 0—IP fragment.
• 1—IP impossible.
• 2—Teardrop
• 3—Tiny fragment
Sub signature • 4—Abnormal
SubType Index N/A
type • 5—Smurf
• 6—Trace route
• 7—Ping of death
• 8—Large ICMP
• 9—Large ICMPv6
• 10—TCP invalid flags
• 11—TCP null flag
• 12—TCP all flags
• 13—TCP SYN FIN
flags
• 14—TCP FIN only

17
 Column Column Data type and
Column name Remarks
description type restrictions
• 15—Land
• 16—Winnuke
• 17—UDP bomb
• 18—Snork
• 19—Fraggle

For IP option single packet

attack, SubType is the IP
option value, range: 0 to
255.
• 7—Record route
option.
• 68—Timestamp
option.
• 130—Security option.
• 131—Loose source
routing option.
• 136—Stream identifier
option.
• 137—Strict source
route option.
• 148—Route alert
option.

For ICMP single packet

attack, SubType is the
ICMP type value, range: 0
to 255.
• 8—ICMP echo
request.
• 0—ICMP echo reply.
• 4—ICMP source
quench.
• 3—ICMP destination
unreachable.
• 5—ICMP redirect.
• 11—ICMP time
exceeded.
• 12—ICMP parameter
problem.
• 13—ICMP timestamp
request.
• 14—ICMP timestamp
reply.
• 15—ICMP information
request.
• 16—ICMP information
reply.
• 17—ICMP address
mask request.
• 18—ICMP address
mask reply.

For ICMPv6 single packet

18
 Column Column Data type and
Column name Remarks
description type restrictions
attack, SubType is the
ICMPv6 type value, range:
0 to 255.
• 128—ICMPv6 echo
request.
• 129—ICMPv6 echo
reply.
• 130—ICMPv6 group
query.
• 131—ICMPv6 group
report.
• 132—ICMPv6 group
reduction.
• 1—ICMPv6
destination
unreachable.
• 3—ICMPv6 time
exceeded.
• 4—ICMPv6 parameter
problem.
• 2—ICMPv6 packet
too big.

For IPv6 extend header

single packet attack,
SubType is the header type
value, range: 0 to 255.

For IPv6 extend header

abnormal attack, SubType
is not needed.

For IPv6 extend header

exceed attack, SubType is
the maximum number of
extension headers.
Value range: 0 to 7.
Boolean:
Log Log switch N/A • true Default is false.
• false
Boolean:
Drop packet
Drop
switch
N/A • true Default is false.
• false

ATK/Signature/LargeICMPLength
This table contains large ICMP and ICMPv6 signature information.

19
XML structure
<ATK>
<Signature>
<LargeICMPLength>
<Policy>
<PolicyName></PolicyName>
<IPv4Threshold></IPv4Threshold>
<IPv6Threshold></IPv6Threshold>
</Policy>
</LargeICMPLength>
</Signature>
</ATK>

Table description
Item Description
Feature name ATK
Table name LargeICMPLength
Table type Multi-instance table
Row name Policy
Restrictions None.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
ICMP packet Unsigned integer, value Default is 4000
IPv4Threshold N/A
length threshold range: 28 to 65534 bytes. bytes.
ICMPv6 packet Unsigned integer, value Default is 4000
IPv6Threshold N/A
length threshold range: 48 to 65534 bytes. bytes.

ATK/Signature/LevelActions
This table contains signature level action information.

XML structure
<ATK>
<Signature>

20
 <LevelActions>
<LevelAction>
<PolicyName></PolicyName>
<Level></Level>
<Log></Log>
<Drop></Drop>
</LevelAction>
</LevelActions>
</Signature>
</ATK>

Table description
Item Description
Feature name ATK
Table name LevelActions
Table type Multi-instance table
Row name LevelAction
Restrictions None.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
Enumeration:
• 0—Information.
Level Severity level Index • 1—Low. N/A
• 2—Medium.
• 3—High.
Boolean:
Default value is
Log Log switch N/A • true true
• false
The default value
varies by severity
level. For
Boolean: information level
Drop packet or low level,
Drop
switch
N/A • true default value is
• false false. For
medium level or
high level default
value is true.

21
ATK/Signature/LogAggregate
This table contains signature log aggregation information.

XML structure
<ATK>
<Signature>
<LogAggregate>
<Enable></Enable>
</LogAggregate>
</Signature>
</ATK>

Table description
Item Description
Feature name ATK
Table name LogAggregate
Table type Single-instance table
Row name N/A
Restrictions None.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Boolean:
Log aggregate
Enable
switch.
N/A • true Default is true.
• false

ATK/Blacklist/IPv4Blacklists
This table contains IPv4 blacklist information.

XML structure
<ATK>
<Blacklist>
<IPv4Blacklists>
<Item>
<VrfIndex></VrfIndex>

22
 <Ipv4Address></Ipv4Address>
<DSLitePeer></DSLitePeer>
<TTL></TTL>
</Item>
</IPv4Blacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4Blacklists
Table type Multi-instance table
Row name Item
Restrictions None.
Support for row creation and deletion Yes

Columns
Column Colu
Column
descriptio mn Data type and restrictions Remarks
name
n type
Unsigned integer, 0 represents
VrfIndex Vrf index Index N/A
public vrf.
IPv4
Ipv4Address blacklist Index IPv4 address. N/A
address
In DS-Lite network, this
DS-Lite parameter refers to B4
DSLitePeer tunnel peer Index IPv6 address. addresses.
address Leave it empty in other
circumstances.
Unsigned integer, unit second,
TTL Time to live N/A value range: 60 to 604800 N/A
second.

ATK/Blacklist/IPv6Blacklists
This table contains IPv6 blacklist information.

XML structure
<ATK>
<Blacklist>

23
 <IPv6Blacklists>
<Item>
<VrfIndex></VrfIndex>
<Ipv6Address></Ipv6Address>
<TTL></TTL>
</Item>
</IPv6Blacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6Blacklists
Table type Multi-instance table
Row name Item
Restrictions None.
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name
description type restrictions
Unsigned integer, 0
VrfIndex Vrf index Index
represents public vrf.
IPv6 blacklist
Ipv6Address Index IPv6 address.
address
Unsigned integer, unit
TTL Time to live N/A second, value range: 60 to
604800 second.

ATK/Blacklist/IPv4DstBlacklists
This table contains IPv4 destination blacklist information.

XML structure
<ATK>
<Blacklist>
<IPv4DstBlacklists>
<Item>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>

24
 <AgingTime></AgingTime>
</Item>
</IPv4DstBlacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4DstBlacklists
Table type Multi-instance table
Row name Item
Restrictions None.
Support for row creation and deletion Yes

Columns
Column Colu
Column
descriptio mn Data type and restrictions Remarks
name
n type
Unsigned integer, 0 represents
VrfIndex Vpn index Index N/A
public vrf.
IPv4
Ipv4Address blacklist Index IPv4 address. N/A
address
Unsigned integer, unit second,
AgingTime Time to live N/A value range: 60 to 604800 N/A
second.

ATK/Blacklist/IPv6DstBlacklists
This table contains IPv6 destination blacklist information.

XML structure
<ATK>
<Blacklist>
<IPv6DstBlacklists>
<Item>
<VrfIndex></VrfIndex>
<Ipv6Address></Ipv6Address>
<AgingTime></AgingTime>
</Item>

25
 </IPv6DstBlacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6DstBlacklists
Table type Multi-instance table
Row name Item
Restrictions None.
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name
description type restrictions
Unsigned integer, 0
VrfIndex Vpn index Index
represents public vrf.
IPv6 blacklist
Ipv6Address Index IPv6 address.
address
Unsigned integer, unit
AgingTime Time to live N/A second, value range: 60 to
604800 second.

ATK/Blacklist/InterfaceSwitches
This table contains blacklist interface switch information.

XML structure
<ATK>
<Blacklist>
<InterfaceSwitches>
<Switch>
<IfIndex></IfIndex>
<Enable></Enable>
</Switch>
</InterfaceSwitches>
</Blacklist>
</ATK>

26
Table description
Item Description
Feature name ATK
Table name InterfaceSwitches
Table type Multi-instance table
Row name Switch
Restrictions None.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
IfIndex Interface index Index Unsigned integer. N/A
Boolean:
Enable Blacklist switch. N/A • true Default is false.
• false

ATK/Blacklist/ZoneSwitches
This table is used to configure the blacklist for a security zone.

XML structure
<ATK>
<Blacklist>
<ZoneSwitches>
<Switch>
<ZoneID></ZoneID>
<Enable></Enable>
</Switch>
</ZoneSwitches>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name ZoneSwitches
Table type Multi-instance table
Row name Switch

27
 Item Description
Restrictions None
Support for row creation and deletion No

Columns
Column Column
Column name Data type and restrictions
description type
ZoneID Security zone ID Index Unsigned integer.

Whether to Boolean:
Enable enable the N/A • true—Enables the blacklist.
blacklist • false—Disables the blacklist (default).

ATK/Blacklist/GlobalConfigs
This table contains blacklist global configuration information.

XML structure
<ATK>
<Blacklist>
<GlobalConfigs>
<Enable></Enable>
<Log></Log>
</GlobalConfigs>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name GlobalConfigs
Table type Single-instance table
Row name N/A
Restrictions None.
Support for row creation and deletion No

28
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Boolean:
Enable Global switch. N/A • true Default is false.
• false
Boolean:
Log Log switch N/A • true Default is false.
• false

ATK/Whitelist/IPv4ObjItems
This table contains IPv4 whitelist information.

XML structure
<ATK>
<Whitelist>
<IPv4ObjItems>
<Item>
<ObjGrpName></ObjGrpName>
</Item>
</IPv4ObjItems>
</Whitelist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4ObjItems
Table type Multi-instance table
Row name Item
Restrictions None
Support for row creation and deletion Yes

Columns
Colu
Column Data type and
Column description mn Remarks
name restrictions
type
ObjGrpName Object group IP Name Index String, case insensitive. N/A

29
 Colu
Column Data type and
Column description mn Remarks
name restrictions
type
Length: 1 to 31 characters.

ATK/Whitelist/IPv6ObjItems
This table contains IPv6 whitelist information.

XML structure
<ATK>
<Whitelist>
<IPv6ObjItems>
<Item>
<ObjGrpName></ObjGrpName>
</Item>
</IPv6ObjItems>
</Whitelist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6ObjItems
Table type Multi-instance table
Row name Item
Restrictions None
Support for row creation and deletion Yes

Columns
Column Colu
Column
descripti mn Data type and restrictions Remarks
name
on type
Object String, case insensitive.
ObjGrpName group IPv6 Index N/A
Name Length: 1 to 31 characters.

30
ATK/Whitelist/InterfaceSwitches
This table is used to configure the whitelist for an interface.

XML structure
<ATK>
<Whitelist>
<InterfaceSwitches>
<Switch>
<IfIndex></IfIndex>
<Enable></Enable>
</Switch>
</InterfaceSwitches>
</Whitelist>
</ATK>

Table description
Item Description
Feature name ATK
Table name InterfaceSwitches
Table type Multi-instance table
Row name Switch
Restrictions None
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions
support interface
name. For
relevant
information, see
the XSD
document of your
product. For
IfIndex Interface index Index Unsigned integer.
information
about IfIndex,
see “Appendix”
in Ifmgr
NETCONF XML
API
Configuration
Reference.
Enable Enable or disable N/A Boolean: Default is false.

31
 Column Column Data type and
Column name Remarks
description type restrictions
the whitelist • true
function • false

ATK/Whitelist/ZoneSwitches
This table is used to configure the whitelist for a security zone.

XML structure
<ATK>
<Whitelist>
<ZoneSwitches>
<Switch>
<ZoneID></ZoneID>
<Enable></Enable>
</Switch>
</ZoneSwitches>
</Whitelist>
</ATK>

Table description
Item Description
Feature name ATK
Table name ZoneSwitches
Table type Multi-instance table
Row name Switch
Restrictions None
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
ZoneID Security zone ID Index Unsigned integer. N/A
Boolean:
Enable or disable
Enable
the whitelist
N/A • true Default is false.
• false

32
ATK/Whitelist/GlobalSwitches
This table contains whitelist global switch information.

XML structure
<ATK>
<Whitelist>
<GlobalSwitches>
<Enable></Enable>
</GlobalSwitches>
</Whitelist>
</ATK>

Table description
Item Description
Feature name ATK
Table name GlobalSwitches
Table type Single-instance table
Row name N/A
Restrictions None
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Enable or disable Boolean:
Enable the global N/A • true Default is false.
configuration. • false

ATK/ClientVerify/Switches
This table contains client verification switch information.

XML structure
<ATK>
<ClientVerify>
<Switches>
<Switch>
<IfIndex></IfIndex>

33
 <VerifyType></VerifyType>
<VerifyMode></VerifyMode>
</Switch>
</Switches>
</ClientVerify>
</ATK>

Table description
Item Description
Feature name ATK
Table name Switches
Table type Multi-instance table
Row name Switch
Restrictions None.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name
description type restrictions
IfIndex Interface index Index Unsigned integer.
Enumeration:
• 0—TCP proxy
• 1—DNS client
verification.
VerifyType Verification type Index • 2—HTTP client
verification.
• 3—DNS reply
verification.
• 4—SIP client
verification.
Enumeration, value range
varies according to
MainType.

For TCP proxy:

• 0—Shutdown.
• 1—SYN cookie.
VerifyMode Verification mode N/A • 2—Safe reset.

For DNS client verification:

• 0—Shutdown.
• 1—Truncate.

For HTTP client

verification:

34
 Column Column Data type and
Column name
description type restrictions
• 0—Shutdown.
• 1—Redirection.

For DNS reply verification:

• 0—DNS request.

For SIP client verification:

• 0—Shutdown.
• 1—Redirection.

ATK/ClientVerify/ZoneSwitches
This table is used to configure client verification for a security zone.

XML structure
<ATK>
<ClientVerify>
<ZoneSwitches>
<Switch>
<ZoneID></ZoneID>
<VerifyType></VerifyType>
<VerifyMode></VerifyMode>
</Switch>
</ZoneSwitches>
</ClientVerify>
</ATK>

Table description
Item Description
Feature name ATK
Table name ZoneSwitches
Table type Multi-instance table
Row name Switch
Restrictions None
Support for row creation and deletion No

35
Columns
Column Column
Column name Data type and restrictions
description type
ZoneID Security zone ID Index Unsigned integer.

Enumeration:
• 0—TCP proxy.
• 1—DNS client verification.
VerifyType Verification type Index
• 2—HTTP client verification.
• 3—DNS reply verification.
• 4—SIP client verification.
Enumeration:
For TCP proxy:
• 0—Shutdown.
• 1—SYN cookie.
• 2—Safe reset.
For DNS client verification:
• 0—Shutdown.
• 1—Truncation.
VerifyMode Verification mode N/A
For HTTP client verification:
• 0—Shutdown.
• 1—Redirection.
For DNS reply verification:
• 0—DNS request.
For SIP client verification:
• 0—Shutdown.
• 1—Redirection.

ATK/ClientVerify/IPv4ProtectHosts
This table contains IPv4 client verification protect hosts information.

XML structure
<ATK>
<ClientVerify>
<IPv4ProtectHosts>
<Host>
<VerifyType></VerifyType>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<PortNumber></PortNumber>
</Host>
</IPv4ProtectHosts>
</ClientVerify>
</ATK>

36
Table description
Item Description
Feature name ATK
Table name IPv4ProtectHosts
Table type Multi-instance table
Row name Host
Restrictions None.
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Enumeration:
• 0—TCP proxy
• 1—DNS client
verification.
VerifyType Verification type Index • 2—HTTP client N/A
verification.
• 3—DNS reply
verification.
• 4—SIP client
verification.
Unsigned integer, 0
VrfIndex Vrf index Index N/A
represents public vrf.
Ipv4Address Host address Index IPv4 address. N/A
For TCP proxy,
port number 0 is
Unsigned integer. The available which
value range varies by means that any
verification type. hosts connected
to any service
For TCP proxy: port will be
PortNumber Port number Index
0-65535 monitored. For
For DNS, HTTP, DNS reply DNS, HTTP,
and SIP client verification: DNS reply and
SIP client
1-65535 verification, port
number 0 is
unavailable.

ATK/ClientVerify/IPv6ProtectHosts
This table contains IPv6 client verification protect hosts information.

37
XML structure
<ATK>
<ClientVerify>
<IPv6ProtectHosts>
<Host>
<VerifyType></VerifyType>
<VrfIndex></VrfIndex>
<Ipv6Address></Ipv6Address>
<PortNumber></PortNumber>
</Host>
</IPv6ProtectHosts>
</ClientVerify>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6ProtectHosts
Table type Multi-instance table
Row name Host
Restrictions None.
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Enumeration:
• 0—TCP proxy
• 1—DNS client
verification.
VerifyType Verification type Index • 2—HTTP client N/A
verification.
• 3—DNS reply
verification.
• 4—SIP client
verification.
Unsigned integer, 0
VrfIndex Vrf index Index N/A
represents public vrf.
Ipv6Address Host address Index IPv6 address. N/A

Unsigned integer. The Zero can be set

value range varies by only when TCP
PortNumber Port number Index verification type. proxy is
specified, which
For TCP proxy: means detect all

38
 Column Column Data type and
Column name Remarks
description type restrictions
0-65535 service ports.
For DNS, HTTP, DNS reply
and SIP client verification:
1-65535

ATK/TopStatisticsSwitch
This table contains ATK top statistics switch configuration.

XML structure
<ATK>
<TopStatisticsSwitch>
<Enable></Enable>
</TopStatisticsSwitch>
</ATK>

Table description
Item Description
Feature name ATK
Table name TopStatisticsSwitch
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Data type and
Column type Remarks
name description restrictions
Whether enable Boolean:
Enable ATK top statistics N/A • true—YES N/A
function • false—NO

39
Contents
ATK·······························································································1
ATK/Policies ····························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ATK/PolicyInterfaces ·················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
ATK/PolicyZoneApplies ··············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
ATK/PolicyZones ······················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
ATK/PolicyApplies ······················································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
ATK/PolicyLocal ························································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
ATK/IPv4Exempts ······················································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6
ATK/IPv6Exempts ······················································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 7
Columns ···························································································································· 7
ATK/InterfaceAttackStatistics········································································································ 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8
ATK/ZoneAttackStatistics ·········································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 10
Columns ·························································································································· 11
ATK/LocalAttackStatistics ·········································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 13
Columns ·························································································································· 13
ATK/Scan/Policies ··················································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 16
Columns ·························································································································· 16
ATK/Flood/DefaultConfigs·········································································································· 18
XML structure ··················································································································· 18
Table description ··············································································································· 18
Columns ·························································································································· 18
ATK/Flood/IPv4ProtectHosts ······································································································ 20
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 21

i
ATK/Flood/IPv6ProtectHosts ······································································································ 22
XML structure ··················································································································· 22
Table description ··············································································································· 23
Columns ·························································································································· 23
ATK/Flood/LearnItems ·············································································································· 24
XML structure ··················································································································· 24
Table description ··············································································································· 25
Columns ·························································································································· 25
ATK/Flood/FlowResults ············································································································· 25
XML structure ··················································································································· 26
Table description ··············································································································· 26
Columns ·························································································································· 26
ATK/Signature/Detects ·············································································································· 27
XML structure ··················································································································· 28
Table description ··············································································································· 28
Columns ·························································································································· 28
ATK/Signature/LargeICMPLength································································································ 31
XML structure ··················································································································· 31
Table description ··············································································································· 31
Columns ·························································································································· 32
ATK/Signature/LevelActions ······································································································· 32
XML structure ··················································································································· 32
Table description ··············································································································· 32
Columns ·························································································································· 33
ATK/Signature/LogAggregate ····································································································· 33
XML structure ··················································································································· 33
Table description ··············································································································· 33
Columns ·························································································································· 34
ATK/Blacklist/IPv4Blacklists ······································································································· 34
XML structure ··················································································································· 34
Table description ··············································································································· 34
Columns ·························································································································· 35
ATK/Blacklist/IPv6Blacklists ······································································································· 35
XML structure ··················································································································· 35
Table description ··············································································································· 36
Columns ·························································································································· 36
ATK/Blacklist/IPv4DstBlacklists ··································································································· 36
XML structure ··················································································································· 37
Table description ··············································································································· 37
Columns ·························································································································· 37
ATK/Blacklist/IPv6DstBlacklists ··································································································· 38
XML structure ··················································································································· 38
Table description ··············································································································· 38
Columns ·························································································································· 39
ATK/Blacklist/InterfaceSwitches ·································································································· 39
XML structure ··················································································································· 39
Table description ··············································································································· 40
Columns ·························································································································· 40
ATK/Blacklist/ZoneSwitches ······································································································· 40
XML structure ··················································································································· 40
Table description ··············································································································· 40
Columns ·························································································································· 41
ATK/Blacklist/GlobalConfigs ······································································································· 41
XML structure ··················································································································· 41
Table description ··············································································································· 41
Columns ·························································································································· 41
ATK/Whitelist/IPv4ObjItems ······································································································· 42
XML structure ··················································································································· 42
Table description ··············································································································· 42
Columns ·························································································································· 42
ATK/Whitelist/IPv6ObjItems ······································································································· 42
XML structure ··················································································································· 43

ii
 Table description ··············································································································· 43
Columns ·························································································································· 43
ATK/Whitelist/InterfaceSwitches ·································································································· 43
XML structure ··················································································································· 43
Table description ··············································································································· 44
Columns ·························································································································· 44
ATK/Whitelist/ZoneSwitches······································································································· 44
XML structure ··················································································································· 44
Table description ··············································································································· 45
Columns ·························································································································· 45
ATK/Whitelist/GlobalSwitches ····································································································· 45
XML structure ··················································································································· 45
Table description ··············································································································· 45
Columns ·························································································································· 46
ATK/ClientVerify/Switches ········································································································· 46
XML structure ··················································································································· 46
Table description ··············································································································· 46
Columns ·························································································································· 47
ATK/ClientVerify/ZoneSwitches··································································································· 47
XML structure ··················································································································· 47
Table description ··············································································································· 48
Columns ·························································································································· 48
ATK/ClientVerify/IPv4ProtectHosts ······························································································ 49
XML structure ··················································································································· 49
Table description ··············································································································· 49
Columns ·························································································································· 50
ATK/ClientVerify/IPv6ProtectHosts ······························································································ 50
XML structure ··················································································································· 51
Table description ··············································································································· 51
Columns ·························································································································· 51
ATK/ClientVerify/IPv4TrustClients ······························································································· 52
XML structure ··················································································································· 52
Table description ··············································································································· 53
Columns ·························································································································· 53
ATK/ClientVerify/IPv6TrustClients ······························································································· 54
XML structure ··················································································································· 54
Table description ··············································································································· 54
Columns ·························································································································· 54
ATK/Specification····················································································································· 55
XML structure ··················································································································· 55
Table description ··············································································································· 55
Columns ·························································································································· 55
ATK/TopStatisticsSwitch············································································································ 56
XML structure ··················································································································· 56
Table description ··············································································································· 56
Columns ·························································································································· 56
ATK/TopStatisticsSampleTime···································································································· 56
XML structure ··················································································································· 57
Table description ··············································································································· 57
Columns ·························································································································· 57
ATK/TopAttackStatisticsByIP ······································································································ 57
XML structure ··················································································································· 58
Table description ··············································································································· 58
Columns ·························································································································· 58
ATK/TopAttackStatisticsByType ·································································································· 59
XML structure ··················································································································· 59
Table description ··············································································································· 59
Columns ·························································································································· 60
ATK/ScanAttackTypes ·············································································································· 60
XML structure ··················································································································· 61
Table description ··············································································································· 61
Columns ·························································································································· 61

iii
ATK/FloodAttackTypes·············································································································· 61
XML structure ··················································································································· 61
Table description ··············································································································· 62
Columns ·························································································································· 62
ATK/SignatureAttackTypes ········································································································ 62
XML structure ··················································································································· 62
Table description ··············································································································· 62
Columns ·························································································································· 63
ATK/BlacklistTypes ·················································································································· 63
XML structure ··················································································································· 63
Table description ··············································································································· 63
Columns ·························································································································· 63

iv
ATK
ATK/Policies
This table is used to operate ATK policies.

XML structure
<ATK>
<Policies>
<Policy>
<PolicyName></PolicyName>
</Policy>
</Policies>
</ATK>

Table description
Item Description
Feature name ATK
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.

ATK/PolicyInterfaces
This table is used to operate ATK policy appliances on interfaces.

XML structure
<ATK>
<PolicyInterfaces>
<Apply>

1
 <IfIndex></IfIndex>
<PolicyName></PolicyName>
</Apply>
</PolicyInterfaces>
</ATK>

Table description
Item Description
Feature name ATK
Table name PolicyInterfaces
Table type Multi-instance table
Row name Apply
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
IfIndex Interface index Index Unsigned integer. N/A

Name of Attack String.

PolicyName N/A Case insensitive
Defense policy Length: 1 to 31 characters.

ATK/PolicyZoneApplies
This table contains information about the application of an attack defense policy to security zones.

XML structure
<ATK>
<PolicyZoneApplies>
<Apply>
<PolicyName></PolicyName>
<ZoneID></ZoneID>
</Apply>
</PolicyZoneApplies>
</ATK>

Table description
Item Description
Feature name ATK
Table name PolicyZoneApplies

2
 Item Description
Table type Multi-instance table
Row name Apply
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Case insensitive.
Valid characters
Attack defense String. include letters,
PolicyName Index
policy name Length: 1 to 31 characters. digits,
underscores (_),
and hyphens (-).

ZoneID Security zone ID Index Unsigned integer. N/A

ATK/PolicyZones
This table contains information about the attack defense policy applied to a security zone.

XML structure
<ATK>
<PolicyZones>
<Apply>
<ZoneID></ZoneID>
<PolicyName></PolicyName>
</Apply>
</PolicyZones>
</ATK>

Table description
Item Description
Feature name ATK
Table name PolicyZones
Table type Multi-instance table
Row name Apply
Restrictions None

3
Columns
Column Column Data type and
Column name Remarks
description type restrictions
ZoneID Security zone ID Index Unsigned integer. N/A
Case insensitive.
Valid characters
Attack defense String. include letters,
PolicyName N/A
policy name Length: 1 to 31 characters. digits,
underscores (_),
and hyphens (-).

ATK/PolicyApplies
This table is used to operate ATK policy appliances on interfaces.

XML structure
<ATK>
<PolicyApplies>
<Entity>
<PolicyName></PolicyName>
<IfIndex></IfIndex>
</Entity>
</PolicyApplies>
</ATK>

Table description
Item Description
Feature name ATK
Table name PolicyApplies
Table type Multi-instance table
Row name Entity
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
IfIndex Interface index Index Unsigned integer. N/A

4
ATK/PolicyLocal
This table is used to operate local ATK policy appliance.

XML structure
<ATK>
<PolicyLocal>
<PolicyName></PolicyName>
</PolicyLocal>
</ATK>

Table description
Item Description
Feature name ATK
Table name PolicyLocal
Table type Single-instance table
Row name N/A
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName N/A Case insensitive
Defense policy Length: 1 to 31 characters.

ATK/IPv4Exempts
This table contains IPv4 exemption information

XML structure
<ATK>
<IPv4Exempts>
<Exempt>
<PolicyName></PolicyName>
<AclNum></AclNum>
<AclName></AclName>

5
 </Exempt>
</IPv4Exempts>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4Exempts
Table type Multi-instance table
Row name Exempt
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
AclNum and
AclName are
Unsigned integer. mutual exclusive
AclNum Acl number N/A and only one of
Value range: 2000 to 3999 them can be set
in a single
message.
AclNum and
AclName are
String. mutual exclusive
AclName Acl name N/A and only one of
Length: 1 to 63 characters. them can be set
in a single
message.

ATK/IPv6Exempts
This table contains IPv6 exemption information

XML structure
<ATK>
<IPv6Exempts>
<Exempt>
<PolicyName></PolicyName>
<AclNum></AclNum>
<AclName></AclName>

6
 </Exempt>
</IPv6Exempts>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6Exempts
Table type Multi-instance table
Row name Exempt
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
AclNum and
AclName are
Unsigned integer. mutual exclusive
AclNum Acl number N/A and only one of
Value range: 2000 to 3999 them can be set
in a single
message.
AclNum and
AclName are
String. mutual exclusive
AclName Acl name N/A and only one of
Length: 1 to 63 characters. them can be set
in a single
message.

ATK/InterfaceAttackStatistics
This table contains interface attack statistics.

XML structure
<ATK>
<InterfaceAttackStatistics>
<Statistics>
<IfIndex></IfIndex>
<Chassis></Chassis>
<Slot></Slot>

7
 <CPUID></CPUID>
<MainType></MainType>
<SubType></SubType>
<AtkTimes></AtkTimes>
<DropCnt></DropCnt>
</Statistics>
</InterfaceAttackStatistics>
</ATK>

Table description
Item Description
Feature name ATK
Table name InterfaceAttackStatistics
Table type Multi-instance table
Row name Statistics
Restrictions None.

Columns
Column Column
Column name Data type and restrictions
description type
IfIndex Interface index Index Unsigned integer.
ID of the member Unsigned integer.
Chassis where the Index
interface resides Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot Index
interface Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index
Value range: 0 to 7.
Enumeration:
• 0—Scan.
• 1—Transport layer flood.
• 2—Application layer flood.
• 3—Named single packet attack.
Maintype Main attack type Index • 4—IP option single packet attack.
• 5—ICMP single packet attack.
• 6—ICMPv6 single packet attack.
• 7—IPv6 extend header attack.
• 8—IPv6 extend header abnormal attack.
• 9—IPv6 extend header exceed attack.
Enumeration, value range varies according to
MainType.
SubType Sub attack type Index

For scan:

8
 Column Column
Column name Data type and restrictions
description type
• 0—Port scan.
• 1—IP sweep.
• 2—Distributed IP sweep.

For transport layer flood:

• 0—SYN flood.
• 1—ACK flood.
• 2—SYN-ACK flood.
• 3—RESET flood.
• 4—FIN flood.
• 5—UDP flood.
• 6—ICMP flood.
• 7—ICMPv6 flood.

For application layer flood:

• 0—DNS flood.
• 1—HTTP flood.
• 2—DNS reply flood.
• 3—SIP flood.

For named single packet attack:

• 0—IP fragment.
• 1—IP impossible.
• 2—Teardrop
• 3—Tiny fragment
• 4—Abnormal
• 5—Smurf
• 6—Trace route
• 7—Ping of death
• 8—Large ICMP
• 9—Large ICMPv6
• 10—TCP invalid flags
• 11—TCP null flag
• 12—TCP all flags
• 13—TCP SYN FIN flags
• 14—TCP FIN only
• 15—Land
• 16—Winnuke
• 17—UDP bomb
• 18—Snork
• 19—Fraggle

For IP option single packet attack, SubType is

the IP option value, range: 0 to 255.

For ICMP single packet attack, SubType is the

ICMP type value, range: 0 to 255.

For ICMPv6 single packet attack, SubType is

9
 Column Column
Column name Data type and restrictions
description type
the ICMPv6 type value, range: 0 to 255.

For IPv6 extend header single packet attack,

SubType is the header type value, range: 0 to
255.

For IPv6 extend header abnormal attack,

SubType is not needed.

For IPv6 extend header exceed attack,

SubType is the maximum number of extension
headers.
Value range: 0 to 7.
AtkTimes Attack times N/A Unsigned integer.
Dropped packet
DropCnt N/A Unsigned integer.
count

ATK/ZoneAttackStatistics
This table contains attack statistics for a security zone.

XML structure
<ATK>
<ZoneAttackStatistics>
<Statistics>
<ZoneID></ZoneID>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<MainType></MainType>
<SubType></SubType>
<AtkTimes></AtkTimes>
<DropCnt></DropCnt>
</Statistics>
</ZoneAttackStatistics>
</ATK>

Table description
Item Description
Feature name ATK
Table name ZoneAttackStatistics
Table type Multi-instance table
Row name Statistics

10
 Item Description
Restrictions None

Columns
Column Column
Column name Data type and restrictions
description type
ZoneID Security zone ID Index Unsigned integer.
Unsigned integer.
Chassis Chassis ID Index
Value range: 0 to 65535.
Unsigned integer.
Slot Slot ID Index
Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index
Value range: 0 to 7.
Enumeration:
• 0—Scan attack.
• 1—Transport layer flood.
• 2—Application layer flood.
• 3—Named single-packet attack.
Maintype Main attack type Index • 4—IP option single-packet attack.
• 5—ICMP single-packet attack.
• 6—ICMPv6 single-packet attack.
• 7—IPv6 extension header single-packet
attack.
• 8—IPv6 extend header abnormal attack.
• 9—IPv6 extend header exceed attack.
Enumeration:
• For scan attacks:
 0—Port scan.
 1—IP sweep.
 2—Distributed IP sweep.
• For transport layer floods:
 0—SYN flood.
 1—ACK flood.
 2—SYN-ACK flood.
 3—RST flood.
 4—FIN flood.
SubType Attack subtype Index
 5—UDP flood.
 6—ICMP flood.
 7—ICMPv6 flood.
• For application layer floods:
 0—DNS flood.
 1—HTTP flood.
 2—DNS reply flood.
 3—SIP flood.
• For named single-packet attacks:
 0—IP fragment attack.
 1—IP impossible attack.

11
 Column Column
Column name Data type and restrictions
description type
 2—Teardrop attack.
 3—Tiny fragment attack.
 4—IP-option-abnormal attack.
 5—Smurf attack.
 6—Traceroute attack.
 7—Ping-of-death attack.
 8—Large ICMP attack.
 9—Large ICMPv6 attack.
 10—TCP-invalid-flags attack.
 11—TCP-null-flag attack.
 12—TCP-all-flags attack.
 13—TCP-SYN-FIN attack.
 14—TCP-FIN-only attack.
 15—Land attack.
 16—WinNuke attack.
 17—UDP bomb attack.
 18—Snork attack.
 19—Fraggle attack.
• For IP option single-packet attacks, a
subtype is an IP option value in the range
of 0 to 255.
• For ICMP single-packet attacks, a subtype
is an ICMP type value in the range of 0 to
255.
• For ICMPv6 single-packet attacks, a
subtype is an ICMPv6 type value in the
range of 0 to 255.
• For IPv6 extension header single-packet
attacks, a subtype is an IPv6 extension
header type value in the range of 0 to 255.
• For IPv6 extend header abnormal attack,
SubType is not needed.
• For IPv6 extend header exceed attack,
SubType is the maximum number of
extension headers. Value range: 0 to 7.
Number of times
AtkTimes that the attack N/A Unsigned integer.
occurred

Number of
DropCnt N/A Unsigned integer.
dropped packets

ATK/LocalAttackStatistics
This table contains local attack statistics.

XML structure
<ATK>
<LocalAttackStatistics>

12
 <Statistics>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<MainType></MainType>
<SubType></SubType>
<AtkTimes></AtkTimes>
<DropCnt></DropCnt>
</Statistics>
</LocalAttackStatistics>
</ATK>

Table description
Item Description
Feature name ATK
Table name LocalAttackStatistics
Table type Multi-instance table
Row name Statistics
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
ID of the member Unsigned integer.
Chassis where the entity Index
resides Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot Index
entity Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index
Value range: 0 to 7.
Enumeration:
• 0—Scan.
• 1—Transport layer
flood.
• 2—Application layer
flood.
• 3—Named single
Maintype Main attack type Index packet attack.
• 4—IP option single
packet attack.
• 5—ICMP single
packet attack.
• 6—ICMPv6 single
packet attack.
• 7—IPv6 extend

13
 Column Column Data type and
Column name
description type restrictions
header attack.
• 8—IPv6 extend
header abnormal
attack.
• 9—IPv6 extend
header exceed attack.
Enumeration, value range
varies according to
MainType.

For scan:
• 0—Port scan.
• 1—IP sweep.
• 2—Distributed IP
sweep.

For transport layer flood:

• 0—SYN flood.
• 1—ACK flood.
• 2—SYN-ACK flood.
• 3—RESET flood.
• 4—FIN flood.
• 5—UDP flood.
• 6—ICMP flood.
• 7—ICMPv6 flood.

For application layer flood:

SubType Sub attack type Index • 0—DNS flood.
• 1—HTTP flood.
• 2—DNS reply flood.
• 3—SIP flood.

For named single packet

attack:
• 0—IP fragment.
• 1—IP impossible.
• 2—Teardrop
• 3—Tiny fragment
• 4—Abnormal
• 5—Smurf
• 6—Trace route
• 7—Ping of death
• 8—Large ICMP
• 9—Large ICMPv6
• 10—TCP invalid flags
• 11—TCP null flag
• 12—TCP all flags
• 13—TCP SYN FIN
flags
• 14—TCP FIN only

14
 Column Column Data type and
Column name
description type restrictions
• 15—Land
• 16—Winnuke
• 17—UDP bomb
• 18—Snork
• 19—Fraggle

For IP option single packet

attack, SubType is the IP
option value, range: 0 to
255.

For ICMP single packet

attack, SubType is the
ICMP type value, range: 0
to 255.

For ICMPv6 single packet

attack, SubType is the
ICMPv6 type value, range:
0 to 255.

For IPv6 extend header

single packet attack,
SubType is the header type
value, range: 0 to 255.

For IPv6 extend header

abnormal attack, SubType
is not needed.

For IPv6 extend header

exceed attack, SubType is
the maximum number of
extension headers.
Value range: 0 to 7.
AtkTimes Attack times N/A Unsigned integer.
Dropped packet
DropCnt N/A Unsigned integer.
count

ATK/Scan/Policies
This table contains scan policy information.

XML structure
<ATK>
<Scan>
<Policies>

15
 <Policy>
<PolicyName></PolicyName>
<Level></Level>
</UserDefinedCfg>
<PortScanEnable></PortScanEnable>
<PortScanThreshold></PortScanThreshold>
<IPSweepEnable></IPSweepEnable>
<IPSweepThreshold></IPSweepThreshold>
<Period></Period>
</UserDefinedCfg>
<Log></Log>
<Drop></Drop>
<BlockSource>
<Enable></Enable>
<BlockTime></BlockTime>
</BlockSource>
</Policy>
</Policies>
</Scan>
</ATK>

Table description
Item Description
Feature name ATK
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String,case-insensitive.
PolicyName Index N/A
Defense policy Length: 1 to 31 characters.
Enumeration:
• 0—Don’t detect. UserDefinedCfg
• 1—Low sensibility. and its members
Level Scan detect level N/A • 2—Middle sensibility. are available
only in scan
• 3—High sensibility.
detect level 4.
• 4—User defined
sensibility.

Custom scan Data Members include:

UserDefinedCfg N/A
detection struct • PortScanEnable

16
 Column Column Data type and
Column name Remarks
description type restrictions
configuration. • PortScanThreshold
• IPSweepEnable
• IPSweepThreshold
• Period

Port scan Boolean:

detection
PortScanEnable N/A • true. N/A
switch. • false.

Signed integer. Value must be

Port scan
set if
PortScanThreshold detection N/A
Value range: 1 to PortScanEnable
threshold.
1000000000 pps. is true.

Boolean:
IP sweep
IPSweepEnable
detection switch.
N/A • true. N/A
• false.

Signed integer. Value must be

IP sweep
set if
IPSweepThreshold detection N/A
Value range: 1 to IPSweepEnable is
threshold.
1000000000 pps. true.

Signed integer.
Period Detection cycle N/A N/A
Value range: 1 to
1000000000 seconds.
Boolean:
Log Log switch N/A • true N/A
• false
Drop and
BlockSource are
Boolean: mutually
Drop packet
Drop
switch
N/A • true exclusive and
• false only one of them
can be set in a
single message.
Drop and
BlockSource are
Members include: mutually
Block source Data
BlockSource
configs struct • Enable exclusive and
• BlockTime only one of them
can be set in a
single message.
Boolean:
Block source
Enable
switch.
N/A • true N/A
• false
When and only
Source block Unsigned integer, value when Enable is
BlockTime N/A
duration. range 1 to 1000 minutes. true, this column
is useful.

17
ATK/Flood/DefaultConfigs
This table contains flood default configurations.

XML structure
<ATK>
<Flood>
<DefaultConfigs>
<Config>
<PolicyName></PolicyName>
<MainType></MainType>
<SubType></SubType>
<Log></Log>
<Drop></Drop>
<ClientVerify></ClientVerify>
<Threshold></Threshold>
<MonitorPort></MonitorPort>
<NonSpecificSwitch></NonSpecificSwitch>
</Config>
</DefaultConfigs>
</Flood>
</ATK>

Table description
Item Description
Feature name ATK
Table name DefaultConfigs
Table type Multi-instance table
Row name Config
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
String.
Name of Attack
PolicyName Index Length: 1 to 31 Case insensitive
Defense policy
characters.
Enumeration:
Maintype Main flood type Index • 0—Transpor N/A
t layer flood.

18
 Column Column Data type and
Column name Remarks
description type restrictions
• 1—Applicati
on layer
flood.
Enumeration,
value range
varies according
to MainType.

For transport
layer flood:
• 0—SYN
flood.
• 1—ACK
flood.
• 2—SYN-AC
K flood.
• 3—RESET
flood.
• 4—FIN
flood.
SubType Sub flood type Index N/A
• 5—UDP
flood.
• 6—ICMP
flood.
• 7—ICMPv6
flood.

For application
layer flood:
• 0—DNS
flood.
• 1—HTTP
flood.
• 2—DNS
reply flood.
• 3—SIP
flood.
Boolean:
Log Log switch N/A • true Default is false.
• false
Boolean:
Drop packet
Drop
switch
N/A • true Default is false.
• false
Boolean:
Client verification
ClientVerify
switch
N/A • true Default is false.
• false
Signed integer,
Flood detect
Threshold N/A value range: 1 to N/A
threshold
1000000 pps.
Port range string,
Monitor service Support Application layer
MonitorPort N/A port value range:
port range only for now.
1 to 65535.

19
 Column Column Data type and
Column name Remarks
description type restrictions
For http flood, default
monitored port is 80.
For DNS flood, default
monitored port is 53.
For DNS reply flood,
default monitored port is
53.
For SIP flood, default
monitored port is 5060.
At most specify a
maximum of 32 port items.

Non specific Boolean: Default value is false which

NonSpecificSwitch protect hosts N/A • true means only detect protect
detect switch • false hosts.

ATK/Flood/IPv4ProtectHosts
This table contains IPv4 flood protect hosts information.

XML structure
<ATK>
<Flood>
<IPv4ProtectHosts>
<Host>
<PolicyName></PolicyName>
<MainType></MainType>
<SubType></SubType>
<VrfName></VrfName>
<Ipv4Address></Ipv4Address>
<Threshold></Threshold>
<Log></Log>
<Drop></Drop>
<ClientVerify></ClientVerify>
<MonitorPort></MonitorPort>
</Host>
</IPv4ProtectHosts>
</Flood>
</ATK>

Table description
Item Description
Feature name ATK

20
 Item Description
Table name IPv4ProtectHosts
Table type Multi-instance table
Row name Host
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
Enumeration:
• 0—Transport layer
Maintype Main flood type Index flood. N/A
• 1—Application layer
flood.
Enumeration, value range
varies according to
MainType.

For transport layer flood:

• 0—SYN flood.
• 1—ACK flood.
• 2—SYN-ACK flood.
• 3—RESET flood.
SubType Sub flood type Index • 4—FIN flood. N/A
• 5—UDP flood.
• 6—ICMP flood.
• 7—ICMPv6 flood.

For application layer flood:

• 0—DNS flood.
• 1—HTTP flood.
• 2—DNS reply flood.
• 3—SIP flood.
Case sensitive,
String. empty
VrfName Vrf name Index
Length: 0 to 31 characters. represents public
vrf.
IPv4 protected
Ipv4Address Index IPv4 address. N/A
host address
Flood detect Signed integer, value
Threshold N/A N/A
threshold range: 1 to 1000000 pps.

Boolean: No default value.

Should be
Log Log switch N/A • true
configured along
• false with drop and

21
 Column Column Data type and
Column name Remarks
description type restrictions
clientverify
column.
No default value.
Boolean: Should be
Drop packet configured along
Drop
switch
N/A • true with log and
• false clientverify
column.
No default value.
Boolean: Should be
Client verification
ClientVerify
switch
N/A • true configured along
• false with log and drop
column.
Support
Application layer
Monitor service Port range string, port only for now.
MonitorPort N/A
port range value range: 1 to 65535. At most specify a
maximum of 24
port items.

ATK/Flood/IPv6ProtectHosts
This table contains IPv6 flood protect hosts information.

XML structure
<ATK>
<Flood>
<IPv6ProtectHosts>
<Host>
<PolicyName></PolicyName>
<MainType></MainType>
<SubType></SubType>
<VrfName></VrfName>
<Ipv6Address></Ipv6Address>
<Threshold></Threshold>
<Log></Log>
<Drop></Drop>
<ClientVerify></ClientVerify>
<MonitorPort></MonitorPort>
</Host>
</IPv6ProtectHosts>
</Flood>
</ATK>

22
Table description
Item Description
Feature name ATK
Table name IPv6ProtectHosts
Table type Multi-instance table
Row name Host
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
Enumeration:
• 0—Transport layer
Maintype Main flood type Index flood. N/A
• 1—Application layer
flood.
Enumeration, value range
varies according to
MainType.

For transport layer flood:

• 0—SYN flood.
• 1—ACK flood.
• 2—SYN-ACK flood.
• 3—RESET flood.
SubType Sub flood type Index • 4—FIN flood. N/A
• 5—UDP flood.
• 6—ICMP flood.
• 7—ICMPv6 flood.

For application layer flood:

• 0—DNS flood.
• 1—HTTP flood.
• 2—DNS reply flood.
• 3—SIP flood.
Case sensitive,
String. empty
VrfName Vrf name Index
Length: 0 to 31 characters. represents public
vrf.
IPv6 protected
Ipv6Address Index IPv6 address. N/A
host address
Flood detect Signed integer, value
Threshold N/A N/A
threshold range: 1 to 1000000 pps.

23
 Column Column Data type and
Column name Remarks
description type restrictions
No default value.
Boolean: Should be
configured along
Log Log switch N/A • true with drop and
• false clientverify
column.
No default value.
Boolean: Should be
Drop packet configured along
Drop
switch
N/A • true with log and
• false clientverify
column.
No default value.
Boolean: Should be
Client verification
ClientVerify
switch
N/A • true configured along
• false with log and drop
column.
Support
Application layer
Monitor service Port range string, port only for now.
MonitorPort N/A
port range value range: 1 to 65535. At most specify a
maximum of 24
port items.

ATK/Flood/LearnItems
This table contains flow threshold learning information.

XML structure
<ATK>
<Flood>
<LearnItems>
<Item>
<PolicyName></PolicyName>
<Status></Status>
<TimeValue></TimeValue>
<Mode></Mode>
<IntervalValue></IntervalValue>
<AutoApply></AutoApply>
<Scope></Scope>
</Item>
</LearnItems>
</Flood>
</ATK>

24
Table description
Item Description
Feature name ATK
Table name LearnItems
Table type Multi-instance table
Row name Item
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of the String, case-insensitive.
PolicyName attack defense Index N/A
policy Length: 1 to 31 characters.

Boolean:
Status Learning switch N/A • true Default is false.
• false
Unsigned integer, value Default is 1440
TimeValue Time value N/A range: 1 to 1200000 minutes.
minutes.
Enumeration:
Mode Learning mode N/A • 0—Single. N/A
• 1—Cycle.
Only when the
Unsigned integer. mode is cycle,
Interval value for
IntervalValue N/A Value range: 1 to 1200000 this column is
cycle mode
minutes. useful. Default is
1440 minutes.
Boolean:
Auto application
AutoApply
switch
N/A • true Default is false.
• false
Only when
Unsigned integer. AutoApply is
Deviation of study
Scope N/A true, this column
result Value range: 0 to 4000. is useful. Default
is 50.

ATK/Flood/FlowResults
This table contains flow threshold learning result information.

25
XML structure
<ATK>
<Flood>
<FlowResults>
<Result>
<PolicyName></PolicyName>
<Status></Status>
<LastResultInterval></LastResultInterval>
<SYN></SYN>
<ACK></ACK>
<SYNACK></SYNACK>
<RST></RST>
<FIN></FIN>
<UDP></UDP>
<ICMP></ICMP>
<ICMPv6></ICMPv6>
<DNS></DNS>
<HTTP></HTTP>
<DNSReply></DNSReply>
<SIP></SIP>
</Result>
</FlowResults>
</Flood>
</ATK>

Table description
Item Description
Feature name ATK
Table name FlowResults
Table type Multi-instance table
Row name Result
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of the String, case-insensitive.
PolicyName attack defense Index N/A
policy Length: 1 to 31 characters.

Enumeration:
Status Learning status N/A • 0—Initialize. N/A
• 1—Stop.

26
 Column Column Data type and
Column name Remarks
description type restrictions
• 2—learning.
Unsigned integer.
Time elapsed
LastResultInterval N/A Value range: 0 to N/A
since last result
4294967295 second.
Unsigned integer.
Learning result of
SYN N/A Value range: 0 to N/A
SYN packets
4294967295 pps.
Unsigned integer.
Learning result of
ACK N/A Value range: 0 to N/A
ACK packets
4294967295 pps.
Unsigned integer.
Learning result of
SYNACK N/A Value range: 0 to N/A
SYNACK packets
4294967295 pps.
Unsigned integer.
Learning result of
RST N/A Value range: 0 to N/A
RST packets
4294967295 pps.
Unsigned integer.
Learning result of
FIN N/A Value range: 0 to N/A
FIN packets
4294967295 pps.
Unsigned integer.
Learning result of
UDP N/A Value range: 0 to N/A
UDP packets
4294967295 pps.
Unsigned integer.
Learning result of
ICMP N/A Value range: 0 to N/A
ICMP packets
4294967295 pps.
Unsigned integer.
Learning result of
ICMPv6 N/A Value range: 0 to N/A
ICMPv6 packets
4294967295 pps.
Unsigned integer.
Learning result of
DNS N/A Value range: 0 to N/A
DNS packets
4294967295 pps.
Unsigned integer.
Learning result of
HTTP N/A Value range: 0 to N/A
HTTP packets
4294967295 pps.

Learning result of Unsigned integer.

DNSReply DNS reply N/A Value range: 0 to N/A
packets 4294967295 pps.
Unsigned integer.
Learning result of
SIP N/A Value range: 0 to N/A
SIP packets
4294967295 pps.

ATK/Signature/Detects
This table contains signature detects’ information.

27
XML structure
<ATK>
<Signature>
<Detects>
<Detect>
<PolicyName></PolicyName>
<MainType></MainType>
<SubType></SubType>
<Log></Log>
<Drop></Drop>
<level></level>
</Detect>
</Detects>
</Signature>
</ATK>

Table description
Item Description
Feature name ATK
Table name Detects
Table type Multi-instance table
Row name Detect
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
Enumeration:
• 0—Named single
packet attack.
• 1—IP option single
packet attack.
• 2—ICMP single
packet attack.
Main signature
Maintype Index • 3—ICMPv6 single N/A
type
packet attack.
• 4—IPv6 extend
header attack.
• 5—IPv6 extend
header abnormal
attack.
• 6—IPv6 extend

28
 Column Column Data type and
Column name Remarks
description type restrictions
header exceed attack.
Enumeration, value range
varies according to
MainType.

For named single packet

attack:
• 0—IP fragment.
• 1—IP impossible.
• 2—Teardrop
• 3—Tiny fragment
• 4—Abnormal
• 5—Smurf
• 6—Trace route
• 7—Ping of death
• 8—Large ICMP
• 9—Large ICMPv6
• 10—TCP invalid flags
• 11—TCP null flag
• 12—TCP all flags
• 13—TCP SYN FIN
flags
• 14—TCP FIN only
• 15—Land
• 16—Winnuke
Sub signature • 17—UDP bomb
SubType Index N/A
type
• 18—Snork
• 19—Fraggle

For IP option single packet

attack, SubType is the IP
option value, range: 0 to
255.
• 7—Record route
option.
• 68—Timestamp
option.
• 130—Security option.
• 131—Loose source
routing option.
• 136—Stream identifier
option.
• 137—Strict source
route option.
• 148—Route alert
option.

For ICMP single packet

attack, SubType is the
ICMP type value, range: 0
to 255.
• 8—ICMP echo

29
 Column Column Data type and
Column name Remarks
description type restrictions
request.
• 0—ICMP echo reply.
• 4—ICMP source
quench.
• 3—ICMP destination
unreachable.
• 5—ICMP redirect.
• 11—ICMP time
exceeded.
• 12—ICMP parameter
problem.
• 13—ICMP timestamp
request.
• 14—ICMP timestamp
reply.
• 15—ICMP information
request.
• 16—ICMP information
reply.
• 17—ICMP address
mask request.
• 18—ICMP address
mask reply.

For ICMPv6 single packet

attack, SubType is the
ICMPv6 type value, range:
0 to 255.
• 128—ICMPv6 echo
request.
• 129—ICMPv6 echo
reply.
• 130—ICMPv6 group
query.
• 131—ICMPv6 group
report.
• 132—ICMPv6 group
reduction.
• 1—ICMPv6
destination
unreachable.
• 3—ICMPv6 time
exceeded.
• 4—ICMPv6 parameter
problem.
• 2—ICMPv6 packet
too big.

For IPv6 extend header

single packet attack,
SubType is the header type
value, range: 0 to 255.

For IPv6 extend header

abnormal attack, SubType

30
 Column Column Data type and
Column name Remarks
description type restrictions
is not needed.

For IPv6 extend header

exceed attack, SubType is
the maximum number of
extension headers.
Value range: 0 to 7.
Boolean:
Log Log switch N/A • true Default is false.
• false
Boolean:
Drop packet
Drop
switch
N/A • true Default is false.
• false
Enumeration:
• 0—Information.
Level Severity level N/A • 1—Low. N/A
• 2—Medium.
• 3—High.

ATK/Signature/LargeICMPLength
This table contains large ICMP and ICMPv6 signature information.

XML structure
<ATK>
<Signature>
<LargeICMPLength>
<Policy>
<PolicyName></PolicyName>
<IPv4Threshold></IPv4Threshold>
<IPv6Threshold></IPv6Threshold>
</Policy>
</LargeICMPLength>
</Signature>
</ATK>

Table description
Item Description
Feature name ATK
Table name LargeICMPLength
Table type Multi-instance table

31
 Item Description
Row name Policy
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
ICMP packet Unsigned integer, value
IPv4Threshold N/A N/A
length threshold range: 28 to 65534 bytes.
ICMPv6 packet Unsigned integer, value
IPv6Threshold N/A N/A
length threshold range: 48 to 65534 bytes.

ATK/Signature/LevelActions
This table contains signature level action information.

XML structure
<ATK>
<Signature>
<LevelActions>
<LevelAction>
<PolicyName></PolicyName>
<Level></Level>
<Log></Log>
<Drop></Drop>
<LevelAction>
</LevelActions>
</Signature>
</ATK>

Table description
Item Description
Feature name ATK
Table name LevelActions
Table type Multi-instance table
Row name LevelAction
Restrictions None.

32
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of Attack String.
PolicyName Index Case insensitive
Defense policy Length: 1 to 31 characters.
Enumeration:
• 0—Information.
Level Severity level Index • 1—Low. N/A
• 2—Medium.
• 3—High.
Boolean:
Default value is
Log Log switch N/A • true true
• false
The default value
varies by severity
level. For
Boolean: information level
Drop packet or low level,
Drop
switch
N/A • true default value is
• false false. For
medium level or
high level default
value is true.

ATK/Signature/LogAggregate
This table contains signature log aggregation information.

XML structure
<ATK>
<Signature>
<LogAggregate>
<Enable></Enable>
</LogAggregate>
</Signature>
</ATK>

Table description
Item Description
Feature name ATK
Table name LogAggregate
Table type Single-instance table
Row name N/A

33
 Item Description
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Boolean:
Log aggregate
Enable
switch.
N/A • true Default is true.
• false

ATK/Blacklist/IPv4Blacklists
This table contains IPv4 blacklist information.

XML structure
<ATK>
<Blacklist>
<IPv4Blacklists>
<Item>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<DSLitePeer></DSLitePeer>
<AddType></AddType>
<TTL></TTL>
<DropCnt></DropCnt>
</Item>
</IPv4Blacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4Blacklists
Table type Multi-instance table
Row name Item
Restrictions None.

34
Columns
Column Column Data type and
Column name Remarks
description type restrictions
ID of the
member where Unsigned integer.
Chassis Index N/A
the blacklist Value range: 0 to 65535.
resides

Slot ID of the Unsigned integer.

Slot Index N/A
blacklist Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index N/A
Value range: 0 to 7.
Unsigned integer, 0
VrfIndex Vrf index Index N/A
represents public vrf.
IPv4 blacklist
Ipv4Address Index IPv4 address. N/A
address
In DS-Lite network, this
parameter refers to B4
DS-Lite tunnel addresses.
DSLitePeer Index IPv6 address.
peer address
Leave it empty in other
circumstances.
Enumeration:
AddType Add type N/A • 0—Manual add. N/A
• 1—Automatic add.
Unsigned integer, unit
TTL Time to live N/A N/A
second.
Dropped packet
DropCnt N/A Unsigned integer. N/A
count

ATK/Blacklist/IPv6Blacklists
This table contains IPv6 blacklist information.

XML structure
<ATK>
<Blacklist>
<IPv6Blacklists>
<Item>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<VrfIndex></VrfIndex>
<Ipv6Address></Ipv6Address>
<AddType></AddType>
<TTL></TTL>

35
 <DropCnt></DropCnt>
</Item>
</IPv6Blacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6Blacklists
Table type Multi-instance table
Row name Item
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
ID of the member Unsigned integer.
Chassis where the Index
blacklist resides Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot Index
blacklist Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index
Value range: 0 to 7.
Unsigned integer, 0
VrfIndex Vrf index Index
represents public vrf.
IPv6 blacklist
Ipv6Address Index IPv6 address.
address
Enumeration:
AddType Add type N/A • 0—Manual add.
• 1—Automatic add.
Unsigned integer, unit
TTL Time to live N/A
second.
Dropped packet
DropCnt N/A Unsigned integer.
count

ATK/Blacklist/IPv4DstBlacklists
This table contains IPv4 destination blacklist information.

36
XML structure
<ATK>
<Blacklist>
<IPv4DstBlacklists>
<Item>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<ItemType></ItemType>
<AgingTime></AgingTime>
<DropCnt></DropCnt>
</Item>
</IPv4DstBlacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4DstBlacklists
Table type Multi-instance table
Row name Item
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
ID of the
member where Unsigned integer.
Chassis Index N/A
the blacklist Value range: 0 to 65535.
resides

Slot ID of the Unsigned integer.

Slot Index N/A
blacklist Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index N/A
Value range: 0 to 7.
Unsigned integer, 0
VrfIndex Vrf index Index N/A
represents public vrf.
IPv4 blacklist
Ipv4Address Index IPv4 address. N/A
address
ItemType Add type N/A Enumeration: N/A

37
 Column Column Data type and
Column name Remarks
description type restrictions
• 0—Manual add.
• 1—Automatic add.
Unsigned integer, unit
AgingTime Time to live N/A N/A
second.
Dropped packet
DropCnt N/A Unsigned integer. N/A
count

ATK/Blacklist/IPv6DstBlacklists
This table contains IPv6 destination blacklist information.

XML structure
<ATK>
<Blacklist>
<IPv6DstBlacklists>
<Item>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<VrfIndex></VrfIndex>
<Ipv6Address></Ipv6Address>
<ItemType></ItemType>
<AgingTime></AgingTime>
<DropCnt></DropCnt>
</Item>
</IPv6DstBlacklists>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6DstBlacklists
Table type Multi-instance table
Row name Item
Restrictions None.

38
Columns
Column Column Data type and
Column name
description type restrictions
ID of the member Unsigned integer.
Chassis where the Index
blacklist resides Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot Index
blacklist Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index
Value range: 0 to 7.
Unsigned integer, 0
VrfIndex Vrf index Index
represents public vrf.
IPv6 blacklist
Ipv6Address Index IPv6 address.
address
Enumeration:
ItemType Add type N/A • 0—Manual add.
• 1—Automatic add.
Unsigned integer, unit
AgingTime Time to live N/A
second.
Dropped packet
DropCnt N/A Unsigned integer.
count

ATK/Blacklist/InterfaceSwitches
This table contains blacklist interface switch information.

XML structure
<ATK>
<Blacklist>
<InterfaceSwitches>
<Switch>
<IfIndex></IfIndex>
<Enable></Enable>
</Switch>
</InterfaceSwitches>
</Blacklist>
</ATK>

39
Table description
Item Description
Feature name ATK
Table name InterfaceSwitches
Table type Multi-instance table
Row name Switch
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
IfIndex Interface index Index Unsigned integer. N/A
Boolean:
Enable Blacklist switch. N/A • true Default is false.
• false

ATK/Blacklist/ZoneSwitches
This table contains the blacklist configuration for a security zone.

XML structure
<ATK>
<Blacklist>
<ZoneSwitches>
<Switch>
<ZoneID></ZoneID>
<Enable></Enable>
</Switch>
</ZoneSwitches>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name ZoneSwitches
Table type Multi-instance table
Row name Switch
Restrictions None

40
Columns
Column Column
Column name Data type and restrictions
description type
ZoneID Security zone ID Index Unsigned integer.

Whether the Boolean:

Enable blacklist is N/A • true—Enabled.
enabled or not • false—Disabled (default).

ATK/Blacklist/GlobalConfigs
This table contains blacklist global configuration information.

XML structure
<ATK>
<Blacklist>
<GlobalConfigs>
<Enable></Enable>
<Log></Log>
</GlobalConfigs>
</Blacklist>
</ATK>

Table description
Item Description
Feature name ATK
Table name GlobalConfigs
Table type Single-instance table
Row name N/A
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Boolean:
Enable Global switch. N/A • true Default is false.
• false
Boolean:
Log Log switch N/A Default is false.
• true

41
 Column Column Data type and
Column name Remarks
description type restrictions
• false

ATK/Whitelist/IPv4ObjItems
This table contains IPv4 whitelist information.

XML structure
<ATK>
<Whitelist>
<IPv4ObjItems>
<Item>
<ObjGrpName></ObjGrpName>
</Item>
</IPv4ObjItems>
</Whitelist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4ObjItems
Table type Multi-instance table
Row name Item
Restrictions None

Columns
Colu
Column Data type and
Column description mn Remarks
name restrictions
type
String, case insensitive.
ObjGrpName Object group IP name Index N/A
Length: 1 to 31 characters.

ATK/Whitelist/IPv6ObjItems
This table contains IPv6 whitelist information.

42
XML structure
<ATK>
<Whitelist>
<IPv6ObjItems>
<Item>
<ObjGrpName></ObjGrpName>
</Item>
</IPv6ObjItems>
</Whitelist>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6ObjItems
Table type Multi-instance table
Row name Item
Restrictions None

Columns
Column Colu
Column
descripti mn Data type and restrictions Remarks
name
on type
Object String, case insensitive.
ObjGrpName group IPv6 Index N/A
name Length: 1 to 31 characters.

ATK/Whitelist/InterfaceSwitches
This table is used to configure the whitelist for an interface.

XML structure
<ATK>
<Whitelist>
<InterfaceSwitches>
<Switch>
<IfIndex></IfIndex>
<Enable></Enable>
</Switch>
</InterfaceSwitches>

43
 </Whitelist>
</ATK>

Table description
Item Description
Feature name ATK
Table name InterfaceSwitches
Table type Multi-instance table
Row name Switch
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions
support interface
name. For
relevant
information, see
the XSD
document of your
product. For
IfIndex Interface index Index Unsigned integer.
information
about IfIndex,
see “Appendix”
in Ifmgr
NETCONF XML
API
Configuration
Reference.

Enabling status of Boolean:

Enable the whitelist N/A • true N/A
function • false

ATK/Whitelist/ZoneSwitches
This table is used to configure the whitelist for a security zone.

XML structure
<ATK>
<Whitelist>
<ZoneSwitches>
<Switch>
<ZoneID></ZoneID>

44
 <Enable></Enable>
</Switch>
</ZoneSwitches>
</Whitelist>
</ATK>

Table description
Item Description
Feature name ATK
Table name ZoneSwitches
Table type Multi-instance table
Row name Switch
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
ZoneID Security zone ID Index Unsigned integer. N/A
Boolean:
Enabling status of
Enable
the whitelist
N/A • true N/A
• false

ATK/Whitelist/GlobalSwitches
This table contains whitelist global enabling status information.

XML structure
<ATK>
<Whitelist>
<GlobalSwitches>
<Enable></Enable>
</GlobalSwitches>
</Whitelist>
</ATK>

Table description
Item Description
Feature name ATK

45
 Item Description
Table name GlobalSwitches
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Enabling status of Boolean:
Enable the global N/A • true N/A
configuration. • false

ATK/ClientVerify/Switches
This table contains client verification switch information.

XML structure
<ATK>
<ClientVerify>
<Switches>
<Switch>
<IfIndex></IfIndex>
<VerifyType></VerifyType>
<VerifyMode></VerifyMode>
</Switch>
</Switches>
</ClientVerify>
</ATK>

Table description
Item Description
Feature name ATK
Table name Switches
Table type Multi-instance table
Row name Switch
Restrictions None.

46
Columns
Column Column Data type and
Column name
description type restrictions
IfIndex Interface index Index Unsigned integer.
Enumeration:
• 0—TCP proxy
• 1—DNS client
verification.
VerifyType Verification type Index • 2—HTTP client
verification.
• 3—DNS reply
verification.
• 4—SIP client
verification.
Enumeration, value range
varies according to
MainType.

For TCP proxy:

• 0—Shutdown.
• 1—SYN cookie.
• 2—Safe reset.

For DNS client verification:

• 0—Shutdown.
• 1—Truncate.
VerifyMode Verification mode N/A

For HTTP client

verification:
• 0—Shutdown.
• 1—Redirection.

For DNS reply verification:

• 0—DNS request.

For SIP client verification:

• 0—Shutdown.
• 1—Option.

ATK/ClientVerify/ZoneSwitches
This table contains the client verification configuration for a security zone.

XML structure
<ATK>
<ClientVerify>
<ZoneSwitches>

47
 <Switch>
<ZoneID></ZoneID>
<VerifyType></VerifyType>
<VerifyMode></VerifyMode>
</Switch>
</ZoneSwitches>
</ClientVerify>
</ATK>

Table description
Item Description
Feature name ATK
Table name ZoneSwitches
Table type Multi-instance table
Row name Switch
Restrictions None

Columns
Column Column
Column name Data type and restrictions
description type
ZoneID Security zone ID Index Unsigned integer.
Enumeration:
• 0—TCP proxy.
• 1—DNS client verification.
VerifyType Verification type Index
• 2—HTTP client verification.
• 3—DNS reply verification.
• 4—SIP client verification.
Enumeration:
For TCP proxy:
• 0—Shutdown.
• 1—SYN cookie.
• 2—Safe reset.

For DNS client verification:

• 0—Shutdown.
VerifyMode Verification mode N/A • 1—Truncation.

For HTTP client verification:

• 0—Shutdown.
• 1—Redirection.

For DNS reply verification:

• 0—DNS request.

48
 Column Column
Column name Data type and restrictions
description type
For SIP client verification:
• 0—Shutdown.
• 1—Option.

ATK/ClientVerify/IPv4ProtectHosts
This table contains IPv4 client verification protect hosts information.

XML structure
<ATK>
<ClientVerify>
<IPv4ProtectHosts>
<Host>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<VerifyType></VerifyType>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<PortNumber></PortNumber>
<AddType></AddType>
<ReqCnt></ReqCnt>
<AuthCnt></AuthCnt>
</Host>
</IPv4ProtectHosts>
</ClientVerify>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4ProtectHosts
Table type Multi-instance table
Row name Host
Restrictions None.

49
Columns
Column Column Data type and
Column name Remarks
description type restrictions
ID of the member Unsigned integer.
Chassis where the host Index N/A
resides Value range: 0 to 65535.

Unsigned integer.
Slot Slot ID of the host Index N/A
Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index N/A
Value range: 0 to 7.
Enumeration:
• 0—TCP proxy
• 1—DNS client
verification.
VerifyType Verification type Index • 2—HTTP client N/A
verification.
• 3—DNS reply
verification.
• 4—SIP client
verification.
Unsigned integer, 0
VrfIndex Vrf index Index N/A
represents public vrf.
Ipv4Address Host address Index IPv4 address. N/A
For TCP proxy,
Unsigned integer. The port number 0 is
value range varies by the available which
verification type. means that any
hosts connected
For TCP proxy: to any service
PortNumber Port number Index 0-65535 port will be
For DNS, DNS reply, SIP monitored. For
and HTTP client DNS, DNS reply,
verification: SIP and HTTP
client verification,
1-65535 port number 0 is
unavailable.
Enumeration:
AddType Add type N/A • 0—Manual add. N/A
• 1—Automatic add.
ReqCnt Request count N/A Unsigned integer. N/A
Authenticated
AuthCnt N/A Unsigned integer. N/A
request count

ATK/ClientVerify/IPv6ProtectHosts
This table contains IPv6 client verification protect hosts information.

50
XML structure
<ATK>
<ClientVerify>
<IPv6ProtectHosts>
<Host>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<VerifyType></VerifyType>
<VrfIndex></VrfIndex>
<Ipv6Address></Ipv6Address>
<PortNumber></PortNumber>
<AddType></AddType>
<ReqCnt></ReqCnt>
<AuthCnt></AuthCnt>
</Host>
</IPv6ProtectHosts>
</ClientVerify>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6ProtectHosts
Table type Multi-instance table
Row name Host
Restrictions None.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
ID of the member Unsigned integer.
Chassis where the host Index N/A
resides Value range: 0 to 65535.

Unsigned integer.
Slot Slot ID of the host Index N/A
Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index N/A
Value range: 0 to 7.
Enumeration:

VerifyType Verification type Index • 0—TCP proxy N/A

• 1—DNS client
verification.

51
 Column Column Data type and
Column name Remarks
description type restrictions
• 2—HTTP client
verification.
• 3—DNS reply
verification.
• 4—SIP client
verification.
Unsigned integer, 0
VrfIndex Vrf index Index N/A
represents public vrf.
Ipv6Address Host address Index IPv6 address. N/A
For TCP proxy,
Unsigned integer. The port number 0 is
value range varies by the available which
verification type. means that any
hosts connected
For TCP proxy: to any service
PortNumber Port number Index 0-65535 port will be
For DNS, DNS reply, SIP monitored. For
and HTTP client DNS, DNS reply,
verification: SIP and HTTP
client verification,
1-65535 port number 0 is
unavailable.
Enumeration:
AddType Add type N/A • 0—Manual add. N/A
• 1—Automatic add.
ReqCnt Request count N/A Unsigned integer. N/A
Authenticated
AuthCnt N/A Unsigned integer. N/A
request count

ATK/ClientVerify/IPv4TrustClients
This table contains information of trust IPv4 clients verified by ClientVerify module.

XML structure
<ATK>
<ClientVerify>
<IPv4TrustClients>
<Client>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<VerifyType></VerifyType>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<DSLitePeer></DSLitePeer>
<TTL></TTL>

52
 </Client>
</IPv4TrustClients>
</ClientVerify>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv4TrustClients
Table type Multi-instance table
Row name Client
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
ID of the member Unsigned integer.
Chassis where the client Index
resides Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot Index
client Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index
Value range: 0 to 7.
Enumeration:
• 0—TCP proxy
• 1—DNS client
verification.
VerifyType Verification type Index • 2—HTTP client
verification.
• 3—DNS reply
verification.
• 4—SIP client
verification.
Unsigned integer, 0
VrfIndex Vrf index Index
represents public vrf.
Ipv4Address Client address Index IPv4 address.
DS-Lite tunnel
DSLitePeer Index IPv6 address.
peer address
Unsigned integer, unit
TTL Time to live N/A
second.

53
ATK/ClientVerify/IPv6TrustClients
This table contains information of trust IPv6 clients verified by ClientVerify module.

XML structure
<ATK>
<ClientVerify>
<IPv6TrustClients>
<Client>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<VerifyType></VerifyType>
<VrfIndex></VrfIndex>
<Ipv6Address></Ipv6Address>
<TTL></TTL>
</Client>
</IPv6TrustClients>
</ClientVerify>
</ATK>

Table description
Item Description
Feature name ATK
Table name IPv6TrustClients
Table type Multi-instance table
Row name Client
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
ID of the member Unsigned integer.
Chassis where the client Index
resides Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot Index
client Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index
Value range: 0 to 7.
Enumeration:
VerifyType Verification type Index • 0—TCP proxy
• 1—DNS client

54
 Column Column Data type and
Column name
description type restrictions
verification.
• 2—HTTP client
verification.
• 3—DNS reply
verification.
• 4—SIP client
verification.
Unsigned integer, 0
VrfIndex Vrf index Index
represents public vrf.
Ipv6Address Client address Index IPv6 address.
Unsigned integer, unit
TTL Time to live N/A
second.

ATK/Specification
This table contains specification information of the current device.

XML structure
<ATK>
<Specification>
<InterfaceApply></InterfaceApply>
<LocalApply></LocalApply>
<ClientVerify></ClientVerify>
</Specification>
</ATK>

Table description
Item Description
Feature name ATK
Table name Specification
Table type Single-instance table
Row name N/A
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
Support apply a Boolean:
InterfaceApply attack-defense N/A
policy to • True

55
 Column Column Data type and
Column name
description type restrictions
interfaces • false
Support apply a Boolean:
attack-defense
LocalApply
policy to local
N/A • True
host • false

Support Boolean:
ClientVerify client-verify N/A • True
feature. • false

ATK/TopStatisticsSwitch
This table contains ATK top statistics switch configuration.

XML structure
<ATK>
<TopStatisticsSwitch>
<Enable></Enable>
</TopStatisticsSwitch>
</ATK>

Table description
Item Description
Feature name ATK
Table name TopStatisticsSwitch
Table type Single-instance table
Row name N/A

Columns
Column Column Data type and
Column type Remarks
name description restrictions
Whether enable Boolean:
Enable ATK top statistics N/A • true N/A
function • false

ATK/TopStatisticsSampleTime
This table contains sample time for the top statistics in a period.

56
XML structure
<ATK>
<TopStatisticsSampleTime>
<Item>
<Type></Type>
<Period></Period>
<SampleTime></SampleTime>
</Item>
</TopStatisticsSampleTime>
</ATK>

Table description
Item Description
Feature name Session
Table name TopStatisticsSampleTime
Table type Multi-instance table
Row name Item
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:

Type of top • 0—Top statistics by source

Type Index address. N/A
statistics
• 1—Top statistics by
destination address.
Unsigned integer.
Value range: 0 to 2.
Period of history
Period
session statistics
Index • 0—1 hour. N/A
• 1—1 day.
• 2—30 days.

Sample time in a String. Example:

SampleTime N/A
period Length: 1 to 32 characters. 2000-04-25 21:23:23.

ATK/TopAttackStatisticsByIP
This table contains top statistics for attack.

57
XML structure
<ATK>
<TopAttackStatisticsByIP>
<Statistics>
<Type></Type>
<Period></Period>
<Sequence></Sequence>
<Address>
<IPv4Addr></IPv4Addr>
<IPv6Addr></IPv6Addr>
</Address>
<VRF></VRF>
<AttackType></AttackType>
<AttackTimes></AttackTimes>
<SampleCount></SampleCount>
</Statistics>
</TopAttackStatisticsByIP>
</ATK>

Table description
Item Description
Feature name Session
Table name TopAttackStatisticsByIP
Table type Multi-instance table
Row name Statistics
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:

Type of top • 0—Top statistics by source

Type Index address. N/A
statistics
• 1—Top statistics by
destination address.
Enumeration:
Period of history • 0—1 hour.
Period Index N/A
attack statistics • 1—1 day.
• 2—30 days.

58
 Column Column Column
Data type and restrictions Remarks
name description type
Sequence Sequence Index Unsigned integer. N/A
number of top Value range: 1 to 10.
statistics
Address Source or Data Members include: N/A
destination structure • IPv4Addr.
network layer
address • IPv6Addr.

IPv4Addr IPv4 address N/A IPv4 address. Columns IPv4Addr and

IPv6Addr are mutually
exclusive.
IPv6Addr IPv6 address N/A IPv6 address. Columns IPv4Addr and
IPv6Addr are mutually
exclusive.
VRF Name of the VRF N/A String. If the gateway is on the
instance Length: 0 to 31 characters. public network, the
associated with length of characters is
the SSL VPN 0.
gateway
Unsigned integer.
AttackType AttackType N/A 32 N/A
Value range: 0 to 2 – 1.
Unsigned integer.
AttackTimes Attack times N/A 64 N/A
Value range: 0 to 2 – 1.
Unsigned integer.
SampleCount SampleCount N/A 32 N/A
Value range: 0 to 2 – 1.

ATK/TopAttackStatisticsByType
This table contains top statistics for attack.

XML structure
<ATK>
<TopAttackStatisticsByType>
<Statistics>
<Period></Period>
<AttackType></AttackType>
<AttackTimes></AttackTimes>
</Statistics>
</TopAttackStatisticsByType>
</ATK>

Table description
Item Description
Feature name Session

59
 Table name TopAttackStatisticsByType
Table type Multi-instance table
Row name Statistics
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
Period of history • 0—1 hour.
Period Index N/A
attack statistics • 1—1 day.
• 2—30 days.
AttackType Attack type. Index Enumeration: N/A
• 0 ATK_TOPHIS_FLOOD_SYN
• 1 ATK_TOPHIS_FLOOD_ACK
• 2 ATK_TOPHIS_FLOOD_SYNACK
• 3 ATK_TOPHIS_FLOOD_RST
• 4 ATK_TOPHIS_FLOOD_FIN
• 5 ATK_TOPHIS_FLOOD_UDP
• 6 ATK_TOPHIS_FLOOD_ICMP
• 7 ATK_TOPHIS_FLOOD_ICMPV6
• 8 ATK_TOPHIS_FLOOD_DNS
• 9 ATK_TOPHIS_FLOOD_HTTP
• 10 ATK_TOPHIS_SCAN_PORT
• 11 ATK_TOPHIS_SCAN_IP_SWEEP
• 12 ATK_TOPHIS_SCAN_DIST
• 13ATK_TOPHIS_TCP_FRAGMENT
• 14 ATK_TOPHIS_CLIENTVERIFY
• 15ATK_TOPHIS_BLACKLIST
• 16ATK_TOPHIS_BLACKLIST_USER
• 17 ATK_TOPHIS_SIGL3
• 18ATK_TOPHIS_SIGL4
• 19 AT
• K_TOPHIS_SMURF
• 20 ATK_TOPHIS_URPF
• 21
ATK_TOPHIS_FLOOD_DNS_REPLY
• 22 ATK_TOPHIS_FLOOD_SIP

Unsigned integer.
AttackTimes Attack times N/A 64 N/A
Value range: 0 to 2 – 1.

ATK/ScanAttackTypes
This table contains scan attack types information of the current device.

60
XML structure
<ATK>
<ScanAttackTypes>
<AttackType>
<Digest></Digest>
<AttackTypeName></AttackTypeName>
</AttackType>
</ScanAttackTypes>
</ATK>

Table description
Item Description
Feature name ATK
Table name ScanAttackTypes
Table type Multi-instance table
Row name AttackType
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
String.
Digest Name of digest Index
Length: 1 to 32 characters.

Name of attack String.

AttackTypeName N/A
type Length: 1 to 32 characters.

ATK/FloodAttackTypes
This table contains flood attack types information of the current device.

XML structure
<ATK>
<FloodAttackTypes>
<AttackType>
<Digest></Digest>
<AttackTypeName></AttackTypeName>
</AttackType>
</FloodAttackTypes>
</ATK>

61
Table description
Item Description
Feature name ATK
Table name FloodAttackTypes
Table type Multi-instance table
Row name AttackType
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
String.
Digest Name of digest Index
Length: 1 to 32 characters.

Name of attack String.

AttackTypeName N/A
type Length: 1 to 32 characters.

ATK/SignatureAttackTypes
This table contains signature attack types information of the current device.

XML structure
<ATK>
<SignatureAttackTypes>
<AttackType>
<Digest></Digest>
<AttackTypeName></AttackTypeName>
</AttackType>
</SignatureAttackTypes>
</ATK>

Table description
Item Description
Feature name ATK
Table name SignatureAttackTypes
Table type Multi-instance table
Row name AttackType
Restrictions None.

62
Columns
Column Column Data type and
Column name
description type restrictions
String.
Digest Name of digest Index
Length: 1 to 32 characters.

Name of attack String.

AttackTypeName N/A
type Length: 1 to 32 characters.

ATK/BlacklistTypes
This table contains blacklist types information of the current device.

XML structure
<ATK>
<BlacklistTypes>
<Type>
<Digest></Digest>
<TypeName></TypeName>
</Type>
</BlacklistTypes>
</ATK>

Table description
Item Description
Feature name ATK
Table name BlacklistTypes
Table type Multi-instance table
Row name Type
Restrictions None.

Columns
Column Column Data type and
Column name
description type restrictions
String.
Digest Name of digest Index
Length: 1 to 32 characters.
String.
TypeName Name of type N/A
Length: 1 to 32 characters.

63
64
Contents
ATK·······························································································2
ATK/IPv4Exempts ······················································································································ 2
ATK/IPv6Exempts ······················································································································ 2
ATK/Scan/Policies ····················································································································· 2
ATK/Flood/DefaultConfigs············································································································ 3
ATK/Flood/IPv4ProtectHosts ········································································································ 4
ATK/Flood/IPv6ProtectHosts ········································································································ 4
ATK/Signature/Detects ················································································································ 5
ATK/Blacklist/ZoneSwitches ········································································································· 5
ATK/Blacklist/IPv4Blacklists ········································································································· 6
ATK/Blacklist/IPv6Blacklists ········································································································· 6
ATK/Whitelist/ZoneSwitches········································································································· 6
ATK/Whitelist/IPv4ObjItems ········································································································· 6
ATK/Whitelist/IPv6ObjItems ········································································································· 6
ATK/ClientVerify/IPv4ProtectHosts ································································································ 7
ATK/ClientVerify/IPv6ProtectHosts ································································································ 7
ATK/ClientVerify/Switches ··········································································································· 7
ATK/ClientVerify/ZoneSwitches····································································································· 8
ATK/TopStatisticsSwitch·············································································································· 8

i
ATK
ATK/IPv4Exempts
Message Explanation
During executing create、merge or replace operation, ACL numer
Please specify an ACL by either its number or its and ACL name are mutual exclusive and only one of them can be
name. set in a single message.
不能同时设置ACL组名与ACL组号。 当执行create、merge、release操作时，ACL 组号和ACL组名同一
时刻只能设置其一。

ATK/IPv6Exempts
Message Explanation
During executing create、merge or replace operation, ACL numer
Please specify an ACL by either its number or its and ACL name are mutual exclusive and only one of them can be
name. set in a single message.
不能同时设置ACL组名与ACL组号。 当执行create、merge和release操作时，ACL 组号和ACL组名同一
时刻只能设置其一。

ATK/Scan/Policies
Message Explanation
During executing configuration operation(create、merge、replace、
Please specify the detection sensitivity before delete or remove), Please specify the detection sensitivity before
specifying defense actions. specifying defense actions.
未开启指定敏感度的扫描攻击防范时，不能设置行 当执行配置操作（包括create、merge、release、delete和remove）
攻击防范处理行为。 时，未开启指定敏感度的扫描攻击防范时，不能设置行攻击防范处
理行为。

During executing configuration operation(create、merge、replace、

Please specify at least one defense action. delete or remove),please specify at least one defense action.
请至少设置一个攻击防范处理行为。 当执行配置操作（包括create、merge、release、delete和remove）
时，请至少设置一个攻击防范处理行为。

During executing configuration operation(create、merge、replace、

The drop and block-source actions cannot be both delete or remove),drop and BlockSource are mutual exclusive
specified. and only one of them can be set in a single message.
扫描攻击防范的执行动作不能同时设置为丢弃报文 当执行配置操作（包括create、merge、release、delete和remove）
与阻塞攻击源地址。 时，扫描攻击防范的执行动作丢弃报文与阻塞攻击源地址同一时刻
只能设置其一。

The blacklist aging time can only be set for the During executing configuration operation(create、merge、replace、
block-source action. delete or remove), the blacklist aging time can only be set for the
block-source action.
仅在扫描攻击防范的执行动作为阻塞源地址时才能
当执行配置操作（包括create、merge、release、delete和remove）
设置黑名单的老化时间。
时，仅在扫描攻击防范的执行动作为阻塞源地址时才能设置黑名单

2
 的老化时间。

During executing configuration operation(create、merge、replace、

At least one of scan attack detect ways should be delete or remove), at least one of scan attack detect ways should
specified. be specified.
设置自定义级别扫描攻击防范时至少应指定端口检 当执行配置操作（包括create、merge、release、delete和remove）
测和IP检测中的一种方式。 时，设置自定义级别扫描攻击防范时至少应指定端口检测和IP检测
中的一种方式。

During executing configuration operation(create、merge、replace、

The port scan attack detect switch and the port
delete or remove), the port scan attack detect switch and the port
scan attack detect threshold should all be set or
scan attack detect threshold should all be set or neither be set.
neither be set.
当执行配置操作（包括create、merge、release、delete和remove）
设置自定义级别扫描攻击防范时端口扫描检测开关
时，设置自定义级别扫描攻击防范时端口扫描检测开关和端口扫描
和端口扫描检测阈值应该同时设置或不设置。
检测阈值应该同时设置或不设置。

During executing configuration operation(create、merge、replace、

The IP scan attack detect switch and the IP attack delete or remove), the IP scan attack detect switch and the IP
detect threshold should all be set or neither be set. attack detect threshold should all be set or neither be set.
设置自定义级别扫描攻击防范时IP扫描检测开关和 当执行配置操作（包括create、merge、release、delete和remove）
IP扫描检测阈值应该同时设置或不设置。 时，设置自定义级别扫描攻击防范时IP扫描检测开关和IP扫描检测
阈值应该同时设置或不设置。

During executing configuration operation(create、merge、replace、

Ipsweep switch and portscan switch cannot be
delete or remove), IP sweep switch and port scan switch cannot
open when the detect level is UNDO.
be open when the detect level is UNDO.
级别为UNDO时，地址检测或端口检测开关不能为
当执行配置操作（包括create、merge、release、delete和remove）
打开状态。
时，级别为UNDO时，地址检测或端口检测开关不能为打开状态。

ATK/Flood/DefaultConfigs
Message Explanation
During executing create、merge or replace operation, the client
The operation is not supported on the device. verification operation is must supported on the device.
设备不支持此操作。 当执行create、merge和release操作时，请确保设备支持客户端验
证功能。

During executing configuration operation(create、merge、replace、

delete or remove) or get operation, the flood attack type must
The flood attack type doesn't exist.
exist.
该泛洪攻击防范类型不存在。
当执行配置操作（包括create、merge、release、delete和remove）
时，请确保相应的泛洪攻击防范类型必须存在。

During executing configuration operation(create、merge、replace、

Client verification is not an available defense action
delete or remove) or get operation, client verification is not an
for this flood attack.
available defense action for this flood attack.
该类型的泛洪攻击防范的处理行为不能设置为客户
当执行配置操作（包括create、merge、release、delete和remove）
端验证。
时，该类型的泛洪攻击防范的处理行为不能设置为客户端验证。

During executing configuration operation(create、merge、replace、

Only HTTP DNS DNS-REPLY and SIP flood attack
delete or remove) or get operation,only HTTP DNS DNS-REPLY
defense supports port configuration.
and SIP flood attack defense supports port configuration.
仅HTTP泛洪攻击防范、DNS泛洪攻击防范、
当执行配置操作（包括create、merge、release、delete和remove）
DNS-REPLY泛洪攻击防范和SIP范洪攻击防范支持
时，仅HTTP泛洪攻击防范、DNS泛洪攻击防范、DNS-REPLY泛
设置检测端口。
洪攻击防范和SIP范洪攻击防范支持设置检测端口。

The number of detection ports exceeds the upper During executing configuration operation(create、merge、replace、

3
limit. delete or remove) or get operation,the number of detection ports
must not exceeds the upper limit.
检测端口数量超过上限。
当执行配置操作（包括create、merge、release、delete和remove）
时，请确保检测端口数量不能超过上限。

ATK/Flood/IPv4ProtectHosts
Message Explanation
During executing create、merge or replace operation, the client
The operation is not supported on the device. verification operation is must supported on the device.
设备不支持此操作。 当执行create、merge和release操作时，请确保设备支持客户端验
证功能。

During executing configuration operation(create、merge、replace、

delete or remove) or get operation, the flood attack type must
The flood attack type doesn't exist.
exist.
该泛洪攻击防范类型不存在。
当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，请确保相应的泛洪攻击防范类型必须存在。

During executing configuration operation(create、merge、replace、

Client verification is not an available defense action delete or remove) or get operation, client verification is not an
for this flood attack. available defense action for this flood attack.
该类型的泛洪攻击防范的处理行为不能设置为客户 当执行配置操作（包括create、merge、release、delete和remove）
端验证。 和获取操作时，该类型的泛洪攻击防范的处理行为不能设置为客户
端验证。

During executing configuration operation(create、merge、replace、

Only HTTP DNS DNS-REPLY and SIP flood attack delete or remove) or get operation,only HTTP DNS DNS-REPLY
defense supports port configuration. and SIP flood attack defense supports port configuration.
仅HTTP泛洪攻击防范、DNS泛洪攻击防范、 当执行配置操作（包括create、merge、release、delete和remove）
DNS-REPLY泛洪攻击防范和SIP范洪攻击防范支持 和获取操作时，仅HTTP泛洪攻击防范、DNS泛洪攻击防范、
设置检测端口。 DNS-REPLY泛洪攻击防范和SIP范洪攻击防范支持设置检测端
口。

During executing configuration operation(create、merge、replace、

The number of detection ports exceeds the upper delete or remove) or get operation,the number of detection ports
limit. must not exceeds the upper limit.
检测端口数量超过上限。 当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，请确保检测端口数量不能超过上限。

During executing configuration operation(create、merge、replace、

Invalid IP address. delete or remove) or get operation, the IP address is must valid.
指定的地址不合法。 当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，指定的地址必须合法。

ATK/Flood/IPv6ProtectHosts
Message Explanation
During executing create、merge or replace operation, the client
The operation is not supported on the device. verification operation is must supported on the device.
设备不支持此操作。 当执行create、merge和release操作时，请确保设备支持客户端验
证功能。

4
 During executing configuration operation(create、merge、replace、
delete or remove) or get operation, the flood attack type must
The flood attack type doesn't exist.
exist.
该泛洪攻击防范类型不存在。
当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，请确保相应的泛洪攻击防范类型必须存在。

During executing configuration operation(create、merge、replace、

Client verification is not an available defense action delete or remove) or get operation, client verification is not an
for this flood attack. available defense action for this flood attack.
该类型的泛洪攻击防范的处理行为不能设置为客户 当执行配置操作（包括create、merge、release、delete和remove）
端验证。 和获取操作时，该类型的泛洪攻击防范的处理行为不能设置为客户
端验证。

During executing configuration operation(create、merge、replace、

Only HTTP DNS DNS-REPLY and SIP flood attack delete or remove) or get operation,only HTTP DNS DNS-REPLY
defense supports port configuration. and SIP flood attack defense supports port configuration.
仅HTTP泛洪攻击防范、DNS泛洪攻击防范、 当执行配置操作（包括create、merge、release、delete和remove）
DNS-REPLY泛洪攻击防范和SIP范洪攻击防范支持 和获取操作时，仅HTTP泛洪攻击防范、DNS泛洪攻击防范、
设置检测端口。 DNS-REPLY泛洪攻击防范和SIP范洪攻击防范支持设置检测端
口。

During executing configuration operation(create、merge、replace、

The number of detection ports exceeds the upper delete or remove) or get operation,the number of detection ports
limit. must not exceeds the upper limit.
检测端口数量超过上限。 当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，请确保检测端口数量不能超过上限。

During executing configuration operation(create、merge、replace、

Invalid IP address. delete or remove) or get operation, the IP address is must valid.
指定的地址不合法。 当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，指定的地址必须合法。

ATK/Signature/Detects
Message Explanation
During executing configuration operation(create、merge、replace、
delete or remove) or get operation, the single-packet attack type
The single-packet attack type doesn't exist.
must exist.
该单包攻击防范类型不存在。
当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，单包攻击防范类型必须存在。

ATK/Blacklist/ZoneSwitches
Message Explanation
During executing configuration operation(create、merge、replace、
delete or remove) or get operation, The operation is not supported
The operation is not supported on Local zone.
on Local zone.
Local域上不支持该操作。
当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，Local域上不支持该操作。

5
ATK/Blacklist/IPv4Blacklists
Message Explanation
During executing create、merge or replace operation, the
The VRF instance doesn't exist.
specified VPN instance must exist.
指定的VRF不存在。
当执行create、merge和release操作时，指定的VRF必须存在。

ATK/Blacklist/IPv6Blacklists
Message Explanation
During executing create、merge or replace operation, the
The VRF instance doesn't exist.
specified VPN instance must exist.
指定的VRF不存在。
当执行create、merge和release操作时，指定的VRF必须存在。

ATK/Whitelist/ZoneSwitches
Message Explanation
During executing configuration operation(create、merge、replace、
The operation is not supported on Local zone. delete or remove) or get operation, The operation is not supported
Local域上不支持该操作。 on Local zone.
当执行create、merge和release操作时，指定的VRF必须存在。

ATK/Whitelist/IPv4ObjItems
Message Explanation
During executing configuration operation(create、merge、replace、
The IP address object group doesn't exist. delete or remove),the IP address object group must exist.
该地址对象组不存在。 当执行配置操作（包括create、merge、release、delete和remove）
时，指定的地址对象组必须存在。

During executing configuration operation(create、merge、replace、

delete or remove),the object group is must an IP address object
The object group is not an IP address object group.
group.
该对象组不是地址对象组。
当执行配置操作（包括create、merge、release、delete和remove）
时，指定的对象组必须是地址对象组。

ATK/Whitelist/IPv6ObjItems
Message Explanation

The IP address object group doesn't exist. During executing configuration operation(create、merge、replace、
delete or remove),the IP address object group must exist.
该地址对象组不存在。
当执行配置操作（包括create、merge、release、delete和remove）

6
 时，指定的地址对象组必须存在。

During executing configuration operation(create、merge、replace、

delete or remove),the object group is must an IP address object
The object group is not an IP address object group.
group.
该对象组不是地址对象组。
当执行配置操作（包括create、merge、release、delete和remove）
时，指定的对象组必须是地址对象组。

ATK/ClientVerify/IPv4ProtectHosts
Message Explanation
During executing configuration operation(create、merge、replace、
delete or remove) or get operation, the specified VPN instance
The VRF instance doesn't exist.
must exist.
指定的VRF不存在。
当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，指定的VRF必须存在。

During executing configuration operation(create、merge、replace、

Invalid IP address. delete or remove) or get operation, the IP address is must valid.
指定的地址不合法。 当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，指定的地址必须合法。

ATK/ClientVerify/IPv6ProtectHosts
Message Explanation
During executing configuration operation(create、merge、replace、
delete or remove) or get operation, the specified VPN instance
The VRF instance doesn't exist.
must exist.
指定的VRF不存在。
当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，指定的VRF必须存在。

During executing configuration operation(create、merge、replace、

Invalid IP address. delete or remove) or get operation, the IP address is must valid.
指定的地址不合法。 当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，指定的地址必须合法。

ATK/ClientVerify/Switches
Message Explanation
During executing create、merge or replace operation,the
The verification mode is not supported. verification mode is must supported.
该类型客户端验证不支持指定的工作模式。 当执行create、merge和release操作时，客户端验证需要支持指定
的工作模式。

7
ATK/ClientVerify/ZoneSwitches
Message Explanation
During executing create、merge or replace operation,the
The verification mode is not supported. verification mode is must supported.
该类型客户端验证不支持指定的工作模式。 当执行create、merge和release操作时，客户端验证需要支持指定
的工作模式。

During executing configuration operation(create、merge、replace、

delete or remove) or get operation, The operation is not supported
The operation is not supported on Local zone.
on Local zone.
Local域上不支持该操作。
当执行配置操作（包括create、merge、release、delete和remove）
和获取操作时，Local域上不支持该操作。

ATK/TopStatisticsSwitch
Message Explanation
During executing create、merge、replace or action operation, The
The stop process is running. Please try it later. close operation must been completed.
关闭操作尚未执行完毕，请稍后重试。 当执行create、merge、release及action操作时，需要等到关闭操
作执行完毕。

8
Contents
AUDIT ···························································································1
AUDIT/SignatureManualUpgrade ·································································································································· 1
XML structure ··························································································································································· 1
Table description ····················································································································································· 1
Columns ···································································································································································· 1
AUDIT/SignatureAutoUpgradeNow ······························································································································· 1
XML structure ··························································································································································· 2
Table description ····················································································································································· 2
Columns ···································································································································································· 2
AUDIT/SignatureRollback ··············································································································································· 2
XML structure ··························································································································································· 2
Table description ····················································································································································· 2
Columns ···································································································································································· 3
AUDIT/PolicyMove ··························································································································································· 3
XML structure ··························································································································································· 3
Table description ····················································································································································· 3
Columns ···································································································································································· 3
AUDIT
AUDIT/SignatureManualUpgrade
This table contains the information of AUDIT signatures manual upgrading.

XML structure
<AUDIT>
<SignatureManualUpgrade>
<URL></URL>
<Location></Location>
</SignatureManualUpgrade>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name SignatureManualUpgrade
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String: case-insensitive
When the file is remote,
URL of the
URL N/A Length: 1 to 255 characters. N/A
impored rule file
When the file is local,
Length: 1 to 127 characters.
Enumeration:
The Location of
Location
the file
N/A • 0—local. N/A
• 1—remote.

AUDIT/SignatureAutoUpgradeNow
This table contains the information of AUDIT signatures auto upgrading at once.

1
XML structure
<AUDIT>
<SignatureAutoUpgradeNow>
<AutoUpgradeNow></AutoUpgradeNow>
</SignatureAutoUpgradeNow>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name SignatureAutoUpgradeNow
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
AutoUpgrade Auto upgrade at
N/A This column must be empty. N/A
Now once

AUDIT/SignatureRollback
This table contains the information of AUDIT signatures rollback.

XML structure
<AUDIT>
<SignatureRollback>
<Rollback></Rollback>
</SignatureRollback>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name SignatureRollback
Table type Single-instance table
Row name None

2
 Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:

Rollback rollback N/A • true: rollback last version. N/A

• false: rollback original
version.

AUDIT/PolicyMove
This table contains information about the AUDIT’s policy move.

XML structure
<AUDIT>
<PolicyMove>
<Move>
<SrcPolicyName></SrcPolicyName>
<DesPolicyName></DesPolicyName>
<MoveType></MoveType>
</Move>
</PolicyMove>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name PolicyMove
Table type Multi-instance table
Row name Move
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
SrcPolicyNa Source Policy String: case-insensitive.
Index N/A
me Name Length: 1 to 63 characters.
DesPolicyNa Destination Index String: case-insensitive. N/A

3
Column Column Column
Data type and restrictions Remarks
name description type
me Policy Name Length: 1 to 63 characters.
Enumeration:
Moving type for
MoveType
the policy
N/A • 0—Move after a policy. N/A
• 1—Move before a policy.

4
Contents
AUDIT ···························································································1
AUDIT/Policies ·························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AUDIT/PolicyOptions ·················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AUDIT/DefaultPolicyAction··········································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
AUDIT/ AppPolicyKeywordGroups ································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
AUDIT/Keywords ······················································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
AUDIT/PolicyRules ····················································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
AUDIT/SignatureAutoUpgrading···································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8

i
AUDIT
AUDIT/Policies
This table contains information about the AUDIT’s policy.

XML structure
<AUDIT>
<Policies>
<Policy>
<PolicyName></PolicyName>
<Disable></Disable>
<TimeRangeName></TimeRangeName>
<DefaultRuleAction></DefaultRuleAction>
<PolicyType></PolicyType>
<RuleMatchType></RuleMatchType>
</Policy>
</Policies>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String: case-insensitive.
PolicyName Policy Name Index N/A
Length: 1 to 63 characters.

Set this value to Boolean:

Disable true to disable N/A • true. N/A
the policy • false.

TimeRangeN Time Range String: case-insensitive.

N/A N/A
ame Name Length: 1 to 63 characters.

1
 Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
The policy type must be
• 0—NoAudit.
PolicyType Policy Type N/A set when policy is
• 1—Audit. created.
• 2—Deny.
Enumeration:
DefaultRuleA Default Rule
ction Action
N/A • 0—Permit. N/A
• 1—Deny.
Enumeration:
RuleMatchTy Rule Matching
pe Type
N/A • 0—Order. N/A
• 1—Full.

AUDIT/PolicyOptions
This table contains some multiple option information about the AUDIT’s policy.

XML structure
<AUDIT>
<PolicyOptions>
<Option>
<PolicyName></PolicyName>
<OptionType></OptionType>
<OptionValue></OptionValue>
</Option>
</PolicyOptions>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name PolicyOptions
Table type Multi-instance table
Row name Option
Restrictions None
Support for row creation and deletion Yes

Columns

2
 Column Column Column
Data type and restrictions Remarks
name description type
Name can not be
String: case-insensitive.
PolicyName Policy Name Index same with its siblings.
Length: 1 to 63 characters.
It is Mandatory.
Enumeration:
• 1—SourceZones.
• 2—DestZones.
• 3—SourceIPv4AddressSet
s.
• 4—SourceIPv6AddressSet
Type of the s.
OptionType option in the Index N/A
• 5—DestIPv4AddressSets
policy
• 6—DestIPv6AddressSets
• 7—Users.
• 8—User Groups.
• 9—Applications.
• 10—AppGroups.
• 11—Service.
String: case-insensitive.
Length: 1 to 63 characters (for
OptionTypes 9 and 10).
Value of the Values of
Length: 1 to 31 characters
OptionValue special option Index OptionTypes 7 and 8
type in the policy (for OptionTypes 1 through 6, are in Json format.
and OptionType 11).
Length: 1 to 480 characters (for
OptionTypes 7 and 8).

AUDIT/DefaultPolicyAction
This table contains information about the AUDIT’s default policy action.

XML structure
<AUDIT>
<DefaultPolicyAction>
<DefaultAction>
<Action></Action>
</DefaultAction>
</DefaultPolicyAction>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name DefaultPolicyAction
Table type Multi-instance table

3
 Row name DefaultAction
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Packet Action Enumeration:
Action which not match N/A • 0—Permit. N/A
any Audit’s policy • 1—Deny.

AUDIT/ AppPolicyKeywordGroups
This table contains information about the AUDIT’s keywordgroup.

XML structure
<AUDIT>
<AppPolicyKeywordGroups>
<KeywordGroup>
<KeywordGroupName></KeywordGroupName>
<Description></Description>
<RefCnt></RefCnt>
</KeywordGroup>
</AppPolicyKeywordGroups>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name AppPolicyKeywordGroups
Table type Multi-instance table
Row name KeywordGroup
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
KeywordGrou
Keyword Group Index String: case-insensitive. N/A
pName

4
 Column Column Column
Data type and restrictions Remarks
name description type
Name Length: 1 to 63 characters.
Description String: case-insensitive
Description about keyword N/A N/A
group Length: 1 to 256 characters.

Refer count Unsigned integer:

RefCnt about keyword N/A 16 N/A
group Value range: 0 to 2 – 1.

AUDIT/Keywords
This table contains information about the keywords of keywordgroup.

XML structure
<AUDIT>
<Keywords>
<Keyword>
<KeywordGroupName></KeywordGroupName>
<Keyword></Keyword>
</Keyword>
</Keywords>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name Keywords
Table type Multi-instance table
Row name Keyword
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
KeywordGrou Keyword Group String: case-insensitive.
Index N/A
pName Name Length: 1 to 63 characters.
Keyword of
matching the String: case-sensitive.
Keyword Index N/A
application Length: 1 to 63 characters.
behavior content

5
AUDIT/PolicyRules
This table contains the information of a Audit Rule in specify policy.

XML structure
<AUDIT>
<PolicyRules>
<Rule>
<PolicyName></PolicyName>
<RuleID></RuleID>
<AppCategoryID></AppCategoryID>
<AppID></AppID>
<BehaviorID></BehaviorID>
<BhContentID></BhContentID>
<FilterType></FilterType>
<MatchType></MatchType>
<KeywordGroupName></KeywordGroupName>
<Number></Number>
<PktAction></PktAction>
<AuditLogging></AuditLogging>
</Rule>
</PolicyRules>
</AUDIT>

Table description
Item Description
Feature name Audit
Table name PolicyRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String: case-insensitive.
PolicyName Policy Name Index N/A
Length: 1 to 63 characters.
Unsigned integer:
RuleID Rule ID Index N/A
Value range: 1 to 64.

AppCategoryI App Category N/A Unsigned integer: N/A

6
 Column Column Column
Data type and restrictions Remarks
name description type
D 32
ID Value range: 0 to 2 - 1.

Application layer Unsigned integer:

AppID N/A 32 N/A
protocol ID Value range: 0 to 2 - 1.

Application Unsigned integer:

BehaviorID N/A 32 N/A
Behavior ID Value range: 0 to 2 - 1.
Application Unsigned integer:
BhContentID behavior content N/A 32 N/A
ID Value range: 0 to 2 - 1.

Filter type the Enumeration:

FilterType application N/A • 0—Keyword Filter. N/A
behavior content • 1—Number Filter.

String: case-insensitive. Contain the keyword for

KeywordGrou Keyword Group
N/A mathing application
pName Name Length: 1 to 63 characters. behavior content.

Unsigned integer: Number for matching

Number Number N/A 32 the application behavior
Value range: 0 to 2 – 1. content.
Enumeration:
• 0—Equal.
• 1—Greater.
• 2—Less.
MatchType Match Type N/A • 3—Include. N/A
• 4—Greater or Equal.
• 5—Less or Equal.
• 6—Unequal.
• 7—Exclude.
Enumeration:
PktAction Packet Action N/A • 0—Permit. N/A
• 1—Deny.

Whether or not Enumeration:

AuditLogging send the Audit N/A • 0—Don’t Send Audit log. N/A
Logging • 1—Send Audit log.

AUDIT/SignatureAutoUpgrading
This table contains the information of AUDIT signatures auto upgrading.

XML structure
<AUDIT>
<SignatureAutoUpgrading>
<Enabled></Enabled>
<StartTime></StartTime>
<Type></Type>
<Day></Day>
</SignatureAutoUpgrading>

7
 </AUDIT>

Table description
Item Description
Feature name AUDIT
Table name SignatureAutoUpgrading
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
Enabled or
Enabled
disabled
N/A • true. N/A
• false.
The time that the Date Time.
StartTime system auto N/A N/A
upgrading Format: HH:MM:SS

Type of the Enumeration:

Type system auto N/A • 0—Week. N/A
upgrading • 1—periodic.
When Type is 0, the
Unsigned integer: value range is 0 to 6.
Day Days N/A
Value range: 0-6. Otherwise, the value is
invalid.

8
Contents
AUDIT ···························································································1
AUDIT/ Policies ························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AUDIT/PolicyOptions ·················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AUDIT/DefaultPolicyAction··········································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
AUDIT/AppPolicyKeywordGroups·································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
AUDIT/Keywords ······················································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
AUDIT/PolicyRules ····················································································································· 5
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
AUDIT/AppBehaviors ·················································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8
AUDIT/AppBehaviorContents ······································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ···························································································································· 9
AUDIT/AppBhContentsFilterType ·································································································· 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
AUDIT/AppCategories··············································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
AUDIT/AppCategoryMembers ···································································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 12
AUDIT/Behaviors ····················································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 12
AUDIT/BehaviorContents··········································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 13
Columns ·························································································································· 13
AUDIT/SignatureAutoUpgrading·································································································· 13
XML structure ··················································································································· 14
Table description ··············································································································· 14
Columns ·························································································································· 14

i
AUDIT/SignatureFileInfos ·········································································································· 14
XML structure ··················································································································· 15
Table description ··············································································································· 15
Columns ·························································································································· 15
AUDIT/UpdatePercentage ········································································································· 15
XML structure ··················································································································· 16
Table description ··············································································································· 16
Columns ·························································································································· 16
AUDIT/KeywordGroupReferences ······························································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 17
Columns ·························································································································· 17
AUDIT/AUDITSpecification ········································································································ 17
XML structure ··················································································································· 17
Table description ··············································································································· 17
Columns ·························································································································· 18

ii
AUDIT
AUDIT/ Policies
This table contains information about the AUDIT’s policy.

XML structure
<AUDIT>
<Policies>
<Policy>
<PolicyName></PolicyName>
<Disable></Disable>
<TimeRangeName></TimeRangeName>
<DefaultRuleAction></DefaultRuleAction>
<PolicyType></PolicyType>
<RuleMatchType></RuleMatchType>
</Policy>
</Policies>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String: case-insensitive.
PolicyName Policy Name Index N/A
Length: 1 to 63 characters.

Set this value to Boolean:

Disable true to disable N/A • true. N/A
the policy • false.

TimeRangeN Time Range String: case-insensitive.

N/A N/A
ame Name Length: 1 to 63 characters.
Enumeration: The policy type must be
PolicyType Policy Type N/A
• 0—NoAudit. set when policy is

1
 Column Column Column
Data type and restrictions Remarks
name description type
• 1—Audit. created.
• 2—Deny.
Enumeration:
DefaultRuleA Default Rule
ction Action
N/A • 0—Permit. N/A
• 1—Deny.
Enumeration:
RuleMatchTy Rule Matching
pe Type
N/A • 0—Order. N/A
• 1—Full.

AUDIT/PolicyOptions
This table contains some multiple information about the AUDIT’s policy.

XML structure
<AUDIT>
<PolicyOptions>
<Option>
<PolicyName></PolicyName>
<OptionType></OptionType>
<OptionValue></OptionValue>
</Option>
</PolicyOptions>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name PolicyOptions
Table type Multi-instance table
Row name Option
Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
Name can not be
String: case-insensitive. same with its
PolicyName Policy Name Index siblings.
Length: 1 to 63 characters.
It is Mandatory

2
 Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 1—SourceZones.
• 2—DestZones.
• 3—SourceIPv4AddressSets.
• 4—SourceIPv6AddressSets.
Type of the
• 5—DestIPv4AddressSets
OptionType option in the Index N/A
policy • 6—DestIPv6AddressSets
• 7—Users.
• 8—User Groups.
• 9—Applications.
• 10—AppGroups.
• 11—Service.
String: case-insensitive.
Length: 1 to 63 characters (for
OptionTypes 9 and 10).
Value of the Values of
Length: 1 to 31 characters
OptionValue special option Index OptionTypes 7 and
type in the policy (for OptionTypes1 through 6, 8 are in Json format.
and OptionType11).
Length: 1 to 480 characters (for
OptionTypes 7 and 8).

AUDIT/DefaultPolicyAction
This table contains information about the AUDIT’s default policy action.

XML structure
<AUDIT>
<DefaultPolicyAction>
<DefaultAction>
<Action></Action>
</DefaultAction>
</DefaultPolicyAction>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name DefaultPolicyAction
Table type Multi-instance table
Row name DefaultAction
Restrictions None

3
Columns

Column Column Column

Data type and restrictions Remarks
name description type
Packet Action Enumeration:
Action which not match N/A • 0—Permit. N/A
any Audit’s policy • 1—Deny.

AUDIT/AppPolicyKeywordGroups
This table contains information about the AUDIT’s keywordgroup.

XML structure
<AUDIT>
<AppPolicyKeywordGroups>
<KeywordGroup>
<KeywordGroupName></KeywordGroupName>
<Description></Description>
<RefCnt></RefCnt>
</KeywordGroup>
</AppPolicyKeywordGroups>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name AppPolicyKeywordGroups
Table type Multi-instance table
Row name KeywordGroup
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
KeywordGrou Keyword Group String: case-insensitive.
Index N/A
pName Name Length: 1 to 63 characters.
Description String: case-insensitive.
Description about keyword N/A N/A
group Length: 1 to 256 characters.

Refer count Unsigned integer:

RefCnt N/A 16 N/A
about keyword Value range: 0 to 2 – 1.

4
 Column Column Column
Data type and restrictions Remarks
name description type
group

AUDIT/Keywords
This table contains information about the keywords of keywordgroup.

XML structure
<AUDIT>
<Keywords>
<Keyword>
<KeywordGroupName></KeywordGroupName>
<Keyword></Keyword>
</Keyword>
</Keywords>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name Keywords
Table type Multi-instance table
Row name Keyword
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
KeywordGrou Keyword Group String: case-insensitive.
Index N/A
pName Name Length: 1 to 63 characters.
Keyword of
matching the String: case-sensitive.
Keyword Index N/A
application Length: 1 to 63 characters.
behavior content

AUDIT/PolicyRules
This table contains the information of a Audit Rule in specify policy.

5
XML structure
<AUDIT>
<PolicyRules>
<Rule>
<PolicyName></PolicyName>
<RuleID></RuleID>
<AppCategoryID></AppCategoryID>
<AppID></AppID>
<BehaviorID></BehaviorID>
<BhContentID></BhContentID>
<FilterType></FilterType>
<MatchType></MatchType>
<KeywordGroupName></KeywordGroupName>
<Number></Number>
<PktAction></PktAction>
<AuditLogging></AuditLogging>
</Rule>
</PolicyRules>
</AUDIT>

Table description
Item Description
Feature name Audit
Table name PolicyRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String: case-insensitive.
PolicyName Policy Name Index N/A
Length: 1 to 63 characters.
Unsigned integer:
RuleID Rule ID Index N/A
Value range: 1 to 64.

AppCategoryI App Category Unsigned integer:

N/A 32 N/A
D ID Value range: 0 to 2 - 1.

Application layer Unsigned integer:

AppID N/A 32 N/A
protocol ID Value range: 0 to 2 - 1.

Application Unsigned integer:

BehaviorID N/A 32 N/A
Behavior ID Value range: 0 to 2 - 1.

6
 Column Column Column
Data type and restrictions Remarks
name description type
Application Unsigned integer:
BhContentID behavior content N/A 32 N/A
ID Value range: 0 to 2 - 1.

Filter type the Enumeration:

FilterType application N/A • 0—Keyword Filter. N/A
behavior content • 1—Number Filter.

String: case-insensitive. Contain the keyword for

KeywordGrou Keyword Group
N/A mathing application
pName Name Length: 1 to 63 characters. behavior content.

Unsigned integer: Number for matching

Number Number N/A 32 the application behavior
Value range: 0 to 2 – 1. content.
Enumeration:
• 0—Equal.
• 1—Greater.
• 2—Less.
MatchType Match Type N/A • 3—Include. N/A
• 4—Greater or Equal.
• 5—Less or Equal.
• 6—Unequal.
• 7—Exclude.
Enumeration:
PktAction Packet Action N/A • 0—Permit. N/A
• 1—Deny.

Whether or not Enumeration:

AuditLogging send the Audit N/A • 0—Don’t Send Audit log. N/A
Logging • 1—Send Audit log.

AUDIT/AppBehaviors
This table contains the behavior of the application or application category.

XML structure
<AUDIT>
<AppBehaviors>
<AppBehavior>
<AppCategoryID></AppCategoryID>
<AppID></AppID>
<BehaviorIDs>
<BehaviorID></BehaviorID>
</BehaviorIDs>
</AppBehavior>
</AppBehaviors>
</AUDIT>

7
Table description
Item Description
Feature name Audit
Table name AppBehaviors
Table type Multi-instance table
Row name AppBehavior
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
AppCategoryI App Category Unsigned integer:
Index 32 N/A
D ID Value range: 0 to 2 - 1.

Application layer Unsigned integer:

AppID Index 32 N/A
protocol ID Value range: 0 to 2 - 1.

Data Members include:

BehaviorIDs Behavior ID list N/A
structure • BehaviorID.
Contains Multiple
Unsigned integer: BehaviorID in the
BehaviorID Behavior ID N/A 32
Value range: 0 to 2 - 1. application or
application category.

AUDIT/AppBehaviorContents
This table contains the behavior Content of the application or application category.

XML structure
<AUDIT>
<AppBehaviorContents>
<BhContent>
<AppCategoryID></AppCategoryID>
<AppID></AppID>
<BehaviorID></BehaviorID>
<BhContentIDs>
<BhContentID></BhContentID>
</BhContentIDs>
</BhContent>
</AppBehaviorContents>
</AUDIT>

8
Table description
Item Description
Feature name Audit
Table name AppBehaviorContents
Table type Multi-instance table
Row name BhContent
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
AppCategoryI App Category Unsigned integer:
Index 32 N/A
D ID Value range: 0 to 2 - 1.

Application layer Unsigned integer:

AppID Index 32 N/A
protocol ID Value range: 0 to 2 - 1.
Unsigned integer:
BehaviorID Behavior ID Index 32 N/A
Value range: 0 to 2 - 1.

Behavior content Data Members include:

BhContentIDs N/A
ID list structure • BhContentID.
Contains Multiple
Behavior content Unsigned integer. BhContentID in the
BhContentID N/A 32
ID Value range: 0 to 2 - 1. application or
application category.

AUDIT/AppBhContentsFilterType
This table contains the behavior content filter type of the application or application category.

XML structure
<AUDIT>
<AppBhContentFilterType>
<BhContentFilterType>
<AppCategoryID></AppCategoryID>
<AppID></AppID>
<BehaviorID></BehaviorID>
<BhContentID></BhContentID>
<FilterType></FilterType>
</BhContentFilterType>
</AppBhContentFilterType>
</AUDIT>

9
Table description
Item Description
Feature name Audit
Table name AppBhContentFilterType
Table type Multi-instance table
Row name BhContentFilterType
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
AppCategoryI App Category Unsigned integer:
Index 32 N/A
D ID Value range: 0 to 2 - 1.

Application layer Unsigned integer:

AppID Index 32 N/A
protocol ID Value range: 0 to 2 - 1.
Unsigned integer:
BehaviorID Behavior ID Index 32 N/A
Value range: 0 to 2 - 1.

Behavior content Unsigned integer.

BhContentID Index 32 N/A
ID Value range: 0 to 2 - 1.

Filter type the Enumeration:

FilterType application N/A • 0—Keyword Filter. N/A
behavior content • 1—Number Filter.

AUDIT/AppCategories
This table contains informations about the Audit’s application categories.

XML structure
<AUDIT>
<AppCategories>
<AppCategory>
<AppCategoryID></AppCategoryID>
<AppCategoryName></AppCategoryName>
</AppCategory>
</AppCategories>
</AUDIT>

10
Table description
Item Description
Feature name Audit
Table name AppCategories
Table type Multi-instance table
Row name AppCategory
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
AppCategoryI App Category Unsigned integer:
Index 32 N/A
D ID Value range: 0 to 2 - 1.

AppCategory App Category String: case-insensitive.

N/A N/A
Name Name Length: 1 to 63 characters.

AUDIT/AppCategoryMembers
This table contains the Audit’s application protocols included in an application category.

XML structure
<AUDIT>
<AppCategoryMembers>
<AppCategoryMember>
<AppCategoryID></AppCategoryID>
<AppID></AppID>
<AppName></AppName>
</AppCategoryMember>
</AppCategoryMembers>
</AUDIT>

Table description
Item Description
Feature name Audit
Table name AppCategoryMembers
Table type Multi-instance table
Row name AppCategoryMember

11
 Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
AppCategoryI App Category Unsigned integer:
Index 32 N/A
D ID Value range: 0 to 2 - 1.

Application layer Unsigned integer:

AppID Index 32 N/A
protocol ID Value range: 0 to 2 - 1.

Application layer String: case-insensitive.

AppName N/A N/A
protocol name Length: 1 to 63 characters.

AUDIT/Behaviors
This table contains informations about the Audit’s application behaviors

XML structure
<AUDIT>
<Behaviors>
<Behavior>
<BehaviorID></BehaviorID>
<BehaviorName></BehaviorName>
</Behavior>
</Behaviors>
</AUDIT>

Table description
Item Description
Feature name Audit
Table name Behaviors
Table type Multi-instance table
Row name Behavior
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
App Behavior Unsigned integer:
BehaviorID Index 32 N/A
ID Value range: 0 to 2 - 1.

12
 Column Column Column
Data type and restrictions Remarks
name description type
BehaviorNam App Behavior String: case-insensitive.
N/A N/A
e Name Length: 1 to 63 characters.

AUDIT/BehaviorContents
This table contains informations about the Audit’s application behavior contents.

XML structure
<AUDIT>
<BehaviorContents>
<BehaviorContent>
<BhContentID></BhContentID>
<BhContentName></BhContentName>
</BehaviorContnet>
</BehaviorContents>
</AUDIT>

Table description
Item Description
Feature name Audit
Table name BehaviorContents
Table type Multi-instance table
Row name BehaviorContent
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
App Behavior Unsigned integer:
BhContentID Index 32 N/A
Content ID Value range: 0 to 2 - 1.

BhContentNa App Behavior String, case-insensitive:

N/A N/A
me Content Name Length: 1 to 63 characters.

AUDIT/SignatureAutoUpgrading
This table contains the information of AUDIT signatures auto upgrading.

13
XML structure
<AUDIT>
<SignatureAutoUpgrading>
<Enabled></Enabled>
<StartTime></StartTime>
<Type></Type>
<Day></Day>
</SignatureAutoUpgrading>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name SignatureAutoUpgrading
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
Enabled or
Enabled
disabled
N/A • true. N/A
• false.

The time that the Date Time.

StartTime system auto N/A Format: N/A
upgrading HH:MM:SS.

Type of the Enumeration:

Type system auto N/A • 0—Week. N/A
upgrading • 1—periodic.
When Type is 0, the
Unsigned integer: value range is 0 to 6.
Day Days N/A
Value range: 0-6. Otherwise, the value is
invalid.

AUDIT/SignatureFileInfos
This table contains the signature file information.

14
XML structure
<AUDIT>
<SignatureFileInfos>
<FileInfo>
<FileStatus></FileStatus>
<Version></Version>
<PublishedTime></PublishedTime>
<Description></Description>
</FileInfo>
</SignatureFileInfos>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name SignatureFileInfos
Table type MultiSingle-instance table
Row name FileInfo
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
signature file • 1—current.
FileStatus Index N/A
Status • 2—last.
• 3—factory.
Version of the String: case-insensitive.
Version N/A v.v(2.1)
signature file Length: 1 to 31 characters.

The time when DateTime.

PublishedTim
the signature is N/A Format: Consider time-zone.
e
published YYYY-MM-DDTHH:MM:SS.

DescriptionInfor String: case-insensitive

Description N/A N/A
mation Length: 1 to 255 characters.

AUDIT/UpdatePercentage
This table contains the percentage of update.

15
XML structure
<AUDIT>
<UpdatePercentage>
<Percentage></Percentage>
</UpdatePercentage>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name UpdatePercentage
Table Type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
When the value range
the percentage is 0 to 100,it means in
Percentage N/A Unsigned integer:
of update. upgrading, Otherwise,
means error.

AUDIT/KeywordGroupReferences
This table contains the information about the relationship between AUDIT’s policys and
keywordgroups.

XML structure
<AUDIT>
<KeywordGroupReferences>
<KeywordGroupReference>
<KeywordGroupName></KeywordGroupName>
<PolicyName></PolicyName>
<RuleID></RuleID>
</KeywordGroupReference>
</KeywordGroupReferences>
</AUDIT>

16
Table description
Item Description
Feature name AUDIT
Table name KeywordGroupReferences
Table type Multi-instance table
Row name KeywordGroupReference
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
KeywordGrou Keyword Group String: case-insensitive.
Index N/A
pName Name Length: 1 to 63 characters.
String: case-insensitive.
PolicyName Policy Name Index N/A
Length: 1 to 63 characters.
Unsigned integer:
RuleID Rule ID Index N/A
Value range: 1 to 64.

AUDIT/AUDITSpecification
This table contains the AUDIT specification information.

XML structure
<AUDIT>
<AUDITSpecification>
<SupportDomain></SupportDomain>
</AUDITSpecification>
</AUDIT>

Table description
Item Description
Feature name AUDIT
Table name AUDITSpecification
Table type Single-instance table
Row name None
Restrictions None

17
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Whether the Boolean:
SupportDoma function of
in AUDIT domain
N/A • true. N/A
is supported. • false.

18
Contents
AUDIT ···························································································2
AUDIT/Policies ·························································································································· 2
AUDIT/AppPolicyKeywordGroups·································································································· 2
AUDIT/Keywords ······················································································································· 2

i
AUDIT
AUDIT/Policies
Message Explanation
Maximum number of policy already reached. The maximum number of polices cannot be exceeded.
策略数量达到上限。 当配置策略时，策略数量不能超过上限。

AUDIT/AppPolicyKeywordGroups
Message Explanation
The keyword group name cannot be a, an, or any. The name of a keyword group cannot be a, an, or any.
关键字组名称不能是a，an，any。 当配置关键字组时，关键字组名不能是 a，an，any。

A keyword group cannot be deleted when it is being used by a

The keyword group is being used by a rule and rule.
cannot be deleted.
当删除关键字组时，这个关键字组正在被某个规则引用，不能被删
关键字组正在被某个规则引用，不能被删除。
除。

Maximum number of keyword groups already

The maximum number of keyword groups cannot be exceeded.
reached.
当配置关键字组时，关键字组数量不能超过上限。
关键字组数量达到上限。

The keyword group already exists. The keyword group already exists.
关键字组已经存在。 当配置关键字时，关键字组不能相同。

AUDIT/Keywords
Message Explanation
Maximum number of keywords already reached. The maximum number of keywords cannot be exceeded.
关键字数量达到上限。 当配置关键字时，关键字数量不能超过上限。

2
Contents
AVC ······························································································1
AVC/MoveTrafficPolicyRule ········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
AVC
AVC/MoveTrafficPolicyRule
This table contains information about the AVC’s rule number information.

XML structure
<AVC>
<MoveTrafficPolicyRule>
<Move>
<RuleNumber></RuleNumber>
<NextRuleNumber></NextRuleNumber>
</Move>
</MoveTrafficPolicyRule>
</AVC>

Table description
Item Description
Feature name AVC
Table name MoveTrafficPolicyRule
Table type Multi-instance table
Row name Move
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer: Rule number is the
RuleNumber Rule number Index
1 to 4294967295 match order.

NextRuleNum Next rule‘s rule Unsigned integer:

N/A Single value
ber number 0 to 4294967295

1
Contents
AVC ······························································································1
AVC/TrafficPolicyRules ··············································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AVC/RuleOptions ······················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
AVC/TrafficPolicyProfiles ············································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
AVC/ RuleJsonOptions················································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 7
Columns ···························································································································· 7
AVC/FullFlowMonitorSwitch ········································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8

i
AVC
AVC/TrafficPolicyRules
This table contains information about the AVC’s rule information.

XML structure
<AVC>
<TrafficPolicyRules>
<Rule>
<RuleNumber></RuleNumber>
<ParentRuleNumber></ParentRuleNumber>
<RuleName></RuleName>
<Enable></Enable>
<TimeRange></TimeRange>
<Ipv6FlowLabelValue></Ipv6FlowLabelValue>
<Ipv6ExtensionHeader></Ipv6ExtensionHeader>
<Action>
<RuleAction></RuleAction>
<ProfileName></ProfileName>
</Action>
<ModelId></ModelId>
</Rule>
</TrafficPolicyRules>
</AVC>

Table description
Item Description
Feature name AVC
Table name TrafficPolicyRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Rule number is the
RuleNumber Rule number Index Unsigned integer:
match order.

1
 Column Column Column
Data type and restrictions Remarks
name description type
Value range: 1 to 4294967295.

ParentRuleN Parent Rule‘s Unsigned integer:

N/A Optional
umber rule number Value range: 1 to 4294967295.
Name cannot be same
String, case-insensitive.
RuleName name N/A with its siblings.
Length: 1 to 63 characters.
Mandatory

Set this value to Boolean:

Enable true to disable N/A • true. Optional
the rule • false.

Time Range String, case-insensitive.

TimeRange N/A Optional, Single value
Name Length: 1 to 63 characters.

Ipv6FlowLabe Ipv6 header’s Unsigned integer:

N/A Optional
lValue Flow Lbael Value Value range: 0 to 2.

Ipv6Extensio Ipv6 extension Unsigned integer:

N/A Optional
nHeader headers Value range: 0 to 63.

TrafficPolify String, case-insensitive.

ProfileName N/A Optional
profile name Length: 1 to 63 characters.

Model rule Unsigned integer:

ModelId N/A Optional
number Value range: 1 to 4294967295.
Set this value to Unsigned integer:
RuleAction config the rule’s N/A Optional
action Value range: 1 to 3.

AVC/RuleOptions
This table contains some multiple information about the AVC’s rule option.

XML structure
<AVC>
<RuleOptions>
<Option>
<RuleNumber></RuleNumber>
<OptionType></OptionType>
<OptionVal></OptionVal>
</Option>
</RuleOptions>
</AVC>

Table description
Item Description
Feature name AVC

2
 Table name RuleOptions
Table type Multi-instance table
Row name Option
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer: Rule number is the
RuleNumber Rule number Index
Value range: 1 to 4294967295. match order.

Enumeration:
• 1—SourceZones.
• 2—DestZones.
• 3—SourceAddressSets.
• 4—DestAddressSets.
Type of the
OptionType
configuration
Index • 5—Users. N/A
• 6—UserGroups.
• 7—Applications.
• 8—AppGroups.
• 9—Services.
• 10—Dscp.
String, case-insensitive.
Length: 1 to 63characters (for
OptionTypes 7 and 8).
Length: 1 to 31 characters ( for
Value of the Values of OptionTypes
OptionTypes 1 through 4, and
OptionVal special type Index 5 and 6 are in Json
OptionType 9).
configuration format.
Length: 1 to 100 characters
(for OptionType 10).
Length: 1 to 480 characters
(for OptionTypess 5 and 6).

AVC/TrafficPolicyProfiles
This table contains information about the AVC traffic policy’s Control profiles.

XML structure
<AVC>
<TrafficPolicyProfiles>
<Profile>
<ProfileNumber></ProfileNumber>
<ProfileName></ProfileName>
<ReferenceMode></ReferenceMode>
<IpAverageEnable></IpAverageEnable>

3
 <TotalMaxKbps></TotalMaxKbps>
<TotalGuaranteedKbps></TotalGuaranteedKbps>
<TotalGuaranteedKbpsPerIP></TotalGuaranteedKbpsPerIP>
<TotalGuaranteedKbpsPerUser></TotalGuaranteedKbpsPerUser>
<TotalMaxKbpsPerIP></TotalMaxKbpsPerIP>
<TotalMaxKbpsPerUser></TotalMaxKbpsPerUser>
<DnGuaranteedKbpsPerIP></DnGuaranteedKbpsPerIP>
<UpGuaranteedKbpsPerIP></UpGuaranteedKbpsPerIP>
<DnGuaranteedKbpsPerUser></DnGuaranteedKbpsPerUser>
<UpGuaranteedKbpsPerUser></UpGuaranteedKbpsPerUser>
<DnMaxKbps></DnMaxKbps>
<UpMaxKbps></UpMaxKbps>
<DnGuaranteedKbps></DnGuaranteedKbps>
<UpGuaranteedKbps></UpGuaranteedKbps>
<DnMaxKbpsPerIP></DnMaxKbpsPerIP>
<UpMaxKbpsPerIP></UpMaxKbpsPerIP>
<DnMaxKbpsPerUser></DnMaxKbpsPerUser>
<UpMaxKbpsPerUser></UpMaxKbpsPerUser>
<Priority></Priority>
<RemarkDSCP></RemarkDSCP>
<MaxConnNum></MaxConnNum>
<MaxConnNumPerIP></MaxConnNumPerIP>
<MaxConnNumPerUser></MaxConnNumPerUser>
<MaxConnRate></MaxConnRate>
<MaxConnRatePerIP></MaxConnRatePerIP>
<MaxConnRatePerUser></MaxConnRatePerUser>
</Profile>
</TrafficPolicyProfiles>
</AVC>

Table description
Item Description
Feature name AVC
Table name TrafficPolicyProfiles
Table type Multi-instance table
Row name Profile
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ProfileNumbe Rule option is the
Profile number Index Unsigned integer:
r match order.

4
Column Column Column
Data type and restrictions Remarks
name description type
Value range: 1 to 4294967295.
Profile Name,
cannot be same String, case-insensitive.
ProfileName N/A N/A
with other Length: 1 to 63 characters.
profiles
Unsigned integer:
ReferenceMo Rule shared
de mode
N/A • 0—per-rule. N/A
• 1—rule-shared.
Boolean:
IpAverageEn Ip average
able enable
N/A • true. N/A
• false.

TotalMaxKbp Unsigned integer:

Total max kbps N/A N/A
s Value range: 8 to 100,000,000.

TotalGuarant Total guaranteed Unsigned integer:

N/A N/A
eedKbps kbps Value range: 8 to 100,000,000.
TotalGuarant Total Unsigned integer:
eedKbpsPerI guaranteed kbps N/A N/A
P per ip Value range: 8 to 100,000,000.

TotalGuarant Unsigned integer:

Total guaranteed
eedKbpsPerU N/A N/A
kbps per user Value range: 8 to 100,000,000.
ser

TotalMaxKbp Total max kbps Unsigned integer:

N/A N/A
sPerIP per ip Value range: 8 to 100,000,000.

TotalMaxKbp Total max kbps Unsigned integer:

N/A N/A
sPerUser per user Value range: 8 to 100,000,000.
Down Unsigned integer:
DnGuarantee
guaranteed kbps N/A N/A
dKbpsPerIP Value range: 8 to 100,000,000.
per ip

UpGuarantee Up guaranteed Unsigned integer:

N/A N/A
dKbpsPerIP kbps per ip Value range: 8 to 100,000,000.
DnGuarantee Down Unsigned integer:
dKbpsPerUse guaranteed kbps N/A N/A
r per user Value range: 8 to 100,000,000.

UpGuarantee Unsigned integer:

Up guaranteed
dKbpsPerUse N/A N/A
kbps per user Value range: 8 to 100,000,000.
r
Downstream Unsigned integer:
DnGuarantee
Guaranteed N/A Optional
dKbps Value range: 8 to 100,000,000.
bandwidth

UpGuarantee Upstream Unsigned integer:

N/A Optional
dKbps guaranteed Kbps Value range: 8 to 100,000,000.

Downstream Unsigned integer:

DnMaxKbps N/A Optional
Max Kbps Value range: 8 to 100,000,000.

Upstream Max Unsigned integer:

UpMaxKbps N/A Optional
Kbps Value range: 8 to 100,000,000.

5
 Column Column Column
Data type and restrictions Remarks
name description type
DnMaxKbpsP Downstream Unsigned integer:
N/A Optional
erIP Max Kbps per iP Value range: 8 to 100,000,000.

Unsigned integer: Optional. Per-IP and

UpMaxKbpsP Upstream Max
N/A Per-User are
erIP Kbps Per IP Value range: 8 to 100,000,000. exclusive.
Downstream Unsigned integer:
DnMaxKbpsP
Max Kbps per N/A Optional
erUser Value range: 8 to 100,000,000.
User

UpMaxKbpsP Upstream Max Unsigned integer:

N/A Optional
erUser Kbps PerUser Value range: 8 to 100,000,000.
When the outbound
bandwidth is limited,
Stream Priority Unsigned integer: the priority of the
Priority N/A
leve Value range: 1 to 7. stream is higher, the
stream is prior to pass
the interface.

RemarkDSC Unsigned integer:

Dscp value N/A Optional
P Value range: 0 to 63.

MaxConnNu Max up Unsigned integer:

N/A Optional
m connections Value range: 1 to 12,000,000.
Max up Unsigned integer: Optional Per-IP and
MaxConnNu
connections per N/A Per-User are
mPerIP Value range: 1 to 12,000,000.
IP exclusive.
Max up Unsigned integer:
MaxConnNu
connections per N/A Optional
mPerUser Value range: 1 to 12,000,000.
User
Unsigned integer:
MaxConnRat Max up
N/A Value range: 1 to 12,000,000 Optional
e connections rate
times per second.

Max up Unsigned integer: Optional Per-IP and

MaxConnRat
connections rate N/A Value range: 1 to 12,000,000 Per-User are
ePerIP
per IP times per second. exclusive.

Max up Unsigned integer:

MaxConnRat
connections rate N/A Value range: 1 to 12,000,000 Optional
ePerUser
per user times per second.

AVC/ RuleJsonOptions
This table contains information about the AVC’s rule options information.

XML structure
<AVC>
<RuleJsonOptions>
</OptionJson>
<RuleJsonNumber></RuleJsonNumber>

6
 <OptionJsonType></OptionJsonType>
<OptionJsonVal></OptionJsonVal>
</OptionJson>
</RuleJsonOptions>
</AVC>

Table description
Item Description
Feature name AVC
Table name RuleJsonOptions
Table type Multi-instance table
Row name OptionJson
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
RuleJsonNu Unsigned integer: Rule number is the
Rule number Index
mber Value range: 1 to 4294967295. match order.

Enumeration:
• 1—SourceZones.
• 2—DestZones.
• 3—SourceAddressSets.
• 4—DestAddressSets.
OptionJsonTy Type of the
pe configuration
Index • 5—Users. N/A
• 6—UserGroups.
• 7—Applications.
• 8—AppGroups.
• 9—Services.
• 10—Dscp.
Json values of String, case-insensitive.
OptionJsonV
the special type Index N/A
al Length: 1 to 65535 characters.
configurations

AVC/FullFlowMonitorSwitch
This table contains information about the AVC’s full Flow monitor

XML structure
<AVC>
<FullFlowMonitorSwitch>
<MonitorSwitch>

7
 <Switch></Switch>
</MonitorSwitch>
</FullFlowMonitorSwitch>
</AVC >

Table description

Item Description
Feature name AVC
Table name FullFlowMonitorSwitch
Table type Multi-instance table
Row name MonitorSwitch
Restrictions None
Support for row creation and deletion NO

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:

Siwtch
Control flow
N/A • 0—Monitors only N/A.
monitoring TCP,UDP,ICMP.
• 1—Monitors all packets.

8
Contents
AVC ······························································································1
AVC/TrafficParentRules ·············································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AVC/TrafficPolicyChildRules ········································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
AVC/AvcRuleOptions ·················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
AVC/TrafficPolicyQuery ··············································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6
AVC/TrafficQueParentRule ·········································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ···························································································································· 9
AVC/TrafficPolicyRules ············································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 10
Columns ·························································································································· 10
AVC/RuleOptions ····················································································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 12
AVC/TrafficPolicyProfiles ··········································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 13
Columns ·························································································································· 13
AVC/AVCSpecification ·············································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 16
Columns ·························································································································· 16
AVC/FullFlowMonitorSwitch ······································································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 16
Columns ·························································································································· 17

i
AVC
AVC/TrafficParentRules
This table contains information about parent traffic rules.

XML structure
<AVC>
<TrafficParentRules>
<Rule>
<Position></Position>
<RuleNumber></RuleNumber>
<RuleName></RuleName>
<OptionContent></OptionContent>
<TotalCount></TotalCount>
<FirstSonRuleNum></FirstSonRuleNum>
<Enable></Enable>
<TimeRange></TimeRange>
<Ipv6FlowLabelValue></Ipv6FlowLabelValue>
<Ipv6ExtensionHeader></Ipv6ExtensionHeader>
<ProfileName></ProfileName>
<RuleAction></RuleAction>
</Rule>
</TrafficParentRules>
</AVC>

Table description
Item Description
Feature name AVC
Table name TrafficParentRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Record the Unsigned integer:
Position Index N/A
Number Value range: 0 to 200.
RuleNumber Rule number N/A Unsigned integer: N/A

1
 Column Column
Column name Data type and restrictions Remarks
description type
Value range: 1 to 4294967295.
String, case-insensitive.
RuleName Rule name N/A N/A
Length: 1 to 63 characters.
This column stores all
match criteria of a
parent traffic rule in the
JSON array format. A
JSON array is made up
of JSON objects. A
String, case-insensitive. JSON object describes
Match
information about one
OptionContent criterion N/A Length: 1 to65535 characters. match criterion type by
content Content: JSON array. using optionType and
optionVal. The
optionVal is a set of
values for the match
criterion. A JSON object
contains a maximum of
64 characters.

Total number Unsigned integer:

TotalCount N/A N/A
of rules Value range: 1 to 4294967295.
Return the
number of Unsigned integer:
FirstSonRuleNum N/A N/A
the first child Value range: 1 to 4294967295.
rule
Set this value Boolean:
to true to
Enable
enable the
N/A • true. N/A
rule • false.

Time range String, case-insensitive.

TimeRange N/A N/A
name Length: 1 to 32 characters.
Ipv6
Ipv6FlowLabelVal header’s Unsigned integer:
N/A N/A
ue Flow Label Value range: 0 to 2.
Value
Ipv6 Unsigned integer:
Ipv6ExtensionHe
extension N/A N/A
ader Value range: 0 to 63.
headers

Traffic profile String, case-insensitive.

ProfileName N/A N/A
name Length: 1 to 63 characters.

The Action of Unsigned integer:

RuleAction N/A N/A
Rule Value range: 0 to 3.

AVC/TrafficPolicyChildRules
This table contains information about child traffic rules.

XML structure
<AVC>

2
 <TrafficPolicyChildRules>
<Rule>
<RuleNumber></RuleNumber>
<ParentRuleNumber></ParentRuleNumber>
<RuleName></RuleName>
<FirstSonRuleNum></FirstSonRuleNum>
<Enable></Enable>
<TimeRange></TimeRange>
<Ipv6FlowLabelValue></Ipv6FlowLabelValue>
<Ipv6ExtensionHeader></Ipv6ExtensionHeader>
<RuleAction></RuleAction>
<ProfileName></ProfileName>
<OptionContent></OptionContent>
</Rule>
</TrafficPolicyChildRules>
</AVC>

Table description
Item Description
Feature name AVC
Table name TrafficPolicyChildRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Unsigned integer:
RuleNumber Rule number Index N/A
Value range: 1 to 4294967295.

ParentRuleNum Number of the Unsigned integer:

N/A N/A
ber parent rule Value range: 1 to 4294967295.
String, case-insensitive.
RuleName Rule name N/A N/A
Length: 1 to 63 characters.
Return the Unsigned integer:
FirstSonRuleNu
number of the N/A N/A
m Value range: 1 to 4294967295.
first child rule

Set this value Boolean:

Enable to true to N/A • true. N/A
enable the rule • false.

Time range String, case-insensitive.

TimeRange N/A N/A
name Length: 1 to 32 characters.

Ipv6FlowLabelV Ipv6 header’s N/A Unsigned integer: N/A

3
 Column Column
Column name Data type and restrictions Remarks
description type
alue flow lable Value range: 0 to 2.
value

Ipv6ExtensionH Ipv6 extension Unsigned integer:

N/A N/A
eader headers Value range: 0 to 63.

The action of Unsigned integer:

RuleAction N/A N/A
the rule Value range: 0 to 3.

Traffic profile String, case-insensitive.

ProfileName N/A N/A
name Length: 1 to 63 characters.
This column stores all
match criteria of a
parent traffic rule in the
JSON array format. A
JSON array is made up
of JSON objects. A
String, case-insensitive. JSON object describes
Match criterion information about one
OptionContent N/A Length: 1 to 10240.
content match criterion type by
Content: JSON array. using optionType and
optionVal. The
optionVal is a set of
values for the match
criterion. A JSON object
contains a maximum of
64 characters.

AVC/AvcRuleOptions
This table contains match criterion types.

XML structure
<AVC>
<AvcRuleOptions>
<AvcOption>
<AvcRuleNumber></AvcRuleNumber>
<AvcSeqNum></AvcSeqNum>
<AvcOptionType></AvcOptionType>
<AvcOptionVal></AvcOptionVal>
</AvcOption>
</AvcRuleOptions>
</AVC>

Table description
Item Description
Feature name AVC
Table name AvcRuleOptions

4
 Table type Multi-instance table
Row name AvcOption
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
AvcRuleNum Unsigned integer:
Rule number Index N/A
ber Value range: 1 to 4294967295.
Sequence
numbers for Unsigned integer:
AvcSeqNum Index N/A
values of a Value range: 1 to 4294967295.
match criterion
Enumeration:
• 1—SourceZones.
• 2—DestZones.
• 3—SourceAddressSets.
• 4—DestAddressSets.
AvcOptionTy Match criterion
pe type
N/A • 5—Users. N/A
• 6—UserGroups.
• 7—Applications.
• 8—AppGroups.
• 9—Services.
• 10—Dscp.
String, case-insensitive.
Length: 1 to65535 characters . A JSON array contains
Match criterion
AvcOptionVal N/A Content: JSON array. strings of 1 to 64
value
characters.
Such as:
[Optionval1,optionval2,…].

AVC/TrafficPolicyQuery
This table contains information about each match criterion type.

XML structure
<AVC>
<TrafficPolicyQuery>
<RuleQuery>
<UserID></UserID>
<Position></Position>
<RuleNameFilter></RuleNameFilter>
<EnableFilter></EnableFilter>
<ProfileNameFilter></ProfileNameFilter>
<TimeRangeFilter></TimeRangeFilter>
<SrcZoneFilter></SrcZoneFilter>

5
 <DestZoneFilter></DestZoneFilter>
<SrcAddrSetFilter></SrcAddrSetFilter>
<DestAddrSetFilter></DestAddrSetFilter>
<UserFilter></UserFilter>
<UserGroupFilter></UserGroupFilter>
<ApplicationFilter></ApplicationFilter>
<AppGroupFilter></AppGroupFilter>
<ServiceFilter></ServiceFilter>
<DscpFilter></DscpFilter>
<ParentRuleNumber></ParentRuleNumber>
<RuleNumber></RuleNumber>
<RuleName></RuleName>
<OptionContent></OptionContent>
<TotalCount></TotalCount>
<Enable></Enable>
<TimeRange></TimeRange>
<ProfileName></ProfileName>
<IsExistSonFlag></IsExistSonFlag>
<Ipv6FlowLabelValue></Ipv6FlowLabelValue>
<Ipv6ExtensionHeader></Ipv6ExtensionHeader>
<Ipv6ExtensionHeaderFilter></Ipv6ExtensionHeaderFilter>
<DomainFilter></DomainFilter>
<RuleAction></RuleAction>
</RuleQuery>
</TrafficPolicyQuery>
</AVC>

Table description
Item Description
Feature name AVC
Table name TrafficPolicyQuery
Table type Multi-instance table
Row name RuleQuery
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Record the user Unsigned integer:
UserID Index N/A
ID Value range: 1 to 65535.
Record the last Unsigned integer:
Position Index N/A
query position Value range: 0 to 200.
RuleNameFilt
Rule name N/A String, case-insensitive. N/A
er

6
Column Column Column
Data type and restrictions Remarks
name description type
Length: 1 to 63 characters.
Unsigned integer:
Set this value to
• 0—Invalid.
EnableFilter true to enable N/A N/A
the rule • 1—disbale.
• 2—enable.

TimeRangeFil Time range String, case-insensitive.

N/A N/A
ter name Length: 1 to 32 characters.

ProfileNameF Traffic profile String, case-insensitive.

N/A N/A
ilter name Length: 1 to 63 characters.

Source zone String, case-insensitive.

SrcZoneFilter N/A N/A
name Length: 1 to 31 characters.

DestZoneFilte Destination zone String, case-insensitive.

N/A N/A
r name Length: 1 to 31 characters.

SrcAddrSetFil Source address String, case-insensitive.

N/A N/A
ter object name Length: 1 to 31 characters.
Destination String, case-insensitive.
DestAddrSet
address object N/A N/A
Filter Length: 1 to 31 characters.
name
String, case-insensitive.
UserFilter Username N/A N/A
Length: 1 to 55 characters.

UserGroupFilt String, case-insensitive.

User group name N/A N/A
er Length: 1 to 200 characters.

ApplicationFilt String, case-insensitive.

Application name N/A N/A
er Length: 1 to 63 characters.

AppGroupFilt Application String, case-insensitive.

N/A N/A
er group name Length: 1 to 63 characters.
String, case-insensitive.
ServiceFilter Service name N/A N/A
Length: 1 to 3 characters.
String, case-insensitive.
DscpFilter DSCP value N/A N/A
Length: 1 to 31 characters.

ParentRuleN Parent rule Unsigned integer:

N/A N/A
umber number Value range: 1 to 4294967295.

Child rule Unsigned integer:

RuleNumber N/A N/A
number Value range: 1 to 4294967295.
String, case-insensitive.
RuleName Rule name N/A N/A
Length: 1 to 63 characters.
This column stores all
match criteria of a
String, case-insensitive. parent traffic rule in the
OptionConten Match criterion JSON array format. A
N/A Length: 1 to65535.
t content JSON array is made up
Content: JSON array. of JSON objects. A
JSON object describes
information about one

7
 Column Column Column
Data type and restrictions Remarks
name description type
match criterion type by
using optionType and
optionVal. The
optionVal is a set of
values for the match
criterion. A JSON object
contains a maximum of
64 characters.

Total number of Unsigned integer:

TotalCount N/A N/A
rules Value range: 1 to 4294967295.

Set this value to Boolean:

Enable true to enable N/A • true. N/A
the rule • false.

Time range String, case-insensitive.

TimeRange N/A N/A
name Length: 1 to 32 characters.

Traffic profile String, case-insensitive.

ProfileName N/A N/A
name Length: 1 to 63 characters.
Set this value to
IsExistSonFla son traffic id to Unsigned integer:
N/A N/A
g sign if this traffic Value range: 1 to 4294967295.
has sons

Ipv6FlowLabe Ipv6 header’s Unsigned integer:

N/A N/A
lValue flow lable value Value range: 0 to 2.

Ipv6Extensio Ipv6 extension Unsigned integer:

N/A N/A
nHeader headers Value range: 1 to 4294967295.

Ipv6Extensio Ipv6 extension Unsigned integer:

N/A N/A
nHeaderFilter headers filter Value range: 0 to 63.
String, case-insensitive.
DomainFilter Domain value N/A N/A
Length: 1 to 255 characters.

The action of the Unsigned integer:

RuleAction N/A N/A
rule Value range: 0 to 3.

AVC/TrafficQueParentRule
This table contains information about the parent rule for a child rule.

XML structure
<AVC>
<TrafficQueParentRule>
<QueRule>
<RuleNumber></RuleNumber>
<PRuleNumber></PRuleNumber>
<RuleName></RuleName>
<OptionContent></OptionContent>
<Enable></Enable>

8
 <TimeRange></TimeRange>
<ProfileName></ProfileName>
</QueRule>
</TrafficQueParentRule>
</AVC>

Table description
Item Description
Feature name AVC
Table name TrafficQueParentRule
Table type Multi-instance table
Row name QueRule
Restrictions None

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Child rule Unsigned integer:
RuleNumber Index N/A
number Value range: 1 to 4294967295.

Parent rule Unsigned integer:

PRuleNumber N/A N/A
number Value range: 1 to 4294967295.
String, case-insensitive.
RuleName Rule name N/A N/A
Length: 1 to 63 characters.
This column stores all
match criteria of a
parent traffic rule in the
JSON array format. A
JSON array is made up
of JSON objects. A
String, case-insensitive. JSON object describes
Match criterion information about one
OptionContent N/A Length: 1 to 10240.
content match criterion type by
Content: JSON array. using optionType and
optionVal. The optionVal
is a set of values for the
match criterion. A JSON
object contains a
maximum of 64
characters.

Set this value Boolean:

Enable to true to N/A • true. N/A
enable the rule • false.

Time range String, case-insensitive.

TimeRange N/A N/A
name Length: 1 to 32 characters.

Traffic profile String, case-insensitive.

ProfileName N/A N/A
name Length: 1 to 63 characters.

9
AVC/TrafficPolicyRules
This table contains information about the AVC’s rule information.

XML structure
<AVC>
<TrafficPolicyRules>
<Rule>
<RuleNumber></RuleNumber>
<ParentRuleNumber></ParentRuleNumber>
<RuleName></RuleName>
<Enable></Enable>
<TimeRange></TimeRange>
<Ipv6FlowLabelValue></Ipv6FlowLabelValue>
<Ipv6ExtensionHeader></Ipv6ExtensionHeader>
<Action>
<RuleAction></RuleAction>
<ProfileName></ProfileName>
</Action>
<ModelId></ModelId>
</Rule>
</TrafficPolicyRules>
</AVC>

Table description
Item Description
Feature name AVC
Table name TrafficPolicyRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer: Rule number is the
RuleNumber Rule number Index
Value range: 1 to 4294967295. match order.

ParentRuleN Parent Rule‘s Unsigned integer:

N/A N/A
umber rule number Value range: 1 to 4294967295.
String, case-insensitive. Name cannot be same
RuleName name N/A
Length: 1 to 63 characters. with its siblings.

10
 Column Column Column
Data type and restrictions Remarks
name description type
Mandatory

Set this value to Boolean:

Enable true to disable N/A • true. N/A
the rule • false.

Time Range String, case-insensitive.

TimeRange N/A N/A
Name Length: 1 to 63 characters.

Ipv6FlowLabe Ipv6 header’s Unsigned integer:

N/A N/A
lValue Flow Label Value Value range: 0 to 2.

Ipv6Extensio Ipv6 extension Unsigned integer:

N/A N/A
nHeader headers Value range: 0 to 63.
Set this value to Unsigned integer:
RuleAction config the rule’s N/A N/A
action Value range: 1 to 3.

TrafficPolify String, case-insensitive.

ProfileName N/A N/A
profile name Length: 1 to 63 characters.

Model rule Unsigned integer:

ModelId N/A N/A
number Value range: 1 to 4294967295.

AVC/RuleOptions
This table contains some multiple information about the AVC’s rule option.

XML structure
<AVC>
<RuleOptions>
<Option>
<RuleNumber></RuleNumber>
<OptionType></OptionType>
<OptionVal></OptionVal>
</Option>
</RuleOptions>
</AVC>
<AVC>

Table description
Item Description
Feature name AVC
Table name RuleOptions
Table type Multi-instance table
Row name Option

11
 Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer: Rule number is the
RuleNumber Rule number Index
Value range: 1 to 4294967295. match order.

Enumeration:
• 1—SourceZones.
• 2—DestZones.
• 3—SourceAddressSets.
• 4—DestAddressSets.
Type of the
OptionType
configuration
Index • 5—Users. N/A
• 6—UserGroups.
• 7—Applications.
• 8—AppGroups.
• 9—Services.
• 10—Dscp.
String, case-insensitive.
Length: 1 to 63 characters (for
OptionTypes 7 and 8).
Length: 1 to 31 characters
Value of the Values of OptionTypes
OptionVal special type Index (for OptionTypes 1 through 4, 5 and 6 are in Json
configuration and OptionType 9). format.
Length: 1 to 100 characters
(for OptionType 10).
Length: 1 to 480 characters
(for OptionTypess 5 and 6).

AVC/TrafficPolicyProfiles
This table contains information about the AVC traffic policy’s Control profiles.

XML structure
<AVC>
<TrafficPolicyProfiles>
<Profile>
<ProfileNumber></ProfileNumber>
<ProfileName></ProfileName>
<ReferenceMode></ReferenceMode>
<IpAverageEnable></IpAverageEnable>
<TotalMaxKbps></TotalMaxKbps>
<TotalGuaranteedKbps></TotalGuaranteedKbps>
<TotalGuaranteedKbpsPerIP></TotalGuaranteedKbpsPerIP>
<TotalGuaranteedKbpsPerUser></TotalGuaranteedKbpsPerUser>
<TotalMaxKbpsPerIP></TotalMaxKbpsPerIP>

12
 <TotalMaxKbpsPerUser></TotalMaxKbpsPerUser>
<DnGuaranteedKbpsPerIP></DnGuaranteedKbpsPerIP>
<UpGuaranteedKbpsPerIP></UpGuaranteedKbpsPerIP>
<DnGuaranteedKbpsPerUser></DnGuaranteedKbpsPerUser>
<UpGuaranteedKbpsPerUser></UpGuaranteedKbpsPerUser>
<DnMaxKbps></DnMaxKbps>
<UpMaxKbps></UpMaxKbps>
<DnGuaranteedKbps></DnGuaranteedKbps>
<UpGuaranteedKbps></UpGuaranteedKbps>
<DnMaxKbpsPerIP></DnMaxKbpsPerIP>
<UpMaxKbpsPerIP></UpMaxKbpsPerIP>
<DnMaxKbpsPerUser></DnMaxKbpsPerUser>
<UpMaxKbpsPerUser></UpMaxKbpsPerUser>
<Priority></Priority>
<RemarkDSCP></RemarkDSCP>
<MaxConnNum></MaxConnNum>
<MaxConnNumPerIP></MaxConnNumPerIP>
<MaxConnNumPerUser></MaxConnNumPerUser>
<MaxConnRate></MaxConnRate>
<MaxConnRatePerIP></MaxConnRatePerIP>
<MaxConnRatePerUser></MaxConnRatePerUser>
</Profile>
</TrafficPolicyProfiles>
</AVC>

Table description
Item Description
Feature name AVC
Table name TrafficPolicyProfiles
Table type Multi-instance table
Row name Profile
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ProfileNumbe Unsigned integer: Rule option is the
Profile number Index
r Value range: 1 to 4294967295. match order.

Profile Name,
cannot be same String, case-insensitive.
ProfileName N/A N/A
with other Length: 1 to 63 characters.
profiles

ReferenceMo Rule shared Unsigned integer:

N/A N/A
de mode • 0—per-rule.

13
Column Column Column
Data type and restrictions Remarks
name description type
• 1—rule-shared.
Boolean:
IpAverageEn Ip average
able enable
N/A • true. N/A
• false.

TotalMaxKbp Unsigned integer:

Total max kbps N/A N/A
s Value range: 8 to 100,000,000.

TotalGuarant Total guaranteed Unsigned integer:

N/A N/A
eedKbps kbps Value range: 8 to 100,000,000.
TotalGuarant Total Unsigned integer:
eedKbpsPerI guaranteed kbps N/A N/A
P per ip Value range: 8 to 100,000,000.

TotalGuarant Unsigned integer:

Total guaranteed
eedKbpsPerU N/A N/A
kbps per user Value range: 8 to 100,000,000.
ser

TotalMaxKbp Total max kbps Unsigned integer:

N/A N/A
sPerIP per ip Value range: 8 to 100,000,000.

TotalMaxKbp Total max kbps Unsigned integer:

N/A N/A
sPerUser per user Value range: 8 to 100,000,000.
Down Unsigned integer:
DnGuarantee
guaranteed kbps N/A N/A
dKbpsPerIP Value range: 8 to 100,000,000.
per ip

UpGuarantee Up guaranteed Unsigned integer:

N/A N/A
dKbpsPerIP kbps per ip Value range: 8 to 100,000,000.
DnGuarantee Down Unsigned integer:
dKbpsPerUse guaranteed kbps N/A N/A
r per user Value range: 8 to 100,000,000.

UpGuarantee Unsigned integer:

Up guaranteed
dKbpsPerUse N/A N/A
kbps per user Value range: 8 to 100,000,000.
r
Downstream Unsigned integer:
DnGuarantee
Guaranteed N/A N/A
dkbps Value range: 8 to 100,000,000.
bandwidth

UpGuarantee Upstream Unsigned integer:

N/A N/A
dKbps guaranteed kbps Value range: 8 to 100,000,000.
Downstream Unsigned integer:
DnMaxKbps N/A N/A
Max kbps Value range: 8 to 100,000,000.
Upstream Max Unsigned integer:
UpMaxkbps N/A N/A
kbps Value range: 8 to 100,000,000.

DnMaxKbpsP Downstream Unsigned integer:

N/A N/A
erIP Max kbps per iP Value range: 8 to 100,000,000.

UpMaxKbpsP Upstream Max Unsigned integer: Per-IP and Per-User

N/A
erIP kbps Per IP Value range: 8 to 100,000,000. are exclusive.

Downstream Unsigned integer:

DnMaxKbpsP
Max kbps per N/A N/A
erUser Value range: 8 to 100,000,000.
User

14
 Column Column Column
Data type and restrictions Remarks
name description type
UpMaxKbpsP Upstream Max Unsigned integer:
N/A N/A
erUser kbps PerUser Value range: 8 to 100,000,000.
When the outbound
bandwidth is limited,
Stream Priority Unsigned integer: the priority of the
Priority N/A
leve Value range: 1 to 7. stream is higher, the
stream is prior to pass
the interface.

RemarkDSC Unsigned integer:

Dscp value N/A N/A
P Value range: 0 to 63.

MaxConnNu Max up Unsigned integer:

N/A N/A
m connections Value range: 1 to 12,000,000.
Max up Unsigned integer:
MaxConnNu Per-IP and Per-User
connections per N/A
mPerIP Value range: 1 to 12,000,000. are exclusive
IP
Max up Unsigned integer:
MaxConnNu
connections per N/A N/A
mPerUser Value range: 1 to 12,000,000.
User
Unsigned integer:
MaxConnRat Max up
N/A Value range:1 to 12,000,000 N/A
e connections rate
times per second.

Max up Unsigned integer:

MaxConnRat Per-IP and Per-User
connections rate N/A Value range:1 to 12,000,000
ePerIP are exclusive
per IP times per second.

Max up Unsigned integer:

MaxConnRat
connections rate N/A Value range:1 to 12,000,000 N/A
ePerUser
per user times per second.

AVC/AVCSpecification
This table contains the AVC specification information.

XML structure
<AVC>
<AVCSpecification>
<SupportDomain></SupportDomain>
</AVCSpecification>
</AVC>

15
Table description
Item Description
Feature name AVC
Table name AVCSpecification
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Whether the Boolean:
SupportDoma function of
in AVC domain is
N/A • true. N/A
supported. • false.

AVC/FullFlowMonitorSwitch
This table contains information about the AVC’s full flow monitor.

XML structure
<AVC>
<FullFlowMonitorSwitch>
<MonitorSwitch>
<Switch></Switch>
</MonitorSwitch>
</FullFlowMonitorSwitch>
</AVC>

Table description
Item Description
Feature name AVC
Table name FullFlowMonitorSwitch
Table type Single-instance table
Row name MonitorSwitch
Restrictions None

16
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:

Switch
Control flow
N/A • 0—Monitors only N/A
monitoring. TCP,UDP,ICMP packet.
• 1—Monitors all packets.

17
Contents
AVC ······························································································2
AVC/TrafficPolicyRules ··············································································································· 2
AVC/TrafficPolicyProfiles ············································································································· 3

i
AVC
AVC/TrafficPolicyRules
Message Explanation
Operation failed. The parent rule and the child rule
The parent rule and the child rule cannot use the same traffic
cannot use the same traffic profile.
profile.
操作失败：父策略与子策略不能引用同一个带宽通 配置父子策略时，父子策略不能引用同一个带宽通道。
道。

Operation failed. The parent rule's guaranteed

The parent rule's guaranteed bandwidth must be greater than or
bandwidth must be greater than or equal to the
equal to the child rule's guaranteed bandwidth.
child rule's guaranteed bandwidth.
配置父子策略时，父策略的保证带宽要大于等于子策略的保证带
操作失败：父策略的保证带宽要大于等于子策略的
宽。
保证带宽。

Operation failed. The maximum bandwidth of a

child rule cannot be greater than that of the parent The maximum bandwidth of a child rule cannot be greater than
rule. that of the parent rule.
操作失败：子策略的最大带宽不能大于父策略的最 配置父子策略时，子策略的最大带宽不能大于父策略的最大带宽。
大带宽。

Operation failed. The child rule's guaranteed

The child rule's guaranteed bandwidth cannot be greater than
bandwidth cannot be greater than parent rule's
parent rule's maximum bandwidth.
maximum bandwidth.
配置父子策略时，子策略的保证带宽不能大于父策略的最大限制带
操作失败：子策略的保证带宽不能大于父策略的最
宽。
大限制带宽。

The rule name already exists. The rule name already exists.
策略名称已存在。 配置带宽策略时，策略名称不能相同。

A level-4 rule cannot act as a parent rule. A level-4 rule cannot act as a parent rule.
该父策略是一个四级策略。 配置子带宽策略时，不能指定一个四级策略作为父策略。

The traffic profile reference mode for the parent and child traffic
The traffic profile reference mode for the parent rules must be the same.
and child traffic rules must be the same.
配置子带宽策略时，父子策略引用的带宽通道的限流方式必须一
父子策略引用的带宽通道的限流方式必须一致。
致。

The guaranteed bandwidth for the parent traffic rule The guaranteed bandwidth for the parent traffic rule must be
must be greater than or equal to the guaranteed greater than or equal to the guaranteed bandwidth for its child
bandwidth for its child traffic rule. traffic rule.
父策略引用带宽通道的的保证带宽不能小于子策略 配置子带宽策略时，父策略引用带宽通道的的保证带宽不能小于子
引用带宽通道的保证带宽。 策略引用带宽通道的保证带宽。

The maximum bandwidth for the parent traffic rule When configuring the child rule, the maximum bandwidth for the
must be greater than or equal to the maximum parent traffic rule must be greater than or equal to the maximum
bandwidth for its child traffic rule. bandwidth for its child traffic rule.
父策略引用带宽通道的的最大带宽不能小于子策略 配置子带宽策略时，父策略引用带宽通道的的最大带宽不能小于子
引用带宽通道的最大带宽。 策略引用带宽通道的最大带宽。

The maximum bandwidth for the parent traffic rule When configuring the child rule, the maximum bandwidth for the
must be greater than or equal to the guaranteed parent traffic rule must be greater than or equal to the guaranteed
bandwidth for its child traffic rule. bandwidth for its child traffic rule.
父策略引用带宽通道的的最大带宽不能小于子策略
引用带宽通道的保证带宽。 配置子带宽策略时，父策略引用带宽通道的的最大带宽不能小于子

2
 策略引用带宽通道的保证带宽。

The guaranteed bandwidth for a child traffic rule When configuring the child rule, the guaranteed bandwidth for a
must be smaller than the guaranteed bandwidth for child traffic rule must be smaller than the guaranteed bandwidth
its parent traffic rule. for its parent traffic rule.
子策略引用带宽通道的的保证带宽不能大于父策略 配置子带宽策略时，子策略引用带宽通道的的保证带宽不能大于父
引用带宽通道的保证带宽。 策略引用带宽通道的保证带宽。

The guaranteed bandwidth for its child traffic rule When configuring the child rule, the guaranteed bandwidth for its
must be smaller than the maximum bandwidth for child traffic rule must be smaller than the maximum bandwidth for
its parent traffic rule. its parent traffic rule.
子策略引用带宽通道的的保证带宽不能大于父策略 配置子带宽策略时，子策略引用带宽通道的的保证带宽不能大于父
引用带宽通道的最大带宽。 策略引用带宽通道的最大带宽。

The maximum bandwidth for its child traffic rule When configuring the child rule, the maximum bandwidth for its
must be smaller than the maximum bandwidth for child traffic rule must be smaller than the maximum bandwidth for
its parent traffic rule. its parent traffic rule.
子策略引用带宽通道的的最大带宽不能大于父策略 配置子带宽策略时，子策略引用带宽通道的的最大带宽不能大于父
引用带宽通道的最大带宽。 策略引用带宽通道的最大带宽。

AVC/TrafficPolicyProfiles
Message Explanation
Operation failed. The profile has been used by a
Can't delete a profile that has been used by a rule.
rule.
删除带宽通道时，无法删除已经被策略引用的带宽通道。
操作失败：无法删除已经被引用的带宽通道。

The profile name already exists. The profile name already exists.
带宽通道名称已存在。 新建带宽通道时，通道名称不能相同。

The per-IP/per-user guaranteed bandwidth must

be smaller than or equal to the per-IP/per-user The per-IP/per-user guaranteed bandwidth must be smaller than
maximum bandwidth. or equal to the per-IP/per-user maximum bandwidth.
每IP或每用户的保证带宽不能大于每IP或每用户的 配置带宽通道时，每IP或每用户的保证带宽要小于等于最大带宽。
最大带宽。

The per-IP/per-user guaranteed bandwidth must

The per-IP/per-user guaranteed bandwidth must be smaller than
be smaller than or equal to the total guaranteed
or equal to the total guaranteed bandwidth.
bandwidth.
配置带宽通道时，每IP或每用户的保证带宽不能大于整体的保证带
每IP或每用户的保证带宽不能大于整体的保证带
宽。
宽。

The total guaranteed bandwidth must be smaller The total guaranteed bandwidth must be smaller than or equal to
than or equal to the total maximum bandwidth. the total maximum bandwidth.
整体保证带宽不能大于整体最大带宽。 配置带宽通道时，整体保证带宽不能大于整体最大带宽。

The per-IP/per-user guaranteed bandwidth must The per-IP/per-user guaranteed bandwidth must be smaller than
be smaller than or equal to the total maximum or equal to the total maximum bandwidth.
bandwidth. 配置带宽通道时，每IP或每用户的保证带宽不能大于整体最大带
每IP或每用户的保证带宽不能大于整体最大带宽。 宽。

3
Contents
Bct ································································································1
Bct/ControllerTeams ··················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Bct / Controllers ························································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2

i
Bct

Bct/ControllerTeams
This table is used to configure Bct for a device and show Bct's state.

XML structure
<Bct>
<ControllerTeams>
<Team>
<TeamID></TeamID>
<Name></Name>
</Team>
</ControllerTeams>
</Bct>

Table description
Item Description
Feature name Bct
Table name ControllerTeams
Table type Multi-instance table
Row name Team
Restrictions Device support blade controller team
Support for row creation and deletion YES

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ControllerTeam Unsigned integer.
TeamID Index N/A
ID Value range: 1 to 256.

ControllerTeam String.
Name Index N/A
name Length: 1 to 31 characters.

Bct / Controllers
This table contains controller infomation.

1
XML structure
<Bct>
<Controllers>
<Controller>
<DeviceNode>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</DeviceNode>
<TeamID></TeamID>
</Controller>
</Controllers>
</Bct>

Table description
Item Description
Feature name Bct
Table name Controllers
Table type Multi-instance table
Row name Controller
Restrictions Location node to blade controller team
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
DeviceNod Information of device Data
N/A N/A
e node structure

Chassis number of Unsigned integer.

Chassis Index N/A
disk resource Value range: 0 to 65535.

Slot number of disk Unsigned integer.

Slot Index N/A
resource Value range: 0 to 65535.

CPU ID of disk Unsigned integer.

CPUID Index N/A
resource Value range: 0 to 65535.

Blade controller Unsigned integer.

TeamID N/A N/A
team ID Value range: 2 to 256.

2
Contents
Bct ································································································1
Bct/ControllerTeams ··················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Bct/Controllers ·························································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2

i
Bct

Bct/ControllerTeams
This table is used to configure Bct for a device and show Bct’s state.

XML structure
<Bct>
<ControllerTeams>
<Team>
<TeamID></TeamID>
<Name></Name>
</Team>
</ControllerTeams>
</Bct>

Table description
Item Description
Feature name Bct
Table name ControllerTeams
Table type Multi-instance table
Row name Team
Restrictions All ControllerTeams’ information.

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ControllerTeam Unsigned integer.
TeamID Index N/A
ID Value range: 1 to 256.

ControllerTeam String.
Name Index N/A
name Length: 1 to 31 characters.

Bct/Controllers
This table contains controller infomation.

1
XML structure
<Bct>
<Controllers>
<Controller>
<DeviceNode>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</DeviceNode>
<BelongID></BelongID>
<NodeType></NodeType>
</Controller>
</Controllers>
</Bct>

Table description
Item Description
Feature name Bct
Table name Controllers
Table type Multi-instance table
Row name Controller
Restrictions Controllers’ information.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
DeviceNod Information of device Data
N/A N/A
e node structure

Chassis number of Unsigned integer.

Chassis Index N/A
disk resource Value range: 0 to 65535.

Slot number of disk Unsigned integer.

Slot Index N/A
resource Value range: 0 to 65535.

CPU ID of disk Unsigned integer.

CPUID Index N/A
resource Value range: 0 to 65535.

Owning blade Unsigned integer.

BelongID N/A N/A
controller team ID Value range: 1 to 256.
Enumeration.
1：Master
NodeType Node type N/A N/A
2：Standby
3：Absent.

2
Contents
BFD ······························································································1
BFD/Base ··································································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 2
BFD/Interfaces ···························································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4

i
BFD
BFD/Base
This table contains global BFD information.

XML structure
<BFD>
<Base>
<MultihopMinTransmitInterval></MultihopMinTransmitInterval>
<MultihopMinReceiveInterval></MultihopMinReceiveInterval>
<MultihopDetectMultiplier></MultihopDetectMultiplier>
<EchoSourceIp></EchoSourceIp>
<EchoSourceIpv6></EchoSourceIpv6>
<MultihopAuthentication>
<AuthType></AuthType>
<KeyID></KeyID>
<KeyType></KeyType>
<Key></Key>
</MultihopAuthentication>
<IpRouterAlert></IpRouterAlert>
<InitMode></InitMode>
<MultihopMinControlInterval></MultihopMinControlInterval>
</Base>
</BFD>

Table description
Item Description
Feature name BFD
Table name Base
Table type Single-instance table
Row name None
Restrictions This table supports only global configurations.
Support for row creation and deletion No

1
Columns
Column Column
Column name Data type and restrictions Remarks
description type
Minimum
The value range
interval for Unsigned integer.
MultihopMinTra for this argument
transmitting N/A
nsmitInterval Unit: millisecond. varies by device
multihop BFD
model.
control packet.
MultihopMinRec Minimum
The value range
eiveInterval interval for Unsigned integer. for this argument
receiving N/A
Unit: millisecond. varies by device
multihop BFD
model.
control packet.
The value range
Multihop
MultihopDetect for this argument
detection time N/A Unsigned integer.
Multiplier varies by device
multiplier.
model.

Specify source Example: 1.1.1.1.

IP address in
EchoSourceIp N/A String, dotted decimal notation. 0.0.0.0 is an
BFD echo
packet. invalid value.

Specify source Example: 1::1.

EchoSourceIpv IPv6 address Hexadecimal string,
N/A 0::0 is an invalid
6 in BFD echo colon-separated.
packet. value.

Members include:
 AuthenticationType.
MultihopAuthen Multihop Data
 KeyID. N/A
tication Authentication. structure
 KeyType.
 Key.
Enumeration:
 1—simple.
 2—md5.
 3—m-md5.
Authentication  4—sha1.
AuthType N/A N/A
Type.  5—m-sha1.
 6—hmac-md5.
 7—hmac-m-md5.
 8—hmac-sha1.
 9—hmac-m-sha1.

Unsigned integer.
KeyID Key ID. N/A N/A
Value range: 1 to 255.

Enumeration:
KeyType Key Type. N/A  1—cipher. N/A
 2—plain.
If KeyType is
Key Key. N/A String, case-sensitive. cipher,the length
are 33 to 53

2
 Column Column
Column name Data type and restrictions Remarks
description type
characters.
If KeyType is
plain,the length
are 1 to 16
characters.

When set the ip

Set the Router
Boolean: router alert option，
Alert option in
IpRouterAlert BFD control N/A  true. set the value to
true. Otherwise,
packets for  false. set the value to
MPLS.
false.

Specify mode Enumeration:

InitMode before creating N/A  0—Active. N/A
BFD session.  1—Passive.
The value range
for this argument
varies by device
model.
Minimum It can be used on
interval for some special
transmitting Unsigned integer. devices, and
MultihopMinCo
and receiving N/A cannot be used
ntrolInterval Unit: millisecond.
multihop BFD with
control MinTransmitInterv
packets. al or
MinReceiveInterva
l at the same time
on these special
devices.

BFD/Interfaces
This table contains BFD interface information.

XML structure
<BFD>
<Interfaces>
<Interface>
<IfIndex></IfIndex>
<MinTransmitInterval></MinTransmitInterval>
<MinReceiveInterval></MinReceiveInterval>
<DetectMultiplier></DetectMultiplier>
<MinEchoReceiveInterval></MinEchoReceiveInterval>
<Authentication>
<AuthType></AuthType>
<KeyID></KeyID>
<KeyType></KeyType>
<Key></Key>
</Authentication>

3
 <Demand></Demand>
<Echo></Echo>
<MinControlInterval></MinControlInterval>
</Interface>
</Interfaces>
</BFD>

Table description
Item Description
Feature name BFD
Table name Interfaces
Table type Multi-instance table
Row name Interface
Restrictions none
Support for row creation and deletion No

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Some versions
support interface
names. For
relevant
information, see
the XSD document
of your product.
IfIndex Interface index Index Unsigned integer
For information
about IfIndex, see
“Appendix” in
Ifmgr NETCONF
XML API
Configuration
Reference.
Minimum
The value range
interval for Unsigned integer.
MinTransmitInte for this argument
transmitting N/A
rval Unit: millisecond. varies by device
single-hop
model.
BFD control.
MinReceiveInte Minimum
The value range
rval interval for Unsigned integer. for this argument
receiving N/A
Unit: millisecond. varies by device
single-hop
model.
BFD control.
The value range
Single-hop
for this argument
DetectMultiplier detection time N/A Unsigned integer.
varies by device
multiplier.
model.

4
 Column Column
Column name Data type and restrictions Remarks
description type
Minimum The value range
MinEchoReceiv interval for Unsigned integer. for this argument
N/A
eInterval receiving BFD Unit: millisecond. varies by device
echo. model.
Data Members include: N/A
structure  AuthenticationType.
Authentication Authentication.  KeyID.
 KeyType.
 Key.
Enumeration:
 1—simple.
 2—md5.
 3—m-md5.
Authentication  4—sha1.
AuthType N/A N/A
Type.  5—m-sha1.
 6—hmac-md5.
 7—hmac-m-md5.
 8—hmac-sha1.
 9—hmac-m-sha1.

Unsigned integer.
KeyID Key ID. N/A N/A
Value range: 1 to 255.

Enumeration:
KeyType Key Type. N/A  1—cipher. N/A
 2—plain.
If Key Type is
cipher,the length
are 33 to 53
characters.
Key Key. N/A String, case-sensitive.
If Key Type is
plain,the length
are 1 to 16
characters.
When set the BFD
Boolean: Demand mode，
Specify BFD set the value to
Demand N/A  true.
session mode. true. Otherwise,
 false. set the value to
false.

Enumeration:
 0—Not enable echo
function.
 1—enable echo receive
BFD echo
Echo N/A function. N/A
function.
 2—enable echo send
function.
 3—enable echo receive
and send function.

5
 Column Column
Column name Data type and restrictions Remarks
description type
The value range
for this argument
varies by device
model.
Minimum It can be used on
interval for some special
transmitting Unsigned integer. devices, and
MinControlInter
and receiving N/A cannot be used
val Unit: millisecond.
single-hop with
BFD control MinTransmitInterv
packets. al or
MinReceiveInterva
l at the same time
on these special
devices.

6
Contents
BFD ······························································································1
BFD/Base ··································································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
BFD/Interfaces ···························································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4

i
BFD
BFD/Base
This table contains global BFD information.

XML structure
<BFD>
<Base>
<MultihopMinTransmitInterval></MultihopMinTransmitInterval>
<MultihopMinReceiveInterval></MultihopMinReceiveInterval>
<MultihopDetectMultiplier></MultihopDetectMultiplier>
<EchoSourceIp></EchoSourceIp>
<EchoSourceIpv6></EchoSourceIpv6>
<MultihopAuthentication>
<AuthType></AuthType>
<KeyID></KeyID>
<KeyType></KeyType>
<Key></Key>
</MultihopAuthentication>
<IpRouterAlert></IpRouterAlert>
<InitMode></InitMode>
<MultihopMinControlInterval></MultihopMinControlInterval>
</Base>
</BFD>

Table description
Item Description
Feature name BFD
Table name Base
Table type Single-instance table
Row name None
Restrictions This table supports only global configurations.

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Minimum
interval for The value range
MultihopMinTra transmitting Unsigned integer. for this argument
N/A
nsmitInterval multihop BFD Unit: millisecond. varies by device
control model.
packets.

1
 Column Column
Column name Data type and restrictions Remarks
description type
MultihopMinRec Minimum
eiveInterval interval for The value range
receiving Unsigned integer. for this argument
N/A
multihop BFD Unit: millisecond. varies by device
control model.
packets.
The value range
Multihop
MultihopDetect for this argument
detection time N/A Unsigned integer.
Multiplier varies by device
multiplier.
model.
Specify source Example: 1.1.1.1.
IP address in
EchoSourceIp N/A String, dotted decimal notation. 0.0.0.0 is an
BFD echo
packet. invalid value.

Specify source Example: 1::1.

EchoSourceIpv IPv6 address Hexadecimal string,
N/A 0::0 is an invalid
6 in BFD echo colon-separated.
packet. value.

Members include:
 AuthenticationType.
MultihopAuthen Multihop Data
 KeyID. N/A
tication Authentication. structure
 KeyType.
 Key.

Enumeration:
 1—simple.
 2—md5.
 3—m-md5.
Authentication  4—sha1.
AuthType N/A N/A
Type.  5—m-sha1.
 6—hmac-md5.
 7—hmac-m-md5.
 8—hmac-sha1.
 9—hmac-m-sha1.

Unsigned integer.
KeyID Key ID. N/A N/A
Value range: 1 to 255.

Enumeration:
KeyType Key Type. N/A  1—cipher. N/A
 2—plain.

If Key Type is
cipher,the length
are 33 to 53
Key Key. N/A String, case-sensitive. characters.
If Key Type is
plain,the length
are 1 to 16

2
 Column Column
Column name Data type and restrictions Remarks
description type
characters.
When set the ip
Set the Router
Boolean: router alert option，
Alert option in
set the value to
IpRouterAlert BFD control N/A  true.
true. Otherwise,
packets for  false. set the value to
MPLS.
false.

Specify mode Enumeration:

InitMode before creating N/A  0—Active. N/A
BFD session.  1—Passive.

The value range

for this argument
varies by device
model.
Minimum It can be used on
interval for some special
transmitting Unsigned integer. devices, and
MultihopMinCo
and receiving N/A cannot be used
ntrolInterval Unit: millisecond.
multihop BFD with
control MinTransmitInterv
packets. al or
MinReceiveInterva
l at the same time
on these special
devices.

BFD/Interfaces
This table contains BFD interface information.

XML structure
<BFD>
<Interfaces>
<Interface>
<IfIndex></IfIndex>
<MinTransmitInterval></MinTransmitInterval>
<MinReceiveInterval></MinReceiveInterval>
<DetectMultiplier></DetectMultiplier>
<MinEchoReceiveInterval></MinEchoReceiveInterval>
<Authentication>
<AuthType></AuthType>
<KeyID></KeyID>
<KeyType></KeyType>
<Key></Key>
</Authentication>
<Demand></Demand>

3
 <Echo></Echo>
<MinControlInterval></MinControlInterval>
</Interface>
</Interfaces>
</BFD>

Table description
Item Description
Feature name BFD
Table name Interfaces
Table type Multi-instance table
Row name Interface
Restrictions none

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Some versions
support interface
name. For relevant
information, see
the XSD document
of your product.
IfIndex Interface index Index Unsigned integer For information
about IfIndex, see
“Appendix” in
Ifmgr NETCONF
XML API
Configuration
Reference.
Minimum
interval for The value range
MinTransmitInte transmitting Unsigned integer. for this argument
N/A
rval single-hop Unit: millisecond. varies by device
BFD control model.
packets.
MinReceiveInte Minimum
rval interval for The value range
receiving Unsigned integer. for this argument
N/A
single-hop Unit: millisecond. varies by device
BFD control model.
packets.
The value range
Single-hop
for this argument
DetectMultiplier detection time N/A Unsigned integer.
varies by device
multiplier.
model.

4
 Column Column
Column name Data type and restrictions Remarks
description type
Minimum The value range
MinEchoReceiv interval for Unsigned integer. for this argument
N/A
eInterval receiving BFD Unit: millisecond. varies by device
echo packets model.
Minimum The value range
MinEchoReceiv interval for Unsigned integer. for this argument
N/A
eInterval receiving BFD Unit: millisecond. varies by device
echo. model.
Members include:
 AuthenticationType.
Data
Authentication Authentication.  KeyID. N/A
structure
 KeyType.
 Key.

Enumeration:
 1—simple.
 2—md5.
 3—m-md5.
Authentication  4—sha1.
AuthType N/A N/A
Type.  5—m-sha1.
 6—hmac-md5.
 7—hmac-m-md5.
 8—hmac-sha1.
 9—hmac-m-sha1.

Unsigned integer.
KeyID Key ID. N/A N/A
Value range: 1 to 255.

Enumeration:
KeyType Key Type. N/A  1—cipher. N/A
 2—plain.

If Key Type is
cipher,the length
are 33 to 53
characters.
Key Key. N/A String, case-sensitive.
If Key Type is
plain,the length
are 1 to 16
characters.
When set the BFD
Boolean: Demand mode，
Specify BFD set the value to
Demand N/A  true.
session mode. true. Otherwise,
 false. set the value to
false.
Enumeration:
BFD echo
Echo N/A  0—Not enable echo N/A
function.
function.

5
 Column Column
Column name Data type and restrictions Remarks
description type
 1—enable echo receive
function.
 2—enable echo send
function.
 3—enable echo receive
and send function.

The value range

for this argument
varies by device
model.
Minimum It can be used on
interval for some special
transmitting Unsigned integer. devices, and
MinControlInter
and receiving N/A cannot be used
val Unit: millisecond.
single-hop with
BFD control MinTransmitInterv
packets. al or
MinReceiveInterva
l at the same time
on these special
devices.

6
Contents
BFD ······························································································2
BFD/Base ··································································································································· 2
BFD/Interfaces ···························································································································· 2

i
BFD
BFD/Base
Message Explanation
The specified configuration doesn't exist. The specified configuration doesn't exist, when getting or deleting
指定的配置不存在。 it.

Configuration already exists.

Configuration already exists, when set new configuration.
配置已经存在。

Failed to allocate memory.

No enough resource, please check your device.
分配内存失败。

Not support this value, maybe the device has no

OAM CPU. The device cannot support these parameters, please use the
bigger numbers.
参数不支持, 当前设备可能没有OAM CPU。

BFD is not configured.

BFD service has not been started.
BFD尚未配置。

Invalid value.
Specified parameter value is not valid.
参数值无效。

Min Control Interval not supported on the device.

Please configure Min TX Interval and Min RX
Interval. The device does not support configuring the Min Control Interval
parameter. Please configure Min TX Interval and Min RX Interval.
本设备不支持配置Min Control Interval。请使用Min
TX Interval和Min RX Interval。

Min TX Interval and Min RX Interval not supported

on the device. Please configure Min Control The device does not support configuring the Min TX Interval and
Interval. Min RX Interval parameters. Please configure Min Control
本设备不支持配置Min TX Interval和Min RX Interval Interval.
参数。请使用Min Control Interval。

BFD/Interfaces
Message Explanation
The specified configuration doesn't exist. The specified configuration doesn't exist, when getting or deleting
指定的配置不存在。 it.

Configuration already exists.

Configuration already exists, when set new configuration.
配置已经存在。

Failed to allocate memory.

No enough resource, please check your device.
分配内存失败。

Not support this value, maybe the device has no

OAM CPU. The device cannot support these parameters, please use the
bigger numbers.
参数不支持, 当前设备可能没有OAM CPU。

2
BFD is not configured.
BFD service has not been started.
BFD尚未配置。

Invalid value.
Specified parameter value is not valid.
参数值无效。

Min Control Interval not supported on the device.

Please configure Min TX Interval and Min RX
Interval. The device does not support configuring the Min Control Interval
parameter. Please configure Min TX Interval and Min RX Interval.
本设备不支持配置Min Control Interval。请使用Min
TX Interval和Min TX Interval。

Min TX Interval and Min RX Interval not supported

on the device. Please configure Min Control The device does not support configuring the Min TX Interval and
Interval. Min RX Interval parameters. Please configure Min Control
本设备不支持配置Min TX Interval和Min TX Interval Interval.
参数。请使用Min Control Interval。

3
Contents
BGP ······························································································1
BGP/Operations ························································································································ 1
XML structure ····················································································································· 1
Responsed XML structure ····································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 2
Responsed columns ············································································································ 2
BGP/FlushRoutes ······················································································································ 2
XML structure ····················································································································· 2
Responsed XML structure ····································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
Responsed columns ············································································································ 3
BGP/Resets ······························································································································ 4
XML structure ····················································································································· 4
Responsed XML structure ····································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
Responsed columns ············································································································ 5
BGP/Refreshs ··························································································································· 6
XML structure ····················································································································· 6
Responsed XML structure ····································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7
Responsed columns ············································································································ 7

i
BGP
BGP/Operations
This table is a description of BGP protocol actions.

XML structure
<BGP>
<Operations>
<Operation>
<OperationType></OperationType>
<Name></Name>
</Operation>
</Operations>
</BGP>

Responsed XML structure

N/A

Table description
Item Description
Feature name BGP
Table name Operations
Table type Multi-instance table
Row name Operation
Restrictions None

1
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration
1 – Send update message
immediately The operation type
OperationTyp specify the operation
Operation type Index 2 – Notice BGP protocol
e which BGP protocol
smooth start should perform.
3 –Notice BGP protocol
smooth end

String. An empty string

Name Instance name Index indicates the default
Length: 0 to 31 characters. BGP process.

Responsed columns
N/A

BGP/FlushRoutes
This table flush routes to BGP protocol.

XML structure
<BGP>
<FlushRoutes>
<FlushRoute>
<Name></Name>
<VRF></VRF>
<OperationType></OperationType>
<RouteType></RouteType>
<RouteKey></RouteKey>
<RouteSegment></RouteSegment>
<RouteAttr></RouteAttr>
</FlushRoute>
</FlushRoutes>
</BGP>

Responsed XML structure

N/A

2
Table description
Item Description
Feature name BGP
Table name FlushRoutes
Table type Multi-instance table
Row name Operation
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String. An empty string
Name Instance name Index indicates the default
Length: 0 to 31 characters. BGP process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.

Enumeration The operation type

OperationTyp specify the operation
Operation type Index 1 – Add
e that BGP should
2 – Delete perform.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
RouteType Type of route Index
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
• 7—VPNv6
• 8—L2VPN
• 9—EVPN

Binary. An empty string

RouteKey Key of route Index indicates there is no
Length: 0 to 128 characters. key of the route.

RouteSegme Route Binary.

Index
nt information Length: 1 to 4096 characters.
Binary.
RouteAttr Attribute of route
Length: 1 to 4096 characters.

Responsed columns
N/A

3
BGP/Resets
This table resets data for the BGP protocol.

XML structure
<BGP>
<Resets>
<Reset>
<Name></Name>
<Type></Type>
<Family></Family>
<ASNumber></ASNumber>
<IpAddress></IpAddress>
<Mask></Mask>
<GroupName></GroupName>
<VRF></VRF>
</Reset>
</Resets>
</BGP>

Responsed XML structure

N/A

Table description
Item Description
Feature name BGP
Table name Resets
Table type Multi-instance table
Row name Operation
Restrictions None

4
Columns
Column Column Column
Data type and restrictions Remarks
name description type
String. An empty string
Name Instance name Index indicates the default
Length: 0 to 31 characters. BGP process.
Enumeration
• 1 – As Number
• 2 – Ipv4 Address
• 3 – Ipv6 Address
Type Type Index N/A
• 4 – all
• 5 – external
• 6 – Group Name
• 7 – Internal
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
• 5—IPv6 Unicast
Address family
Family Index • 6—IPv6 Multicast. N/A
identifier
• 7—VPNv6
• 8—L2VPN
• 9—L2VPN EVPN
• 10—Link-State
• 11—IPv4 rtfilter.
• 12—IPv4 mvpn.
Unsigned integer.
Autonomous
ASNumber Value range: N/A
system number
1 to 4294967295
Example: 1.1.1.1 or
Address of String,IPv4 address string or 1::1.
IpAddress
network IPv6 address string.

For non-dynamic peers,

Mask of Unsigned integer. this is 255.For IPv4
Mask dynamic peers,this is 0
network address Value range: 0 to 128,or 255 to 32.For IPv6 dynamic
peers, this is 0 to 128.
String.
GroupName Group name N/A
Length: 1 to 47 characters.

String. An empty string

VRF VRF name indicates the public
Length: 0 to 31 characters. network.

Responsed columns
N/A

5
BGP/Refreshs
This table manually resets the BGP session softly.

XML structure
<BGP>
<Refreshs>
<Refresh>
<Name></Name>
<Type></Type>
<TriggerDirection></TriggerDirection>
<Family></Family>
<IpAddress></IpAddress>
<Mask></Mask>
<GroupName></GroupName>
<VpnInstanceName></VpnInstanceName>
</Refresh>
</Refreshs>
</BGP>

Responsed XML structure

N/A

Table description
Item Description
Feature name BGP
Table name Refreshs
Table type Multi-instance table
Row name Operation
Restrictions None

6
Columns
Column Column Column
Data type and restrictions Remarks
name description type
String. An empty string
Name Instance name Index indicates the default
Length: 0 to 31 characters. BGP process.
Enumeration:
• 1—IPAddr
• 2—All
Type Session type Index N/A
• 3—External
• 4—Group
• 5—Internal

Triggering the Enumeration.

TriggerDirecti
on
soft reset of the Index • 1—Export. N/A
direction • 2—Import.
Enumeration:
• 1—IPv4 Multicast.
• 2—IPv4 MVPN.
• 3—IPv4 Rtfilter
• 4—IPv4 Unicast
Address family • 5—IPv6 Multicast
Family identifier of Index N/A
refresh • 6—IPv6 Unicast.
• 7—Link-State
• 8—VPNv4
• 9—VPNv6
• 10—L2VPN
• 11—L2VPN EVPN
Example: 1.1.1.1 or
Address of IPv4 address string or IPv6 1::1.
IpAddress
refresh address string.

For non-dynamic peers,

Mask of Unsigned integer. this is 255.For IPv4
Mask dynamic peers,this is 0
refresh address Value range: 0 to 128,or 255 to 32.For IPv6 dynamic
peers, this is 0 to 128.
String.
GroupName Group name N/A
Length: 1 to 47 characters.

String. An empty string

VpnInstance VPN instance
indicates the public
Name name Length: 1 to 31 characters. network.

Responsed columns
N/A

7
Contents
BGP ······························································································1
BGP/Instances ·························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
BGP/VRFs ······························································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
BGP/CfgSessionGroups ·············································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ·························································································································· 10
BGP/CfgSessions ···················································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 15
BGP/Familys ··························································································································· 18
XML structure ··················································································································· 18
Table description ··············································································································· 20
Columns ·························································································································· 21
BGP/Networks ························································································································ 29
XML structure ··················································································································· 29
Table description ··············································································································· 29
Columns ·························································································································· 30
BGP/Aggregates ······················································································································ 30
XML structure ··················································································································· 30
Table description ··············································································································· 31
Columns ·························································································································· 32
BGP/NeighborGroups ··············································································································· 32
XML structure ··················································································································· 32
Table description ··············································································································· 34
Columns ·························································································································· 35
BGP/Neighbors ······················································································································· 40
XML structure ··················································································································· 40
Table description ··············································································································· 41
Columns ·························································································································· 42
BGP/Redistributes···················································································································· 47
XML structure ··················································································································· 47
Table description ··············································································································· 47
Columns ·························································································································· 48
BGP/RedistributesAppend ········································································································· 48
XML structure ··················································································································· 48
Table description ··············································································································· 49
Columns ·························································································································· 50
BGP/BMPs ····························································································································· 50
XML structure ··················································································································· 50
Table description ··············································································································· 51
Columns ·························································································································· 52
BGP/Rpkis ····························································································································· 52
XML structure ··················································································································· 52
Table description ··············································································································· 53
Columns ·························································································································· 53
BGP/Rpkis/Rpki/Servers············································································································ 53
XML structure ··················································································································· 54
Table description ··············································································································· 54
Columns ·························································································································· 55

i
BGP/FilterPolicyExports ············································································································ 55
XML structure ··················································································································· 55
Table description ··············································································································· 56
Columns ·························································································································· 57
BGP/PeerGpDefRtAdvVpnInsts ·································································································· 58
XML structure ··················································································································· 58
Table description ··············································································································· 58
Columns ·························································································································· 59
BGP/PeerDefRtAdvVpnInsts ······································································································ 59
XML structure ··················································································································· 59
Table description ··············································································································· 59
Columns ·························································································································· 60

ii
BGP
BGP/Instances
This table contains BGP instance information.

XML structure
<BGP>
<Instances>
<Instance>
<Name></Name>
<ASNumber></ASNumber>
<NSR></NSR>
<SendDelayTime></SendDelayTime>
<SendDelayPrefix></SendDelayPrefix>
<SendDelayIPv6Prefix></SendDelayIPv6Prefix>
<SendStartupTime></SendStartupTime>
<StartupPolicyMed></StartupPolicyMed>
<FlushSuboptimalRoute></FlushSuboptimalRoute>
<RouteReplicateEnable></RouteReplicateEnable>
<DefaultRouteUpdateFirst></DefaultRouteUpdateFirst>
<EbgpInterfaceSensitive></EbgpInterfaceSensitive>
<GracefulRestartEnable></GracefulRestartEnable>
<GracefulRestartTimerPurgeTime></GracefulRestartTimerPurgeTime>
<GracefulRestartTimerRestart></GracefulRestartTimerRestart>
<GracefulRestartTimerWaitForRib></GracefulRestartTimerWaitForRib>
<IgnoreAllPeers>
<IgnoreAllPeersEnable></IgnoreAllPeersEnable>
<GracefulTime></GracefulTime>
<CommunityNumber></CommunityNumber>
<LocalPreference></LocalPreference>
<Med></Med>
</IgnoreAllPeers>
<IgnoreFirstAs></IgnoreFirstAs>
<LabelAllocationMode></LabelAllocationMode>
<LabeledRouteIgnoreNoTunnel></LabeledRouteIgnoreNoTunnel>
<LogPeerChange></LogPeerChange>
<PrimaryPathDetectBfdEcho></PrimaryPathDetectBfdEcho>
<RetainLocalLabel></RetainLocalLabel>
<RouteRateLimit></RouteRateLimit>
<RouteUpdateIntervalWithdrawnEnable></RouteUpdateIntervalWithdrawnEnable>
<SnmpContextName></SnmpContextName>
<VpnPopgo></VpnPopgo>
<ConfederationId></ConfederationId>
<ConfederationNonstandard></ConfederationNonstandard>

1
 <ConfederationPeerAs></ConfederationPeerAs>
</Instance>
</Instances>
</BGP>

Table description
Item Description
Feature name BGP
Table name Instances
Table type Multi-instance table
Row name Instance
Restrictions No
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
indicates the
default BGP
process.
String. When execute get
Name Instance name Index
Length: 0 to 31 characters. bulk operation, you
can only get the
data of the
specified BGP
instance.

2
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
Autonomous
ASNumber Value range: N/A
System number
1 to 4294967295
Enumeration.
NSR Nonstop Routing • 0—Disable.(default) N/A
• 1—Enable.
The value 0
Unsigned integer. indicates that the
SendDelayTim Send delay time
Value range: BGP speaker never
e in seconds
0 to 3600 send the update
message.

SendDelayPre Send delay using String.

N/A
fix IPv4 prefix list Length: 1 to 63 characters.

Send delay String.

SendDelayIPv
6Prefix using IPv6 N/A
prefix list Length: 1 to 63 characters.

The value 0
indicates that the
Unsigned integer. BGP speaker
SendStartupTi Send startup
Value range: always send the
me time in seconds
0 to 3600 update message
with the startup
policy.
Unsigned integer.
StartupPolicy Satrtup policy
Value range: N/A
Med MED
0 to 4294967295
Enumeration.
FlushSubopti Flush suboptimal
malRoute route to RIB • 0—Disable. N/A
• 1—Enable.
Enable mutual
route Enumeration.
RouteReplic replication
• 0—Disable. N/A
ateEnable between public
and private • 1—Enable.
networks
Enable BGP to
send withdrawal Enumeration.
DefaultRoute messages of the
UpdateFirst default route • 0—Disable. N/A
prior to other • 1—Enable.
routes
Immediate Enumeration.
EbgpInterface re-establishment
Sensitive of direct EBGP • 0—Disable. N/A
sessions • 1—Enable.

Enumeration.
GracefulRest Enabling
artEnable graceful restart • 0—Disable. N/A
• 1—Enable.
GracefulRest Graceful restart Unsigned integer. Graceful restart

3
Column Column Column
Data type and restrictions Remarks
name description type
artTimerPurg purge time in Value range: must be enabled
eTime seconds first.
1 to 6000

GracefulRest Graceful restart Unsigned integer. Graceful restart

artTimerRest restart time in Value range: must be enabled
art seconds 3 to 600 first.

Graceful restart
GracefulRest time to wait for Unsigned integer. Graceful restart
artTimerWaitF the End-of-RIP Value range: must be enabled
orRib marker in 3 to 3600 first.
seconds
Include:
• IgnoreAllPeersEnable
IgnoreAllPeer Data • GracefulTime
Ignore all peers N/A
s Structure • CommunityNumber
• LocalPreference
• Med
Enumeration.
IgnoreAllPeer Ignore all peers
sEnable enable • 0—Disable. N/A
• 1—Enable.
Ignore all peers
must be enabled
Unsigned integer. first.
Graceful time in Community,
GracefulTime Value range:
seconds LocalPreference
60 to 65535 and Med should be
set on at least
GracefulTime.
Ignore all peers
must be enabled
Unsigned integer. first.
Value range: Example: 10 or
1 to 4294967295. 1:65535
CommunityN Community Repeat supported
String.
umber number for 32 times along
Length: 3 to 11 characters. with
Format: CommunityAttr.
AA<0-65535>:NN<0-65535> Only supported for
basic community
list.
Unsigned integer. Ignore all peers
LocalPreferen
Local preference Value range: must be enabled
ce
0 to 4294967295 first.

Unsigned integer. Ignore all peers

Med MED of route Value range: must be enabled
0 to 4294967295 first.

Enumeration.
Ignore the first
IgnoreFirstAs
AS • 0—Disable. N/A
• 1—Enable.

4
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration.
LabelAllocatio Label allocation • 0—per-hop.
N/A
nMode mode • 1—per-prefix
• 2- per-vrf.
Ignore labeled Enumeration.
LabeledRoute
routes with no
IgnoreNoTun
tunnel • 0—Disable. N/A
nel • 1—Enable.
information
Enumeration.
LogPeerChan
ge
Log peer change • 0—Disable. N/A
• 1—Enable.

Detect primary Enumeration.

PrimaryPathD
etectBfdEcho
path using BFD • 0—Disable. N/A
echo. • 1—Enable.

Update delay for Unsigned integer.

RetainLocalL
local MPLS Value range: N/A
abel
labels in seconds 1 to 21845

RouteRateLi Unsigned integer.

Route rate limit N/A
mit Value range:0 to 4294967295

Apply route
RouteUpdateI update interval Enumeration.
ntervalWithdr setting to • 0—Disable. N/A
awnEnable withdrawn • 1—Enable.
routes
SnmpContext SNMP context String.
N/A
Name name Length: 1 to 32 characters.
Enumeration.
VpnPopgo VPN POPGO • 0—Disable. N/A
• 1—Enable.
Unsigned integer.
Confederatio
Confederation ID Value range: N/A
nId
1 to 4294967295

Enable
compatibility
Confederatio with routers not Enumeration.
nNonstandar compliant with • 0—Disable. N/A
d RFC 3065 in • 1—Enable.
the
confederation

Confederation Unsigned integer.

Confederatio
peer sub-AS Value range: N/A
nPeerAs
number. 1 to 4294967295

5
BGP/VRFs
This table contains BGP VRF information.

XML structure
<BGP>
<VRFs>
<VRF>
<Name></Name>
<VRF></VRF>
<RouterId></RouterId>
<Timer>
<KeepAlive></KeepAlive>
<HoldTime></HoldTime>
</Timer>
<BestRouteIgpMetricIgnore></BestRouteIgpMetricIgnore>
<BestRouteAsPathNeglect></BestRouteAsPathNeglect>
<BestRouteCompareMED></BestRouteCompareMED>
<BestRouteConfederationMED></BestRouteConfederationMED>
<BestRouteRouterIdIgnore></BestRouteRouterIdIgnore>
<CompareDifferentAsMED></CompareDifferentAsMED>
<TimerConnectRetry></TimerConnectRetry>
</VRF>
</VRFs>
</BGP>

Table description
Item Description
Feature name BGP
Table name VRFs
Table type Multi-instance table
Row name VRF
Restrictions No
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

6
Column Column Column
Data type and restrictions Remarks
name description type
String. An empty string
VRFName VRF name Index indicates the public
Length: 0 to 31 characters. network.
RouterId BGP Router Id IPv4 address string N/A
Include:
Keepalive and Data
Timer
Holdtime Structure • KeepAlive N/A
• HoldTime

Keepalive Unsigned integer.

KeepAlive Interval in Value range: N/A
Seconds 0 to 21845
Unsigned integer.
Holdtime in
HoldTime Value range: N/A
Seconds
0 to 65535
Ignore IGP Enumeration.
metrics during
BestRouteIgp
optimal route • 0—Disable.(default) N/A
MetricIgnore
selection • 1—Enable.
Ignore the
AS-PATH Enumeration.
BestRouteAs attribute during • 0—Disable.(default) N/A
PathNeglect optimal route • 1—Enable.
selection
Consider MED Enumeration.
value during
BestRouteCo • 0—Disable.(default) N/A
mpareMED optimal route
selection • 1—Enable.
Compare the
MEDs of routes
from Enumeration.
BestRouteCo
nfederationM confederation • 0—Disable.(default) N/A
ED peers during • 1—Enable.
optimal route
selection

Ignore router ID Enumeration.

BestRouteRo during optimal • 0—Disable.(default) N/A
uterIdIgnore route selection • 1—Enable.
Compare the
MEDs of routes Enumeration.
from different
CompareDiffe
ASs during • 0—Disable.(default) N/A
rentAsMED
optimal route • 1—Enable.
selection
Unsigned integer.
TimerConnec Session retry
Value range: N/A
tRetry timer in seconds
1 to 65535

7
BGP/CfgSessionGroups
This table contains configure information of BGP session group.

XML structure
<BGP>
<CfgSessionGroups>
<CfgSessionGroup>
<Name></Name>
<VRF></VRF>
<GroupName></GroupName>
<Type></Type>
<ASNumber></ASNumber>
<ConnectInterface></ConnectInterface>
<UpdateInterval></UpdateInterval>
<PasswordType></PasswordType>
<Password></Password>
<BfdType></BfdType>
<EbgpMaxHop></EbgpMaxHop>
<Ignore></Ignore>
<Description></Description>
<NexthopRecursivePolicyDisable></NexthopRecursivePolicyDisable>
<FakeAS></FakeAS>
<DualAS></DualAS>
<PrependGlobalAS></PrependGlobalAS>
<PrependFakeAS></PrependFakeAS>
<BmpServer></BmpServer>
<Dscp></Dscp>
<IgnoreOriginatorid></IgnoreOriginatorid>
<LogChange></LogChange>
<LowMemoryExempt></LowMemoryExempt>
<Ipv4SourceAddr></Ipv4SourceAddr>
<Ipv6SourceAddr></Ipv6SourceAddr>
<SubstituteAs></SubstituteAs>
<Timer>
<KeepAlive></KeepAlive>
<HoldTime></HoldTime>
</Timer>
<TtlSecurity></TtlSecurity>
<CapSupAs4></CapSupAs4>
<CapOrfNonStandard></CapOrfNonStandard>
<CapConventional></CapConventional>
<IpsecProfile></IpsecProfile>
<Keychain></Keychain>
</CfgSessionGroup>
</CfgSessionGroups>
</BGP>

8
Table description
Item Description
Feature name BGP
Table name CfgSessionGroups

Table type Multi-instance table

Row name CfgSessionGroup

Restrictions No
Support for row creation and deletion Yes

9
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
String.
GroupName Group Name Index N/A
Length: 1 to 47 characters.
Enumeration.
Internal or
Type
External • 0—Internal.(default) N/A
• 1—External.
Unsigned integer.
Autonomous
ASNumber Value range: N/A
System number
1 to 4294967295

ConnectInterf Connect String.

N/A
ace Interface Length: 1 to 47 characters.
Unsigned integer.
UpdateInterv Route Update
Value range: N/A
al Interval
0 to 600

Enumeration.
PasswordTyp
Password type. • 1—Ciphertext. N/A
e
• 2—Plaintext.
String.
Length:
Password Password. 1 to 80 characters for MD5 N/A
plaintext password.
33 to 137 characters for MD5
ciphertext password.
The default type
indicate that actual
bfd type
(single-hop or
Enumeration.
multi-hop) depend
• 0—default type on different
BfdType Bfd type • 1—single-hop situations.
• 2—multi-hop Some versions not
support. For
relevant
information, see
the XSD document
of your product.

Unsigned integer.
EbgpMaxHop EBGP multihop Value range: N/A
1 to 255

10
Column Column Column
Data type and restrictions Remarks
name description type
Disable session Enumeration.
Ignore establishment to • 0—Disable.(default) N/A
the peers • 1—Enable.

String.
Description Peer Description Case Sensitive
Length: 1 to 79 characters.

Disable route
recursion policy Enumeration.
NexthopRecu
control for routes
rsivePolicyDis • 0—Disable. N/A
received from the
able • 1—Enable.
specified peer or
peer group
Unsigned integer.
Value range:
Specify a virtual 1 to 4294967295. By default, the fake
local AS number
FakeAS String. AS number does
for the peer or
Length: 3 to 11 characters. not exist.
peer group
Format:
AA<0-65535>.NN<0-65535>
The object does
Support both real not exist if FakeAS
and fake AS Enumeration. is not configured.
numbers for peer
DualAS • 0—Disable. If you configure
group
relationship • 1—Enable. FakeAS but not
establishment DualAS, the value
for DualAS is 0.
The object does
not exist if FakeAS
Add the real AS is not configured.
number to the Enumeration.
PrependGlob If you configure
AS_PATH • 0—Disable. FakeAS but not
alAS
attribute in sent • 1—Enable. PrependGlobalAS,
packets the value for
PrependGlobalAS
is 0.
The object does
not exist if FakeAS
Add the fake AS is not configured.
number to the Enumeration.
PrependFake If you configure
AS_PATH • 0—Disable. FakeAS but not
AS
attribute in • 1—Enable. PrependFakeAS,
received packets the value for
PrependFakeAS is
0.
Up to 8 BGP
Configure the Unsigned integer. monitoring servers
BmpServer BMP server peer Value range: can be configured
or peer group 1 to 8 in the same
command.

Set the DSCP Unsigned integer.

Dscp priority of BGP Value range: N/A
packets 0 to 63

11
Column Column Column
Data type and restrictions Remarks
name description type
Ignore the Enumeration.
IgnoreOrigina ORIGINATOR_I
torid D attribute of a • 0—Disable. (default) N/A
BGP route • 1—Enable.

Enable the
logging function Enumeration.
of the BGP
LogChange
session with the • 0—Disable. N/A
specified peer or • 1—Enable. (default)
peer group
Do not
disconnect the Enumeration.
LowMemoryE session with the
xempt specified EBGP • 0—Disable. (default) N/A
peer or peer • 1—Enable.
group

Ipv4Source IPv4 Source

IPv4 address string . Example: 1.1.1.1.
Addr Address

Ipv6Source IPv6 Source

IPv6 address string. Example: 1::1.
Addr Address

Replace the AS
number of the
specified peer or Enumeration.
SubstituteAs peer group in • 0—Disable. (default) N/A
the AS_PATH • 1—Enable.
attribute with the
local AS number
The hold time must
Members include: be greater than or
Keepalive and Data
Timer
holdtime • KeepAlive equal to three
structure times the keepalive
• HoldTime.
time.

Keepalive Unsigned integer.

KeepAlive interval in Value range: N/A
seconds 0 to 21845
Unsigned integer.
Holdtime in
HoldTime Value range: N/A
seconds
0 , 3 to 65535
Enable BGP Unsigned integer.
GTSM fuction for
TtlSecurity Value range: N/A
a peer or peer
group 1 to 254

Enable 4-byte Enumeration.

AS number
CapSupAs4
suppression • 0—Disable. (default) N/A
function • 1—Enable.

Enable Enumeration.
CapOrfNonSt non-standard
andard • 0—Disable. (default) N/A
ORF capability
for BGP neighbor • 1—Enable.

12
 Column Column Column
Data type and restrictions Remarks
name description type
negotiation

Disable the BGP

route
refresh,multiprot
ocol extension, Enumeration.
CapConventi and 4-byte AS
onal number function • 0—Disable. (default) N/A
of the local router • 1—Enable.
and the specified
peer or peer
group
Apply the IPsec
security String.
IpsecProfile framework to N/A
IPv6 BGP peer Length: 1 to 63 characters.
or peer group
Configure
keychain
authentication
when a BGP String.
Keychain N/A
peer or peer Length: 1 to 63 characters.
group
establishes a
TCP connection

BGP/CfgSessions
This table contains configure information of BGP session.

XML structure
<BGP>
<CfgSessions>
<CfgSession>
<Name></Name>
<VRF></VRF>
<SessAF></SessAF>
<IpAddress></IpAddress>
<Mask></Mask>
<ASNumber></ASNumber>
<GroupName></GroupName>
<ConnectInterface></ConnectInterface>
<UpdateInterval></UpdateInterval>
<PasswordType></PasswordType>
<Password></Password>
<BfdType></BfdType>
<EbgpMaxHop></EbgpMaxHop>

13
 <Ignore></Ignore>
<Description></Description>
<NexthopRecursivePolicyDisable></NexthopRecursivePolicyDisable>
<FakeAS></FakeAS>
<DualAS></DualAS>
<PrependGlobalAS></PrependGlobalAS>
<PrependFakeAS></PrependFakeAS>
<BmpServer></BmpServer>
<Dscp></Dscp>
<IgnoreOriginatorid></IgnoreOriginatorid>
<LogChange></LogChange>
<LowMemoryExempt></LowMemoryExempt>
<SourceAddress></SourceAddress>
<SubstituteAs></SubstituteAs>
<Timer>
<KeepAlive></KeepAlive>
<HoldTime></HoldTime>
</Timer>
<TtlSecurity></TtlSecurity>
<CapSupAs4></CapSupAs4>
<CapOrfNonStandard></CapOrfNonStandard>
<CapConventional></CapConventional>
<IpsecProfile></IpsecProfile>
<Keychain></Keychain>
</CfgSession>
</CfgSessions>
</BGP>

Table description
Item Description
Feature name BGP
Table name CfgSessions

Table type Multi-instance table

Row name CfgSession

Restrictions No
Support for row creation and deletion Yes

14
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
Address family of
SessAF
session
Index • 1—IPv4. N/A
• 2—IPv6.
Example: 1.1.1.1 or
Address of String,IPv4 address string or 1::1.
IpAddress Index
session IPv6 address string.

For non-dynamic
peers, this is
255.For IPv4
Mask of dynamic peers,this
Unsigned integer.
Mask session address Index is 0 to 32.For IPv6
Value range: 0 to 128,or 255 dynamic peers, this
is 0 to 128.
Dynamic peers are
not supported.
Unsigned integer.
Autonomous
ASNumber Value range: N/A
System number
1 to 4294967295
String.
GroupName Group Name N/A
Length: 1 to 47 characters.

ConnectInterf Connect String.

N/A
ace Interface Length: 1 to 47 characters.
Unsigned integer.
UpdateInterv Route Update
Value range: N/A
al Interval
0 to 600

Enumeration.
PasswordTyp
Password type. • 1—Ciphertext. N/A
e
• 2—Plaintext.
String.
Length:
Password Password. 1 to 80 characters for MD5 N/A
plaintext password.
33 to 137 characters for MD5
ciphertext password.

Enumeration. The default type

• 0—default type indicate that actual
BfdType Bfd type bfd type
• 1—single-hop (single-hop or
• 2—multi-hop multi-hop) depend

15
Column Column Column
Data type and restrictions Remarks
name description type
on different
situations.
Some versions not
support. For
relevant
information, see
the XSD document
of your product.

Unsigned integer.
EbgpMaxHop EBGP multihop Value range: N/A
1 to 255

Disable session Enumeration.

Ignore establishment to • 0—Disable.(default) N/A
the peers • 1—Enable.

String.
Description Peer Description Case Sensitive
Length: 1 to 79 characters.

Disable route
recursion policy Enumeration.
NexthopRecu
control for routes
rsivePolicyDis • 0—Disable. N/A
received from the
able • 1—Enable.
specified peer or
peer group
Unsigned integer.
Value range:
Specify a virtual 1 to 4294967295. By default, the fake
local AS number
FakeAS String. AS number does
for the peer or
Length: 3 to 11 characters. not exist.
peer group
Format:
AA<0-65535>.NN<0-65535>
The object does
Support both real not exist if FakeAS
and fake AS Enumeration. is not configured.
DualAS numbers for peer • 0—Disable. If you configure
relationship • 1—Enable. FakeAS but not
establishment DualAS, the value
for DualAS is 0.
The object does
not exist if FakeAS
Add the real AS is not configured.
number to the Enumeration.
PrependGlob If you configure
AS_PATH • 0—Disable. FakeAS but not
alAS
attribute in sent • 1—Enable. PrependGlobalAS,
packets the value for
PrependGlobalAS
is 0.
The object does
Add the fake AS not exist if FakeAS
number to the Enumeration.
PrependFake is not configured.
AS_PATH • 0—Disable.
AS If you configure
attribute in • 1—Enable.
received packets FakeAS but not
PrependFakeAS,

16
Column Column Column
Data type and restrictions Remarks
name description type
the value for
PrependFakeAS is
0.

Up to 8 BGP
Configure the Unsigned integer. monitoring servers
BmpServer BMP server peer Value range: can be configured
or peer group 1 to 8 in the same
command.

Set the DSCP Unsigned integer.

Dscp priority of BGP Value range: N/A
packets 0 to 63
Ignore the Enumeration.
IgnoreOrigina ORIGINATOR_I
torid D attribute of a • 0—Disable. (default) N/A
BGP route • 1—Enable.

Enable the
logging function Enumeration.
of the BGP
LogChange
session with the • 0—Disable. N/A
specified peer or • 1—Enable. (default)
peer group
Do not
disconnect the Enumeration.
LowMemoryE session with the
xempt specified EBGP • 0—Disable. (default) N/A
peer or peer • 1—Enable.
group

SourceAddre IPv4 address string or IPv6 Example: 1.1.1.1 or

Source Address
ss address string. 1::1.

Replace the AS
number of the
specified peer or Enumeration.
SubstituteAs peer group in • 0—Disable. (default) N/A
the AS_PATH • 1—Enable.
attribute with the
local AS number
The hold time must
Members include: be greater than or
Keepalive and Data
Timer
holdtime • KeepAlive equal to three
structure times the keepalive
• HoldTime.
time.

Keepalive Unsigned integer.

KeepAlive interval in Value range: N/A
seconds 0 to 21845
Unsigned integer.
Holdtime in
HoldTime Value range: N/A
seconds
0 ,3 to 65535

17
 Column Column Column
Data type and restrictions Remarks
name description type
Enable BGP Unsigned integer.
GTSM fuction for
TtlSecurity Value range: N/A
a peer or peer
group 1 to 254

Enable 4-byte Enumeration.

AS number
CapSupAs4
suppression • 0—Disable. (default) N/A
function • 1—Enable.

Enable
non-standard Enumeration.
CapOrfNonSt
andard
ORF capability • 0—Disable. (default) N/A
for BGP neighbor • 1—Enable.
negotiation
Disable the BGP
route
refresh,multiprot
ocol extension, Enumeration.
CapConventi and 4-byte AS
onal number function • 0—Disable. (default) N/A
of the local router • 1—Enable.
and the specified
peer or peer
group
Apply the IPsec
security String.
IpsecProfile framework to N/A
IPv6 BGP peer Length: 1 to 63 characters.
or peer group
Configure
keychain
authentication
when a BGP String.
Keychain N/A
peer or peer Length: 1 to 63 characters.
group
establishes a
TCP connection

BGP/Familys
This table contains address family identifier information of BGP.

XML structure
<BGP>
<Familys>
<Family>
<Name></Name>
<VRF></VRF>
<Type></Type>
<Preference>
<Ebgp></Ebgp>

18
 <Ibgp></Ibgp>
<Local></Local>
</Preference>
<BalanceAsPathNeglect></BalanceAsPathNeglect>
<BalanceAsPathRelax></BalanceAsPathRelax>
<Balance>
<MaxBalance></MaxBalance>
<MaxEBGPBalance></MaxEBGPBalance>
<MaxIBGPBalance></MaxIBGPBalance>
<MaxEIBGPBalance></MaxEIBGPBalance>
</Balance>
<PolicyVpnTarget></PolicyVpnTarget>
<ReflectBtwClients></ReflectBtwClients>
<ReflectorClusterID></ReflectorClusterID>
<RrFilter></RrFilter>
<DefaultRtImport></DefaultRtImport>
<DomainDistinguisher></DomainDistinguisher>
<PIC></PIC>
<VpnCrossMultipath></VpnCrossMultipath>
<RouteSelectDelay></RouteSelectDelay>
<AdvertiseEvpnRoute>
<AdvertiseEvpnEnable></AdvertiseEvpnEnable>
<AdvertiseEvpnPolicy></AdvertiseEvpnPolicy>
<AdvertiseEvpnReplaceRt></AdvertiseEvpnReplaceRt>
</AdvertiseEvpnRoute>
<AdvertiseL2vpnEvpnRoute></AdvertiseL2vpnEvpnRoute>
<AdvertiseL3vpnRoute>
<AdvertiseL3vpnEnable></AdvertiseL3vpnEnable>
<AdvertiseL3vpnPolicy></AdvertiseL3vpnPolicy>
<AdvertiseL3vpnReplaceRt></AdvertiseL3vpnReplaceRt>
</AdvertiseL3vpnRoute>
<ImportEvpnMacIp></ImportEvpnMacIp>
<DefaultLocalPreference></DefaultLocalPreference>
<AddPathsSelectBestNum></AddPathsSelectBestNum>
<DefaultMedValue></DefaultMedValue>
<FrrRtPolicyName></FrrRtPolicyName>
<MvpnAdvRtImport></MvpnAdvRtImport>
<UpdateFirstRtPolicyName></UpdateFirstRtPolicyName>
<AdvRibActive></AdvRibActive>
<BestRtOriAsValidation></BestRtOriAsValidation>
<BestRtAllowInvalid></BestRtAllowInvalid>
<NestingVpn></NestingVpn>
<SummaryAutomatic></SummaryAutomatic>
<FilterPolicyImport>
<AclNumImp></AclNumImp>
<AclNameImp></AclNameImp>
<PrefixListNameImp></PrefixListNameImp>
</FilterPolicyImport>

19
 <LogRouteFlap>
<MonitorTime></MonitorTime>
<MonitorCount></MonitorCount>
<LogCountLimit></LogCountLimit>
<RtPolicyName></RtPolicyName>
</LogRouteFlap>
<Dampening>
<DampeningEnable></DampeningEnable>
<HalfLifeReach></HalfLifeReach>
<HalfLifeUnReach></HalfLifeUnReach>
<Reuse></Reuse>
<Suppress></Suppress>
<Ceiling></Ceiling>
<DampRtPolicyName></DampRtPolicyName>
</Dampening>
<RedirectToTunnel></RedirectToTunnel>
</Family>
</Familys>
</BGP>

Table description
Item Description
Feature name BGP
Table name Family

Table type Multi-instance table

Row name Family

Restrictions No
Support for row creation and deletion Yes

20
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
• 7—VPNv6
Address Family
Type
Identifier
Index • 8—L2VPN N/A
• 9—L2VPN EVPN
• 10—Link-State
• 11—IPv4 rtfilter.
• 12—IPv4 mvpn.
• 13—IPv4 Flowspec
• 14—VPNv4 Flowspec
• 15—IPv6 Flowspec
• 16—VPNv6 Flowspec
Include:
Preference for Data • Ebgp
Preference N/A
BGP Routes Structure • Ibgp
• Local
Unsigned integer.
Preference for
Ebgp Value range: N/A
eBGP Routes
1 to 255
Unsigned integer.
Preference for
Ibgp Value range: N/A
iBGP Routes
1 to 255
Unsigned integer.
Preference for
Local Value range: N/A
Local Routes
1 to 255

Ignore the
AS_PATH Enumeration:
BalanceAsPa
attribute when • 0—Disable. N/A
thNeglect
implementing 1—Enable.
load balancing

BalanceAsPa Load balancing Enumeration:

for routes that N/A
thRelax
have different • 0—Disable.

21
Column Column Column
Data type and restrictions Remarks
name description type
AS_PATH 1—Enable.
attributes of the
same length
Include:
number of BGP • MaxBalance
Data
Balance ECMP routes for
Structure • MaxEBGPBalance N/A
load balancing • MaxIBGPBalance
• MaxEIBGPBalance
maximum Unsigned integer.
number of BGP
MaxBalance Value range: N/A
ECMP routes for
load balancing 1 to 255

EBGP load
Maximum Unsigned integer. balancing and
MaxEBGPBal number of EBGP EBGP/IBGP load
Value range:
ance ECMP routes for balancing cannot
load balancing 1 to 255 be configured at
the same time
EBGP load
Maximum Unsigned integer. balancing and
MaxIBGPBal number of IBGP EBGP/IBGP load
Value range:
ance ECMP routes for balancing cannot
load balancing 1 to 255 be configured at
the same time
Maximum EBGP load
number of ECMP Unsigned integer. balancing and
MaxEIBGPBa routes between EBGP/IBGP load
Value range:
lance EBGP and balancing cannot
IBGP routes for 1 to 255 be configured at
load balancing the same time

Enumeration:
Filter VPN routes
PolicyVpnTar
with VPN-Target • 0—Disable. N/A
get
attribute • 1—Enable.

Enumeration:
ReflectBtwCli Route reflection • 0—Disable. N/A
ents between clients
• 1—Enable.
String,IPv4 address string or
Unsigned integer.
ReflectorClus cluster ID of the
Value range: N/A
terID route reflector
1 to 4294967295

RR-filter number: Only IBGP routes

Number or name
Unsigned integer. whose extended
of the extended
Value range: 1 to 199. community
community list in
N/A attribute matches
RrFilter the route filtering RR-filter name: the specified
policy specified
String. extended
for the route
community list are
reflector Length: 1 to 63 characters. reflected.

Enumeration:
DefaultRtImp
Import default • 0—Disable N/A
ort

22
Column Column Column
Data type and restrictions Remarks
name description type
route • 1—Enable.
String.
A globally Length: 9 to 26 characters.
DomainDistin unique The format is Example:
guisher identifier for LS 100:13.14.23.22
AS<1-4294967295>:routerID
domain
<X.X.X.X>.

Enumeration:
Enable Prefix
PIC Independent • 0—Disable N/A
Convergence • 1—Enable.

Redistribute
multiple routes Enumeration:
VpnCrossMul with the same • 0—Disable N/A
tipath prefix and RD • 1—Enable.
to the VPN
routing table
Unsigned integer.
Optimal route
RouteSelectD Value range:
elay
calculation N/A
delay time 0 to 600 seconds.

Include:
Advertise BGP
• AdvertiseEvpnEnable
EVPN routes
AdvertiseEv Data • AdvertiseEvpnPolicy
through the N/A
pnRoute Structure • AdvertiseEvpnReplace
current
address family Rt

Enable
advertise BGP Enumeration:
AdvertiseEv EVPN routes • 0—Disable N/A
pnEnable through the • 1—Enable.
current
address family

Filter BGP
String.
AdvertiseEv EVPN routes
Length: 1 to 63 characters. N/A
pnPolicy by a routing
policy

Replace the
route targets of Enumeration:
AdvertiseEv
pnReplaceR
BGP EVPN • 0—Disable. N/A
routes with • 1—Enable.
t
those of VPN
instances

Enumeration:
AdvertiseL2 Advertise BGP
vpnEvpnRou EVPN route to • 0—Disable N/A
te the local site • 1—Enable. (default)

23
Column Column Column
Data type and restrictions Remarks
name description type
Include:
Advertise BGP
• AdvertiseL3vpnEnable
L3VPN routes
AdvertiseL3 Data • AdvertiseL3vpnPolicy
through the N/A
vpnRoute Structure • AdvertiseL3vpnReplac
BGP EVPN
address family eRt

Enable
advertise BGP Enumeration:
AdvertiseL3 L3VPN routes • 0—Disable N/A
vpnEnable through the • 1—Enable.
BGP EVPN
address family

Filter BGP
String.
AdvertiseL3 L3VPN routes
Length: 1 to 63 characters. N/A
vpnPolicy by a routing
policy

Replace the
route targets of Enumeration:
AdvertiseL3
vpnReplace
BGP L3VPN • 0—Disable. N/A
routes with • 1—Enable.
Rt
those of EVPN
instances

Redistribute Enumeration:
ImportEvpn MAC/IP • 0—Disable. (default) N/A
MacIp advertisement • 1—Enable.
routes
The default local
preference is
Unsigned integer. supported only by
DefaultLocalP Configure default
Value range: IPv4 unicast, IPv4
reference local preference
0 to 4294967295 multicast, IPv6
unicast, and IPv6
multicast routes.
Set the
maximum
number of Unsigned integer.
AddPathsSel
Add-Path optimal Value range: N/A
ectBestNum
routes that can 2 to 32
be advertised to
all peers.
Unsigned integer.
DefaultMedV Configure default
Value range: N/A
alue MED value.
0 to 4294967295
Configure the String.
FrrRtPolicyNa
route policy N/A
me Length: 1 to 63 characters.
name of FRR.
Enable MVPN Enumeration:
MvpnAdvRtI
advertisement N/A
mport
RT import • 0—Disable. (default)

24
Column Column Column
Data type and restrictions Remarks
name description type
• 1—Enable.

25
Column Column Column
Data type and restrictions Remarks
name description type
Routing policy
used to match
routes whose String.
UpdateFirstRt
withdrawal N/A
PolicyName Length: 1 to 63 characters.
messages are
sent prior to
other routes.
Enable to Enumeration:
advertise the
AdvRibActive • 0—Disable. (default) N/A
best routes of IP
routing table.. • 1—Enable.

Configure BGP
RPKI
authentication Enumeration:
BestRtOriAsV
results to • 0—Disable. (default) N/A
alidation
participate in • 1—Enable.
route
optimization.
Allow routes with
Invalid
authentication Enumeration: BestRtAllowInvalid
BestRtAllowIn must be set with
results to • 0—Disable. (default)
valid BestRtOriAsValidat
participate in • 1—Enable. ion.
route
optimization

Enumeration:
Enable nested
NestingVpn • 0—Disable. (default) N/A
VPN function
• 1—Enable.
Automatic route
summarization Enumeration:
SummaryAut
for redistributed • 0—Disable. (default) N/A
omatic
IGP subnet • 1—Enable.
routes
Include:
FilterPolicyIm Filter received Data • AclNumImp
N/A
port BGP routes Structure • AclNameImp
• PrefixListNameImp

Filter BGP routes Unsigned integer.

AclNumImp by an ACL Value range: N/A
number. 2000 to 3999
ACL name (start
Filter BGP routes String. with[a-z,A-Z]).Can’t
AclNameImp
by an ACL name. Length: 1 to 63 characters. use “all” as ACL
name.
Filter BGP routes String.
PrefixListNam
by a prefix-list N/A
eImp Length: 1 to 63 characters.
name.
Include:
LogRouteFla Logging for BGP Data • MonitorTime
N/A
p route flapping Structure • MonitorCount
• LogCountLimit

26
Column Column Column
Data type and restrictions Remarks
name description type
• RtPolicyName

27
Column Column Column
Data type and restrictions Remarks
name description type
Monitoring Unsigned integer.
MonitorTime interval for route Value range: Units are minutes.
flapping 1 to 600

Number of route Unsigned integer.

MonitorCount flaps for Value range: N/A
triggering a log 2 to 8
Maximum
number of logs Unsigned integer.
LogCountLimi
allowed to be Value range: N/A
t
generated in a 1 to 600
minute
Filter BGP routes String.
RtPolicyNam
to monitor the N/A
e Length: 1 to 63 characters.
route flaps.
Include:
• DampeningEnable
• HalfLifeReach
Configure Data • HalfLifeUnReach
Dampening N/A
dampening.
Structure • Reuse
• Suppress
• Ceiling
• DampRtPolicyName
Enumeration:
DampeningE Enable
• 0—Disable. (default) N/A.
nable dampening.
• 1—Enable.
You must set all of
Specify the Unsigned integer. HalfLifeReach,
HalfLifeReac half-life of the HalfLifeUnReach,
Value range:
h reachable route Reuse, Suppress
that oscillates. 1 to 45 and Ceiling, or set
none of them.
You must set all of
Specify the
Unsigned integer. HalfLifeReach,
half-life of an
HalfLifeUnRe HalfLifeUnReach,
unreachable Value range:
ach Reuse, Suppress
route that 1 to 45 and Ceiling, or set
oscillates.
none of them.
You must set all of
Unsigned integer. HalfLifeReach,
Specify the route HalfLifeUnReach,
Reuse Value range:
reuse threshold. Reuse, Suppress
1 to 20000 and Ceiling, or set
none of them.
You must set all of
Unsigned integer. HalfLifeReach,
Specify the route
HalfLifeUnReach,
Suppress suppression Value range:
Reuse, Suppress
threshold. 1 to 20000 and Ceiling, or set
none of them..

Ceiling Specify the Unsigned integer. You must set all of

upper limit of HalfLifeReach,

28
 Column Column Column
Data type and restrictions Remarks
name description type
penalty value. Value range: HalfLifeUnReach,
Reuse, Suppress
1001 to 20000 and Ceiling, or set
none of them.
Specify the route
policy name that String.
DampRtPolic
routes are routed N/A
yName Length: 1 to 63 characters.
to be attenuated
by.
The default local
Configure String. preference is
RedirectToTu redirect IP relay supported only by
nnel tunnel capability Length: 0 to 40 characters. IPv4 flowspec,
IPv6 flowspec.

BGP/Networks
This table contains BGP network information.

XML structure
<BGP>
<Networks>
<Network>
<Name></Name>
<VRF></VRF>
<Family></Family>
<IpAddress></IpAddress>
<Mask></Mask>
<RoutePolicy></RoutePolicy>
</Network>
</Networks>
</BGP>

Table description
Item Description
Feature name BGP
Table name Networks
Table type Multi-instance table
Row name Network
Restrictions No
Support for row creation and deletion Yes

29
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
Address Family • 1—IPv4 Unicast
N/A
Family Identifier of Index • 2—IPv4 Multicast
Network • 5—IPv6 Unicast
• 6—IPv6 Multicast
Example: 1.1.1.1 or
Address of String,IPv4 address string or 1::1.
IpAddress Index
Network IPv6 address string.

Unsigned integer. For IPv4,this is 0 to

Mask of
Mask Index Value range: 32.For IPv6 this is
Network address 0 to 128.
0 to 128

Name of the String.

RoutePolicy N/A
routing policy Length: 1 to 63 characters.

BGP/Aggregates
This table contains BGP aggregate information.

XML structure
<BGP>
<Aggregates>
<Aggregate>
<Name></Name>
<VRF></VRF>
<Family></Family>
<IpAddress></IpAddress>
<Mask></Mask>
<DetailSuppressed></DetailSuppressed>
<AsSet></AsSet>
<AttributePolicy></AttributePolicy>
<OriginPolicy></OriginPolicy>
<SuppressPolicy></SuppressPolicy>

30
 </Aggregate>
</Aggregates>
</BGP>

Table description
Item Description
Feature name BGP
Table name Aggregates
Table type Multi-instance table
Row name Aggregate
Restrictions No
Support for row creation and deletion Yes

31
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
Address Family • 1—IPv4 Unicast
N/A
Family Identifier of Index • 2—IPv4 Multicast
Aggregate • 5—IPv6 Unicast
• 6—IPv6 Multicast
Example: 1.1.1.1 or
Address of String,IPv4 address string or 1::1.
IpAddress Index
aggregate IPv6 address string.

Mask of Unsigned integer. For IPv4,this is 0 to

Mask aggregate Index Value range: 32.For IPv6 this is
address 0 to 128 0 to 128.

Enumeration.
DetailSuppre Detail
ssed Suppressed • 0—Disable.(default) N/A
• 1—Enable.

Creating a Enumeration.
AsSet summary route • 0—Disable.(default) N/A
with AS set path • 1—Enable.
Routing policy
AttributePolic used to set the String.
N/A
y attributes of the Length: 1 to 63 characters.
summary route
Routing policy
used to filter String.
OriginPolicy original specific N/A
routes to be Length: 1 to 63 characters.
summarized
Routing policy
SuppressPoli used to filter String.
N/A
cy specific routes to Length: 1 to 63 characters.
be advertised

BGP/NeighborGroups
This table contains BGP neighbor group information.

XML structure
<BGP>

32
<NeighborGroups>
<NeighborGroup>
<Name></Name>
<VRF></VRF>
<Family></Family>
<GroupName></GroupName>
<RtPolicyImport></RtPolicyImport>
<RtPolicyExport></RtPolicyExport>
<AllowAsLoop></AllowAsLoop>
<ReflectClient></ReflectClient>
<NexthopInvariable></NexthopInvariable>
<NexthopLocal></NexthopLocal>
<RouterMacLocal></RouterMacLocal>
<AdvertiseCommunity></AdvertiseCommunity>
<AdvertiseExtCommunity></AdvertiseExtCommunity>
<ReOriginated></ReOriginated>
<AdvEvpnRouteSuppressMac></AdvEvpnRouteSuppressMac>
<AdvEvpnRouteSuppressPrefix></AdvEvpnRouteSuppressPrefix>
<DefaultgatewayNoAdv></DefaultgatewayNoAdv>
<RouteLimit>
<Number></Number>
<Percentage></Percentage>
<AlertOnly></AlertOnly>
<Discard></Discard>
<Reconnect></Reconnect>
</RouteLimit>
<PreferredValue></PreferredValue>
<NexthopVpn></NexthopVpn>
<AdditionalPathsRcv></AdditionalPathsRcv>
<AdditionalPathsSend></AdditionalPathsSend>
<AdvAddPathsBest></AdvAddPathsBest>
<RouteAdv>
<DefRouteAdv></DefRouteAdv>
<RoutePlcy></RoutePlcy>
</RouteAdv>
<KeepAllRoutes></KeepAllRoutes>
<LblRouteCapability></LblRouteCapability>
<PrefixListExp></PrefixListExp>
<PrefixListImp></PrefixListImp>
<PublicAsOnly></PublicAsOnly>
<SooSiteOfOrigin></SooSiteOfOrigin>
<FlPlcyAclNoOrNameExp></FlPlcyAclNoOrNameExp>
<FlPlcyAclNoOrNameImp></FlPlcyAclNoOrNameImp>
<AdvOrigAsVld></AdvOrigAsVld>
<CapOrf></CapOrf>
<Signaling>
<SigEnable></SigEnable>
<SigNonStd></SigNonStd>

33
 </Signaling>
<UpeEnable></UpeEnable>
<UpeRoutePlcy></UpeRoutePlcy>
<AutoDisc>
<DiscEnable></DiscEnable>
<DiscNonStd></DiscNonStd>
</AutoDisc>
<ValidationDisable></ValidationDisable>
<ValidationRedirectDisable></ValidationRedirectDisable>
</NeighborGroup>
</NeighborGroups>
</BGP>

Table description
Item Description
Feature name BGP
Table name NeighborGroups
Table type Multi-instance table
Row name NeighborGroup
Restrictions No
Support for row creation and deletion Yes

34
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
Address Family • 7—VPNv6
N/A
Family Identifier of Index • 8—L2VPN
NeighborGroup
• 9—L2VPN EVPN
• 10—Link-State
• 11—IPv4 rtfilter.
• 12—IPv4 mvpn.
• 13—IPv4 Flowspec
• 14—VPNv4 Flowspec
• 15—IPv6 Flowspec
• 16—VPNv6 Flowspec
String.
GroupName Group Name Index N/A
Length: 1 to 47 characters.
Import String.
RtPolicyImpor
Route-Policy for N/A
t Length: 1 to 63 characters.
NeighborGroup
Export String.
RtPolicyExpo
Route-Policy for N/A
rt Length: 1 to 63 characters.
NeighborGroup
allow a local AS
number to exist Unsigned integer.
AllowAsLoop in the AS_PATH Value range: N/A
attribute of 1 to 10
routes

Configure the
device as a
route reflector Enumeration.
ReflectClient and specify a • 0—Disable. N/A
peer or peer • 1—Enable.
group as a
client

NexthopInvari
Send original Enumeration. Next-hop-local
next hop for conflict with
able • 0—Disable. next-hop-invariable
routes

35
Column Column Column
Data type and restrictions Remarks
name description type
advertised to • 1—Enable. .
the peer
Specify local
address as the Enumeration. Next-hop-local
NexthopLocal next hop of • 0—Disable. conflict with
routes advertised • 1—Enable. next-hop-invariable
to the peers
Specify local
MAC as the Enumeration.
RouterMacLo router MAC of
• 0—Disable. N/A
cal routes advertised
to and received • 1—Enable.
from the peers

Send community Enumeration.

AdvertiseCo
attribute to the • 0—Disable. N/A
mmunity
peers • 1—Enable.

Send extended Enumeration.

AdvertiseExt community
• 0—Disable. N/A
Community attribute to the
peers 1—Enable.

Re-originate
EVPN routes Enumeration.
received from the • 0—Disable.
ReOriginated peer by N/A
modifying the L3 • 1—Enable.
VXLAN ID and • 2--- ReplaceRT.
RD
Advertise EVPN
AdvEvpnRout
routes to the Enumeration.
peer excluding
eSuppressMa • 0—Disable. N/A
MAC/IP
c • 1—Enable.
advertisement
routes
Advertise EVPN
AdvEvpnRout
routes to the Enumeration.
peer excluding IP
eSuppressPr • 0—Disable. N/A
prefix
efix • 1—Enable.
advertisement
routes
Advertise EVPN
routes by
deleting the Enumeration.
Defaultgatew
default gateway • 0—Disable. N/A
ayNoAdv
extended • 1—Enable.
community
attribute
Include:
Configure the
maximum • Number
number of routes Data • Percentage
RouteLimit N/A
that can be Structure • AlertOnly
received from the
• Discard
peers
• Reconnect

36
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
Number of
Number prefixes
Value range: N/A
1 to 4294967295
Percentage Unsigned integer.
value to trigger a
Percentage warning
Value range: N/A
message 1 to 100. Default is 75

Generate a log Enumeration.

message when
AlertOnly • 0—Disable. (default) N/A
the route limit is
exceeded • 1—Enable.

Discard routes Enumeration.

received after the
Discard • 0—Disable. (default) N/A
route limit is
exceeded • 1—Enable.

Unsigned integer.
Reconnect time
Reconnect in seconds
Value range: N/A
1 to 65535
Set a preferred Unsigned integer.
PreferredVal value for routes
Value range: N/A
ue received from the
peers 0 to 65535
Change the next
hop of received Enumeration.
VPNv4 or VPNv6
NexthopVpn • 0—Disable. N/A
routes to that of
the matching • 1—Enable.
VPN instance
Specify Enumeration.
AdditionalPat additional path
• 0—Disable. N/A
hsRcv receiving ability
for the peers • 1—Enable.

Specify Enumeration.
AdditionalPat additional path
• 0—Disable. N/A
hsSend sending ability
for the peers • 1—Enable.

Specify the
maximum
number of Unsigned integer.
AdvAddPaths Add-Path optimal
Value range: N/A
Best routes that can
be advertised to 2 to 32. Default is 1
a peer or peer
group

Set default route Include:

Data
RouteAdv info to peer or
Structure • DefRouteAdv N/A
peer group • RoutePlcy
Specify default
route Enumeration.
DefRouteAdv advertisement • 0—Disable. N/A
info to peer or • 1—Enable.
peer group

37
Column Column Column
Data type and restrictions Remarks
name description type
Specify a route String.
RoutePlcy N/A
policy Length: 1 to 63 characters.
Save original Enumeration.
KeepAllRoute route update info
• 0—Disable.(default) N/A
s from all peer or
peer groups • 1—Enable.

Specify labeled Enumeration.

LblRouteCap route exchange
• 0—Disable. (default) N/A
ability ability for peer or
peer groups • 1—Enable.

Specify a prefix
list to filter routes String.
PrefixListExp advertised to a N/A
peer or peer Length: 1 to 63 characters.
group
Specify a prefix
list to filter routes String.
PrefixListImp received from a N/A
peer or peer Length: 1 to 63 characters.
group
Remove private
AS numbers in Enumeration.
BGP updates
PublicAsOnly • 0—Disable.(default) N/A
sent to an EBGP
peer or peer • 1—Enable.
group
String.
Length: 3 to 21 characters.
Configure SoO The format is Example: 101:3 or
SooSiteOfOri
info for peer or IP<X.X.X.X>:NN<0-65535> or 192.168.122.15:1
gin
peer groups AS<0-65535>:NN<0-4294967 or 65535:1..
295> or
AS<65536-4294967295>:NN<
0-65535>.
Unsigned integer.
Specify an ACL
to filter routes Value range:
FlPlcyAclNoO
advertised to 2000 to 3999. N/A
rNameExp
peers or peer String.
groups
Length: 1 to 63 characters.
Unsigned integer.
Specify an ACL
to filter routes Value range:
FlPlcyAclNoO
received from 2000 to 3999. N/A
rNameImp
peers or peer String.
groups
Length: 1 to 63 characters.
Send BGP RPKI Enumeration.
validation results
AdvOrigAsVld • 0—Disable.(default) N/A
to peer or peer
groups • 1—Enable.

Specify BGP Enumeration:

CapOrf N/A
neighbor ORF • 0—Disable.(default)

38
Column Column Column
Data type and restrictions Remarks
name description type
capabilities • 1—Receive.
negotiation • 2—Send.
• 3—Both
Set MPLS
L2VPN tag block
info exchange Include:
Data
Signaling ability between
Structure • SigEnable N/A
local route and • SigNonStd
specified peer or
peer groups

Specify default Enumeration.

SigEnable tag block info • 0—Disable. N/A
exchange ability • 1—Enable. (default)
Specify Enumeration.
non-stand format
SigNonStd • 0—Disable. N/A
to exchange tag
block info • 1—Enable.

Set UPE as
HoVPN for Enumeration.
UpeEnable routes received • 0—Disable.(default) N/A
from peers or • 1—Enable.
peer groups
Configure
UpeRoutePlc specified UPE String.
N/A
y route info filtered Length: 1 to 63 characters.
by route policy
Set VPLS PE tag
block info
exchange ability Include:
Data
AutoDisc between local
Structure • DiscEnable N/A
route and • DiscNonStd
specified peer or
peers groups

Specify default Enumeration.

DiscEnable tag block info • 0—Disable. N/A
exchange ability • 1—Enable. (default)
Specify
non-standard Enumeration.
DiscNonStd format to • 0—Disable. N/A
exchange tag • 1—Enable.
block info
Disable Enumeration.
ValidationDis validation for
• 0—Disable. (default) N/A
able BGP flowspec
routes • 1—Enable.

ValidationRe Disable Enumeration.

validation for Only EBGP
directDisabl • 0—Disable. (default)
BGP flowspec neighbors support.
e redirect nexthop • 1—Enable.

39
BGP/Neighbors
This table contains BGP neighbor information.

XML structure
<BGP>
<Neighbors>
<Neighbor>
<Name></Name>
<VRF></VRF>
<Family></Family>
<SessAF></SessAF>
<IpAddress></IpAddress>
<Mask></Mask>
<RtPolicyImport></RtPolicyImport>
<RtPolicyExport></RtPolicyExport>
<AllowAsLoop></AllowAsLoop>
<ReflectClient></ReflectClient>
<NexthopInvariable></NexthopInvariable>
<NexthopLocal></NexthopLocal>
<RouterMacLocal></RouterMacLocal>
<AdvertiseCommunity></AdvertiseCommunity>
<AdvertiseExtCommunity></AdvertiseExtCommunity>
<ReOriginated></ReOriginated>
<AdvEvpnRouteSuppressMac></AdvEvpnRouteSuppressMac>
<AdvEvpnRouteSuppressPrefix></AdvEvpnRouteSuppressPrefix>
<DefaultgatewayNoAdv></DefaultgatewayNoAdv>
<RouteLimit>
<Number></Number>
<Percentage></Percentage>
<AlertOnly></AlertOnly>
<Discard></Discard>
<Reconnect></Reconnect>
</RouteLimit>
<PreferredValue></PreferredValue>
<NexthopVpn></NexthopVpn>
<AdditionalPathsRcv></AdditionalPathsRcv>
<AdditionalPathsSend></AdditionalPathsSend>
<AdvAddPathsBest></AdvAddPathsBest>
<RouteAdv>
<DefRouteAdv></DefRouteAdv>
<RoutePlcy></RoutePlcy>
</RouteAdv>
<KeepAllRoutes></KeepAllRoutes>
<LblRouteCapability></LblRouteCapability>
<PrefixListExp></PrefixListExp>
<PrefixListImp></PrefixListImp>

40
 <PublicAsOnly></PublicAsOnly>
<SooSiteOfOrigin></SooSiteOfOrigin>
<FlPlcyAclNoOrNameExp></FlPlcyAclNoOrNameExp>
<FlPlcyAclNoOrNameImp></FlPlcyAclNoOrNameImp>
<AdvOrigAsVld></AdvOrigAsVld>
<CapOrf></CapOrf>
<Signaling>
<SigEnable></SigEnable>
<SigNonStd></SigNonStd>
</Signaling>
<UpeEnable></UpeEnable>
<UpeRoutePlcy></UpeRoutePlcy>
<AutoDisc>
<DiscEnable></DiscEnable>
<DiscNonStd></DiscNonStd>
</AutoDisc>
<ValidationDisable></ValidationDisable>
<ValidationRedirectDisable></ValidationRedirectDisable>
</Neighbor>
</Neighbors>
</BGP>

Table description
Item Description
Feature name BGP
Table name Neighbors
Table type Multi-instance table
Row name Neighbor
Restrictions No
Support for row creation and deletion Yes

41
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
Address Family • 7—VPNv6
N/A
Family Identifier of Index • 8—L2VPN
Neighbor
• 9—L2VPN EVPN
• 10—Link-State
• 11—IPv4 rtfilter.
• 12—IPv4 mvpn.
• 13—IPv4 Flowspec
• 14—VPNv4 Flowspec
• 15—IPv6 Flowspec
• 16—VPNv6 Flowspec
Enumeration:
Address family of
SessAF
session
Index • 1—IPv4. N/A
• 2—IPv6.
Example: 1.1.1.1 or
Address of String,IPv4 address string or 1::1.
IpAddress Index
session IPv6 address string.

For non-dynamic
peers, this is
255.For IPv4
Unsigned integer. dynamic peers,this
Mask of
Mask Index Value range: is 0 to 32.For IPv6
session address dynamic peers, this
0 to 128,or 255
is 0 to 128.
Dynamic peers are
not supported.
Import String.
RtPolicyImpor
Route-Policy for N/A
t Length: 1 to 63 characters.
Neighbor
Export String.
RtPolicyExpo
Route-Policy for N/A
rt Length: 1 to 63 characters.
Neighbor
allow a local AS Unsigned integer.
AllowAsLoop number to exist N/A
in the AS_PATH Value range:

42
Column Column Column
Data type and restrictions Remarks
name description type
attribute of 1 to 10
routes
Configure the
device as a route Enumeration.
reflector and
ReflectClient • 0—Disable. N/A
specify a peer or
peer group as a • 1—Enable.
client
Send original Enumeration. Next-hop-local
NexthopInvari next hop for
• 0—Disable. conflict with
able routes advertised
• 1—Enable. next-hop-invariable
to the peer
Specify local
address as the Enumeration. Next-hop-local
NexthopLocal next hop of • 0—Disable. conflict with
routes advertised • 1—Enable. next-hop-invariable
to the peers
Specify local
MAC as the Enumeration.
RouterMacLo router MAC of
• 0—Disable. N/A
cal routes advertised
to and received • 1—Enable.
from the peers

Send community Enumeration.

AdvertiseCo
attribute to the • 0—Disable. N/A
mmunity
peers • 1—Enable.

Send extended Enumeration.

AdvertiseExt community
• 0—Disable. N/A
Community attribute to the
peers 1—Enable.

Re-originate
EVPN routes Enumeration.
received from the • 0—Disable.
ReOriginated peer by N/A
• 1—Enable.
modifying the L3
VXLAN ID and • 2--- ReplaceRT.
RD

Advertise EVPN
AdvEvpnRout routes to the Enumeration.
eSuppressMa peer excluding • 0—Disable. N/A
c MAC/IP
• 1—Enable
advertisement
routes

Advertise EVPN
AdvEvpnRout routes to the Enumeration.
eSuppressPr peer excluding IP • 0—Disable. N/A
efix prefix
• 1—Enable
advertisement
routes

Defaultgatew • Enumeration.
Advertise EVPN N/A
ayNoAdv
routes by • 0—Disable.

43
Column Column Column
Data type and restrictions Remarks
name description type
deleting the • 1—Enable.
default gateway
extended
community
attribute
Include:
Configure the
maximum • Number
number of routes Data • Percentage
RouteLimit N/A
that can be Structure • AlertOnly
received from the
• Discard
peers
• Reconnect
Unsigned integer.
Number of
Number prefixes
Value range: N/A
1 to 4294967295
Percentage Unsigned integer.
value to trigger a
Percentage warning
Value range: N/A
message 1 to 100. Default is 75

Generate a log Enumeration.

message when
AlertOnly • 0—Disable. (default) N/A
the route limit is
exceeded • 1—Enable.

Discard routes Enumeration.

received after the
Discard • 0—Disable. (default) N/A
route limit is
exceeded • 1—Enable.

Unsigned integer.
Reconnect time
Reconnect in seconds
Value range: N/A
1 to 65535
Set a preferred Unsigned integer.
PreferredVal value for routes
Value range: N/A
ue received from the
peers 0 to 65535
Change the next
hop of received Enumeration.
VPNv4 routes to
NexthopVpn • 0—Disable. N/A
that of the
matching VPN • 1—Enable.
instance
Specify Enumeration.
AdditionalPat additional path
• 0—Disable. N/A
hsRcv receiving ability
for the peers • 1—Enable.

Specify Enumeration.
AdditionalPat additional path
• 0—Disable. N/A
hsSend sending ability
for the peers • 1—Enable.

Specify the
Unsigned integer.
AdvAddPaths maximum
number of Value range: N/A
Best
Add-Path optimal 2 to 32. Default is 1
routes that can

44
Column Column Column
Data type and restrictions Remarks
name description type
be advertised to
a peer or peer
group

Set default route Include:

Data
RouteAdv info to peer or
Structure • DefRouteAdv N/A
peer group • RoutePlcy
Specify default
route Enumeration.
DefRouteAdv advertisement • 0—Disable. N/A
info to peer or • 1—Enable.
peer group

Specify a route String.

RoutePlcy N/A
policy Length: 1 to 63 characters.
Save original Enumeration.
KeepAllRoute route update info
• 0—Disable.(default) N/A
s from all peer or
peer groups • 1—Enable.

Specify labeled Enumeration.

LblRouteCap route exchange
• 0—Disable. (default) N/A
ability ability for peer or
peer groups • 1—Enable.

Specify a prefix
list to filter routes String.
PrefixListExp advertised to a N/A
peer or peer Length: 1 to 63 characters.
group
Specify a prefix
list to filter routes String.
PrefixListImp received from a N/A
peer or peer Length: 1 to 63 characters.
group
Remove private
AS numbers in Enumeration.
BGP updates
PublicAsOnly • 0—Disable.(default) N/A
sent to an EBGP
peer or peer • 1—Enable.
group
String.
Length: 3 to 21 characters.
Configure SoO The format is Example: 101:3 or
SooSiteOfOri
info for peer or IP<X.X.X.X>:NN<0-65535> or 192.168.122.15:1
gin
peer groups AS<0-65535>:NN<0-4294967 or 65535:1..
295> or
AS<65536-4294967295>:NN<
0-65535>.
Unsigned integer.
Specify an ACL
to filter routes Value range:
FlPlcyAclNoO
advertised to 2000 to 3999. N/A
rNameExp
peers or peer String.
groups
Length: 1 to 63 characters.

FlPlcyAclNoO Specify an ACL Unsigned integer. N/A

45
Column Column Column
Data type and restrictions Remarks
name description type
rNameImp to filter routes Value range:
received from
peers or peer 2000 to 3999.
groups String.
Length: 1 to 63 characters.
Send BGP RPKI Enumeration.
validation results
AdvOrigAsVld • 0—Disable.(default) N/A
to peer or peer
groups • 1—Enable.

Specify BGP Enumeration:

neighbor ORF • 1—Receive.
CapOrf N/A
capabilities • 2—Send.
negotiation
• 3—Both
Set MPLS
L2VPN tag block
info exchange Include:
Data
Signaling ability between
Structure • SigEnable N/A
local route and • SigNonStd
specified peer or
peer groups

Specify default Enumeration.

SigEnable tag block info • 0—Disable. N/A
exchange ability • 1—Enable. (default)
Specify Enumeration.
non-stand format
SigNonStd • 0—Disable. N/A
to exchange tag
block info • 1—Enable.

Set UPE as
HoVPN for Enumeration.
UpeEnable routes received • 0—Disable.(default) N/A
from peers or • 1—Enable.
peer groups
Configure
UpeRoutePlc specified UPE String.
N/A
y route info filtered Length: 1 to 63 characters.
by route policy
Set VPLS PE tag
block info
exchange ability Include:
Data
AutoDisc between local
Structure • DiscEnable N/A
route and • DiscNonStd
specified peer or
peers groups

Specify default Enumeration.

DiscEnable tag block info • 0—Disable. N/A
exchange ability • 1—Enable. (default)
Specify
non-standard Enumeration.
DiscNonStd format to • 0—Disable. N/A
exchange tag • 1—Enable.
block info
Disable
ValidationDis Enumeration. N/A
validation for

46
 Column Column Column
Data type and restrictions Remarks
name description type
able BGP flowspec • 0—Disable. (default)
routes
• 1—Enable.

ValidationRe Disable Enumeration.

validation for Only EBGP
directDisabl • 0—Disable. (default)
BGP flowspec neighbors support.
e redirect nexthop • 1—Enable.

BGP/Redistributes
This table contains BGP redistribute information.

XML structure
<BGP>
<Redistributes>
<Redist>
<Name></Name>
<VRF></VRF>
<Family></Family>
<Protocol></Protocol>
<RedistName></RedistName>
<AllowDirect></AllowDirect>
<Med></Med>
<RoutePolicy></RoutePolicy>
</Redist>
</Redistributes>
</BGP>

Table description
Item Description
Feature name BGP
Table name Redistributes
Table type Multi-instance table
Row name Redist
Restrictions No
Support for row creation and deletion Yes

47
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
Address Family
Family Index • 2—IPv4 Multicast.
Identifier N/A
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
Enumeration:
• 1—Direct.
• 2—Static.
• 3—RIP
Protocol Protocol name Index • 4—OSPF N/A
• 5—ISIS
• 6—EIGRP
• 7—UNR
• 8—Guard

Redistributed It must be empty

String. when the Protocol
RedistName pocess Index
Length: 0 to 31 characters. column is Direct,
name Static.
Enumeration:
Include direct
AllowDirect • 0—Disable. N/A
routes.
• 1—Enable.
Unsigned integer.
Value of the
Med Value range: N/A
MED.
0 to 4294967295

Name of the String.

RoutePolicy N/A
routing policy. Length: 1 to 63 characters

BGP/RedistributesAppend
This table contains BGP redistribution appended information.

XML structure
<BGP>
<RedistributesAppend>
<Redist>
<Name></Name>

48
 <VRF></VRF>
<Family></Family>
<Protocol></Protocol>
<RedistName></RedistName>
<AllowDirect></AllowDirect>
<Med></Med>
<RoutePolicy></RoutePolicy>
</Redist>
</RedistributesAppend>
</BGP>

Table description
Item Description
Feature name BGP
Table name RedistributesAppend
Table type Multi-instance table
Row name Redist
Restrictions No
Support for row creation and deletion Yes

49
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
Address Family
Family
Identifier
Index • 2—IPv4 Multicast.
N/A
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
Enumeration:
• 1—Direct.
• 2—Static.
• 3—RIP
Protocol Protocol name Index • 4—OSPF N/A
• 5—ISIS
• 6—EIGRP
• 7—UNR
• 8—Guard

Redistributed It must be empty

String. when the Protocol
RedistName pocess Index
Length: 0 to 31 characters. column is Direct,
name Static.
Enumeration:
Include direct
AllowDirect • 0—Disable. N/A
routes.
• 1—Enable.
Unsigned integer.
Value of the
Med Value range: N/A
MED.
0 to 4294967295

Name of the String.

RoutePolicy N/A
routing policy. Length: 1 to 63 characters

BGP/BMPs
This table contains BGP BMP information.

XML structure
<BGP>
<BMPs>
<BMP>

50
 <ServerNum></ServerNum>
<ServerAddr></ServerAddr>
<ServerPortNum></ServerPortNum>
<StatisInterValue></StatisInterValue>
<ConnectInterfaceName></ConnectInterfaceName>
<RouteModeAdjRibOut></RouteModeAdjRibOut>
<RouteModeLocRib></RouteModeLocRib>
</BMP>
</BMPs>
</BGP>

Table description
Item Description
Feature name BGP
Table name BMPs
Table type Multi-instance table
Row name BMP
Restrictions No
Support for row creation and deletion Yes

51
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
BMP server
ServerNum Index Value range: N/A
number
1 to 8
You must set both
Specify the IPv4
ServerAddr and
ServerAddr address of BMP String,IPv4 address string.
ServerPortNum, or
server
set neither of them.

Unsigned integer. You must set both

Specify the port
ServerPortNu ServerAddr and
number of BMP Value range:
m ServerPortNum, or
server 1 to 65535 set neither of them.
Specify the Unsigned integer.
StatisInterVal statistics interval
Value range: Unit is seconds.
ue value number of
BMP server 1 to 3600

Specify the
source interface Example:
ConnectInterf String.
aceName
of TCP • M-GigabitEther
connections to Length: 0 to 47 characters.
net0/0/0
the BMP server
Enable BGP to
send routes Enumeration:
RouteModeA advertised to the
• 0—Disable. N/A
djRibOut monitored peer
or peer group to • 1—Enable
the BMP server
Enable BGP to
send the optimal Enumeration:
RouteModeL
routes in the • 0—Disable. N/A
ocRib
routing table to • 1—Enable
the BMP server

BGP/Rpkis
This table contains BGP RPKI information.

XML structure
<BGP>
<Rpkis>
<Rpki>
<Name></Name>
<CheckOriginValidation></CheckOriginValidation>
<Servers>
<Server>
<VRF></VRF>

52
 <Family></Family>
<IpAddress></IpAddress>
<Port></Port>
<PasswordType></PasswordType>
<Password></Password>
<RefreshTime></RefreshTime>
<ResponseTime></ResponseTime>
<PurgeTime></PurgeTime>
</Server>
</Servers>
</Rpki>
</Rpkis>
</BGP>

Table description
Item Description
Feature name BGP
Table name Rpkis
Table type Multi-instance table
Row name N/A
Restrictions No
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.
Enumeration.
CheckOriginV Check origin
alidation validation • 0—Disable. N/A
• 1—Enable.
For more
Site containing information, see
Servers the rpki server Subtable N/A the
information BGP/Rpkis/Rpki/Se
rvers

BGP/Rpkis/Rpki/Servers
This table contains BGP RPKI server information.

53
XML structure
Please refer to the XML structure of BGP/Rpkis.

Table description
Item Description
Feature name BGP
Table name Servers
Table type Multi-instance table
Row name N/A
Restrictions No
Support for row creation and deletion Yes

54
Columns
Column Column Column
Data type and restrictions Remarks
name description type
String. An empty string
VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
Address family
Family
identifier
Index • 1—IPv4.
N/A
• 2—IPv6
Example: 1.1.1.1 or
Summary String,IPv4 address string or 1::1.
IpAddress Index
address IPv6 address string.

Unsigned integer.
Port Port Value range: N/A
1 to 65535
Enumeration.
PasswordTyp
Password type. • 1—Ciphertext. N/A
e
• 2—Plaintext.
String.
Length:
Password Password. 1 to 80 characters for MD5 N/A
plaintext password.
33 to 137 characters for MD5
ciphertext password.
Unsigned integer.
Refresh time in
RefreshTime Value range: N/A
seconds
15 to 3600
Unsigned integer.
ResponseTim Response time in
Value range: N/A
e seconds
15 to 3600
Unsigned integer.
Purge time in
PurgeTime Value range: N/A
seconds
30 to 360

BGP/FilterPolicyExports
This table contains BGP filter-policy export information.

XML structure
<BGP>
<FilterPolicyExports>
<FilterPolicyExport>
<Name></Name>
<VRF></VRF>

55
 <Family></Family>
<ProtocolExp></ProtocolExp>
<ProcessIDExp></ProcessIDExp>
<AclNumExp></AclNumExp>
<AclNameExp></AclNameExp>
<PrefixListNameExp></PrefixListNameExp>
</FilterPolicyExport>
</FilterPolicyExports>
</BGP>

Table description
Item Description
Feature name BGP
Table name FilterPolicyExports
Table type Multi-instance table
Row name FilterPolicyExport
Restrictions No
Support for row creation and deletion Yes

56
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
Address Family
Family Index • 4—VPNv4
Identifier N/A
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
• 7—VPNv6
The Protocol can
be empty.
The Protocol can
Enumeration: be set to direct,
• 1—direct isis, ospf, rip or
static only when
• 2—isis. the Type had been
Specify where • 3—isisv6 set to IPv4 Unicast,
ProtocolExp the BGP routes Index • 4—ospf IPv4 Multicast, or
VPNv4. The
are imported. • 5—ospfv3
Protocol can be set
• 6—rip. to direct, isisv6,
• 7—ripng ospfv3, ripng or
static only when
• 8—static the Type had been
set to IPv6 Unicast,
IPv6 Multicast, or
VPNv6.

Unsigned integer. It must be empty

Specify the
ProcessIDEx when the Protocol
process ID of Index Value range:
p column is Direct,
routing protocol. 1 to 65535 Static or empty.
You can only set
Filter BGP routes Unsigned integer. one of AclNumExp,
AclNumExp by an ACL Value range: AclNameExp and
number. 2000 to 3999 PrefixListNameExp
at the same time.
ACL name (start
with[a-z,A-Z]).Can’t
use “all” as ACL
name.
Filter BGP routes String.
AclNameExp You can only set
by an ACL name. Length: 1 to 63 characters.
one of AclNumExp,
AclNameExp and
PrefixListNameExp
at the same time.

PrefixListNam Filter BGP routes String. You can only set

57
 Column Column Column
Data type and restrictions Remarks
name description type
eExp by a prefix-list Length: 1 to 63 characters. one of AclNumExp,
name. AclNameExp and
PrefixListNameExp
at the same time.

BGP/PeerGpDefRtAdvVpnInsts
This table contains BGP peer group-name default-route-advertise vpn-instance vpn-instance-name
information.

XML structure
<BGP>
<PeerGpDefRtAdvVpnInsts>
<PeerGpDefRtAdvVpnInst>
<Name></Name>
<VRF></VRF>
<Family></Family>
<GroupName></GroupName>
<PeerGpDefRtAdvVpnInstName></PeerGpDefRtAdvVpnInstName>
</PeerGpDefRtAdvVpnInst>
</PeerGpDefRtAdvVpnInsts>
</BGP>

Table description
Item Description
Feature name BGP
Table name PeerGpDefRtAdvVpnInsts
Table type Multi-instance table
Row name PeerGpDefRtAdvVpnInst
Restrictions No
Support for row creation and deletion Yes

58
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Address Family Enumeration: N/A
Family Identifier of Index
NeighborGroup • 4—VPNv4

String.
GroupName Group Name Index N/A
Length: 1 to 47 characters.
PeerGpDefRt String.
Specify a VPN
AdvVpnInstN Index N/A
instance name. Length: 1 to 31 characters.
ame

BGP/PeerDefRtAdvVpnInsts
This table contains BGP peer ipv4-address mask-length default-route-advertise vpn-instance
vpn-instance-name information.

XML structure
<BGP>
<PeerDefRtAdvVpnInsts>
<PeerDefRtAdvVpnInst>
<Name></Name>
<VRF></VRF>
<Family></Family>
<SessAF></SessAF>
<IpAddress></IpAddress>
<Mask></Mask>
<PeerDefRtAdvVpnInstName></PeerDefRtAdvVpnInstName>
</PeerDefRtAdvVpnInst>
</PeerDefRtAdvVpnInsts>
</BGP>

Table description
Item Description
Feature name BGP

59
 Table name PeerDefRtAdvVpnInsts
Table type Multi-instance table
Row name PeerDefRtAdvVpnInst
Restrictions No
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Address Family Enumeration: N/A
Family Identifier of Index
Neighbor • 4—VPNv4

Address family of Enumeration:

SessAF Index N/A
session • 1—IPv4.

Address of String Example: 1.1.1.1.

IpAddress Index
session IPv4 address string.
For non-dynamic
Unsigned integer. peers, this is
Mask of
Mask Index Value range: 255.For IPv4
session address dynamic peers,this
0 to 32,or 255
is 0 to 32.
PeerDefRtAd String.
Specify a VPN
vVpnInstNam Index N/A
instance name Length: 1 to 31 characters.
e

60
Contents
BGP ······························································································1
BGP/Instances ·························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
BGP/VRFs ······························································································································· 5
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
BGP/CfgSessionGroups ·············································································································· 7
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ·························································································································· 10
BGP/CfgSessions ···················································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 15
BGP/Sessions ························································································································· 18
XML structure ··················································································································· 18
Table description ··············································································································· 19
Columns ·························································································································· 20
BGP/Familys ··························································································································· 23
XML structure ··················································································································· 23
Table description ··············································································································· 25
Columns ·························································································································· 26
BGP/Networks ························································································································ 33
XML structure ··················································································································· 33
Table description ··············································································································· 33
Columns ·························································································································· 34
BGP/Aggregates ······················································································································ 34
XML structure ··················································································································· 34
Table description ··············································································································· 35
Columns ·························································································································· 36
BGP/NeighborGroups ··············································································································· 36
XML structure ··················································································································· 36
Table description ··············································································································· 38
Columns ·························································································································· 39
BGP/Neighbors ······················································································································· 43
XML structure ··················································································································· 44
Table description ··············································································································· 45
Columns ·························································································································· 46
BGP/Redistributes···················································································································· 51
XML structure ··················································································································· 51
Table description ··············································································································· 51
Columns ·························································································································· 52
BGP/SessionCounts ················································································································· 52
XML structure ··················································································································· 52
Table description ··············································································································· 53
Columns ·························································································································· 53
BGP/NeighborInformations ········································································································ 53
XML structure ··················································································································· 53
Table description ··············································································································· 54
Columns ·························································································································· 55
BGP/RedistributesAppend ········································································································· 57
XML structure ··················································································································· 57
Table description ··············································································································· 58
Columns ·························································································································· 59

i
BGP/BMPs ····························································································································· 59
XML structure ··················································································································· 59
Table description ··············································································································· 60
Columns ·························································································································· 61
BGP/Rpkis ····························································································································· 61
XML structure ··················································································································· 61
Table description ··············································································································· 62
Columns ·························································································································· 62
BGP/Rpkis/Rpki/Servers············································································································ 62
XML structure ··················································································································· 63
Table description ··············································································································· 63
Columns ·························································································································· 64
BGP/FilterPolicyExports ············································································································ 64
XML structure ··················································································································· 64
Table description ··············································································································· 65
Columns ·························································································································· 66
BGP/PeerGpDefRtAdvVpnInsts ·································································································· 67
XML structure ··················································································································· 67
Table description ··············································································································· 67
Columns ·························································································································· 68
BGP/PeerDefRtAdvVpnInsts ······································································································ 68
XML structure ··················································································································· 68
Table description ··············································································································· 68
Columns ·························································································································· 69

ii
BGP
BGP/Instances
This table contains BGP instance information.

XML structure
<BGP>
<Instances>
<Instance>
<Name></Name>
<ASNumber></ASNumber>
<NSR></NSR>
<SendDelayTime></SendDelayTime>
<SendDelayPrefix></SendDelayPrefix>
<SendDelayIPv6Prefix></SendDelayIPv6Prefix>
<SendStartupTime></SendStartupTime>
<StartupPolicyMed></StartupPolicyMed>
<FlushSuboptimalRoute></FlushSuboptimalRoute>
<RouteReplicateEnable></RouteReplicateEnable>
<DefaultRouteUpdateFirst></DefaultRouteUpdateFirst>
<EbgpInterfaceSensitive></EbgpInterfaceSensitive>
<GracefulRestartEnable></GracefulRestartEnable>
<GracefulRestartTimerPurgeTime></GracefulRestartTimerPurgeTime>
<GracefulRestartTimerRestart></GracefulRestartTimerRestart>
<GracefulRestartTimerWaitForRib></GracefulRestartTimerWaitForRib>
<IgnoreAllPeers>
<IgnoreAllPeersEnable></IgnoreAllPeersEnable>
<GracefulTime></GracefulTime>
<CommunityNumber></CommunityNumber>
<LocalPreference></LocalPreference>
<Med></Med>
</IgnoreAllPeers>
<IgnoreFirstAs></IgnoreFirstAs>
<LabelAllocationMode></LabelAllocationMode>
<LabeledRouteIgnoreNoTunnel></LabeledRouteIgnoreNoTunnel>
<LogPeerChange></LogPeerChange>
<PrimaryPathDetectBfdEcho></PrimaryPathDetectBfdEcho>
<RetainLocalLabel></RetainLocalLabel>
<RouteRateLimit></RouteRateLimit>
<RouteUpdateIntervalWithdrawnEnable></RouteUpdateIntervalWithdrawnEnable>
<SnmpContextName></SnmpContextName>
<VpnPopgo></VpnPopgo>
<ConfederationId></ConfederationId>
<ConfederationNonstandard></ConfederationNonstandard>

1
 <ConfederationPeerAs></ConfederationPeerAs>
</Instance>
</Instances>
</BGP>

Table description
Item Description
Feature name BGP
Table name Instances
Table type Multi-instance table
Row name Instance
Restrictions No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
indicates the
default BGP
process.
String. When execute get
Name Instance name Index
Length: 0 to 31 characters. bulk operation, you
can only get the
data of the
specified BGP
instance.

2
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
Autonomous
ASNumber Value range: N/A
System number
1 to 4294967295
Enumeration.
NSR Nonstop Routing • 0—Disable. N/A
• 1—Enable.
The value 0
Unsigned integer. indicates that the
SendDelayTim Send delay time
Value range: BGP speaker never
e in seconds
0 to 3600 send the update
message.

SendDelayPre Send delay using String.

N/A
fix IPv4 prefix list Length: 1 to 63 characters.

Send delay String.

SendDelayIPv
6Prefix using IPv6 N/A
prefix list Length: 1 to 63 characters.

The value 0
indicates that the
Unsigned integer. BGP speaker
SendStartupTi Send startup
Value range: always send the
me time in seconds
0 to 3600 update message
with the startup
policy.
Unsigned integer.
StartupPolicy Satrtup policy
Value range: N/A
Med MED
0 to 4294967295
Enumeration.
FlushSubopti Flush suboptimal
malRoute route to RIB • 0—Disable. N/A
• 1—Enable.
Enable mutual
route Enumeration.
RouteReplic replication
• 0—Disable. N/A
ateEnable between public
and private • 1—Enable.
networks
Enable BGP to
send withdrawal Enumeration.
DefaultRoute messages of the
UpdateFirst default route • 0—Disable. N/A
prior to other • 1—Enable.
routes
Immediate Enumeration.
EbgpInterface re-establishment
Sensitive of direct EBGP • 0—Disable. N/A
sessions • 1—Enable.

Enumeration.
GracefulRest Enabling
artEnable graceful restart • 0—Disable. N/A
• 1—Enable.
GracefulRest Graceful restart Unsigned integer. Graceful restart

3
Column Column Column
Data type and restrictions Remarks
name description type
artTimerPurg purge time in Value range: must be enabled
eTime seconds first.
1 to 6000

GracefulRest Graceful restart Unsigned integer. Graceful restart

artTimerRest restart time in Value range: must be enabled
art seconds 3 to 600 first.

Graceful restart
GracefulRest time to wait for Unsigned integer. Graceful restart
artTimerWaitF the End-of-RIP Value range: must be enabled
orRib marker in 3 to 3600 first.
seconds
Include:
• IgnoreAllPeersEnable
IgnoreAllPeer Data • GracefulTime
Ignore all peers N/A
s Structure • CommunityNumber
• LocalPreference
• Med
Enumeration.
IgnoreAllPeer Ignore all peers
sEnable enable • 0—Disable. N/A
• 1—Enable.
Ignore all peers
must be enabled
Unsigned integer. first.
Graceful time in Community,
GracefulTime Value range:
seconds LocalPreference
60 to 65535 and Med should be
set on at least
GracefulTime.
Ignore all peers
must be enabled
Unsigned integer. first.
Value range: Example: 10 or
1 to 4294967295. 1:65535
CommunityN Community Repeat supported
String.
umber number for 32 times along
Length: 3 to 11 characters. with
Format: CommunityAttr.
AA<0-65535>:NN<0-65535> Only supported for
basic community
list.
Unsigned integer. Ignore all peers
LocalPreferen
Local preference Value range: must be enabled
ce
0 to 4294967295 first.

Unsigned integer. Ignore all peers

Med MED of route Value range: must be enabled
0 to 4294967295 first.

Enumeration.
Ignore the first
IgnoreFirstAs
AS • 0—Disable. N/A
• 1—Enable.

4
 Column Column Column
Data type and restrictions Remarks
name description type
Enumeration.
LabelAllocatio Label allocation • 0—per-hop.
N/A
nMode mode • 1—per-prefix
• 2- per-vrf.
Ignore labeled Enumeration.
LabeledRoute
routes with no
IgnoreNoTun
tunnel • 0—Disable. N/A
nel • 1—Enable.
information
Enumeration.
LogPeerChan
ge
Log peer change • 0—Disable. N/A
• 1—Enable.

Detect primary Enumeration.

PrimaryPathD
etectBfdEcho
path using BFD • 0—Disable. N/A
echo. • 1—Enable.

Update delay for Unsigned integer.

RetainLocalL
local MPLS Value range: N/A
abel
labels in seconds 1 to 21845

RouteRateLi Unsigned integer.

Route rate limit N/A
mit Value range:0 to 4294967295
Apply route Enumeration.
RouteUpdateI
update interval
ntervalWithdr
setting to • 0—Disable. N/A
awnEnable • 1—Enable.
withdrawn routes

SnmpContext SNMP context String.

N/A
Name name Length: 1 to 32 characters.
Enumeration.
VpnPopgo VPN POPGO • 0—Disable. N/A
• 1—Enable.
Unsigned integer.
Confederatio
Confederation ID Value range: N/A
nId
1 to 4294967295
Enable
compatibility with Enumeration.
Confederatio
routers not
nNonstandar
compliant with • 0—Disable. N/A
d • 1—Enable.
RFC 3065 in the
confederation

Confederation Unsigned integer.

Confederatio
peer sub-AS Value range: N/A
nPeerAs
number. 1 to 4294967295

BGP/VRFs
This table contains BGP VRF information.

5
XML structure
<BGP>
<VRFs>
<VRF>
<Name></Name>
<VRF></VRF>
<RouterId></RouterId>
<Timer>
<KeepAlive></KeepAlive>
<HoldTime></HoldTime>
</Timer>
<BestRouteIgpMetricIgnore></BestRouteIgpMetricIgnore>
<BestRouteAsPathNeglect></BestRouteAsPathNeglect>
<BestRouteCompareMED></BestRouteCompareMED>
<BestRouteConfederationMED></BestRouteConfederationMED>
<BestRouteRouterIdIgnore></BestRouteRouterIdIgnore>
<CompareDifferentAsMED></CompareDifferentAsMED>
<TimerConnectRetry></TimerConnectRetry>
</VRF>
</VRFs>
</BGP>

Table description
Item Description
Feature name BGP
Table name VRFs
Table type Multi-instance table
Row name VRF
Restrictions No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.

6
 Column Column Column
Data type and restrictions Remarks
name description type
RouterId BGP Router Id String,IPv4 address string N/A
Include:
Keepalive and Data
Timer
Holdtime Structure • KeepAlive N/A
• HoldTime

Keepalive Unsigned integer.

KeepAlive Interval in Value range: N/A
Seconds 0 to 21845
Unsigned integer.
Holdtime in
HoldTime Value range: N/A
Seconds
0, or 3 to 65535
Ignore IGP Enumeration.
metrics during
BestRouteIgp • 0—Disable. N/A
MetricIgnore optimal route
selection • 1—Enable.
Ignore the
AS-PATH Enumeration.
BestRouteAs attribute during • 0—Disable. N/A
PathNeglect optimal route • 1—Enable.
selection
Consider MED Enumeration.
value during
BestRouteCo
optimal route • 0—Disable. N/A
mpareMED
selection • 1—Enable.
Compare the
MEDs of routes
from Enumeration.
BestRouteCo
nfederationM confederation • 0—Disable. N/A
ED peers during • 1—Enable.
optimal route
selection

Ignore router ID Enumeration.

BestRouteRo during optimal • 0—Disable. N/A
uterIdIgnore route selection • 1—Enable.
Compare the
MEDs of routes Enumeration.
from different
CompareDiffe • 0—Disable. N/A
rentAsMED ASs during
optimal route • 1—Enable.
selection
Unsigned integer.
TimerConnec Timer connect
Value range: N/A
tRetry retry in seconds
1 to 65535

BGP/CfgSessionGroups
This table contains configure information of BGP session group.

7
XML structure
<BGP>
<CfgSessionGroups>
<CfgSessionGroup>
<Name></Name>
<VRF></VRF>
<GroupName></GroupName>
<Type></Type>
<ASNumber></ASNumber>
<ConnectInterface></ConnectInterface>
<UpdateInterval></UpdateInterval>
<PasswordType></PasswordType>
<Password></Password>
<BfdType></BfdType>
<EbgpMaxHop></EbgpMaxHop>
<Ignore></Ignore>
<Description></Description>
<NexthopRecursivePolicyDisable></NexthopRecursivePolicyDisable>
<FakeAS></FakeAS>
<DualAS></DualAS>
<PrependGlobalAS></PrependGlobalAS>
<PrependFakeAS></PrependFakeAS>
<BmpServer></BmpServer>
<Dscp></Dscp>
<IgnoreOriginatorid></IgnoreOriginatorid>
<LogChange></LogChange>
<LowMemoryExempt></LowMemoryExempt>
<Ipv4SourceAddr></Ipv4SourceAddr>
<Ipv6SourceAddr></Ipv6SourceAddr>
<SubstituteAs><SubstituteAs>
<Timer>
<Keepalive></Keepalive>
<HoldTime></HoldTime>
</Timer>
<TtlSecurity></TtlSecurity>
<CapSupAs4></CapSupAs4>
<CapOrfNonStandard></CapOrfNonStandard>
<CapConventional></CapConventional>
<IpsecProfile></IpsecProfile>
<Keychain></Keychain>
</CfgSessionGroup>
</CfgSessionGroups>
</BGP>

8
Table description
Item Description
Feature name BGP
Table name CfgSessionGroups

Table type Multi-instance table

Row name CfgSessionGroup

Restrictions No

9
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
String.
GroupName Group Name Index N/A
Length: 1 to 47 characters.
Enumeration.
Internal or
Type
External • 0—Internal. N/A
• 1—External.
Unsigned integer.
Autonomous
ASNumber Value range: N/A
System number
1 to 4294967295

ConnectInterf Connect String.

N/A
ace Interface Length: 1 to 47 characters.
Unsigned integer.
UpdateInterv Route Update
Value range: N/A
al Interval
0 to 600

Enumeration. The password can

PasswordTyp
Password type. • 1—Ciphertext. only be displayed
e
• 2—Plaintext. in ciper text.

String.
Length:
Password Password. 1 to 80 characters for MD5
plaintext password.
33 to 137 characters for MD5
ciphertext password.
The default type
indicate that actual
bfd type
(single-hop or
Enumeration.
multi-hop) depend
• 0—default type on different
BfdType Bfd type • 1—single-hop situations.
• 2—multi-hop Some versions not
support. For
relevant
information, see
the XSD document
of your product.

Unsigned integer.
EbgpMaxHop EBGP multihop Value range: N/A
1 to 255

10
Column Column Column
Data type and restrictions Remarks
name description type
Disable session Enumeration.
Ignore establishment to • 0—Disable. N/A
the peers • 1—Enable.

String.
Description Peer Description Case Sensitive
Length: 1 to 79 characters.

Disable route
recursion policy Enumeration.
NexthopRecu
control for routes
rsivePolicyDis • 0—Disable. N/A
received from the
able • 1—Enable.
specified peer or
peer group
Unsigned integer.
Value range:
Specify a virtual 1 to 4294967295. By default, the fake
local AS number
FakeAS String. AS number does
for the peer or
Length: 3 to 11 characters. not exist.
peer group
Format:
AA<0-65535>.NN<0-65535>
The object does
Support both real not exist if FakeAS
and fake AS Enumeration. is not configured.
numbers for peer
DualAS • 0—Disable. If you configure
group
relationship • 1—Enable. FakeAS but not
establishment DualAS, the value
for DualAS is 0.
The object does
not exist if FakeAS
Add the real AS is not configured.
number to the Enumeration.
PrependGlob If you configure
AS_PATH • 0—Disable. FakeAS but not
alAS
attribute in sent • 1—Enable. PrependGlobalAS,
packets the value for
PrependGlobalAS
is 0.
The object does
not exist if FakeAS
Add the fake AS is not configured.
number to the Enumeration.
PrependFake If you configure
AS_PATH • 0—Disable. FakeAS but not
AS
attribute in • 1—Enable. PrependFakeAS,
received packets the value for
PrependFakeAS is
0.
Up to 8 BGP
Configure the Unsigned integer. monitoring servers
BmpServer BMP server peer Value range: can be configured
or peer group 1 to 8 in the same
command.

Set the DSCP Unsigned integer.

Dscp priority of BGP Value range: N/A
packets 0 to 63

11
Column Column Column
Data type and restrictions Remarks
name description type
Ignore the Enumeration.
IgnoreOrigina ORIGINATOR_I
torid D attribute of a • 0—Disable. (default) N/A
BGP route • 1—Enable.

Enable the
logging function Enumeration.
of the BGP
LogChange
session with the • 0—Disable. N/A
specified peer or • 1—Enable. (default)
peer group
Do not
disconnect the Enumeration.
LowMemoryE session with the
xempt specified EBGP • 0—Disable. (default) N/A
peer or peer • 1—Enable.
group

Ipv4Source IPv4 Source

IPv4 address string . Example: 1.1.1.1.
Addr Address

Ipv6Source IPv6 Source

IPv6 address string. Example: 1::1.
Addr Address

Replace the AS
number of the
specified peer or Enumeration.
SubstituteAs peer group in • 0—Disable. (default) N/A
the AS_PATH • 1—Enable.
attribute with the
local AS number
The hold time must
Members include: be greater than or
Keepalive and Data
Timer
holdtime • Keepalive equal to three
structure times the keepalive
• HoldTime.
time.

Keepalive Unsigned integer.

Keepalive interval in Value range: N/A
seconds 0 to 21845
Unsigned integer.
Holdtime in
HoldTime Value range: N/A
seconds
0 , 3 to 65535
Enable BGP Unsigned integer.
GTSM fuction for
TtlSecurity Value range: N/A
a peer or peer
group 1 to 254

Enable 4-byte Enumeration.

AS number
CapSupAs4
suppression • 0—Disable. (default) N/A
function • 1—Enable.

Enable Enumeration.
CapOrfNonSt non-standard
andard • 0—Disable. (default) N/A
ORF capability
for BGP neighbor • 1—Enable.

12
 Column Column Column
Data type and restrictions Remarks
name description type
negotiation

Disable the BGP

route
refresh,multiprot
ocol extension, Enumeration.
CapConventi and 4-byte AS
onal number function • 0—Disable. (default) N/A
of the local router • 1—Enable.
and the specified
peer or peer
group
Apply the IPsec
security String.
IpsecProfile framework to N/A
IPv6 BGP peer Length: 1 to 63 characters.
or peer group
Configure
keychain
authentication
when a BGP String.
Keychain N/A
peer or peer Length: 1 to 63 characters.
group
establishes a
TCP connection

BGP/CfgSessions
This table contains configure information of BGP session.

XML structure
<BGP>
<CfgSessions>
<CfgSession>
<Name></Name>
<VRF></VRF>
<SessAF></SessAF>
<IpAddress></IpAddress>
<Mask></Mask>
<ASNumber></ASNumber>
<GroupName></GroupName>
<ConnectInterface></ConnectInterface>
<UpdateInterval></UpdateInterval>
<PasswordType></PasswordType>
<Password></Password>
<BfdType></BfdType>
<EbgpMaxHop></EbgpMaxHop>

13
 <Ignore></Ignore>
<Description></Description>
<NexthopRecursivePolicyDisable></NexthopRecursivePolicyDisable>
<FakeAS></FakeAS>
<DualAS></DualAS>
<PrependGlobalAS></PrependGlobalAS>
<PrependFakeAS></PrependFakeAS>
<BmpServer></BmpServer>
<Dscp></Dscp>
<IgnoreOriginatorid></IgnoreOriginatorid>
<LogChange></LogChange>
<LowMemoryExempt></LowMemoryExempt>
<SourceAddress></SourceAddress>
<SubstituteAs></SubstituteAs>
<Timer>
<Keepalive></Keepalive>
<HoldTime></HoldTime>
</Timer>
<TtlSecurity></TtlSecurity>
<CapSupAs4></CapSupAs4>
<CapOrfNonStandard></CapOrfNonStandard>
<CapConventional></CapConventional>
<IpsecProfile></IpsecProfile>
<Keychain></Keychain>
</CfgSession>
</CfgSessions>
</BGP>

Table description
Item Description
Feature name BGP
Table name CfgSessions

Table type Multi-instance table

Row name CfgSession

Restrictions No

14
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
Address family of
SessAF
session
Index • 1—IPv4. N/A
• 2—IPv6.
Example: 1.1.1.1 or
Address of String,IPv4 address string or 1::1.
IpAddress Index
session IPv6 address string.

For non-dynamic
peers, this is
255.For IPv4
Mask of dynamic peers,this
Unsigned integer.
Mask session address Index is 0 to 32.For IPv6
Value range: 0 to 128,or 255 dynamic peers, this
is 0 to 128.
Dynamic peers are
not supported.
Unsigned integer.
Autonomous
ASNumber Value range: N/A
System number
1 to 4294967295
String.
GroupName Group Name N/A
Length: 1 to 47 characters.

ConnectInterf Connect String.

N/A
ace Interface Length: 1 to 47 characters.
Unsigned integer.
UpdateInterv Route Update
Value range: N/A
al Interval
0 to 600

Enumeration. The password can

PasswordTyp
Password type. • 1—Ciphertext. only be displayed
e
• 2—Plaintext. in ciper text.

String.
Length:
Password Password. 1 to 80 characters for MD5
plaintext password.
33 to 137 characters for MD5
ciphertext password.

Enumeration. The default type

• 0—default type indicate that actual
BfdType Bfd type bfd type
• 1—single-hop (single-hop or
• 2—multi-hop multi-hop) depend

15
Column Column Column
Data type and restrictions Remarks
name description type
on different
situations.
Some versions not
support. For
relevant
information, see
the XSD document
of your product.

Unsigned integer.
EbgpMaxHop EBGP multihop Value range: N/A
1 to 255

Disable session Enumeration.

Ignore establishment to • 0—Disable N/A
the peers • 1—Enable.

String.
Description Peer Description Case Sensitive
Length: 1 to 79 characters.

Disable route
recursion policy Enumeration.
NexthopRecu
control for routes
rsivePolicyDis
received from the • 0—Disable N/A
able • 1—Enable.
specified peer or
peer group
Unsigned integer.
Value range:
Specify a virtual 1 to 4294967295. By default, the fake
local AS number
FakeAS String. AS number does
for the peer or
Length: 3 to 11 characters. not exist.
peer group
Format:
AA<0-65535>.NN<0-65535>
The object does
Support both real not exist if FakeAS
and fake AS Enumeration. is not configured.
DualAS numbers for peer • 0—Disable. If you configure
relationship • 1—Enable. FakeAS but not
establishment DualAS, the value
for DualAS is 0.
The object does
not exist if FakeAS
Add the real AS is not configured.
number to the Enumeration.
PrependGlob If you configure
AS_PATH • 0—Disable. FakeAS but not
alAS
attribute in sent • 1—Enable. PrependGlobalAS,
packets the value for
PrependGlobalAS
is 0.
The object does
Add the fake AS not exist if FakeAS
number to the Enumeration.
PrependFake is not configured.
AS_PATH • 0—Disable.
AS If you configure
attribute in • 1—Enable.
received packets FakeAS but not
PrependFakeAS,

16
Column Column Column
Data type and restrictions Remarks
name description type
the value for
PrependFakeAS is
0.

Up to 8 BGP
Configure the Unsigned integer. monitoring servers
BmpServer BMP server peer Value range: can be configured
or peer group 1 to 8 in the same
command.

Set the DSCP Unsigned integer.

Dscp priority of BGP Value range: N/A
packets 0 to 63
Ignore the Enumeration.
IgnoreOrigina ORIGINATOR_I
torid D attribute of a • 0—Disable. (default) N/A
BGP route • 1—Enable.

Enable the
logging function Enumeration.
of the BGP
LogChange
session with the • 0—Disable. N/A
specified peer or • 1—Enable. (default)
peer group
Do not
disconnect the Enumeration.
LowMemoryE session with the
xempt specified EBGP • 0—Disable. (default) N/A
peer or peer • 1—Enable.
group

SourceAddre IPv4 address string or IPv6 Example: 1.1.1.1 or

Source Address
ss address string. 1::1.

Replace the AS
number of the
specified peer or Enumeration.
SubstituteAs peer group in • 0—Disable. (default) N/A
the AS_PATH • 1—Enable.
attribute with the
local AS number
The hold time must
Members include: be greater than or
Keepalive and Data
Timer
holdtime • Keepalive equal to three
structure times the keepalive
• HoldTime.
time.

Keepalive Unsigned integer.

Keepalive interval in Value range: N/A
seconds 0 to 21845

Unsigned integer.
Holdtime in
HoldTime Value range: N/A
seconds
0 ,3 to 65535

17
 Column Column Column
Data type and restrictions Remarks
name description type
Enable BGP Unsigned integer.
GTSM fuction for
TtlSecurity Value range: N/A
a peer or peer
group 1 to 254

Enable 4-byte Enumeration.

AS number
CapSupAs4
suppression • 0—Disable. (default) N/A
function • 1—Enable.

Enable
non-standard Enumeration.
CapOrfNonSt
andard
ORF capability • 0—Disable. (default) N/A
for BGP neighbor • 1—Enable.
negotiation
Disable the BGP
route
refresh,multiprot
ocol extension, Enumeration.
CapConventi and 4-byte AS
onal number function • 0—Disable. (default) N/A
of the local router • 1—Enable.
and the specified
peer or peer
group
Apply the IPsec
security String.
IpsecProfile framework to N/A
IPv6 BGP peer Length: 1 to 63 characters.
or peer group
Configure
keychain
authentication
when a BGP String.
Keychain N/A
peer or peer Length: 1 to 63 characters.
group
establishes a
TCP connection

BGP/Sessions
This table contains state information of BGP session.

XML structure
<BGP>
<Sessions>
<Session>
<Name></Name>
<VRF></VRF>
<AF></AF>
<IpAddress></IpAddress>
<ASNumber></ASNumber>

18
 <State></State>
<Version></Version>
<LocalRouterID></LocalRouterID>
<Type></Type>
<RemoteRouterID></RemoteRouterID>
<RcvdMsgCnt></RcvdMsgCnt>
<SentMsgCnt></SentMsgCnt>
<Time></Time>
<DynamicallyPeer></DynamicallyPeer>
<CurrentEvent></CurrentEvent>
<LastState></LastState>
<LocalPort></LocalPort>
<RemotePort></RemotePort>
<ConfiguredHoldTime></ConfiguredHoldTime>
<ConfiguredKeepaliveTime></ConfiguredKeepaliveTime>
<ReceivedHoldTime></ReceivedHoldTime>
<NegotiatedHoldTime></NegotiatedHoldTime>
<NegotiatedKeepaliveTime></NegotiatedKeepaliveTime>
<MultiProtocolExtensionCapability></MultiProtocolExtensionCapability>
<RouteRefreshCapability></RouteRefreshCapability>
<GracefulRestartCapability></GracefulRestartCapability>
<AS4Capability></AS4Capability>
<AddressfamilyCapability>
<Family></Family>
<Advertised></Advertised>
<Received></Received>
</AddressfamilyCapability>
<InQUpdates></InQUpdates>
<OutQUpdates></OutQUpdates>
<UpdateInterval></UpdateInterval>
</Session>
</Sessions>
</BGP>

Table description
Item Description
Feature name BGP
Table name Sessions
Table type Multi-instance table
Row name Session
Restrictions No

19
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
Address family of
AF
session
Index • 1—IPv4. N/A
• 2—IPv6.
Example: 1.1.1.1 or
Address of String,IPv4 address string or 1::1.
IpAddress Index
session IPv6 address string.

Unsigned integer.
Autonomous
ASNumber Value range: N/A
System number
1 to 4294967295

Enumeration: Established state

means that the
• 0—Idle BGP session is
• 1—Connect established, but
State Session state • 2—Active whether the
• 3—Opensent address
families are
• 4—Openconfirm negociated is
• 5—Established unknown.
Unsigned integer.
Version BGP version N/A
Value range:4
LocalRouterI
Local router ID String,IPv4 address string N/A
D
Enumeration.
Internal or
Type
External • 0—Internal. N/A
• 1—External.
RemoteRoute Router ID of the
String,IPv4 address string N/A
rID peer

Number of Unsigned integer.

RcvdMsgCnt messages Value range: N/A
received 0 to 4294967295
Unsigned integer.
Number of
SentMsgCnt Value range: N/A
messages sent
0 to 4294967295
Unsigned integer.
Lasting time of Value range:
Time the current BGP N/A
session state 0 to 4294967295.
Unit is second.

20
Column Column Column
Data type and restrictions Remarks
name description type

Whether the peer Boolean:

DynamicallyP
is a dynamic • true. N/A
eer
peer
• false.
Enumeration:
• 0—Start
• 1—Stop
• 2—CRTimerExpired
• 3—KATimerExpired
• 4—HoldTimerExpired
• 5—CR ACKED
• 6—ConnConfirmed
Current event of • 7—ConnFailed
the BGP session
CurrentEvent between the • 8—RecvOpen N/A
local router and • 9—HeadErr
the peer • 10—OpenMsgErr
• 11—RecvVerNotificatio
n
• 12—RecvNotification
• 13—RecvKeepalive
• 14—RecvUpdate
• 15—UpdateMsgErr
• 16—RecvRouteRefresh
• 17—Unknown

Enumeration: Established state

means that the
• 0—Idle BGP session is
• 1—Connect established, but
Previous state of
LastState
the BGP session • 2—Active whether the
• 3—Opensent address
families are
• 4—Openconfirm negociated is
• 5—Established unknown.
Local TCP port Unsigned integer.
numbers of the
LocalPort Value range: N/A
local router and
its peer 179, 1025 to 65535

Remote TCP Unsigned integer.

port numbers of
RemotePort Value range: N/A
the local router
and its peer 179, 1025 to 65535

Configured Unsigned integer.

ConfiguredHo
holdtime in Value range: N/A
ldTime
seconds 0, or 3 to 65535

Configured Unsigned integer.

ConfiguredKe
keepalive time in Value range: N/A
epaliveTime
seconds 0 to 21845

Received Unsigned integer.

ReceivedHold
holdtime in Value range: N/A
Time
seconds 0, or 3 to 65535

21
Column Column Column
Data type and restrictions Remarks
name description type
Negotiated Unsigned integer.
NegotiatedHo
holdtime in Value range: N/A
ldTime
seconds 0, or 3 to 65535

Negotiated Unsigned integer.

NegotiatedKe
keepalive time in Value range: N/A
epaliveTime
seconds 0 to 21845

Support for
MultiProtocol Boolean:
multiprotocol
ExtensionCap N/A
extension • true.
ability
capability • false.

Boolean:
RouteRefresh Support for route
N/A
Capability refresh capability • true.
• false.

Boolean:
GracefulRest Support for GR
N/A
artCapability capability • true.
• false.

Support for Boolean:

AS4Capabilit
4-byte AS N/A
y • true.
capability
• false.
Include:
Support for • Family
Addressfamil Data
address family N/A
yCapability
capability
Structure • Advertised
• Received
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
Address Family N/A
Family Index • 5—IPv6 Unicast
Identifier
• 6—IPv6 Multicast.
• 7—VPNv6
• 8—L2VPN
• 9—L2VPN EVPN
• 10—Link-State

Advertised Boolean:
Advertised address family N/A
• true.
identifier
• false.

Received Boolean:
Received address family N/A
• true.
identifier
• false.
InQUpdates Number of Unsigned integer. N/A

22
 Column Column Column
Data type and restrictions Remarks
name description type
received updates Value range:
to be processed.
0 to 4294967295
Unsigned integer.
Number of
OutQUpdates Value range: N/A
updates to be
sent to the peer. 0 to 4294967295
Unsigned integer.
UpdateInterv Route update
Value range: N/A
al interval
• 0 to 600

BGP/Familys
This table contains address family identifier information of BGP.

XML structure
<BGP>
<Familys>
<Family>
<Name></Name>
<VRF></VRF>
<Type></Type>
<Preference>
<Ebgp></Ebgp>
<Ibgp></Ibgp>
<Local></Local>
</Preference>
<BalanceAsPathNeglect></BalanceAsPathNeglect>
<BalanceAsPathRelax></BalanceAsPathRelax>
<Balance>
<MaxBalance></MaxBalance>
<MaxEBGPBalance></MaxEBGPBalance>
<MaxIBGPBalance></MaxIBGPBalance>
<MaxEIBGPBalance></MaxEIBGPBalance>
</Balance>
<PolicyVpnTarget></PolicyVpnTarget>
<ReflectBtwClients></ReflectBtwClients>
<ReflectorClusterID></ReflectorClusterID>
<RrFilter></RrFilter>
<DefaultRtImport></DefaultRtImport>
<DomainDistinguisher></DomainDistinguisher>
<PIC></PIC>
<VpnCrossMultipath></VpnCrossMultipath>
<RouteSelectDelay></RouteSelectDelay>
<AdvertiseEvpnRoute>

23
 <AdvertiseEvpnEnable></AdvertiseEvpnEnable>
<AdvertiseEvpnPolicy></AdvertiseEvpnPolicy>
<AdvertiseEvpnReplaceRt></AdvertiseEvpnReplaceRt>
</AdvertiseEvpnRoute>
<AdvertiseL2vpnEvpnRoute></AdvertiseL2vpnEvpnRoute>
<AdvertiseL3vpnRoute>
<AdvertiseL3vpnEnable></AdvertiseL3vpnEnable>
<AdvertiseL3vpnPolicy></AdvertiseL3vpnPolicy>
<AdvertiseL3vpnReplaceRt></AdvertiseL3vpnReplaceRt>
</AdvertiseL3vpnRoute>
<ImportEvpnMacIp></ImportEvpnMacIp>
<DefaultLocalPreference></DefaultLocalPreference>
<AddPathsSelectBestNum></AddPathsSelectBestNum>
<DefaultMedValue></DefaultMedValue>
<FrrRtPolicyName></FrrRtPolicyName>
<MvpnAdvRtImport></MvpnAdvRtImport>
<UpdateFirstRtPolicyName></UpdateFirstRtPolicyName>
<AdvRibActive></AdvRibActive>
<BestRtOriAsValidation></BestRtOriAsValidation>
<BestRtAllowInvalid></BestRtAllowInvalid>
<NestingVpn></NestingVpn>
<SummaryAutomatic></SummaryAutomatic>
<FilterPolicyImport>
<AclNumImp></AclNumImp>
<AclNameImp></AclNameImp>
<PrefixListNameImp></PrefixListNameImp>
</FilterPolicyImport>
<LogRouteFlap>
<MonitorTime></MonitorTime>
<MonitorCount></MonitorCount>
<LogCountLimit></LogCountLimit>
<RtPolicyName></RtPolicyName>
</LogRouteFlap>
<Dampening>
<DampeningEnable></DampeningEnable>
<HalfLifeReach></HalfLifeReach>
<HalfLifeUnReach></HalfLifeUnReach>
<Reuse></Reuse>
<Suppress></Suppress>
<Ceiling></Ceiling>
<DampRtPolicyName></DampRtPolicyName>
</Dampening>
<RedirectToTunnel></RedirectToTunnel>
</Family>
</Familys>
</BGP>

24
Table description
Item Description
Feature name BGP
Table name Family
Table type Multi-instance table
Row name Family
Restrictions No

25
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
• 7—VPNv6
Address Family
Type
Identifier
Index • 8—L2VPN N/A
• 9—L2VPN EVPN
• 10—Link-State
• 11—IPv4 rtfilter.
• 12—IPv4 mvpn.
• 13—IPv4 Flowspec
• 14—VPNv4 Flowspec
• 15—IPv6 Flowspec
• 16—VPNv6 Flowspec
Include:
Preference for Data • Ebgp
Preference N/A
BGP Routes Structure • Ibgp
• Local
Unsigned integer.
Preference for
Ebgp Value range: N/A
eBGP Routes
1 to 255
Unsigned integer.
Preference for
Ibgp Value range: N/A
iBGP Routes
1 to 255
Unsigned integer.
Preference for
Local Value range: N/A
Local Routes
1 to 255

Ignore the
AS_PATH Enumeration:
BalanceAsPa
attribute when • 0—Disable. N/A
thNeglect
implementing • 1—Enable.
load balancing

BalanceAsPa Load balancing Enumeration:

for routes that N/A
thRelax
have different • 0—Disable.

26
Column Column Column
Data type and restrictions Remarks
name description type
AS_PATH • 1—Enable.
attributes of the
same length
Include:
number of BGP • MaxBalance
Data
Balance ECMP routes for
Structure • MaxEBGPBalance N/A
load balancing • MaxIBGPBalance
• MaxEIBGPBalance
maximum Unsigned integer.
number of BGP
MaxBalance Value range: N/A
ECMP routes for
load balancing 1 to 255

EBGP load
Maximum Unsigned integer. balancing and
MaxEBGPBal number of EBGP EBGP/IBGP load
Value range:
ance ECMP routes for balancing cannot
load balancing 1 to 255 be configured at
the same time
EBGP load
Maximum Unsigned integer. balancing and
MaxIBGPBal number of IBGP EBGP/IBGP load
Value range:
ance ECMP routes for balancing cannot
load balancing 1 to 255 be configured at
the same time
Maximum EBGP load
number of ECMP Unsigned integer. balancing and
MaxEIBGPBa routes between EBGP/IBGP load
Value range:
lance EBGP and balancing cannot
IBGP routes for 1 to 255 be configured at
load balancing the same time

Enumeration:
Filter VPN routes
PolicyVpnTar
with VPN-Target • 0—Disable. N/A
get • 1—Enable.
attribute
Enumeration:
ReflectBtwCli Route reflection • 0—Disable. N/A
ents between clients • 1—Enable.
String,IPv4 address string or
Unsigned integer.
ReflectorClus cluster ID of the
Value range: N/A
terID route reflector
1 to 4294967295

RR-filter number: Only IBGP routes

Number or name
Unsigned integer. whose extended
of the extended
Value range: 1 to 199. community
community list in
N/A attribute matches
RrFilter the route filtering RR-filter name: the specified
policy specified
String. extended
for the route
community list are
reflector Length: 1 to 63 characters. reflected.
Enumeration:
DefaultRtImp Import default • 0—Disable N/A
ort route • 1—Enable.

27
Column Column Column
Data type and restrictions Remarks
name description type
String.
A globally Length: 9 to 26 characters.
DomainDistin unique The format is Example:
guisher identifier for LS 100:13.14.23.22
AS<1-4294967295>:routerID
domain <X.X.X.X>.

Enumeration:
Enable Prefix
PIC Independent • 0—Disable N/A
Convergence • 1—Enable.

Redistribute
multiple routes Enumeration:
VpnCrossMul with the same • 0—Disable. N/A
tipath prefix and RD • 1—Enable.
to the VPN
routing table
Unsigned integer.
Optimal route
RouteSelectD Value range:
elay
calculation N/A
delay time 0 to 600 seconds.

Include:
Advertise BGP
EVPN routes • AdvertiseEvpnEnable
AdvertiseEv Data • AdvertiseEvpnPolicy
through the N/A
pnRoute Structure • AdvertiseEvpnReplace
current
address family Rt

Enable
advertisement Enumeration:
AdvertiseEv of BGP EVPN • 0—Disable N/A
pnEnable routes through • 1—Enable.
the current
address family

Filter BGP
String.
AdvertiseEv EVPN routes
Length: 1 to 63 characters. N/A
pnPolicy by a routing
policy

Replace the
route targets of Enumeration:
AdvertiseEv
pnReplaceR
BGP EVPN • 0—Disable. N/A
routes with • 1—Enable.
t
those of VPN
instances

Enumeration:
AdvertiseL2 Advertise BGP
vpnEvpnRou EVPN route to • 0—Disable N/A
te the local site • 1—Enable.

Include:
AdvertiseL3 Advertise BGP Data
• AdvertiseL3vpnEnable N/A
vpnRoute L3VPN routes Structure

28
Column Column Column
Data type and restrictions Remarks
name description type
through the • AdvertiseL3vpnPolicy
BGP EVPN • AdvertiseL3vpnReplac
address family eRt

Enable
advertise BGP Enumeration:
AdvertiseL3 L3VPN routes • 0—Disable N/A
vpnEnable through the • 1—Enable.
BGP EVPN
address family

Filter BGP
String.
AdvertiseL3 L3VPN routes
Length: 1 to 63 characters. N/A
vpnPolicy by a routing
policy

Replace the
route targets of Enumeration:
AdvertiseL3
vpnReplace
BGP L3VPN • 0—Disable. N/A
routes with • 1—Enable.
Rt
those of EVPN
instances

Redistribute Enumeration:
ImportEvpn MAC/IP • 0—Disable. N/A
MacIp advertisement • 1—Enable.
routes

The default local

preference is
Unsigned integer. supported only
Configure
DefaultLocalP Value range: by IPv4 unicast,
reference
default local
0 to 4294967295 IPv4 multicast,
preference
IPv6 unicast, and
IPv6 multicast
routes.
Set the
maximum
number of Unsigned integer.
AddPathsSel
Add-Path optimal Value range: N/A
ectBestNum
routes that can 2 to 32
be advertised to
all peers.
Unsigned integer.
DefaultMedV Configure default
Value range: N/A
alue MED value.
0 to 4294967295
Configure the String.
FrrRtPolicyNa
route policy N/A
me Length: 1 to 63 characters.
name of FRR.

Enable MVPN Enumeration:

MvpnAdvRtI
advertisement • 0—Disable. (default) N/A
mport
RT import • 1—Enable.

29
Column Column Column
Data type and restrictions Remarks
name description type
Routing policy
used to match
routes whose String.
UpdateFirstRt
withdrawal N/A
PolicyName Length: 1 to 63 characters.
messages are
sent prior to
other routes.
Enable to Enumeration:
advertise the
AdvRibActive • 0—Disable. (default) N/A
best routes of IP
routing table.. • 1—Enable.

Configure BGP
RPKI
authentication Enumeration:
BestRtOriAsV
results to • 0—Disable. (default) N/A
alidation
participate in • 1—Enable.
route
optimization.
Allow routes with
Invalid
authentication Enumeration: BestRtAllowInvalid
BestRtAllowIn must be set with
results to • 0—Disable. (default)
valid BestRtOriAsValidat
participate in • 1—Enable. ion.
route
optimization

Enumeration:
Enable nested
NestingVpn • 0—Disable. (default) N/A
VPN function
• 1—Enable.
Automatic route
summarization Enumeration:
SummaryAut
for redistributed • 0—Disable. (default) N/A
omatic
IGP subnet • 1—Enable.
routes
Include:
FilterPolicyIm Filter received Data • AclNumImp
N/A
port BGP routes
Structure • AclNameImp
• PrefixListNameImp

Filter BGP routes Unsigned integer.

AclNumImp by an ACL Value range: N/A
number. 2000 to 3999
ACL name (start
Filter BGP routes String. with[a-z,A-Z]).Can’t
AclNameImp
by an ACL name. Length: 1 to 63 characters. use “all” as ACL
name.
Filter BGP routes String.
PrefixListNam
by a prefix-list N/A
eImp Length: 1 to 63 characters.
name.
Include:
LogRouteFla Logging for BGP Data • MonitorTime
N/A
p route flapping
Structure • MonitorCount
• LogCountLimit

30
Column Column Column
Data type and restrictions Remarks
name description type
• RtPolicyName

31
Column Column Column
Data type and restrictions Remarks
name description type
Monitoring Unsigned integer.
MonitorTime interval for route Value range: Units are minutes.
flapping 1 to 600

Number of route Unsigned integer.

MonitorCount flaps for Value range: N/A
triggering a log 2 to 8
Maximum
number of logs Unsigned integer.
LogCountLimi
allowed to be Value range: N/A
t
generated in a 1 to 600
minute
Filter BGP routes String.
RtPolicyNam
to monitor the N/A
e Length: 1 to 63 characters.
route flaps.
Include:
• DampeningEnable
• HalfLifeReach
Configure Data • HalfLifeUnReach
Dampening N/A
dampening.
Structure • Reuse
• Suppress
• Ceiling
• DampRtPolicyName
Enumeration:
DampeningE Enable
• 0—Disable. (default) N/A.
nable dampening.
• 1—Enable.
You must set all of
Specify the Unsigned integer. HalfLifeReach,
HalfLifeReac half-life of the HalfLifeUnReach,
Value range:
h reachable route Reuse, Suppress
that oscillates. 1 to 45 and Ceiling, or set
none of them.
You must set all of
Specify the
Unsigned integer. HalfLifeReach,
half-life of an
HalfLifeUnRe HalfLifeUnReach,
unreachable Value range:
ach Reuse, Suppress
route that 1 to 45 and Ceiling, or set
oscillates.
none of them.
You must set all of
Unsigned integer. HalfLifeReach,
Specify the route HalfLifeUnReach,
Reuse Value range:
reuse threshold. Reuse, Suppress
1 to 20000 and Ceiling, or set
none of them.
You must set all of
Unsigned integer. HalfLifeReach,
Specify the route
HalfLifeUnReach,
Suppress suppression Value range:
Reuse, Suppress
threshold. 1 to 20000 and Ceiling, or set
none of them..

Ceiling Specify the Unsigned integer. You must set all of

upper limit of HalfLifeReach,

32
 Column Column Column
Data type and restrictions Remarks
name description type
penalty value. Value range: HalfLifeUnReach,
Reuse, Suppress
1001 to 20000 and Ceiling, or set
none of them.
Specify the route
policy name that String.
DampRtPolic
routes are routed N/A
yName Length: 1 to 63 characters.
to be attenuated
by.

The default local

Configure
String. preference is
RedirectToTu redirect IP
nnel Length: 0 to 40 characters. supported only
relay tunnel
by IPv4 flowspec,
capability
IPv6 flowspec.

BGP/Networks
This table contains BGP network information.

XML structure
<BGP>
<Networks>
<Network>
<Name></Name>
<VRF></VRF>
<Family></Family>
<IpAddress></IpAddress>
<Mask></Mask>
<RoutePolicy></RoutePolicy>
</Network>
</Networks>
</BGP>

Table description
Item Description
Feature name BGP
Table name Networks
Table type Multi-instance table
Row name Network
Restrictions No

33
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
Address Family • 1—IPv4 Unicast
N/A
Family Identifier of Index • 2—IPv4 Multicast
Aggregate • 5—IPv6 Unicast
• 6—IPv6 Multicast
Example: 1.1.1.1 or
Address of String,IPv4 address string or 1::1.
IpAddress Index
Network IPv6 address string.

Unsigned integer. For IPv4,this is 0 to

Mask of
Mask Index Value range: 32.For IPv6, this is
Network address 0 to 128.
0 to 128

Name of the String.

RoutePolicy N/A
routing policy Length: 1 to 63 characters.

BGP/Aggregates
This table contains BGP aggregate information.

XML structure
<BGP>
<Aggregates>
<Aggregate>
<Name></Name>
<VRF></VRF>
<Family></Family>
<IpAddress></IpAddress>
<Mask></Mask>
<DetailSuppressed></DetailSuppressed>
<AsSet></AsSet>
<AttributePolicy></AttributePolicy>
<OriginPolicy></OriginPolicy>
<SuppressPolicy></SuppressPolicy>
</Aggregate>

34
 </Aggregates>
</BGP>

Table description
Item Description
Feature name BGP
Table name Aggregates
Table type Multi-instance table
Row name Aggregate
Restrictions No

35
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
Address Family • 1—IPv4 Unicast
N/A
Family Identifier of Index • 2—IPv4 Multicast
Aggregate • 5—IPv6 Unicast
• 6—IPv6 Multicast
Example: 1.1.1.1 or
Address of String,IPv4 address string or 1::1.
IpAddress Index
aggregate IPv6 address string.

Mask of Unsigned integer. For IPv4,this is 0 to

Mask aggregate Index Value range: 32.For IPv6, this is
address 0 to 128. 0 to 128.

Enumeration.
DetailSuppre Detail
ssed Suppressed • 0—Disable. N/A
• 1—Enable.

Creating a Enumeration.
AsSet summary route • 0—Disable. N/A
with AS set path • 1—Enable.
Routing policy
AttributePolic used to set the String.
N/A
y attributes of the Length: 1 to 63 characters.
summary route
Routing policy
used to filter String.
OriginPolicy original specific N/A
routes to be Length: 1 to 63 characters.
summarized
Routing policy
SuppressPoli used to filter String.
N/A
cy specific routes to Length: 1 to 63 characters.
be advertised

BGP/NeighborGroups
This table contains BGP neighbor group information.

XML structure
<BGP>

36
<NeighborGroups>
<NeighborGroup>
<Name></Name>
<VRF></VRF>
<Family></Family>
<GroupName></GroupName>
<RtPolicyImport></RtPolicyImport>
<RtPolicyExport></RtPolicyExport>
<AllowAsLoop></AllowAsLoop>
<ReflectClient></ReflectClient>
<NexthopInvariable></NexthopInvariable>
<NexthopLocal></NexthopLocal>
<RouterMacLocal></RouterMacLocal>
<AdvertiseCommunity></AdvertiseCommunity>
<AdvertiseExtCommunity></AdvertiseExtCommunity>
<ReOriginated></ReOriginated>
<AdvEvpnRouteSuppressMac></AdvEvpnRouteSuppressMac>
<AdvEvpnRouteSuppressPrefix></AdvEvpnRouteSuppressPrefix>
<DefaultgatewayNoAdv></DefaultgatewayNoAdv>
<RouteLimit>
<Number></Number>
<Percentage></Percentage>
<AlertOnly></AlertOnly>
<Discard></Discard>
<Reconnect></Reconnect>
</RouteLimit>
<PreferredValue></PreferredValue>
<NexthopVpn></NexthopVpn>
<AdditionalPathsRcv></AdditionalPathsRcv>
<AdditionalPathsSend></AdditionalPathsSend>
<AdvAddPathsBest></AdvAddPathsBest>
<RouteAdv>
<DefRouteAdv></DefRouteAdv>
<RoutePlcy></RoutePlcy>
</RouteAdv>
<KeepAllRoutes></KeepAllRoutes>
<LblRouteCapability></LblRouteCapability>
<PrefixListExp></PrefixListExp>
<PrefixListImp></PrefixListImp>
<PublicAsOnly></PublicAsOnly>
<SooSiteOfOrigin></SooSiteOfOrigin>
<FlPlcyAclNoOrNameExp></FlPlcyAclNoOrNameExp>
<FlPlcyAclNoOrNameImp></FlPlcyAclNoOrNameImp>
<AdvOrigAsVld></AdvOrigAsVld>
<CapOrf></CapOrf>
<Signaling>
<SigEnable></SigEnable>
<SigNonStd></SigNonStd>

37
 </Signaling>
<UpeEnable></UpeEnable>
<UpeRoutePlcy></UpeRoutePlcy>
<AutoDisc>
<DiscEnable></DiscEnable>
<DiscNonStd></DiscNonStd>
</AutoDisc>
<ValidationDisable></ValidationDisable>
<ValidationRedirectDisable></ValidationRedirectDisable>
</NeighborGroup>
</NeighborGroups>
</BGP>

Table description
Item Description
Feature name BGP
Table name NeighborGroups
Table type Multi-instance table
Row name NeighborGroup
Restrictions No

38
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
Address Family • 7—VPNv6
N/A
Family Identifier of Index • 8—L2VPN
NeighborGroup
• 9—L2VPN EVPN
• 10—Link-State
• 11—IPv4 rtfilter.
• 12—IPv4 mvpn.
• 13—IPv4 Flowspec
• 14—VPNv4 Flowspec
• 15—IPv6 Flowspec
• 16—VPNv6 Flowspec
String.
GroupName Group Name Index N/A
Length: 1 to 47 characters.
Import String.
RtPolicyImpor
Route-Policy for N/A
t Length: 1 to 63 characters.
NeighborGroup
Export String.
RtPolicyExpo
Route-Policy for N/A
rt Length: 1 to 63 characters.
NeighborGroup
allow a local AS
number to exist Unsigned integer.
AllowAsLoop in the AS_PATH Value range: N/A
attribute of 1 to 10
routes
Configure the
device as a route Enumeration.
reflector and
ReflectClient • 0—Disable. N/A
specify a peer or
peer group as a • 1—Enable.
client
Send original Enumeration. Next-hop-local
NexthopInvari next hop for
• 0—Disable. conflict with
able routes advertised
to the peer • 1—Enable. next-hop-invariable

39
Column Column Column
Data type and restrictions Remarks
name description type
Specify local
address as the Enumeration. Next-hop-local
conflict with
NexthopLocal next hop of • 0—Disable.
next-hop-invariable
routes advertised • 1—Enable. .
to the peers
Specify local
MAC as the Enumeration.
RouterMacLo router MAC of
• 0—Disable. N/A
cal routes advertised
to and received • 1—Enable.
from the peers

Send community Enumeration.

AdvertiseCo
attribute to the • 0—Disable. N/A
mmunity
peers • 1—Enable.

Send extended Enumeration.

AdvertiseExt community
• 0—Disable. N/A
Community attribute to the
peers 1—Enable.

Re-originate
EVPN routes Enumeration.
received from the • 0—Disable.
ReOriginated peer by N/A
modifying the L3 • 1—Enable.
VXLAN ID and • 2--- ReplaceRT.
RD
Advertise EVPN
AdvEvpnRout
routes to the Enumeration.
peer excluding
eSuppressMa • 0—Disable. N/A
MAC/IP
c • 1—Enable.
advertisement
routes
Advertise EVPN
AdvEvpnRout
routes to the Enumeration.
peer excluding IP
eSuppressPr • 0—Disable. N/A
prefix
efix • 1—Enable.
advertisement
routes
Advertise EVPN
routes by
deleting the Enumeration.
Defaultgatew
default gateway • 0—Disable. N/A
ayNoAdv
extended • 1—Enable.
community
attribute
Include:
Configure the
maximum • Number
number of routes Data • Percentage
RouteLimit N/A
that can be Structure • AlertOnly
received from the
• Discard
peers
• Reconnect

Number of Unsigned integer.

Number prefixes
N/A
Value range:

40
Column Column Column
Data type and restrictions Remarks
name description type
1 to 4294967295
Percentage Unsigned integer.
value to trigger a
Percentage warning
Value range: N/A
message 1 to 100. Default is 75

Generate a log Enumeration.

message when
AlertOnly • 0—Disable. N/A
the route limit is
exceeded • 1—Enable.

Discard routes Enumeration.

received after the
Discard • 0—Disable. N/A
route limit is
exceeded • 1—Enable.

Unsigned integer.
Reconnect time
Reconnect in seconds
Value range: N/A
1 to 65535
Set a preferred Unsigned integer.
PreferredVal value for routes
Value range: N/A
ue received from the
peers 0 to 65535
Change the next
hop of received Enumeration.
VPNv4 or VPNv6
NexthopVpn • 0—Disable. N/A
routes to that of
the matching • 1—Enable.
VPN instance
Specify Enumeration.
AdditionalPat additional path
• 0—Disable. N/A
hsRcv receiving ability
for the peers • 1—Enable.

Specify Enumeration.
AdditionalPat additional path
• 0—Disable. N/A
hsSend sending ability
for the peers • 1—Enable.

Specify the
maximum
number of Unsigned integer.
AdvAddPaths Add-Path optimal
Value range: N/A
Best routes that can
be advertised to 2 to 32. Default is 1
a peer or peer
group

Set default route Include:

Data
RouteAdv info to peer or
Structure • DefRouteAdv N/A
peer group • RoutePlcy
Specify default
route Enumeration.
DefRouteAdv advertisement • 0—Disable. N/A
info to peer or • 1—Enable.
peer group

Specify a route String.

RoutePlcy N/A
policy Length: 1 to 63 characters.

41
Column Column Column
Data type and restrictions Remarks
name description type
Save original Enumeration.
KeepAllRoute route update info
• 0—Disable. N/A
s from all peer or
peer groups • 1—Enable.

Specify labeled Enumeration.

LblRouteCap route exchange
• 0—Disable. N/A
ability ability for peer or
peer groups • 1—Enable.

Specify a prefix
list to filter routes String.
PrefixListExp advertised to a N/A
peer or peer Length: 1 to 63 characters.
group
Specify a prefix
list to filter routes String.
PrefixListImp received from a N/A
peer or peer Length: 1 to 63 characters.
group
Remove private
AS numbers in Enumeration.
BGP updates
PublicAsOnly • 0—Disable. N/A
sent to an EBGP
peer or peer • 1—Enable.
group
String.
Length: 3 to 21 characters.
Configure SoO The format is Example: 101:3 or
SooSiteOfOri
info for peer or IP<X.X.X.X>:NN<0-65535> or 192.168.122.15:1
gin
peer groups AS<0-65535>:NN<0-4294967 or 65535:1..
295> or
AS<65536-4294967295>:NN<
0-65535>.
Unsigned integer.
Specify an ACL
to filter routes Value range:
FlPlcyAclNoO
advertised to 2000 to 3999. N/A
rNameExp
peers or peer String.
groups
Length: 1 to 63 characters.
Unsigned integer.
Specify an ACL
to filter routes Value range:
FlPlcyAclNoO
received from 2000 to 3999. N/A
rNameImp
peers or peer String.
groups
Length: 1 to 63 characters.
Send BGP RPKI Enumeration.
validation results
AdvOrigAsVld • 0—Disable N/A
to peer or peer
groups • 1—Enable.

Specify BGP Enumeration:

neighbor ORF • 1—Receive.
CapOrf N/A
capabilities • 2—Send.
negotiation
• 3—Both

42
 Column Column Column
Data type and restrictions Remarks
name description type
Set MPLS
L2VPN tag block
info exchange Include:
Data
Signaling ability between
Structure • SigEnable N/A
local route and • SigNonStd
specified peer or
peer groups

Specify default Enumeration.

SigEnable tag block info • 0—Disable. N/A
exchange ability • 1—Enable.
Specify Enumeration.
non-stand format
SigNonStd • 0—Disable. N/A
to exchange tag
block info • 1—Enable.

Set UPE as
HoVPN for Enumeration.
UpeEnable routes received • 0—Disable. N/A
from peers or • 1—Enable.
peer groups
Configure
UpeRoutePlc specified UPE String.
N/A
y route info filtered Length: 1 to 63 characters.
by route policy
Set VPLS PE tag
block info
exchange ability Include:
Data
AutoDisc between local
Structure • DiscEnable N/A
route and • DiscNonStd
specified peer or
peers groups

Specify default Enumeration.

DiscEnable tag block info • 0—Disable. N/A
exchange ability • 1—Enable.
Specify
non-standard Enumeration.
DiscNonStd format to • 0—Disable. N/A
exchange tag • 1—Enable.
block info
Disable Enumeration.
ValidationDis validation for
• 0—Disable. N/A
able BGP flowspec
routes • 1—Enable.

ValidationRe Disable Enumeration.

validation for Only EBGP
directDisabl • 0—Disable.
BGP flowspec neighbors support.
e redirect nexthop • 1—Enable.

BGP/Neighbors
This table contains BGP neighbor information.

43
XML structure
<BGP>
<Neighbors>
<Neighbor>
<Name></Name>
<VRF></VRF>
<Family></Family>
<SessAF></SessAF>
<IpAddress></IpAddress>
<Mask></Mask>
<RtPolicyImport></RtPolicyImport>
<RtPolicyExport></RtPolicyExport>
<AllowAsLoop></AllowAsLoop>
<ReflectClient></ReflectClient>
<NexthopInvariable></NexthopInvariable>
<NexthopLocal></NexthopLocal>
<RouterMacLocal></RouterMacLocal>
<AdvertiseCommunity></AdvertiseCommunity>
<AdvertiseExtCommunity></AdvertiseExtCommunity>
<ReOriginated></ReOriginated>
<AdvEvpnRouteSuppressMac></AdvEvpnRouteSuppressMac>
<AdvEvpnRouteSuppressPrefix></AdvEvpnRouteSuppressPrefix>
<DefaultgatewayNoAdv></DefaultgatewayNoAdv>
<RouteLimit>
<Number></Number>
<Percentage></Percentage>
<AlertOnly></AlertOnly>
<Discard></Discard>
<Reconnect></Reconnect>
</RouteLimit>
<PreferredValue></PreferredValue>
<NexthopVpn></NexthopVpn>
<AdditionalPathsRcv></AdditionalPathsRcv>
<AdditionalPathsSend></AdditionalPathsSend>
<AdvAddPathsBest></AdvAddPathsBest>
<RouteAdv>
<DefRouteAdv></DefRouteAdv>
<RoutePlcy></RoutePlcy>
</RouteAdv>
<KeepAllRoutes></KeepAllRoutes>
<LblRouteCapability></LblRouteCapability>
<PrefixListExp></PrefixListExp>
<PrefixListImp></PrefixListImp>
<PublicAsOnly></PublicAsOnly>
<SooSiteOfOrigin></SooSiteOfOrigin>
<FlPlcyAclNoOrNameExp></FlPlcyAclNoOrNameExp>
<FlPlcyAclNoOrNameImp></FlPlcyAclNoOrNameImp>

44
 <AdvOrigAsVld></AdvOrigAsVld>
<CapOrf></CapOrf>
<Signaling>
<SigEnable></SigEnable>
<SigNonStd></SigNonStd>
</Signaling>
<UpeEnable></UpeEnable>
<UpeRoutePlcy></UpeRoutePlcy>
<AutoDisc>
<DiscEnable></DiscEnable>
<DiscNonStd></DiscNonStd>
</AutoDisc>
<ValidationDisable></ValidationDisable>
<ValidationRedirectDisable></ValidationRedirectDisable>
</Neighbor>
</Neighbors>
</BGP>

Table description
Item Description
Feature name BGP
Table name Neighbors
Table type Multi-instance table
Row name Neighbor
Restrictions No

45
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
Address Family • 7—VPNv6
N/A
Family Identifier of Index • 8—L2VPN
Neighbor
• 9—L2VPN EVPN
• 10—Link-State
• 11—IPv4 rtfilter.
• 12—IPv4 mvpn.
• 13—IPv4 Flowspec
• 14—VPNv4 Flowspec
• 15—IPv6 Flowspec
• 16—VPNv6 Flowspec
Enumeration:
Address family of
SessAF
session
Index • 1—IPv4. N/A
• 2—IPv6.
Example: 1.1.1.1 or
Address of String,IPv4 address string or 1::1.
IpAddress Index
session IPv6 address string.

For non-dynamic
peers, this is
255.For IPv4
Unsigned integer. dynamic peers,this
Mask of
Mask Index Value range: is 0 to 32.For IPv6
session address dynamic peers, this
0 to 128,or 255
is 0 to 128.
Dynamic peers are
not supported.
Import String.
RtPolicyImpor
Route-Policy for N/A
t Length: 1 to 63 characters.
Neighbor
Export String.
RtPolicyExpo
Route-Policy for N/A
rt Length: 1 to 63 characters.
Neighbor
allow a local AS Unsigned integer.
AllowAsLoop number to exist N/A
in the AS_PATH Value range:

46
Column Column Column
Data type and restrictions Remarks
name description type
attribute of 1 to 10
routes
Configure the
device as a route Enumeration.
reflector and • 0—Disable.
ReflectClient N/A
specify a peer or
peer group as a • 1—Enable.
client
Send original Enumeration.
NexthopInvari next hop for
• 0—Disable. N/A
able routes advertised
to the peer • 1—Enable.

Specify local
address as the Enumeration. Next-hop-local
conflict with
NexthopLocal next hop of • 0—Disable.
next-hop-invariable
routes advertised • 1—Enable. .
to the peers
Specify local
MAC as the Enumeration.
RouterMacLo router MAC of
• 0—Disable. N/A
cal routes advertised
to and received • 1—Enable.
from the peers

Send Enumeration.
AdvertiseCo community
• 0—Disable. N/A
mmunity attribute to the
peers • 1—Enable.

Send extended Enumeration.

AdvertiseExt community
• 0—Disable. N/A
Community attribute to the
peers • 1—Enable.

Re-originate
EVPN routes Enumeration.
received from the • 0—Disable.
ReOriginated peer by N/A
modifying the L3 • 1—Enable.
VXLAN ID and • 2--- ReplaceRT.
RD

Advertise EVPN
AdvEvpnRout routes to the Enumeration.
eSuppressMa peer excluding • 0—Disable. N/A
c MAC/IP
• 1—Enable
advertisement
routes

Advertise EVPN
AdvEvpnRout routes to the Enumeration.
eSuppressPr peer excluding IP • 0—Disable. N/A
efix prefix
• 1—Enable
advertisement
routes

Defaultgatew Advertise EVPN • Enumeration.

routes by N/A
ayNoAdv
deleting the • 0—Disable.

47
Column Column Column
Data type and restrictions Remarks
name description type
default gateway • 1—Enable.
extended
community
attribute
Include:
Configure the
maximum • Number
number of routes Data • Percentage
RouteLimit N/A
that can be Structure • AlertOnly
received from the
• Discard
peers
• Reconnect
Unsigned integer.
Number of
Number prefixes
Value range: N/A
1 to 4294967295
Percentage Unsigned integer.
value to trigger a
Percentage warning
Value range: N/A
message 1 to 100. Default is 75

Generate a log Enumeration.

message when
AlertOnly • 0—Disable. N/A
the route limit is
exceeded • 1—Enable.

Discard routes Enumeration.

received after the
Discard • 0—Disable. N/A
route limit is
exceeded • 1—Enable.

Unsigned integer.
Reconnect time
Reconnect in seconds
Value range: N/A
1 to 65535
Set a preferred Unsigned integer.
PreferredVal value for routes
Value range: N/A
ue received from the
peers 0 to 65535
Change the next
hop of received Enumeration.
VPNv4 or VPNv6
NexthopVpn • 0—Disable. N/A
routes to that of
the matching • 1—Enable.
VPN instance
Specify Enumeration.
AdditionalPat additional path
• 0—Disable. N/A
hsRcv receiving ability
for the peers • 1—Enable.

Specify Enumeration.
AdditionalPa additional path
• 0—Disable. N/A
thsSend sending ability
for the peers • 1—Enable.

Specify the
maximum Unsigned integer.
AdvAddPaths number of Value range: N/A
Best Add-Path optimal
routes that can 2 to 32. Default is 1
be advertised to

48
Column Column Column
Data type and restrictions Remarks
name description type
a peer or peer
group

Set default route Include:

Data
RouteAdv info to peer or
Structure • DefRouteAdv N/A
peer group • RoutePlcy
Specify default
route Enumeration.
DefRouteAdv advertisement • 0—Disable. N/A
info to peer or • 1—Enable.
peer group

Specify a route String.

RoutePlcy N/A
policy Length: 1 to 63 characters.
Save original Enumeration.
KeepAllRoute route update info
• 0—Disable N/A
s from all peer or
peer groups • 1—Enable.

Specify labeled Enumeration.

LblRouteCap route exchange
• 0—Disable. N/A
ability ability for peer or
peer groups • 1—Enable.

Specify a prefix
list to filter routes String.
PrefixListExp advertised to a N/A
peer or peer Length: 1 to 63 characters.
group
Specify a prefix
list to filter routes String.
PrefixListImp received from a N/A
peer or peer Length: 1 to 63 characters.
group
Remove private
AS numbers in Enumeration.
BGP updates
PublicAsOnly • 0—Disable. N/A
sent to an EBGP
peer or peer • 1—Enable.
group
String.
Length: 3 to 21 characters.
Configure SoO The format is Example: 101:3 or
SooSiteOfOri
info for peer or IP<X.X.X.X>:NN<0-65535> or 192.168.122.15:1
gin
peer groups AS<0-65535>:NN<0-4294967 or 65535:1..
295> or
AS<65536-4294967295>:NN<
0-65535>.
Unsigned integer.
Specify an ACL
to filter routes Value range:
FlPlcyAclNoO
advertised to 2000 to 3999. N/A
rNameExp
peers or peer String.
groups
Length: 1 to 63 characters.

FlPlcyAclNoO Specify an ACL Unsigned integer.

N/A
rNameImp to filter routes Value range:

49
Column Column Column
Data type and restrictions Remarks
name description type
received from 2000 to 3999.
peers or peer
groups String.
Length: 1 to 63 characters.
Send BGP RPKI Enumeration.
validation results
AdvOrigAsVld • 0—Disable N/A
to peer or peer
groups • 1—Enable.

Specify BGP Enumeration:

neighbor ORF • 1—Receive.
CapOrf N/A
capabilities • 2—Send.
negotiation
• 3—Both
Set MPLS
L2VPN tag block
info exchange Include:
Data
Signaling ability between
Structure • SigEnable N/A
local route and • SigNonStd
specified peer or
peer groups

Specify default Enumeration.

SigEnable tag block info • 0—Disable. N/A
exchange ability • 1—Enable.
Specify Enumeration.
non-stand format
SigNonStd • 0—Disable. N/A
to exchange tag
block info • 1—Enable.

Set UPE as
HoVPN for Enumeration.
UpeEnable routes received • 0—Disable. N/A
from peers or • 1—Enable.
peer groups
Configure
UpeRoutePlc specified UPE String.
N/A
y route info filtered Length: 1 to 63 characters.
by route policy
Set VPLS PE tag
block info
exchange ability Include:
Data
AutoDisc between local
Structure • DiscEnable N/A
route and • DiscNonStd
specified peer or
peers groups

Specify default Enumeration.

DiscEnable tag block info • 0—Disable. N/A
exchange ability • 1—Enable.
Specify
non-standard Enumeration.
DiscNonStd format to • 0—Disable. N/A
exchange tag • 1—Enable.
block info

ValidationDis Disable Enumeration.

validation for N/A
able
BGP flowspec • 0—Disable.

50
 Column Column Column
Data type and restrictions Remarks
name description type
routes • 1—Enable.

ValidationRe Disable Enumeration.

validation for Only EBGP
directDisabl • 0—Disable.
BGP flowspec neighbors support.
e redirect nexthop • 1—Enable.

BGP/Redistributes
This table contains BGP redistribute information.

XML structure
<BGP>
<Redistributes>
<Redist>
<Name></Name>
<VRF></VRF>
<Family></Family>
<Protocol></Protocol>
<RedistName></RedistName>
<AllowDirect></AllowDirect>
<Med></Med>
<RoutePolicy></RoutePolicy>
</Redist>
</Redistributes>
</BGP>

Table description
Item Description
Feature name BGP
Table name Redistributes
Table type Multi-instance table
Row name Redist
Restrictions No

51
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
Address Family
Family Index • 2—IPv4 Multicast.
Identifier N/A
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
Enumeration:
• 1—Direct.
• 2—Static.
• 3—RIP
Protocol Protocol name Index • 4—OSPF N/A
• 5—ISIS
• 6—EIGRP
• 7—UNR
• 8—Guard

Redistributed It must be empty

String. when the Protocol
RedistName pocess Index
Length: 0 to 31 characters. column is Direct,
name Static.
Enumeration:
Include direct
AllowDirect • 0—Disable. N/A
routes.
• 1—Enable.
Unsigned integer.
Value of the
Med Value range: N/A
MED.
0 to 4294967295

Name of the String.

RoutePolicy N/A
routing policy. Length: 1 to 63 characters.

BGP/SessionCounts
This table contains session statistics.

XML structure
<BGP>
<SessionCounts>
<SessionCount>

52
 <Name></Name>
<VRF></VRF>
<State></State>
<Count></Count>
</SessionCount>
</SessionCounts>
</BGP>

Table description
Item Description
Feature name BGP
Table name SessionCounts

Table type Multi-instance table

Row name SessionCount

Restrictions No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration: Established state
• 0—Idle means that the
• 1—Connect BGP session is
established, but
State Session state Index • 2—Active whether the
• 3—Opensent address families
• 4—Openconfirm are negociated is
• 5—Established unknown.

Unsigned integer.
Total number of
Count Value range: N/A
sessions
0 to 4294967295

BGP/NeighborInformations
This table contains detailed information of BGP peer.

XML structure
<BGP>

53
 <NeighborInformations>
<NeighborInformation>
<Name></Name>
<VRF></VRF>
<Family></Family>
<SessAF></SessAF>
<IpAddress></IpAddress>
<OutQPrefixCnt></OutQPrefixCnt>
<RcvdPrefixCnt></RcvdPrefixCnt>
<RcvdUnReachNLRI></RcvdUnReachNLRI>
<RcvdReachNLRI></RcvdReachNLRI>
<SentUnReachNLRI></SentUnReachNLRI>
<SentReachNLRI></SentReachNLRI>
<RouteLimitNumber></RouteLimitNumber>
<Percentage></Percentage>
<PreferredValue></PreferredValue>
<NexthopInvariable></NexthopInvariable>
<NexthopLocal></NexthopLocal>
<AdvertiseCommunity></AdvertiseCommunity>
<AdvertiseExtCommunity></AdvertiseExtCommunity>
<ReflectClient></ReflectClient>
<RtPolicyImport></RtPolicyImport>
<RtPolicyExport></RtPolicyExport>
<AllowAsLoop></AllowAsLoop>
<RouterMacLocal></RouterMacLocal>
<ReOriginated></ReOriginated>
<AdvEvpnRouteSuppressMac></AdvEvpnRouteSuppressMac>
<AdvEvpnRouteSuppressPrefix></AdvEvpnRouteSuppressPrefix>
<DefaultgatewayNoAdv></DefaultgatewayNoAdv>
</NeighborInformation>
</NeighborInformations>
</BGP>

Table description
Item Description
Feature name BGP
Table name NeighborInformations
Table type Multi-instance table
Row name NeighborInformation
Restrictions No

54
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
Address Family • 5—IPv6 Unicast
N/A
Family Identifier of Index • 6—IPv6 Multicast.
neighbor • 7—VPNv6
• 8—L2VPN
• 9—L2VPN EVPN
• 10—Link-State
• 11—IPv4 rtfilter.
• 12—IPv4 mvpn.
Enumeration:
Address family of
SessAF
session
Index • 1—IPv4. N/A
• 2—IPv6.
Example: 1.1.1.1 or
Address of String,IPv4 address string or 1::1.
IpAddress Index
session IPv6 address string.

Number of Unsigned integer.

OutQPrefixCn
prefixes to be Value range: N/A
t
sent 0 to 4294967295
Number of
prefixes that
have been Unsigned integer.
RcvdPrefixCn received from the
Value range: N/A
t peer and added
into the local 0 to 4294967295
BGP routing
table
Number of the
unreachable
routes received Unsigned integer.
RcvdUnReac
from the peer Value range: N/A
hNLRI
after the BGP 0 to 4294967295
session is
established
Number of the Unsigned integer.
RcvdReachN reachable routes
Value range: N/A
LRI received from the
peer after the • 0 to 4294967295

55
Column Column Column
Data type and restrictions Remarks
name description type
BGP session is
established
Number of the
unreachable Unsigned integer.
SentUnReach routes sent to the
Value range: N/A
NLRI peer after the
BGP session is • 0 to 4294967295
established
Number of the
reachable routes Unsigned integer.
SentReachNL sent to the peer
Value range: N/A
RI after the BGP
session is • 0 to 4294967295
established
Unsigned integer.
RouteLimitNu Number of
Value range: N/A
mber prefixes
• 1 to 4294967295
Percentage Unsigned integer.
value to trigger a
Percentage Value range: N/A
warning
message • 1 to 100. Default is 75

Set a preferred Unsigned integer.

PreferredVal value for routes
Value range: N/A
ue received from the
peers 0 to 65535
Send original Enumeration. Next-hop-local
NexthopInvari next hop for
• 0—Disable. conflict with
able routes advertised
to the peer • 1—Enable. next-hop-invariable

Specify local
address as the Enumeration. Next-hop-local
conflict with
NexthopLocal next hop of • 0—Disable.
next-hop-invariable
routes advertised • 1—Enable. .
to the peers

Send community Enumeration.

AdvertiseCo
attribute to the • 0—Disable. N/A
mmunity
peers • 1—Enable.
Send extended Enumeration.
AdvertiseExt community
• 0—Disable. N/A
Community attribute to the
peers • 1—Enable.

Configure the
device as a route Enumeration.
reflector and
ReflectClient • 0—Disable. N/A
specify a peer or
peer group as a • 1—Enable.
client
Import routing String.
RtPolicyImpor
policy for peer N/A
t Length: 1 to 63 characters.
group

RtPolicyExpo Export routing String.

N/A
rt policy for peer Length: 1 to 63 characters.

56
 Column Column Column
Data type and restrictions Remarks
name description type
group
Allow a local AS
number to exist Unsigned integer.
AllowAsLoop in the AS_PATH Value range: N/A
attribute of 1 to 10
routes
Specify local
MAC as the Enumeration.
RouterMacLo router MAC of
• 0—Disable. N/A
cal routes advertised
to and received • 1—Enable.
from the peers
Re-originate
EVPN routes
received from the Enumeration.
ReOriginated peer by • 0—Disable. N/A
modifying the L3 • 1—Enable.
VXLAN ID and
RD
Advertise EVPN
AdvEvpnRout
routes to the Enumeration.
peer excluding
eSuppressMa • 0—Disable. N/A
MAC/IP
c • 1—Enable.
advertisement
routes
Advertise EVPN
AdvEvpnRout
routes to the Enumeration.
peer excluding IP
eSuppressPr • 0—Disable. N/A
prefix
efix • 1—Enable.
advertisement
routes
Advertise EVPN
routes by
deleting the Enumeration.
Defaultgatew
default gateway • 0—Disable. N/A
ayNoAdv
extended • 1—Enable.
community
attribute

BGP/RedistributesAppend
This table contains BGP redistribution appended information.

XML structure
<BGP>
<RedistributesAppend>
<Redist>
<Name></Name>
<VRF></VRF>
<Family></Family>
<Protocol></Protocol>

57
 <RedistName></RedistName>
<AllowDirect></AllowDirect>
<Med></Med>
<RoutePolicy></RoutePolicy>
</Redist>
</RedistributesAppend>
</BGP>

Table description
Item Description
Feature name BGP
Table name RedistributesAppend
Table type Multi-instance table
Row name Redist
Restrictions No

58
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
Address Family
Family Index • 2—IPv4 Multicast.
Identifier N/A
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
Enumeration:
• 1—Direct.
• 2—Static.
• 3—RIP
Protocol Protocol name Index • 4—OSPF N/A
• 5—ISIS
• 6—EIGRP
• 7—UNR
• 8—Guard

Redistributed It must be empty

String. when the Protocol
RedistName pocess Index
Length: 0 to 31 characters. column is Direct,
name Static.
Enumeration:
Include direct
AllowDirect • 0—Disable. N/A
routes.
• 1—Enable.
Unsigned integer.
Value of the
Med Value range: N/A
MED.
0 to 4294967295

Name of the String.

RoutePolicy N/A
routing policy. Length: 1 to 63 characters.

BGP/BMPs
This table contains BGP BMP information.

XML structure
<BGP>

59
 <BMPs>
<BMP>
<ServerNum></ServerNum>
<ServerAddr></ServerAddr>
<ServerPortNum></ServerPortNum>
<StatisInterValue></StatisInterValue>
<ConnectInterfaceName></ConnectInterfaceName>
<RouteModeAdjRibOut></RouteModeAdjRibOut>
<RouteModeLocRib></RouteModeLocRib>
</BMP>
</BMPs>
</BGP>

Table description
Item Description
Feature name BGP
Table name BMPs
Table type Multi-instance table
Row name BMP
Restrictions No
Support for row creation and deletion Yes

60
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
BMP server
ServerNum Index Value range: N/A
number
1 to 8
You must set both
Specify the IPv4
ServerAddr and
ServerAddr address of BMP String,IPv4 address string.
ServerPortNum, or
server
set neither of them.

Unsigned integer. You must set both

Specify the port
ServerPortNu ServerAddr and
number of BMP Value range:
m ServerPortNum, or
server 1 to 65535 set neither of them.
Specify the Unsigned integer.
StatisInterVal statistics interval
Value range: Units are seconds.
ue value number of
BMP server 1 to 3600

Specify the
source interface Example:
ConnectInterf String.
aceName
of TCP • M-GigabitEther
connections to Length: 0 to 47 characters.
net0/0/0
the BMP server
Enable BGP to
send routes Enumeration:
RouteModeA advertised to the
• 0—Disable. N/A
djRibOut monitored peer
or peer group to • 1—Enable
the BMP server
Enable BGP to
send the optimal Enumeration:
RouteModeL
routes in the • 0—Disable. N/A
ocRib
routing table to • 1—Enable
the BMP server

BGP/Rpkis
This table contains BGP RPKI information.

XML structure
<BGP>
<Rpkis>
<Rpki>
<Name></Name>
<CheckOriginValidation></CheckOriginValidation>
<Servers>
<Server>

61
 <VRF></VRF>
<Family></Family>
<IpAddress></IpAddress>
<Port></Port>
<PasswordType></PasswordType>
<Password></Password>
<RefreshTime></RefreshTime>
<ResponseTime></ResponseTime>
<PurgeTime></PurgeTime>
</Server>
</Servers>
</Rpki>
</Rpkis>
</BGP>

Table description
Item Description
Feature name BGP
Table name Rpkis
Table type Multi-instance table
Row name N/A
Restrictions No
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.
Enumeration.
CheckOriginV Check origin
alidation validation • 0—Disable. N/A
• 1—Enable.
For more
Site containing information, see
Servers the rpki server Subtable N/A the
information BGP/Rpkis/Rpki/Se
rvers

BGP/Rpkis/Rpki/Servers
This table contains BGP RPKI server information.

62
XML structure
Please refer to the XML structure of BGP/Rpkis.

Table description
Item Description
Feature name BGP
Table name Servers
Table type Multi-instance table
Row name N/A
Restrictions No
Support for row creation and deletion Yes

63
Columns
Column Column Column
Data type and restrictions Remarks
name description type
String. An empty string
VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
Address family
Family
identifier
Index • 1—IPv4.
N/A
• 2—IPv6
Example: 1.1.1.1 or
Summary String,IPv4 address string or 1::1.
IpAddress Index
address IPv6 address string.

Unsigned integer.
Port Port Value range: N/A
1 to 65535
Enumeration.
PasswordTyp
Password type. • 1—Ciphertext. N/A
e
• 2—Plaintext.
String.
Length:
Password Password. 1 to 80 characters for MD5 N/A
plaintext password.
33 to 137 characters for MD5
ciphertext password.
Unsigned integer.
Refresh time in
RefreshTime Value range: N/A
seconds
15 to 3600
Unsigned integer.
ResponseTim Response time in
Value range: N/A
e seconds
15 to 3600
Unsigned integer.
Purge time in
PurgeTime Value range: N/A
seconds
30 to 360

BGP/FilterPolicyExports
This table contains BGP filter-policy export information.

XML structure
<BGP>
<FilterPolicyExports>
<FilterPolicyExport>
<Name></Name>

64
 <VRF></VRF>
<Family></Family>
<ProtocolExp></ProtocolExp>
<ProcessIDExp></ProcessIDExp>
<AclNumExp></AclNumExp>
<AclNameExp></AclNameExp>
<PrefixListNameExp></PrefixListNameExp>
</FilterPolicyExport>
</FilterPolicyExports>
</BGP>

Table description
Item Description
Feature name BGP
Table name FilterPolicyExports
Table type Multi-instance table
Row name FilterPolicyExport
Restrictions No
Support for row creation and deletion Yes

65
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
Address Family
Family Index • 4—VPNv4
Identifier N/A
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
• 7—VPNv6
The Protocol can
be empty.
The Protocol can
Enumeration: be set to direct,
• 1—direct isis, ospf, rip or
static only when
• 2—isis. the Type had been
Specify where • 3—isisv6 set to IPv4 Unicast,
ProtocolExp the BGP routes Index • 4—ospf IPv4 Multicast, or
VPNv4. The
are imported. • 5—ospfv3
Protocol can be set
• 6—rip. to direct, isisv6,
• 7—ripng ospfv3, ripng or
static only when
• 8—static the Type had been
set to IPv6 Unicast,
IPv6 Multicast, or
VPNv6.

Unsigned integer. It must be empty

Specify the
ProcessIDEx when the Protocol
process ID of Index Value range:
p column is Direct,
routing protocol. 1 to 65535 Static or empty.
You can only set
Filter BGP routes Unsigned integer. one of AclNumExp,
AclNumExp by an ACL Value range: AclNameExp and
number. 2000 to 3999 PrefixListNameExp
at the same time.
ACL name (start
with[a-z,A-Z]).Can’t
use “all” as ACL
name.
Filter BGP routes String.
AclNameExp You can only set
by an ACL name. Length: 1 to 63 characters.
one of AclNumExp,
AclNameExp and
PrefixListNameExp
at the same time.

PrefixListNam Filter BGP routes String. You can only set

66
 Column Column Column
Data type and restrictions Remarks
name description type
eExp by a prefix-list Length: 1 to 63 characters. one of AclNumExp,
name. AclNameExp and
PrefixListNameExp
at the same time.

BGP/PeerGpDefRtAdvVpnInsts
This table contains BGP peer group-name default-route-advertise vpn-instance vpn-instance-name
information.

XML structure
<BGP>
<PeerGpDefRtAdvVpnInsts>
<PeerGpDefRtAdvVpnInst>
<Name></Name>
<VRF></VRF>
<Family></Family>
<GroupName></GroupName>
<PeerGpDefRtAdvVpnInstName></PeerGpDefRtAdvVpnInstName>
</PeerGpDefRtAdvVpnInst>
</PeerGpDefRtAdvVpnInsts>
</BGP>

Table description
Item Description
Feature name BGP
Table name PeerGpDefRtAdvVpnInsts
Table type Multi-instance table
Row name PeerGpDefRtAdvVpnInst
Restrictions No
Support for row creation and deletion Yes

67
Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Address Family Enumeration: N/A
Family Identifier of Index
NeighborGroup • 4—VPNv4

String.
GroupName Group Name Index N/A
Length: 1 to 47 characters.
PeerGpDefRt String.
Specify a VPN
AdvVpnInstN Index N/A
instance name. Length: 1 to 31 characters.
ame

BGP/PeerDefRtAdvVpnInsts
This table contains BGP peer ipv4-address mask-length default-route-advertise vpn-instance
vpn-instance-name information.

XML structure
<BGP>
<PeerDefRtAdvVpnInsts>
<PeerDefRtAdvVpnInst>
<Name></Name>
<VRF></VRF>
<Family></Family>
<SessAF></SessAF>
<IpAddress></IpAddress>
<Mask></Mask>
<PeerDefRtAdvVpnInstName></PeerDefRtAdvVpnInstName>
</PeerDefRtAdvVpnInst>
</PeerDefRtAdvVpnInsts>
</BGP>

Table description
Item Description
Feature name BGP

68
 Table name PeerDefRtAdvVpnInsts
Table type Multi-instance table
Row name PeerDefRtAdvVpnInst
Restrictions No
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
An empty string
String. indicates the
Name Instance name Index
Length: 0 to 31 characters. default BGP
process.

String. An empty string

VRF VRF name Index indicates the public
Length: 0 to 31 characters. network.
Address Family Enumeration: N/A
Family Identifier of Index
Neighbor • 4—VPNv4

Address family of Enumeration:

SessAF Index N/A
session • 1—IPv4.

Address of Example: 1.1.1.1.

IpAddress Index String,IPv4 address string.
session

For non-dynamic
Unsigned integer. peers, this is
Mask of
Mask Index Value range: 255.For IPv4
session address dynamic peers,this
0 to 32,or 255
is 0 to 32.
PeerDefRtAd String.
Specify a VPN
vVpnInstNam Index N/A
instance name Length: 1 to 31 characters.
e

69
Contents
BGP ······························································································2
BGP/Instances ·························································································································· 2
BGP/VRFs ······························································································································· 3
BGP/CfgSessionGroups ·············································································································· 4
BGP/CfgSessions ······················································································································ 5
BGP/Familys ····························································································································· 7
BGP/Networks ························································································································ 10
BGP/Aggregates ······················································································································ 10
BGP/NeighborGroups ··············································································································· 11
BGP/Neighbors ······················································································································· 14
BGP/Redistributes···················································································································· 18
BGP/RedistributesAppend ········································································································· 18
BGP/BMPs ····························································································································· 19
BGP/Rpkis ····························································································································· 20
BGP/Resets ···························································································································· 20
BGP/Refreshs ························································································································· 20
BGP/FilterPolicyExports ············································································································ 21
BGP/PeerDefRtAdvVpnInsts ······································································································ 22

i
BGP
BGP/Instances
Message Explanation
The BGP process already exists but the AS
number doesn't match. Configuration already exists, when set new configuration.
BGP进程已存在，AS号不匹配。

BGP is disabling NSR.

The NSR is being deleted, when replacing or deleting it.
BGP进程正在处理NSR删除，请稍后再进行配置。

Can't enable NSR because the address family

which not support NSR has been configured. Invalid configuration, please modify configuration under the
guidance.
地址族配置与NSR配置冲突，不能配置NSR。

Centralized device doesn't support NSR. Invalid configuration, please modify configuration under the
集中式设备，无法支持NSR。 guidance.

AS number is required for BGP instance. Invalid configuration, please modify configuration under the
必须为BGP实例指定AS号。 guidance.

Enable IgnoreAllPeers and configure GracefulTime

first. Invalid configuration, please modify configuration under the
需先禁止所有对等体、对等体组建立对话、配置 guidance.
GracefulTime。

GracefulTime and
Conmmunity/LocalPreference/Med must be
performed toghter with IgnoreAllPeers. Invalid configuration, please modify configuration under the
GracefulTime必须与Conmmunity或 guidance.
LocalPreference或Med同时配置，且需和
IgnoreAllPeersEnable一起。

The label of per-vrf conflict with vpn popgo. Invalid configuration, please modify configuration under the
为每个实例申请标签方式与vpn popgo命令互斥。 guidance.

Configure the confederation id first before

configure. Invalid configuration, please modify configuration under the
guidance.
请先配置ConfederationId。

Please enable Graceful Restart (GR) capability

first. Invalid configuration, please modify configuration under the
guidance.
请先使能Graceful-restart

Please remove configuration peers first. Invalid configuration, please modify configuration under the
请先删除该联盟子地址族。 guidance.

Confededation peer sub-AS number cannot be the

same with local AS number. Invalid configuration, please modify configuration under the
guidance.
子地址族与本地AS Number冲突。

The total count of confederation peer must not

greater than 32. Invalid configuration, please modify configuration under the
guidance.
子地址族总数不能超过32。

2
 Confederation peer sub-AS number cannot be the
same with the AS number of VPN instance peers. Invalid configuration, please modify configuration under the
guidance.
子地址族与VPN实例的AS Number冲突。

AS number is conflicted with Peer group or peer

session configured with fake AS number. Invalid configuration, please modify configuration under the
guidance.
子地址族与会话或会话组的虚拟AS Number冲突。

Community sequence number, in the range of 1 to

4294967295. Invalid configuration, please modify configuration under the
guidance.
团体序号的取值范围为1~4294967295。

Community number, in the format of

aa(0-65535):nn(0-65535). Invalid configuration, please modify configuration under the
guidance.
团体号的格式为aa(0-65535):nn(0-65535)。

Cannot configure same AS number in

confederation. Invalid configuration, please modify configuration under the
guidance.
不能在联盟中配置相同的AS号。

The BGP process doesn’t exist or the TCP

connection failed. The BGP process doesn’t exist or the TCP connection failed.
BGP进程不存在或者TCP连接失败。

Configure the confederation id first. Invalid configuration, please modify configuration under the
请先配置ConfederationId。 guidance.

BGP/VRFs
Message Explanation
The BGP process already exists but the AS
number doesn't match. Configuration already exists, when set new configuration.
BGP进程已存在，AS号不匹配。

AS number is required for BGP instance. Invalid configuration, please modify configuration under the
必须为BGP实例指定AS号。 guidance.

The VRF instance doesn't exist. Invalid configuration, please modify configuration under the
该VPN不存在。 guidance.

The VRF instance is being deleted.

The specified VRF is being deleted, when replacing or deleting it.
该VPN正在删除中。

The VRF instance RD is not configured. Invalid configuration, please modify configuration under the
该VPN没有配置RD。 guidance.

The public VRF can't be deleted. Invalid configuration, please modify configuration under the
公网VPN实例不允许删除。 guidance.

Invalid hold or keepalive time value. Invalid configuration, please modify configuration under the
Keepalive定时器或Hold定时器取值错误。 guidance.

Invalid router ID. Invalid configuration, please modify configuration under the
无效的RouterID。 guidance.

The VPN already exists in another BGP instance.

The VPN can’t exists in two or more BGP instances.
该VPN已存在于其他BGP实例中。

3
BGP/CfgSessionGroups
Message Explanation
The BGP process already exists but the AS
number doesn't match. Configuration already exists, when set new configuration.
BGP进程已存在，AS号不匹配。

AS number is required for BGP instance. Invalid configuration, please modify configuration under the
必须为BGP实例指定AS号。 guidance.

The VRF instance doesn't exist. Invalid configuration, please modify configuration under the
该VPN不存在。 guidance.

The VRF instance is being deleted.

The specified VRF is being deleted, when replacing or deleting it.
该VPN正在删除中。

The VRF instance is not configured. Invalid configuration, please modify configuration under the
该VPN没有配置。 guidance.

The interface is not belong to the VRF instance. Invalid configuration, please modify configuration under the
指定接口不属于该VPN。 guidance.

When the operation is create, merge or replace, the

group type must not be null. Invalid configuration, please modify configuration under the
Create、merge、replace操作时，对等体组类型不 guidance.
能为空。

When the operation is delete or remove, the group

type can’t be specified. Invalid configuration, please modify configuration under the
guidance.
Delete、remove操作时，不能指定对等体组类型。

Not necessary to configure AS number for an IBGP

group. Invalid configuration, please modify configuration under the
guidance.
不能配置或者删除IBGP组的AS号。

Can't change or delete AS number for a peer group

that contains peers. Invalid configuration, please modify configuration under the
对等体组中存在会话，不能变更或者删除对等体组 guidance.
AS号。

Invalid peer group name. Invalid configuration, please modify configuration under the
组名称不合法。 guidance.

The specified peer group doesn't exist. Invalid configuration, please modify configuration under the
指定的对等体组不存在。 guidance.

The interface is not belong to the VRF instance. Invalid configuration, please modify configuration under the
指定接口不属于该VPN。 guidance.

PasswordType and Password must both be

configured. Invalid configuration, please modify configuration under the
guidance.
PasswordType和Password必须同时配置。

Invalid ciphertext password. Invalid configuration, please modify configuration under the
密文密码不合法。 guidance.

Invalid simpletext password length. Invalid configuration, please modify configuration under the
明文密码长度不合法。 guidance.

4
 Invalid ciphertext password length. Invalid configuration, please modify configuration under the
密文密码长度不合法。 guidance.

BFD not supported.

BFD service has not been started.
不支持BFD

When enabling dual-as, prepend-global-as, or

prepend-fake-as, you must specify the fake AS
number. Invalid configuration, please modify configuration under the
guidance.
配置dual-as、prepend-global-as、prepend-fake-as
使能时，fake-as不能为空。

Invalid fake AS number. Invalid configuration, please modify configuration under the
指定的fake-as无效。 guidance.

EBGP peer groups don’t exist. Invalid configuration, please modify configuration under the
EBGP对等体组不存在。 guidance.

The ORIGINATOR_ID attribute is not supported for

EBGP peer groups. Invalid configuration, please modify configuration under the
guidance.
ORIGINATOR_ID属性不适用于EBGP对等体组。

Invalid hold or keepalive time value. Invalid configuration, please modify configuration under the
Keepalive定时器或Hold定时器取值错误。 guidance.

BGP/CfgSessions
Message Explanation
The BGP process already exists but the AS
number doesn't match. Configuration already exists, when set new configuration.
BGP进程已存在，AS号不匹配。

AS number is required for BGP instance. Invalid configuration, please modify configuration under the
必须为BGP实例指定AS号。 guidance.

The VRF instance doesn't exist. Invalid configuration, please modify configuration under the
该VPN不存在。 guidance.

The VRF instance is being deleted.

The specified VRF is being deleted, when replacing or deleting it.
该VPN正在删除中。

The VRF instance is not configured. Invalid configuration, please modify configuration under the
该VPN没有配置。 guidance.

The interface is not belong to the VRF instance. Invalid configuration, please modify configuration under the
指定接口不属于该VPN。 guidance.

The session already exists. The AS number can't

be changed. Configuration already exists, when set new configuration.
会话已存在，不允许修改会话的AS号。

Invalid IP address. Invalid configuration, please modify configuration under the

无效的IP地址。 guidance.

Interface name is invalid, or interface failed RBAC

check. Invalid configuration, please modify configuration under the
guidance.
接口名称非法或者无法通过RBAC检查。

5
When the operation is create, merge, or replace,
the AS number can’t be specified. Invalid configuration, please modify configuration under the
guidance.
Create、merge、replace操作时，不能指定AS号。

When the operation is delete or remove, cannot set

the ASNumber column. Invalid configuration, please modify configuration under the
guidance.
Delete、remove操作时，AS号必须为空。

The specified peer group doesn't exist. Invalid configuration, please modify configuration under the
指定的对等体组不存在。 guidance.

The interface is not belong to the VRF instance. Invalid configuration, please modify configuration under the
指定接口不属于该VPN。 guidance.

PasswordType and Password must both be

configured. Invalid configuration, please modify configuration under the
guidance.
PasswordType和Password必须同时配置。

Invalid ciphertext password. Invalid configuration, please modify configuration under the
密文密码不合法。 guidance.

Invalid simpletext password length. Invalid configuration, please modify configuration under the
明文密码长度不合法。 guidance.

Invalid ciphertext password length. Invalid configuration, please modify configuration under the
密文密码长度不合法。 guidance.

BFD not supported.

BFD service has not been started.
不支持BFD

Not EBGP peers.

Only EBGP peers support the configuration.
仅EBGP邻居支持本配置。

When enabling dual-as, prepend-global-as, or

prepend-fake-as, you must specify the fake AS
number. Invalid configuration, please modify configuration under the
guidance.
配置dual-as、prepend-global-as、prepend-fake-as
使能时，fake-as不能为空。

Invalid fake AS number. Invalid configuration, please modify configuration under the
指定的fake-as无效。 guidance.

The peers belong to another peer group. Invalid configuration, please modify configuration under the
指定对等体已经加入其它对等体组。 guidance.

EBGP peers don’t exist. Invalid configuration, please modify configuration under the
EBGP对等体不存在。 guidance.

The ORIGINATOR_ID attribute is not supported for

EBGP peers. Invalid configuration, please modify configuration under the
guidance.
ORIGINATOR_ID属性不适用于EBGP对等体。

IPv4 does not support the use of Ipsec-policy. Invalid configuration, please modify configuration under the
IPv4不支持使用Ipsec策略。 guidance.

Invalid hold or keepalive time value. Invalid configuration, please modify configuration under the
Keepalive定时器或Hold定时器取值错误。 guidance.

6
BGP/Familys
Message Explanation
The BGP process already exists but the AS
number doesn't match. Configuration already exists, when set new configuration.
BGP进程已存在，AS号不匹配。

AS number is required for BGP instance. Invalid configuration, please modify configuration under the
必须为BGP实例指定AS号。 guidance.

The VRF instance doesn't exist. Invalid configuration, please modify configuration under the
该VPN不存在。 guidance.

The VRF instance is being deleted.

The specified VRF is being deleted, when replacing or deleting it.
该VPN正在删除中。

The VRF instance is not configured. Invalid configuration, please modify configuration under the
该VPN没有配置。 guidance.

This address family doesn't support NSR. Please

disable NSR first. Invalid configuration, please modify configuration under the
guidance.
当前地址族不支持NSR，请先将NSR配置删除。

The specified address family doesn't exist. Invalid configuration, please modify configuration under the
指定的地址族不存在。 guidance.

Can't configure both EIBGP load balancing and

EBGP/IBGP load balancing at the same time. Invalid configuration, please modify configuration under the
guidance.
EIBGP等价不能和EBGP等价、IBGP等价同时配置。

Unsupported address family. Invalid configuration, please modify configuration under the
不支持该地址族。 guidance.

The specified address family doesn't support the

preference command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持preference命令。

The specified address family doesn't support the

balance command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持balance命令。

Number of BGP routes exceeded the maximum for

load balancing. Invalid configuration, please modify configuration under the
guidance.
配置的等价条数超过产品所能配置的最大值。

You must set all of the EBGP preference, IBGP

preference, and LOCAL preference, or set none of
them. Invalid configuration, please modify configuration under the
guidance.
EBGP preference、IBGP preference、LOCAL
preference必须同时进行配置或取消配置。

The specified address family doesn't support policy

vpn-target command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持policy vpn-target命令。

The specified address family doesn't support

rr-filter command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持rr-filter命令。

7
Cluster ID must be an IPv4 address or a number
between 1 to 0xFFFFFFFF(notice that it must not
be 0.0.0.0). Invalid configuration, please modify configuration under the
guidance.
Cluster ID必须是一个合法的IPv4地址或者32位无
符号正整数(注意不能是0.0.0.0或者数字0)。

The specified address family doesn't support

default-route imported command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持default-route imported命令。

The specified address family doesn't support the

pic command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持pic命令。

The specified address family doesn't support the

balance as-path-neglect command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持balance as-path-neglect命令。

The specified address family doesn't support the

balance as-path-relax command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持balance as-path-relax命令。

The specified address family doesn't support the

advertise l3vpn route command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持advertise l3vpn route命令。

The specified address family doesn't support the

advertise l2vpn evpn command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持advertise l2vpn evpn命令。

The specified address family doesn't support the

import evpn mac-ip command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持import evpn mac-ip命令。

The specified address family doesn't support

advertise evpn route command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持advertise evpn route命令。

To configure replace-rt or advertise-policy,you

must enable EVPN route advertisement for the
VPNv4 or VPNv6 address family. Invalid configuration, please modify configuration under the
配置修改路由的RT或通过路由策略过滤BGP EVPN guidance.
路由时需要配置允许BGP EVPN路由通过VPNv4或
VPNv6地址族发布给邻居

To configure replace-rt or advertise-policy,you

must enable VPNv4 or VPNv6 route advertisement
for the EVPN address family. Invalid configuration, please modify configuration under the
配置修改路由的RT或通过路由策略过滤BGP guidance.
VPNv4或VPNv6路由时需要配置允许VPNv4或
VPNv6路由通过EVPN地址族发布给邻居

The specified address family doesn't support the

additional-paths select-best command. Invalid configuration, please modify configuration under the
指定的地址族不支持additional-paths select-best命 guidance.
令。

The specified address family doesn't support the

advertise-rib-active command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持advertise-rib-active命令。

8
The specified address family doesn't support the
bestroute origin-as-validation command. Invalid configuration, please modify configuration under the
指定的地址族不支持bestroute origin-as-validation guidance.
命令。

The specified address family doesn't support the

dampening command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持dampening命令。

The specified address family doesn't support the

default med command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持default med命令。

The specified address family doesn't support the

fast-reroute route-policy command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持fast-reroute route-policy命令。

The specified address family doesn't support the

filter-policy export command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持filter-policy export命令。

The specified address family doesn't support the

filter-policy import command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持filter-policy import命令。

The specified address family doesn't support the

log-route-flap command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持log-route-flap命令。

The specified address family doesn't support the

mvpn-advertise-rt-import command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持mvpn-advertise-rt-import命令。

The specified address family doesn't support the

nesting-vpn command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持nesting-vpn命令。

The specified address family doesn't support the

summary automatic command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持summary automatic命令。

The specified address family doesn't support the

update-first route-policy command. Invalid configuration, please modify configuration under the
guidance.
指定的地址族不支持update-first route-policy命令。

ACL name (start with [a-z,A-Z]). Can not use 'all' as

ACL name. Invalid configuration, please modify configuration under the
ACL名称必须以英文字母开头，且不允许使用英文 guidance.
单词all。

The value of Ceiling must be greater than the value

of Suppress. Invalid configuration, please modify configuration under the
guidance.
Ceiling的值必须比Suppress的值大。

The value of Suppress must be greater than the

value of Reuse. Invalid configuration, please modify configuration under the
guidance.
Suppress的值必须比Reuse的值大。

Before You set the HalfLifeReach, Invalid configuration, please modify configuration under the
HalfLifeUnReach, Reuse, Suppresss, Ceiling or guidance.
DampRtPolicyName, DampeningEnable must be

9
 enable first.
配置HalfLifeReach、HalfLifeUnReach、Reuse、
Suppresss、Ceiling和DampRtPolicyName时，
DampeningEnable必须先使能。

The value of Suppress must be greater than the

value of Reuse. Invalid configuration, please modify configuration under the
guidance.
Suppress的值必须比Reuse的值大。

The value of Ceiling must be greater than the value

of Suppress. Invalid configuration, please modify configuration under the
guidance.
Ceiling的值必须比Suppress的值大。

You must set all of the HalfLifeReach,

HalfLifeUnReach, Reuse, Suppresss and Ceiling,
or set none of them. Invalid configuration, please modify configuration under the
guidance.
HalfLifeReach、HalfLifeUnReach、Reuse、
Suppresss和Ceiling必须同时配置或者不配置。

BGP/Networks
Message Explanation
The BGP process already exists but the AS
number doesn't match. Configuration already exists, when set new configuration.
BGP进程已存在，AS号不匹配。

AS number is required for BGP instance. Invalid configuration, please modify configuration under the
必须为BGP实例指定AS号。 guidance.

The VRF instance doesn't exist. Invalid configuration, please modify configuration under the
该VPN不存在。 guidance.

The VRF instance is being deleted.

The specified VRF is being deleted, when replacing or deleting it.
该VPN正在删除中。

The VRF instance is not configured. Invalid configuration, please modify configuration under the
该VPN没有配置。 guidance.

Invalid IP address. Invalid configuration, please modify configuration under the

无效的IP地址。 guidance.

IPv4 address mask length can't be greater than 32. Invalid configuration, please modify configuration under the
IPv4地址的掩码长度不能超过32。 guidance.

The specified address family doesn't support the

network command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持network命令。

BGP/Aggregates
Message Explanation
The BGP process already exists but the AS
number doesn't match. Configuration already exists, when set new configuration.
BGP进程已存在，AS号不匹配。

10
 AS number is required for BGP instance. Invalid configuration, please modify configuration under the
必须为BGP实例指定AS号。 guidance.

The VRF instance doesn't exist. Invalid configuration, please modify configuration under the
该VPN不存在。 guidance.

The VRF instance is being deleted.

The specified VRF is being deleted, when replacing or deleting it.
该VPN正在删除中。

The VRF instance is not configured. Invalid configuration, please modify configuration under the
该VPN没有配置。 guidance.

Invalid IP address. Invalid configuration, please modify configuration under the

无效的IP地址。 guidance.

IPv4 address mask length can't be greater than 32. Invalid configuration, please modify configuration under the
IPv4地址的掩码长度不能超过32。 guidance.

The specified address family doesn't support the

aggregate command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持aggregate命令。

BGP/NeighborGroups
Message Explanation
The BGP process already exists but the AS
number doesn't match. Configuration already exists, when set new configuration.
BGP进程已存在，AS号不匹配。

AS number is required for BGP instance. Invalid configuration, please modify configuration under the
必须为BGP实例指定AS号。 guidance.

The VRF instance doesn't exist. Invalid configuration, please modify configuration under the
该VPN不存在。 guidance.

The VRF instance is being deleted.

The specified VRF is being deleted, when replacing or deleting it.
该VPN正在删除中。

The VRF instance is not configured. Invalid configuration, please modify configuration under the
该VPN没有配置。 guidance.

The specified address family doesn't support the

route-policy import command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持route-policy import命令。

The specified address family doesn't support the

route-policy export command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持route-policy export命令。

Reflect not for EBGP peergroups。 Invalid configuration, please modify configuration under the
EBGP对等体组不能配置反射 guidance.

Next-hop-local conflict with next-hop-invariable.

Invalid configuration, please modify configuration under the
Next-hop-local命令和next-hop-invariable命令存在 guidance.
冲突，不能同时配置。

The specified address family doesn't support the Invalid configuration, please modify configuration under the

11
next-hop-invariable command. guidance.
指定地址族不支持next-hop-invariable命令。

The specified address family doesn't support the

reflect between-clients command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持reflect between-clients命令。

The specified address family doesn't support the

reflector cluster-id command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持reflector cluster-id命令。

The specified address family doesn't support the

reflect-client command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持reflect-client命令。

The specified address family doesn't support the

next-hop-local command。 Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持next-hop-local命令

The specified address family doesn't support the

router-mac-local command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持router-mac-local命令。

The specified address family doesn't support the

advertise-community command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持advertise-community命令。

The specified address family doesn't support the

allow-as-loop command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持allow-as-loop命令。

The specified address family doesn't support the

route-limit command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持route-limit命令。

Invalid prefix count. Invalid configuration, please modify configuration under the
前缀数目配置错误。 guidance.

Alert-only, Discard, Reconnect can't be configured

at the same time. Invalid configuration, please modify configuration under the
guidance.
Alert-only、Discard、Reconnect不能同时配置。

Invalid peer group name. Invalid configuration, please modify configuration under the
组名称不合法。 guidance.

The specified peer group doesn't exist. Invalid configuration, please modify configuration under the
指定的对等体组不存在。 guidance.

The specified address family doesn't support the

next-hop-vpn command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持next-hop-vpn命令

The specified address family doesn't support the

advertise-ext-community command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持advertise-ext-community命令。

The specified address family doesn’t support the

additional-paths receive command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持additional-paths receive命令。

The specified address family doesn’t support the Invalid configuration, please modify configuration under the

12
additional-paths send command. guidance.
指定地址族不支持additional-paths send命令。

The specified address family doesn’t support the

advertise additional-paths best command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持additional-paths best命令。

The specified address family doesn’t support the

default-route-advertise command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持default-route-advertise命令。

Route policy name and vpn instance name can’t be

configured at the same time. Invalid configuration, please modify configuration under the
Route policy name和vpn instance name不能同时 guidance.
配置。

Invalid default-route-advertise value. Invalid configuration, please modify configuration under the
指定的default-route-advertise值不存在。 guidance.

The specified address family doesn’t support the

keep-all-routes command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持keep-all-routes命令。

The specified address family doesn’t support the

label-route-capability command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持label-route-capability命令。

The specified address family doesn’t support the

prefix-list export command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持prefix-list export命令。

The specified address family doesn’t support the

prefix-list import command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持prefix-list import命令。

The specified address family doesn’t support the

public-as-only command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持public-as-only命令。

The specified address family doesn’t support the

soo command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持soo命令。

The specified address family doesn’t support the

filter-policy export command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持filter-policy export命令。

The specified address family doesn’t support the

filter-policy import command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持filter-policy import命令。

The specified address family doesn’t support the

advertise origin-as-validation command. Invalid configuration, please modify configuration under the
指定地址族不支持advertise origin-as-validation命 guidance.
令。

The specified address family doesn’t support the

capability-advertise orf prefix-list command. Invalid configuration, please modify configuration under the
指定地址族不支持capability-advertise orf prefix-list guidance.
命令。

13
 The specified address family doesn’t support the
signaling command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持signaling命令。

Invalid signaling non-standard value. Invalid configuration, please modify configuration under the
指定的signaling non-standard值不存在。 guidance.

Invalid signaling value. Invalid configuration, please modify configuration under the
指定的signaling值不存在。 guidance.

The specified address family doesn’t support the

upe command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持upe命令。

The specified address family doesn’t support the

upe route-policy command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持upe route-policy命令。

The specified address family doesn’t support the

auto-discovery command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持auto-discovery命令。

Invalid auto-discovery non-standard value. Invalid configuration, please modify configuration under the
指定的auto-discovery non-standard值不存在。 guidance.

Invalid auto-discovery value. Invalid configuration, please modify configuration under the
指定的auto-discovery值不存在。 guidance.

Invalid site-of-origin. Invalid configuration, please modify configuration under the

site-of-origin格式不合法。 guidance.

AdvAddPathsBest, in the range of 2 to 32. Invalid configuration, please modify configuration under the
AdvAddPathsBest的取值范围为2~32。 guidance.

To configure DiscNonStd, you must set DiscEnable

first. Invalid configuration, please modify configuration under the
guidance.
在配置SigNonStd之前必须先配置SigEnable。

Only DiscNonStd can is 1 when DiscEnable is 1. Invalid configuration, please modify configuration under the
只有在DiscEnable为1时，DiscNonStd才能为1。 guidance.

Only SigNonStd can is 1 when SigEnable is 1. Invalid configuration, please modify configuration under the
只有在SigEnable为1时，SigNonStd才能为1。 guidance.

BGP/Neighbors
Message Explanation
The BGP process already exists but the AS
number doesn't match. Configuration already exists, when set new configuration.
BGP进程已存在，AS号不匹配。

AS number is required for BGP instance. Invalid configuration, please modify configuration under the
必须为BGP实例指定AS号。 guidance.

The VRF instance doesn't exist. Invalid configuration, please modify configuration under the
该VPN不存在。 guidance.

14
The VRF instance is being deleted.
The specified VRF is being deleted, when replacing or deleting it.
该VPN正在删除中。

The VRF instance is not configured. Invalid configuration, please modify configuration under the
该VPN没有配置。 guidance.

The specified neighbor can't be enabled in the

current address family. Invalid configuration, please modify configuration under the
guidance.
指定的会话在该实例下不能使能。

The specified peer doesn't exist. Invalid configuration, please modify configuration under the
指定的对等体会话不存在。 guidance.

Reflect not for EBGP peers. Invalid configuration, please modify configuration under the
EBGP邻居不能配置反射 guidance.

The specified address family doesn't support the

route-policy import command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持route-policy import命令。

The specified address family doesn't support the

route-policy export command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持route-policy export命令。

Next-hop-local conflict with next-hop-invariable.

Invalid configuration, please modify configuration under the
Next-hop-local命令和next-hop-invariable命令存在 guidance.
冲突，不能同时配置。

The specified address family doesn't support the

next-hop-invariable command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持next-hop-invariable命令。

The specified address family doesn't support the

reflect between-clients command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持reflect between-clients命令。

The specified address family doesn't support the

reflector cluster-id command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持reflector cluster-id命令。

The specified address family doesn't support the

reflect-client command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持reflect-client命令。

The specified address family doesn't support the

next-hop-local command。 Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持next-hop-local命令

The specified address family doesn't support the

router-mac-local command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持router-mac-local命令。

The specified address family doesn't support the

advertise-community command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持advertise-community命令。

The specified address family doesn't support the

allow-as-loop command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持allow-as-loop命令。

Invalid IP address. Invalid configuration, please modify configuration under the

15
无效的IP地址。 guidance.

The specified address family doesn't support the

route-limit command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持route-limit命令。

Invalid prefix count. Invalid configuration, please modify configuration under the
前缀数目配置错误。 guidance.

Alert-only, Discard, Reconnect can't be configured

at the same time. Invalid configuration, please modify configuration under the
guidance.
Alert-only、Discard、Reconnect不能同时配置。

The specified address family doesn't support the

next-hop-vpn command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持next-hop-vpn命令

The specified address family doesn't support the

advertise-ext-community command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持advertise-ext-community命令。

The specified address family doesn’t support the

additional-paths receive command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持additional-paths receive命令。

The specified address family doesn’t support the

additional-paths send command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持additional-paths send命令。

The specified address family doesn’t support the

advertise additional-paths best command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持additional-paths best命令。

The specified address family doesn’t support the

default-route-advertise command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持default-route-advertise命令。

Route policy name and vpn instance name can’t be

configured at the same time. Invalid configuration, please modify configuration under the
Route policy name和vpn instance name不能同时 guidance.
配置。

Invalid default-route-advertise value. Invalid configuration, please modify configuration under the
指定的default-route-advertise值不存在。 guidance.

The specified address family doesn’t support the

keep-all-routes command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持keep-all-routes命令。

The specified address family doesn’t support the

label-route-capability command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持label-route-capability命令。

The specified address family doesn’t support the

prefix-list export command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持prefix-list export命令。

The specified address family doesn’t support the

prefix-list import command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持prefix-list import命令。

16
The specified address family doesn’t support the
public-as-only command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持public-as-only命令。

The specified address family doesn’t support the

soo command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持soo命令。

The specified address family doesn’t support the

filter-policy export command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持filter-policy export命令。

The specified address family doesn’t support the

filter-policy import command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持filter-policy import命令。

The specified address family doesn’t support the

advertise origin-as-validation command. Invalid configuration, please modify configuration under the
指定地址族不支持advertise origin-as-validation命 guidance.
令。

The specified address family doesn’t support the

capability-advertise orf prefix-list command. Invalid configuration, please modify configuration under the
指定地址族不支持capability-advertise orf prefix-list guidance.
命令。

The specified address family doesn’t support the

signaling command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持signaling命令。

Invalid signaling non-standard value. Invalid configuration, please modify configuration under the
指定的signaling non-standard值不存在。 guidance.

Invalid signaling value. Invalid configuration, please modify configuration under the
指定的signaling值不存在。 guidance.

The specified address family doesn’t support the

upe command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持upe命令。

The specified address family doesn’t support the

upe route-policy command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持upe route-policy命令。

The specified address family doesn’t support the

auto-discovery command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持auto-discovery命令。

Invalid auto-discovery non-standard value. Invalid configuration, please modify configuration under the
指定的auto-discovery non-standard值不存在。 guidance.

Invalid auto-discovery value. Invalid configuration, please modify configuration under the
指定的auto-discovery值不存在。 guidance.

The specified peers don't exist.

The specified peers don't exist.
指定的对等体不存在。

When the operation is delete or remove, the

RoutePlcy is not allowed to be set. Invalid configuration, please modify configuration under the
guidance.
当delete或remove操作时，不允许指定RoutePlcy。

17
BGP/Redistributes
Message Explanation
The BGP process already exists but the AS
number doesn't match. Configuration already exists, when set new configuration.
BGP进程已存在，AS号不匹配。

AS number is required for BGP instance. Invalid configuration, please modify configuration under the
必须为BGP实例指定AS号。 guidance.

The VRF instance doesn't exist. Invalid configuration, please modify configuration under the
该VPN不存在。 guidance.

The VRF instance is being deleted.

The specified VRF is being deleted, when replacing or deleting it.
该VPN正在删除中。

The VRF instance is not configured. Invalid configuration, please modify configuration under the
该VPN没有配置。 guidance.

The specified address family doesn't support the

import-route command. Invalid configuration, please modify configuration under the
guidance.
指定地址族不支持import-route命令。

You cannot specify a process ID when you

redistribute direct or static routes. Invalid configuration, please modify configuration under the
guidance.
引入协议为直连或者静态时，协议进程号必须为空。

Invalid RIP, OSPF, or IS-IS process ID. Please

specify a process ID in the range of 1 to 65535, or
specify the all-processes keyword to redistribute
routes from all processes of the specified protocol. Invalid configuration, please modify configuration under the
guidance.
RIP、OSPF或ISIS路由协议的进程号非法，请指定
1~65535之间的协议进程号或指定all-processes参
数引入指定路由协议所有进程的路由。

Invalid EIGRP process ID. Please specify a

process ID in the range of 1 to 65535, or specify the
all-as keyword to redistribute routes from all EIGRP
processes. Invalid configuration, please modify configuration under the
guidance.
EIGRP路由协议的进程号非法，请指定1~65535之
间的协议进程号或指定all-as参数引入指定路由协议
所有进程的路由。

When the Protocol is DIRECT or STATIC,

allow-direct can not be configured. Invalid configuration, please modify configuration under the
引入协议为DIRECT或者STATIC时，不能配置 guidance.
allow-direct。

BGP/RedistributesAppend
Message Explanation
The BGP process already exists but the
AS number doesn't match. Configuration already exists, when set new
configuration.
BGP进程已存在，AS号不匹配。

AS number is required for BGP Invalid configuration, please modify configuration

18
 instance. under the guidance.
必须为BGP实例指定AS号。

The VRF instance doesn't exist. Invalid configuration, please modify configuration
该VPN不存在。 under the guidance.

The VRF instance is being deleted. The specified VRF is being deleted, when replacing or
该VPN正在删除中。 deleting it.

The VRF instance is not configured. Invalid configuration, please modify configuration
该VPN没有配置。 under the guidance.

The specified address family doesn't

support the import-route command. Invalid configuration, please modify configuration
under the guidance.
指定地址族不支持import-route命令。

You cannot specify a process ID when you

redistribute direct or static routes. Invalid configuration, please modify configuration under the
guidance.
引入协议为直连或者静态时，协议进程号必须为空。

Invalid RIP, OSPF, or IS-IS process ID. Please

specify a process ID in the range of 1 to 65535, or
specify the all-processes keyword to redistribute
routes from all processes of the specified protocol. Invalid configuration, please modify configuration under the
guidance.
RIP、OSPF或ISIS路由协议的进程号非法，请指定
1~65535之间的协议进程号或指定all-processes参
数引入指定路由协议所有进程的路由。

Invalid EIGRP process ID. Please specify a

process ID in the range of 1 to 65535, or specify the
all-as keyword to redistribute routes from all EIGRP
processes. Invalid configuration, please modify configuration under the
guidance.
EIGRP路由协议的进程号非法，请指定1~65535之
间的协议进程号或指定all-as参数引入指定路由协议
所有进程的路由。

When the Protocol is DIRECT or

STATIC, allow-direct can not be
configured. Invalid configuration, please modify configuration
under the guidance.
引入协议为DIRECT或者STATIC时，不
能配置allow-direct。

BGP/BMPs
Message Explanation
Invalid InterfaceName. Invalid configuration, please modify configuration
无效的接口名。 under the guidance.

The BMP server doesn't exist.

The BMP server doesn't exist.
BMP Server不存在。

Other BMP Server has the same IP

Address and port number. Other BMP Server has the same IP Address and port
其他BMP服务器已有相同的IP地址和端 number.
口号。

19
BGP/Rpkis
Message Explanation
RPKI process is being deleted. Please
try it later. The specified RPKI is being deleted.
正在删除RPKI进程，请稍后重试。

The specified RPKI Server is being

deleted. Please try it later.
The specified RPKI Server is being deleted.
正在删除指定的RPKI服务器，请稍后重
试。

Can not configure before enable the

rpki. Can not configure before enable the rpki.
使能RPKI前不能进行配置。

BGP/Resets
Message Explanation
The configuration does not match the
specified type. Invalid configuration, please modify configuration
under the guidance.
配置信息与指定的Type不符。

Mask can not be set without IpAddress. Invalid configuration, please modify configuration
配置掩码前必须先配置IP地址。 under the guidance.

The VRF cannot be set with specified

type and family . Invalid configuration, please modify configuration
under the guidance.
在当前Type和Family下，不能配置VRF。

The specified type and family do not

match. Invalid configuration, please modify configuration
under the guidance.
指定的Type与Family不匹配。

BGP/Refreshs
Message Explanation
The specified TYPE does not support
the configuration of the ip address. Invalid configuration, please modify configuration
under the guidance.
指定的TYPE不支持配置ip地址。

The ip address does not exist. Invalid configuration, please modify configuration
Ip地址不存在。 under the guidance.

The specified TYPE does not support

the configuration of the group name. Invalid configuration, please modify configuration
under the guidance.
指定的TYPE不支持配置组名。

The group name does not exist. Invalid configuration, please modify configuration
组名不存在。 under the guidance.

The specified address family does not Invalid configuration, please modify configuration

20
 support the configuration of the VPN under the guidance.
instance name.
指定地址族不支持配置VPN实例名称。

Peers are being deleted. Try it later. Invalid configuration, please modify configuration
对等体正在被删除，稍等再试。 under the guidance.

Invalid mask value. Invalid configuration, please modify configuration

Mask取值错误。 under the guidance.

BGP/FilterPolicyExports
Message Explanation
You can only set one of
acl-number,acl-name and
prefix-list-name at the same time. Invalid configuration, please modify configuration
under the guidance.
每次只能配置acl-number、acl-name、
prefix-list-name中的一个。

You cannot specify process-id when

protocol is direct or static, or no
protocol. Invalid configuration, please modify configuration
under the guidance.
引 入 协 议 为 static 或 者 direct 时 ，
process-id必须为空。

The specified address family doesn't

support the filter-policy export
command.. Invalid configuration, please modify configuration
under the guidance.
指定地址族不支持filter-policy export命
令。

The specified address family doesn't

support the filter-policy import
command. Invalid configuration, please modify configuration
under the guidance.
指定地址族不支持filter-policy import命
令。

The specified address family does not

support the configuration of the VPN
instance name. Invalid configuration, please modify configuration
under the guidance.
当不指定协议，或引入协议为static或者
direct时，process-id必须为空。

When protocol is isis/isisv6,

ospf/ospfv3, rip/ripng, the process-id
must not be null. Invalid configuration, please modify configuration
under the guidance.
Protocol 为 isis/isisv6 、 ospf/ospfv3 、
rip/ripng时，process-id不能为空。

When the operation is delete or remove,

acl-number, acl-name and
prefix-list-name are not allowed to be Invalid configuration, please modify configuration
set. under the guidance.
当delete或remove操作时，不允许指定
acl-number、acl-name、prefix-list-name。

The prototol is invalid in the address Invalid configuration, please modify configuration
family. under the guidance.

21
 该地址族不支持指定的协议。

BGP/PeerDefRtAdvVpnInsts
Message Explanation
The peer default-route-advertise
vpn-instance command can only be
configured on the VPNv4 address
family of publicy network. Invalid configuration, please modify configuration
under the guidance.
Peer default-route-advertise
vpn-instance命令只能在公网的VPNv4
地址族下配置。

22
Contents
BGP event stream ············································································1
bgp-operations-to-controller event ································································································· 1
XML structure for event subscription ························································································ 1
XML structure for event report ································································································ 1
bgp-report-route-to-controller event································································································ 2
XML structure for event subscription ························································································ 2
XML structure for event report ································································································ 3
bgp-report-sessionstate-to-controller event ······················································································ 4
XML structure for event subscription ························································································ 4
XML structure for event report ································································································ 5
BGP event stream
BGP stream description.

bgp-operations-to-controller event
This event is used to notice to controller the operation event of BGP protocol.

XML structure for event subscription

<bgp-operations-to-controller>
</bgp-operations-to-controller>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>bgp_stream</stream>
<filter type="subtree">
<bgp-operations-to-controller
xmlns="http://www.h3c.com/netconf/event:1.0/BGP:1.0">
</bgp-operations-to-controller>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name BGP stream
Event name bgp-operations-to-controller
Event namespace http://www.h3c.com/netconf/event:1.0/BGP:1.0
Support for extended query No

XML structure for event report

<bgp-operations-to-controller>
<Operation>
<OperationType></OperationType>
<Name></Name>
</Operation>
</bgp-operations-to-controller>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<bgp-operations-to-controller xmlns="http://www.h3c.com/netconf/event:1.0/BGP:1.0">
<Operation>
<OperationType>1</OperationType>
 <Name></Name>
</Operation>
</bgp-operations-to-controller>
</notification>

Table description

Column
Column description Data type and restrictions Remarks
name
Enumeration
1 – Notice controller smooth start
The operation type
2 – Notice controller smooth end
OperationTyp specifies the operation that
Operation type 3 – Notice controller the lipc
e BGP protocol should
disconnect perform.
4 – Notice controller the lipc
connect successfully
String. An empty string indicates
Name Instance name
Length: 0 to 31 characters. the default BGP process.

bgp-report-route-to-controller event
This event is used to report BGP route to controller.

XML structure for event subscription

<bgp-report-route-to-controller>
</bgp-report-route-to-controller>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>bgp_stream</stream>
<filter type="subtree">
<bgp-report-route-to-controller
xmlns="http://www.h3c.com/netconf/event:1.0/BGP:1.0">
</bgp-report-route-to-controller>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name BGP stream
Event name bgp-report-route-to-controller
Event namespace http://www.h3c.com/netconf/event:1.0/BGP:1.0
Support for extended query No
XML structure for event report
<bgp-report-route-to-controller>
<ReportRoute>
<Name></Name>
<VRF></VRF>
<OperationType></OperationType>
<RouteType></RouteType>
<RouteKey></RouteKey>
<RouteSegment></RouteSegment>
<RouteAttr></RouteAttr>
</ReportRoute>
</bgp-report-route-to-controller>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<bgp-report-route-to-controller
xmlns="http://www.h3c.com/netconf/event:1.0/BGP:1.0">
<ReportRoute>
<Name></Name>
<VRF></VRF>
<OperationType>1</OperationType>
<RouteType>9</RouteType>
<RouteKey></RouteKey>
<RouteSegment>ACcCJQAAAAEAAAPoAAAAAAAAAAAAAAAAAAAwAAwpo3rjIEQCAg+</RouteSegment>
<RouteAttr>AgAGAgEAAADI</RouteAttr>
<RouteAttr>AwAEYgAIRA==</RouteAttr>
<RouteAttr>CAAEAAEA/w==</RouteAttr>
</ReportRoute>
</bgp-report-route-to-controller>
</notification>
Table description

Column
Column description Data type and restrictions Remarks
name
String. An empty string indicates
Name Instance name
Length: 0 to 31 characters. the default BGP process.

String. An empty string indicates

VRF VRF name
Length: 0 to 31 characters. the public network.

Enumeration The operation type

OperationTyp specifies the operation that
Operation type 1 – Add
e BGP protocol should
2 – Delete perform.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
RouteType Type of route
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
• 7—VPNv6
• 8—L2VPN
• 9—EVPN
Binary. An empty string indicates
RouteKey Key of route
Length: 0 to 128 characters. there is no key of the route.

RouteSegmen Binary.
Route information
t Length: 1 to 4096 characters.
Binary.
RouteAttr Attribute of route
Length: 1 to 4096 characters.

bgp-report-sessionstate-to-controller event
This event is used to report BGP session state to controller.

XML structure for event subscription

<bgp-report-sessionstate-to-controller>
</bgp-report-sessionstate-to-controller>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>bgp_stream</stream>
<filter type="subtree">
<bgp-report-sessionstate-to-controller
xmlns="http://www.h3c.com/netconf/event:1.0/BGP:1.0">
</bgp-report-sessionstate-to-controller>
</filter>
</create-subscription>
 </rpc>

Table description

Item Description
Event stream name BGP stream
Event name bgp-report-sessionstate-to-controller
Event namespace http://www.h3c.com/netconf/event:1.0/BGP:1.0
Support for extended query No

XML structure for event report

<bgp-report-sessionstate-to-controller>
<ReportSessionstate>
<Name></Name>
<VRF></VRF>
<AF></AF>
<IpAddress></IpAddress>
<CurrentState></CurrentState>
<LastState></LastState>
</ReportSessionstate>
</bgp-report-sessionstate-to-controller>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2018-09-05T09:10:51</eventTime>
<bgp-report-sessionstate-to-controller
xmlns="http://www.h3c.com/netconf/event:1.0/BGP:1.0">
<ReportSessionstate>
<Name></Name>
<VRF></VRF>
<AF>1</AF>
<IpAddress>1.1.1.1</IpAddress>
<CurrentState>5</CurrentState>
<LastState>4</LastState>
</ReportSessionstate>
</bgp-report-sessionstate-to-controller>
</notification>
Table description

Column
Column description Data type and restrictions Remarks
name
String. An empty string indicates
Name Instance name
Length: 0 to 31 characters. the default BGP process.

String. An empty string indicates

VRF VRF name
Length: 0 to 31 characters. the public network.

Enumeration:
Address family of
AF
session
Index • 1—IPv4.
• 2—IPv6.
String,IPv4 address string
IpAddress Address of session • Index
or IPv6 address string.
Enumeration:
• 0—Idle
• 1—Connect
Current state of the
CurrentState
session • 2—Active
• 3—Opensent
• 4—Openconfirm
• 5—Established
Enumeration:
• 0—Idle
• 1—Connect
Previous state of the
LastState
session • 2—Active
• 3—Opensent
• 4—Openconfirm
• 5—Established
Contents
BrasUpBackup ················································································1
BrasUpBackup/Service ··············································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
BrasUpBackup/Groups················································································································ 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
BrasUpBackup/Groups/Interfaces·································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4

i
BrasUpBackup
BrasUpBackup/Service
This table contains BRAS UP backup log information.

XML structure
<BrasUpBackup>
<Service>
<Log></Log>
</Service>
</BrasUpBackup>

Table description

Item Description
Feature name BrasUpBackup

Table name Service

Table type Single-instance table

Row name None

Restrictions None

Support for row creation and deletion No

Columns

Column Column Column

Data type and restrictions Remarks
name description type

Boolean:
Whether or not to
Log N/A • true N/A
enable logging
• false(default)

BrasUpBackup/Groups
This table contains BRAS UP backup group information.

1
XML structure
<BrasUpBackup>
<Groups>
<Group>
<Id></Id>
<Mode></Mode>
<Interfaces>
<Interface>
<Master></Master>
<Standby></Standby>
</Interface>
</Interfaces>
<LogicUpId></LogicUpId>
<ControlDownSwitch></ControlDownSwitch>
<ControlDownSwitchDelay></ControlDownSwitchDelay>
<FailureRecoverySwitch></FailureRecoverySwitch>
</Group>
</Groups>
</BrasUpBackup>

Table description

Item Description
Feature name BrasUpBackup

Table name Groups

Table type Multi-instance table

Row name Group

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Column

Data type and restrictions Remarks
name description type

Unsigned integer.
Id Group ID Index N/A
Value range: 1 to 16384.

Enumeration:
Mode Group mode N/A N/A
• 0—hot

2
 • 1—warm

For more
Interface
Interfaces Sublist N/A information, see the
configuration
Interfaces table.

LogicUpId Logical UP ID N/A Unsigned integer. N/A

Value range: 1024 to 1279.

Interface state
switchover upon Boolean:
ControlDownSwitc
OpenFlow N/A • true(default) N/A
h
connection • false
failure

Unsigned integer.
ControlDownSwit Switchover
N/A Value range: 1 to 1800 N/A
chDelay delay time
seconds.

Interface state Boolean:

FailureRecoveryS
switchover upon N/A • true(default) N/A
witch
failure recovery • false

BrasUpBackup/Groups/Interfaces
This table contains BRAS UP backup group interface information.

XML structure
Please refer to the XML structure of BrasUpBackup/Groups.

Table description

Item Description
Feature name BrasUpBackup

Table name Interfaces

Table type Multi-instance table

Row name Interface

Restrictions None

3
Columns

Column Column Column

Data type and restrictions Remarks
name description type

Master interface String.

Master N/A N/A
name Length: 2 to 47 characters.

Backup interface String.

Standby N/A N/A
name Length: 2 to 47 characters.

4
Contents
BrasUpBackup ················································································1
BrasUpBackup/Service ··············································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
BrasUpBackup/Groups················································································································ 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
BrasUpBackup/Groups/Interfaces·································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4

i
BrasUpBackup
BrasUpBackup/Service
This table contains BRAS UP backup log information.

XML structure
<BrasUpBackup>
<Service>
<Log></Log>
</Service>
</BrasUpBackup>

Table description

Item Description
Feature name BrasUpBackup

Table name Service

Table type Single-instance table

Row name None

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type

Boolean:
Whether or not to
Log N/A • true N/A
enable logging
• false

BrasUpBackup/Groups
This table contains BRAS UP backup group information.

1
XML structure
<BrasUpBackup>
<Groups>
<Group>
<Id></Id>
<Mode></Mode>
<Interfaces>
<Interface>
<Master></Master>
<MasterState></MasterState>
<Standby></Standby>
<StandbyState></StandbyState>
</Interface>
</Interfaces>
<LogicUpId></LogicUpId>
<ControlDownSwitch></ControlDownSwitch>
<ControlDownSwitchDelay></ControlDownSwitchDelay>
<FailureRecoverySwitch></FailureRecoverySwitch>
</Group>
</Groups>
</BrasUpBackup>

Table description

Item Description
Feature name BrasUpBackup

Table name Groups

Table type Multi-instance table

Row name Group

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type

Unsigned integer.
Id Group ID Index N/A
• Value range: 1 to 16384.

Mode Group Mode N/A Enumeration: N/A

2
 • 0—hot
• 1—warm

For more
Interface
Interfaces Sublist N/A information, see the
configuration
Interfaces table.

LogicUpId Logical UP ID N/A Unsigned integer. N/A

Value range: 1024 to 1279.

Interface state
switchover upon Boolean:
ControlDownSwitc
OpenFlow N/A • true N/A
h
connection • false
failure

Unsigned integer.
ControlDownSwit Switchover
N/A • Value range:1 to 1800 N/A
chDelay delay time
seconds

Interface state Boolean:

FailureRecoveryS
switchover upon N/A • true N/A
witch
failure recovery • false

BrasUpBackup/Groups/Interfaces
This table contains BRAS UP backup group interface information.

XML structure
Please refer to the XML structure of BrasUpBackup/Groups.

Table description

Item Description
Feature name BrasUpBackup

Table name Interfaces

Table type Multi-instance table

Row name Interface

3
 Item Description
Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type

Master interface String.

Master N/A N/A
name Length: 2 to 47 characters.

Master interface Enumeration:

MasterState N/A N/A
state • 0—master
• 1—backup

Backup interface String.

Standby N/A N/A
name Length: 2 to 47 characters.

Backup interface Enumeration:

StandbyState N/A N/A
state • 0—master
• 1—backup

4
Contents
BrasUpBackup ················································································1
BrasUpBackup/Service ··············································································································· 1
BrasUpBackup/Groups················································································································ 1
BrasUpBackup/Groups/Interfaces·································································································· 1

i
BrasUpBackup
BrasUpBackup/Service
Message Explanation
Service failed to start. Invalid configuration, please modify configuration under the
UpBackup进程未启动失败。 guidance.

Incorrect length of received data. Invalid configuration, please modify configuration under the
接受数据长度不正确。 guidance.

BrasUpBackup/Groups
Message Explanation
When creating a group, you must specify the
backup mode. Invalid configuration, please modify configuration under the
创建Group时没有携带Mode参数（Mode为创建 guidance.
Group必须配置参数）。

Modifying backup mode is not allowed.

Invalid configuration, please modify configuration under the
试图修改备份组Group的Mode（Group的Mode不能 guidance.
修改）。

Online users exist. This group cannot be deleted. Invalid configuration, please modify configuration under the
删除有上线用户的Group。 guidance.

Failed to create the group. Invalid configuration, please modify configuration under the
创建Group失败。 guidance.

Cannot set ControlDownSwitchDelay when you

disable ControlDownSwitch. Invalid configuration, please modify configuration under the
当去使能ControlDownSwitch时不能携带 guidance.
ControlDownSwitchDelay配置。

BrasUpBackup/Groups/Interfaces
Message Explanation
Online users exist. This backup relationship cannot
be deleted. Invalid configuration, please modify configuration under the
guidance.
删除有上线用户的备份关系。

Cannot configure ControlDownSwitchDelay when

ControlDownSwitch is false. Invalid configuration, please modify configuration under the
当ControlDownSwitch为去使能状态，不能配置 guidance.
ControlDownSwitchDelay。

The standby interface must be configured when

creating backup relationships. Invalid configuration, please modify configuration under the
guidance.
当创建备份关系时，必须配置备接口。

1
Remote interface not ready. Invalid configuration, please modify configuration under the
远程接口还未就绪。 guidance.

Backup relationship cannot be modified. Invalid configuration, please modify configuration under the
备份关系不能被修改。 guidance.

Cannot configure backup relationship on the same

UP device. Invalid configuration, please modify configuration under the
guidance.
不能在同一个UP上配置备份关系。

2
Contents
Bridge ····························································································1
Bridge/Base ······························································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Bridge/Instances ························································································································ 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2

i
Bridge
Bridge/Base
This table contains global bridge information.

XML structure
<Bridge>
<Base>
<TunnelSkip></TunnelSkip>
</Base>
</Bridge>

Table description
Item Description
Feature name Bridge
Table name Base
Table type Single-instance table
Row name None
Restrictions This table supports only global configurations
Support for row creation and deletion No

Columns
Column Data type and
Column name Column type Remarks
description restrictions
Skip the
tunnel
encapsulatio Boolean:
TunnelSkip n fields N/A • true—Enabled. N/A
during • false—Disabled.
packet
parsing

Bridge/Instances
This table contains information about individual bridge instances. There are four types of bridge
instances. In a forward-type bridge instance, two member interfaces are required. In other types of
bridge instances, only one member interface is required.

1
XML structure
<Bridge>
<Instances>
<Instance>
<BridgeID></BridgeID>
<Mode></Mode>
<IfIndex1></IfIndex1>
<IfIndex2></IfIndex2>
<Bypass></Bypass>
</Instance>
</Instances>
</Bridge>

Table description
Item Description
Feature name Bridge
Table name Instances
Table type Multi-instance table
Row name Instance
Restrictions This table supports the interface only in un-shared mode.
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name Remarks
description type restrictions

Unsigned integer. The value 0 means to

BridgeID Bridge ID Index create a new bridge
Value range: 0-128. instance.
The mode of bridge
instance：
Mode of the Unsigned integer. 1: inter-vlan
Mode bridge N/A
instance. Value range:1 to 4. 2: reflect
3: blackhole
4: forward
Some versions
support interface
name. For relevant
IfIndex1 Interface index N/A Unsigned integer. information, see the
XSD document of
your product.
Applicable to only
Ethernet and POS

2
 Column Column Data type and
Column name Remarks
description type restrictions
interfaces.
I Some versions
support interface
name. For relevant
information, see the
IfIndex2 Interface index N/A Unsigned integer. XSD document of
your product.
Applicable to only
Ethernet and POS
interfaces.
Status of the
security Boolean:
service
Bypass
processing
N/A • true—Enabled. N/A
bypass • false—Disabled.
feature.

3
Contents
Bridge ····························································································1
Bridge/Base ······························································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Bridge/Instances ························································································································ 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
Bridge/Specification ···················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3

i
Bridge
Bridge/Base
This table contains global bridge information.

XML structure
<Bridge>
<Base>
<TunnelSkip></TunnelSkip>
</Base>
</Bridge>

Table description
Item Description
Feature name Bridge
Table name Base
Table type Single-instance table
Row name None
Restrictions This table supports only global configurations

Columns
Column Data type and
Column name Column type Remarks
description restrictions
Skip the
tunnel
encapsulatio Boolean:
TunnelSkip n fields N/A • true—Enabled. N/A
during • false—Disabled.
packet
parsing

Bridge/Instances
This table contains information about individual bridge instances. There are four types of bridge
instances. In a forward-type bridge instance, two member interfaces are required. In other types of
bridge instances, only one member interface is required.

1
XML structure
<Bridge>
<instances>
<Instance>
<BridgeID></BridgeID>
<Mode></Mode>
<IfIndex1></IfIndex1>
<IfIndex2></IfIndex2>
<Bypass></Bypass>
</Instance>
</Instances>
</Bridge>

Table description
Item Description
Feature name Bridge
Table name Instances
Table type Multi-instance table
Row name Instance
Restrictions This table supports the interface only in un-shared mode.

Columns
Column Column Data type and
Column name Remarks
description type restrictions

Unsigned integer. The value 0 means to

BridgeID Bridge ID Index create a new bridge
Value range: 0-128. instance.
The mode of bridge
instance：
Mode of the Unsigned integer. 1: inter-vlan
Mode bridge N/A
instance. Value range:1 to 4. 2: reflect
3: blackhole
4: forward
Some versions
support interface
name. For relevant
information, see the
IfIndex1 Interface index N/A Unsigned integer. XSD document of
your product.
Applicable to only
Ethernet and POS
interfaces.

IfIndex2 Interface index N/A Unsigned integer. Some versions

support interface

2
 Column Column Data type and
Column name Remarks
description type restrictions
name. For relevant
information, see the
XSD document of
your product.
Applicable to only
Ethernet and POS
interfaces.
Status of the
security Boolean:
service
Bypass
processing
N/A • true—Enabled. N/A
bypass • false—Disabled.
feature.

Bridge/Specification
This table contains bridge specification information of the current device.

XML structure
<Bridge>
<Specification>
<SupportInline></SupportInline>
</Specification>
</Bridge>

Table description
Item Description
Feature name Bridge
Table name Specification
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column name Column description Column type Data type and restrictions

Support for the Boolean:

SupportInline inline-forward N/A • true.
configurations. • false.

3
Contents
BufferMonitor ··················································································1
BufferMonitor/GlobalConfigurations ······························································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
BufferMonitor/BoardConfigurations ································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
BufferMonitor/BoardQueConfigurations ·························································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
BufferMonitor/PortQueConfigurations ····························································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5

i
BufferMonitor
BufferMonitor/GlobalConfigurations
This table is used to configurate the global configurations for buffer monitor.

XML structure
<BufferMonitor>
<GlobalConfigurations>
<DropAlarmEnable></DropAlarmEnable>
<DropAlarmInterval></DropAlarmInterval>
<IngressAlarmEnable></IngressAlarmEnable>
<IngressAlarmInterval></IngressAlarmInterval>
<EgressAlarmEnable></EgressAlarmEnable>
<EgressAlarmInterval></EgressAlarmInterval>
<HeadroomAlarmEnable></HeadroomAlarmEnable>
<HeadroomAlarmInterval></HeadroomAlarmInterval>
</GlobalConfigurations>
</BufferMonitor>

Table description
Item Description
Feature name BufferMonitor
Table name GlobalConfigurations
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion None

Columns
Column Column
Column description Data type and restrictions
name type
Enumeration:
DropAlarmEn
Drop alarm enable status N/A 1 ENABLE.
able
2 DISABLE.

DropAlarmInt Unsigned integer.

Drop alarm suppression interval. N/A
erval Value range: 0 to 60.

1
 Column Column
Column description Data type and restrictions
name type
Enumeration:
IngressAlarm
Ingress threshold alarm enable status N/A 1 ENABLE.
Enable
2 DISABLE.

IngressAlarmI Ingress threshold alarm suppression Unsigned integer.

N/A
nterval interval. Value range: 0 to 60.
Enumeration:
EgressAlarm
Egress threshold alarm enable status N/A 1 ENABLE.
Enable
2 DISABLE.

EgressAlarmI Egress threshold alarm suppression Unsigned integer.

N/A
nterval interval. Value range: 0 to 60.
Enumeration:
HeadroomAla Headroom threshold alarm enable
N/A 1 ENABLE.
rmEnable status
2 DISABLE.

HeadroomAla Headroom threshold alarm Unsigned integer.

N/A
rmInterval suppression interval. Value range: 0 to 60.

BufferMonitor/BoardConfigurations
This table is used to configurate the node’s configuration for buffer monitor.

XML structure
<BufferMonitor>
<BoardConfigurations>
<BoardConfiguration>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<HeadroomThreshold></HeadroomThreshold>
</BoardConfiguration>
</BoardConfigurations>
</BufferMonitor>

Table description
Item Description
Feature name BufferMonitor
Table name BoardConfigurations
Table type Multi-instance table
Row name BoardConfiguration
Restrictions None

2
 Item Description
Support for row creation and deletion No

Columns
Column
Column description Column type Data type and restrictions
name
ID of the member where the entity Unsigned integer.
Chassis Index
resides Value range: 0 to 65535.
Unsigned integer.
Slot Slot ID of the entity Index
Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index
Value range: 0 to 7.
HeadroomThr Unsigned integer.
Headroom threshold in ratio. N/A
eshold Value range: 1 to 100.

BufferMonitor/BoardQueConfigurations
This table is used to configurate the queue of node for buffer monitor.

XML structure
<BufferMonitor>
<BoardQueConfigurations>
<BoardQueConfiguration>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<QueIndex></QueIndex>
<IngressThreshold></IngressThreshold>
<EgressThreshold></EgressThreshold>
</BoardQueConfiguration>
</BoardQueConfigurations>
</BufferMonitor>

Table description
Item Description
Feature name BufferMonitor
Table name BoardQueConfigurations
Table type Multi-instance table
Row name BoardQueConfiguration
Restrictions None

3
 Item Description
Support for row creation and deletion No

Columns
Column
Column description Column type Data type and restrictions
name
ID of the member where the entity Unsigned integer.
Chassis Index
resides Value range: 0 to 65535.
Unsigned integer.
Slot Slot ID of the entity Index
Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index
Value range: 0 to 7.
Unsigned integer.
QueIndex Queue index Index
Value range: 0 to 7.

IngressThr Unsigned integer.

Ingress threshold in ratio. N/A
eshold Value range: 1 to 100.

EgressThr Unsigned integer.

Egress threshold in ratio. N/A
eshold Value range: 1 to 100.

BufferMonitor/PortQueConfigurations
This table is used to configurate the queue of interface for buffer monitor..

XML structure
<BufferMonitor>
<PortQueConfigurations>
<PortQueConfiguration>
<IfIndex></IfIndex>
<QueIndex></QueIndex>
<IngressThreshold></IngressThreshold>
<EgressThreshold></EgressThreshold>
<HeadroomThreshold></HeadroomThreshold>
</PortQueConfiguration>
</PortQueConfigurations>
</BufferMonitor>

Table description
Item Description
Feature name BufferMonitor
Table name PortQueConfigurations

4
 Item Description
Table type Multi-instance table
Row name PortQueConfiguration
Restrictions None
Support for row creation and deletion Yes

Columns
Column
Column description Column type Data type and restrictions
name
IfIndex Interface index Index Unsigned integer.
Unsigned integer.
QueIndex Queue index Index
Value range: 0 to 7.

IngressThres Unsigned integer.

Ingress threshold in ratio. N/A
hold Value range: 1 to 100.

EgressThresh Unsigned integer.

Egress threshold in ratio. N/A
old Value range: 1 to 100.

HeadroomThr Headroom threshold in Unsigned integer.

N/A
eshold ratio. Value range: 1 to 100.

5
Contents
BufferMonitor ··················································································1
BufferMonitor/EgressDrops ·········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
BufferMonitor/BoardEgressDrops ·································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3

i
BufferMonitor
BufferMonitor/EgressDrops
This table is used to get the egress drops data for buffer monitor.

XML structure
<BufferMonitor>
<EgressDrops>
<EgressDrop>
<IfIndex/>
<IfName/>
<UnicastDroppedPkts/>
<UnicastDroppedBytes/>
<MulticastDroppedPkts/>
<MulticastDroppedBytes/>
<DroppedPkts/>
<DroppedBytes/>
</EgressDrop>
</EgressDrops>
</BufferMonitor>

Table description
Item Description
Feature name BufferMonitor
Table name EgressDrops
Table type Multi-instance table
Row name EgressDrop
Restrictions None

Columns
Column
Column name Column type Data type and restrictions
description
IfIndex Interface index Index Unsigned integer.
String.
Full name of an Length: 2 to 47 characters.
IfName N/A
interface Example:
GigabitEthernet2/0/2

UnicastDroppedPk Number of packets N/A Unsigned integer64

1
 Column
Column name Column type Data type and restrictions
description
ts lost in outgoing
unicast queue
Number of bytes
UnicastDroppedBy
lost in outgoing N/A Unsigned integer64
tes
unicast queue
Number of packets
MulticastDroppedP
lost in outgoing N/A Unsigned integer64
kts
Multicast queue
Number of bytes
MulticastDroppedB
lost in outgoing N/A Unsigned integer64
ytes
Multicast queue
Number of packets
DroppedPkts lost in specific N/A Unsigned integer64
interface
Number of bytes
DroppedBytes lost in specific N/A Unsigned integer64
interface

BufferMonitor/BoardEgressDrops
This table is used to get the slot egress drops data for buffer monitor.

XML structure
<BufferMonitor>
<BoardEgressDrops>
<BoardEgressDrop>
<Chassis/>
<Slot/>
<Cpu/>
<DroppedPkts/>
<DroppedBytes/>
</BoardEgressDrop>
</BoardEgressDrops>
</BufferMonitor>

Table description
Item Description
Feature name BufferMonitor
Table name BoardEgressDrops
Table type Multi-instance table
Row name BoardEgressDrop
Restrictions None

2
Columns
Column
Column name Column type Data type and restrictions
description
Chassis Chassis number Index Unsigned integer.
Slot Slot number Index Unsigned integer.
Cpu Cpu number Index Unsigned integer.
Number of packets
lost in Egress
DroppedPkts N/A Unsigned integer64
direction at whole
slot
Number of bytes
lost in Egress
DroppedBytes N/A Unsigned integer64
direction at whole
slot

3
Contents
BufferMonitor event stream ································································1
BoardOverrunEvent event ··········································································································1
XML structure for event subscription ······················································································1
XML structure for event report ······························································································2
PortQueOverrunEvent event·······································································································3
XML structure for event subscription ······················································································3
XML structure for event report ······························································································4
PortQueDropEvent event ···········································································································5
XML structure for event subscription ······················································································5
XML structure for event report ······························································································6

i
 批注 [ls1]: Need confirmed by

BufferMonitor event stream product

BoardOverrunEvent event
This event is used to report counters of board overrun threshold.

XML structure for event subscription

<BoardOverrunEvent>
<BoardOverrun>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<AlarmType></AlarmType>
</BoardOverrun>
</BoardOverrunEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns ="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>BufferMonitor</stream>
<filter>
<BoardOverrunEvent xmlns="http://www.h3c.com/netconf/event:1.0/BufferMonitor:1.0">
<BoardOverrun>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
<AlarmType>1</AlarmType>
</BoardOverrun>
</BoardOverrunEvent>
</filter>
</create-subscription>
</rpc>]]>]]>

Table description

Item Description
Event stream name BufferMonitor
Event name BoardOverrunEvent
Event namespace http://www.h3c.com/netconf/event:1.0/BufferMonitor:1.0
Support for extended query No

1
Columns

Support for
Column Column Data type and
extended Remarks
name description restrictions
query
Member ID of
the member Unsigned integer.
Chassis device where No N/A
the entity Value range: 0 to 65535.
resides
Slot number of Unsigned integer.
Slot the device No N/A
node Value range: 0 to 65535.

Unsigned integer.
CPUID ID of the CPU. No N/A
Value range: 0 to 65535.
1—for
AlarmType Alarm type. Unsigned integer. Headroom Alarm type.
overrun

XML structure for event report

<BoardOverrunEvent>
<BoardOverrun>
<Chassis/>
<Slot/>
<CPUID/>
<AlarmType/>
<CurrentValue/>
<CurrentRatio/>
<Threshold/>
</BoardOverrun>
<BoardOverrunEvent>

Table description

Column
Column description Data type and restrictions Remarks
name
Member ID of the Unsigned integer.
Chassis member device where N/A
the entity resides Value range: 0 to 65535.

Slot number of the Unsigned integer.

Slot N/A
device node Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU. N/A
Value range: 0 to 65535.
AlarmType Alarm type. Unsigned integer. 1—for Headroom overrun
Unsigned integer.
CurrentValue Current value.
Value range: 0 to 65535.
Unsigned integer.
CurrentRatio Current usage ratio.
Value range: 1 to 100.

2
 Column
Column description Data type and restrictions Remarks
name
Unsigned integer.
Threshold Threshold usage ratio.
Value range: 1 to 100.

PortQueOverrunEvent event
This event is used to report counters of interface’s queue overrun threshold.

XML structure for event subscription

<PortQueOverrunEvent>
<PortQueOverrun>
<IfIndex></IfIndex>
<QueIndex></QueIndex>
<AlarmType></AlarmType>
<IfName></IfName>
</PortQueOverrun>
</PortQueOverrunEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns ="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>BufferMonitor</stream>
<filter>
<PortQueOverrunEvent xmlns="http://www.h3c.com/netconf/event:1.0/BufferMonitor:1.0">
<PortQueOverrun>
<IfIndex>20</IfIndex>
<QueIndex>1</QueIndex>
<AlarmType>2</AlarmType>
<IfName>GigabitEthernet2/0/2</IfName>
</PortQueOverrun>
</PortQueOverrunEvent>
</filter>
</create-subscription>
</rpc>]]>]]>

Table description

Item Description
Event stream name BufferMonitor
Event name PortQueOverrunEvent
Event namespace http://www.h3c.com/netconf/event:1.0/BufferMonitor:1.0
Support for extended query No

3
Columns

Column Column Data type and Support for

Remarks
name description restrictions extended query
IfIndex Interface index Unsigned integer. No N/A
QueIndex Queue index Unsigned integer. No N/A
1— for ingress
overrun
2— for egress
AlarmType Alarm type. Unsigned integer. No overrun
3— for
headroom
overrun
String.
Full name of Length: 2 to 47 characters.
IfName No N/A
an interface Example:
GigabitEthernet2/0/2

XML structure for event report

<PortQueOverrunEvent>
<IfIndex></IfIndex>
<QueIndex></QueIndex>
<AlarmType></AlarmType>
<CurrentValue><CurrentValue>
<CurrentRatio></CurrentRatio>
<Threshold></Threshold>
<IfName></IfName>
</PortQueOverrunEvent>

Table description

Column
Column description Data type and restrictions Remarks
name
IfIndex Interface index Unsigned integer. N/A
QueIndex Queue index Unsigned integer. N/A
1— for ingress overrun
AlarmType Alarm type. Unsigned integer. 2— for egress overrun
3— for headroom overrun
CurrentValue Current value. Unsigned integer.
Unsigned integer.
CurrentRatio Current usage ratio.
Value range: 1 to 100.
Unsigned integer.
Threshold Threshold usage ratio.
Value range: 1 to 100.
String.
Full name of an
IfName Length: 2 to 47 characters. N/A
interface
Example:

4
PortQueDropEvent event
This event is used to report counters of interface’s queue drop threshold.

XML structure for event subscription

<PortQueDropEvent>
<PortQueDrop>
<IfIndex></IfIndex>
<QueIndex></QueIndex>
<AlarmType></AlarmType>
<IfName></IfName>
</PortQueDrop>
</PortQueDropEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns ="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>BufferMonitor</stream>
<filter>
<PortQueDropEvent xmlns="http://www.h3c.com/netconf/event:1.0/BufferMonitor:1.0">
<PortQueDrop>
<IfIndex>20</IfIndex>
<QueIndex>1</QueIndex>
<AlarmType>2</AlarmType>
<IfName>GigabitEthernet2/0/2</IfName>
</PortQueDrop>
</PortQueDropEvent>
</filter>
</create-subscription>
</rpc>]]>]]>

Table description

Item Description
Event stream name BufferMonitor
Event name PortQueDropEvent
Event namespace http://www.h3c.com/netconf/event:1.0/BufferMonitor:1.0
Support for extended query No

Columns

Column Column Data type and Support for

Remarks
name description restrictions extended query
IfIndex Interface index Unsigned integer. No N/A
QueIndex Queue index Unsigned integer. No N/A
AlarmType Alarm type. Unsigned integer. No 1— for ingress

5
 Column Column Data type and Support for
Remarks
name description restrictions extended query
drops
2— for egress
drops
String.
Full name of Length: 2 to 47 characters.
IfName No N/A
an interface Example:
GigabitEthernet2/0/2

XML structure for event report

<PortQueDropEvent>
<IfIndex></IfIndex>
<QueIndex></QueIndex>
<AlarmType></AlarmType>
<DropCounters></DropCounters>
<IfName></IfName>
</PortQueDropEvent>

Table description

Column
Column description Data type and restrictions Remarks
name
IfIndex Interface index Unsigned integer. N/A
QueIndex Queue indexs Unsigned integer. N/A
1— for ingress drops
AlarmType Alarm type. Unsigned integer.
2— for egress drops
DropCounters Current value. Unsigned integer.
String.
Full name of an Length: 2 to 47 characters.
IfName N/A
interface Example:
GigabitEthernet2/0/2

6
Contents
BYOD ····························································································1
BYOD/DhcpOption55Rules ·········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
BYOD/UserAgentRules ··············································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
BYOD/MacRules························································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
BYOD/AuthorizationInfos ············································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4

i
BYOD
BYOD/DhcpOption55Rules
BYOD DHCP Option 55 rule table for endpoint identification.

XML structure
<BYOD>
<DhcpOption55Rules>
<DhcpOption55Rule>
<DhcpOption55Value></DhcpOption55Value>
<DeviceType></DeviceType>
</DhcpOption55Rule>
</DhcpOption55Rules>
</BYOD>

Table description
Item Description
Feature name BYOD
Table name DhcpOption55Rules
Table type Multi-instance table
Row name DhcpOption55Rule
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions
name description type
DhcpOption5 DHCP Option 55 String.
Index
5Value value. Length: 1 to 255 characters.
String.
DeviceType Device type. N/A
Length: 1 to 127 characters.

BYOD/UserAgentRules
BYOD HTTP user agent rule table for endpoint identification.

1
XML structure
<BYOD>
<UserAgentRules>
<UserAgentRule>
<UserAgentValue></UserAgentValue>
<DeviceType></DeviceType>
</UserAgentRule>
</UserAgentRules>
</BYOD>

Table description
Item Description
Feature name BYOD
Table name UserAgentRules
Table type Multi-instance table
Row name UserAgentRule
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions
name description type
UserAgentVal HTTP user agent String.
Index
ue value. Length: 1 to 255 characters.
String.
DeviceType Device type. N/A
Length: 1 to 127 characters.

BYOD/MacRules
BYOD MAC address rule table for endpoint identification.

XML structure
<BYOD>
<MacRules>
<MacRule>
<MacAddr></MacAddr>
<MacMask></MacMask>
<DeviceType></DeviceType>

2
 </MacRule>
</MacRules>
</BYOD>

Table description
Item Description
Feature name BYOD
Table name MacRules
Table type Multi-instance table
Row name MacRule
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
MacAddr MAC address. Index String, six groups of two For example,
hexadecimal digits, 00-0c-af-e3-5d-c0.
hyphen-separated.
Length: 1 to 17 characters.
MacMask MAC address Index String, six groups of two The significant bits
mask. hexadecimal digits, must be consecutive
hyphen-separated. Fs.
Length: 1 to 17 characters. For example,
ff-ff-ff-00-00-00.
DeviceType Device type. N/A String. N/A
Length: 1 to 127 characters.

BYOD/AuthorizationInfos
BYOD authorization information table.

XML structure
<BYOD>
<AuthorizationInfos>
<AuthorizationInfo>
<UserGroupName></UserGroupName>
<DeviceType></DeviceType>
<AuthorizationData>
<AclNumber></AclNumber>

3
 <CallbackNumber></CallbackNumber>
<SessTimeout></SessTimeout>
<IdleTimeout></IdleTimeout>
<PrimaryDNSServer></PrimaryDNSServer>
<PrimaryDNSIpv6Server></PrimaryDNSIpv6Server>
<SecondaryDNSServer></SecondaryDNSServer>
<SecondaryDNSIpv6Server></SecondaryDNSIpv6Server>
<URL></URL>
<UserProfile></UserProfile>
<VLANID></VLANID>
<VRF></VRF>
<IpPool></IpPool>
<Ipv6Pool></Ipv6Pool>
<SSLVPNPolicy></SSLVPNPolicy>
</AuthorizationData>
<AuthorizationIpv6PrefixInfo>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
</AuthorizationIpv6PrefixInfo>
</AuthorizationInfo>
</AuthorizationInfos>
</BYOD>

Table description
Item Description
Feature name BYOD
Table name AuthorizationInfos
Table type Multi-instance table
Row name AuthorizationInfo
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
UserGroupNa User group Index String. N/A
me name. Length: 1 to 32 characters.
DeviceType Device type. Index String. N/A
Length: 1 to 127 characters.
Authorization Authorization Data Members include: N/A
Data information. structure • AclNumber.
• CallbackNumber.

4
Column Column Column
Data type and restrictions Remarks
name description type
• FTPHomeDir.
• IdleTimeout.
• PrimaryDNSServer.
• SecondaryDNSServer.
• URL.
• UserProfile.
• VLANID.
• VRF.
• IpPool.
• Ipv6Pool.
AclNumber ACL number. N/A Unsigned integer. N/A
Value range: 2000 to 5999.
CallbackNum Callback N/A String. N/A
ber number. Length: 1 to 64 characters.
SessTimeout Session timeout. N/A Unsigned integer. N/A
Value range: 1 to 1440, in
minutes.
IdleTimeout Idle timeout N/A Unsigned integer. N/A
timer. Value range: 1 to 120, in
minutes.
PrimaryDNSS Primary DNS N/A IPv4: String, dotted decimal N/A
erver server. notation.
PrimaryDNSI Primary DNS N/A IPv6: Hexadecimal string,
pv6Server Ipv6 server. colon-separated.
SecondaryDN Secondary DNS N/A IPv4: String, dotted decimal N/A
SServer server. notation.
SecondaryDN Secondary DNS N/A IPv6: Hexadecimal string, N/A
SIpv6Server Ipv6 Server. colon-separated.
URL URL information. N/A String. N/A
Length: 1 to 255 characters.
UserProfile User profile N/A String. The name can contain
name. Length: 1 to 32 characters. digits, letters, and
underscores (_), but the
name can't start with a
digit.
VLANID ID of the N/A Unsigned integer. N/A
authorization Value range: 1 to 4094.
VLAN.
VRF Name of the N/A String. N/A
authorization Length: 1 to 31 characters.
VPN instance.
IpPool Available IP pool N/A String. N/A
name. Length: 1 to 31 characters.
Ipv6Pool Available IPv6 N/A String. N/A
pool name. Length: 1 to 63 characters.
SSLVPNPolic Name of the SSL N/A String, case-insensitive. N/A

5
Column Column Column
Data type and restrictions Remarks
name description type
y VPN policy Length: 1 to 31 characters.
assigned to the
local user.
AuthorizationI Available IPv6 Data Members include: N/A
pv6PrefixInfo prefix. structure • Ipv6Address.
• Ipv6PrefixLength.
Ipv6Address IPv6 address. N/A Hexadecimal string, For example,
colon-separated. 2003:10::1:1.
This column is effective
only when the
Ipv6PrefixLength
column is set.
Ipv6PrefixLen IPv6 prefix N/A Unsigned integer. This column is effective
gth length. Value range: 1 to 128. only when the
Ipv6Address column is
set.

6
Contents
BYOD ····························································································1
BYOD/DhcpOption55Rules ·········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
BYOD/UserAgentRules ··············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
BYOD/MacRules························································································································ 2
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
BYOD/AuthorizationInfos ············································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5

i
BYOD
BYOD/DhcpOption55Rules
BYOD DHCP Option 55 rule table for endpoint identification.

XML structure
<BYOD>
<DhcpOption55Rules>
<DhcpOption55Rule>
<DhcpOption55Value></DhcpOption55Value>
<DeviceType></DeviceType>
<RuleClass></RuleClass>
</DhcpOption55Rule>
</DhcpOption55Rules>
</BYOD>

Table description
Item Description
Feature name BYOD
Table name DhcpOption55Rules
Table type Multi-instance table
Row name DhcpOption55Rule
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions
name description type
DhcpOption5 DHCP Option 55 String.
Index
5Value value. Length: 1 to 255 characters.
String.
DeviceType Device type. N/A
Length: 0 to 127 characters.
Boolean:
RuleClass Rule class. N/A • True.
• False.

1
BYOD/UserAgentRules
BYOD HTTP user agent rule table for endpoint identification.

XML structure
< BYOD>
<UserAgentRules>
<UserAgentRule>
<UserAgentValue></UserAgentValue>
<DeviceType></DeviceType>
<RuleClass></RuleClass>
</UserAgentRule>
</UserAgentRules>
</BYOD>

Table description
Item Description
Feature name BYOD
Table name UserAgentRules
Table type Multi-instance table
Row name UserAgentRule
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions
name description type
UserAgentVal HTTP user agent String.
Index
ue value. Length: 1 to 255 characters.
String.
DeviceType Device type. N/A
Length: 1 to 127 characters.
Boolean:
RuleClass Rule class. N/A • True.
• False.

BYOD/MacRules
BYOD MAC address rule table for endpoint identification.

2
XML structure
< BYOD>
<MacRules>
<MacRule>
<MacAddr></MacAddr>
<MacMask></MacMask>
<DeviceType></DeviceType>
<RuleClass></RuleClass>
</MacRule>
</MacRules>
</BYOD>

Table description
Item Description
Feature name BYOD
Table name MacRules
Table type Multi-instance table
Row name MacRule
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
MacAddr MAC address. Index String, six groups of two For example,
hexadecimal digits, 00-0c-af-e3-5d-c0.
hyphen-separated.
Length: 1 to 17 characters.
MacMask MAC address Index String, six groups of two The significant bits
mask. hexadecimal digits, must be consecutive
hyphen-separated. Fs.
Length: 1 to 17 characters. For example,
ff-ff-ff-00-00-00.
DeviceType Device type. N/A String. N/A
Length: 1 to 127 characters.
Boolean: N/A
RuleClass Rule class. N/A • True.
• False.

3
BYOD/AuthorizationInfos
BYOD authorization information table.

XML structure
<BYOD>
<AuthorizationInfos>
<AuthorizationInfo>
<UserGroupName></UserGroupName>
<DeviceType></DeviceType>
<AuthorizationData>
<AclNumber></AclNumber>
<CallbackNumber></CallbackNumber>
<SessTimeout></SessTimeout>
<IdleTimeout></IdleTimeout>
<PrimaryDNSServer></PrimaryDNSServer>
<PrimaryDNSIpv6Server></PrimaryDNSIpv6Server>
<SecondaryDNSServer></SecondaryDNSServer>
<SecondaryDNSIpv6Server></SecondaryDNSIpv6Server>
<URL></URL>
<UserProfile></UserProfile>
<VLANID></VLANID>
<VRF></VRF>
<IpPool></IpPool>
<Ipv6Pool></Ipv6Pool>
<SSLVPNPolicy></SSLVPNPolicy>
</AuthorizationData>
<AuthorizationIpv6PrefixInfo>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
</AuthorizationIpv6PrefixInfo>
</AuthorizationInfo>
</AuthorizationInfos>
</BYOD>

Table description
Item Description
Feature name BYOD
Table name AuthorizationInfos
Table type Multi-instance table

4
 Row name AuthorizationInfo
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
UserGroupNa User group Index String. N/A
me name. Length: 1 to 32 characters.
DeviceType Device type. Index String. N/A
Length: 1 to 127 characters.
Authorization Authorization Data Members include: N/A
Data information. structure • AclNumber.
• CallbackNumber.
• FTPHomeDir.
• IdleTimeout.
• PrimaryDNSServer.
• SecondaryDNSServer.
• URL.
• UserProfile.
• VLANID.
• VRF.
• IpPool.
• Ipv6Pool.
AclNumber ACL number. N/A Unsigned integer. N/A
Value range: 2000 to 5999.
CallbackNum Callback N/A String. N/A
ber number. Length: 1 to 64 characters.
SessTimeout Session timeout. N/A Unsigned integer. N/A
Value range: 1 to 1440, in
minutes.
IdleTimeout Idle timeout N/A Unsigned integer. N/A
timer. Value range: 1 to 120, in
minutes.
PrimaryDNSS Primary DNS N/A IPv4: String, dotted decimal N/A
erver server. notation.
PrimaryDNSI Primary DNS N/A IPv6: Hexadecimal string, N/A
pv6Server Ipv6 server. colon-separated.
SecondaryDN Secondary DNS N/A IPv4: String, dotted decimal N/A
SServer server. notation.
SecondaryDN Secondary DNS N/A Ipv6: Hexadecimal string, N/A
SIpv6Server Ipv6 server. colon-separated.
\URL URL information. N/A String. N/A
Length: 1 to 255 characters.

5
Column Column Column
Data type and restrictions Remarks
name description type
UserProfile User profile N/A String. The name can contain
name. Length: 1 to 32 characters. digits, letters, and
underscores (_), but the
name can't start with a
digit.
VLANID ID of the N/A Unsigned integer. N/A
authorization Value range: 1 to 4094.
VLAN.
VRF Name of the N/A String. N/A
authorization Length: 1 to 31 characters.
VPN instance.
IpPool Available IP pool N/A String. N/A
name. Length: 1 to 31 characters.
Ipv6Pool Available IPv6 N/A String. N/A
pool name. Length: 1 to 63 characters.
SSLVPNPolic Name of the SSL N/A String, case-insensitive. N/A
y VPN policy Length: 1 to 31 characters.
assigned to the
local user.
AuthorizationI Available IPv6 Data Members include: N/A
pv6PrefixInfo prefix. structure • Ipv6Address.
• Ipv6PrefixLength.
Ipv6Address IPv6 address. N/A Hexadecimal string, For example,
colon-separated. 2003:10::1:1.
This column is effective
only when the
Ipv6PrefixLength
column is set.
Ipv6PrefixLen IPv6 prefix N/A Unsigned integer. This column is effective
gth length. Value range: 1 to 128. only when the
Ipv6Address column is
set.

6
Contents
BYOD ····························································································1
BYOD/DhcpOption55Rules ·········································································································· 1
BYOD/UserAgentRules ··············································································································· 1
BYOD/MacRules························································································································ 1

i
BYOD
BYOD/DhcpOption55Rules
Message Explanation
Operation not supported.
Predefined rules prohibit modification, please check your rules.
不支持该操作。

BYOD/UserAgentRules
Message Explanation
Operation not supported.
Predefined rules prohibit modification, please check your rules.
不支持该操作。

BYOD/MacRules
Message Explanation
Operation not supported.
Predefined rules prohibit modification, please check your rules.
不支持该操作。
Wrong Mask.
Invalid MAC mask, please check your MAC Mask.
错误的MAC地址掩码。
Wrong MAC address.
Invalid MAC address, please check your MAC address.
错误的MAC地址。

1
Contents
CAR ······························································································1
CAR/GlobalPolicies ···················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
CAR
CAR/GlobalPolicies
This table contains information about global committed access rate (CAR) policies.

XML structure
<CAR>
<GlobalPolicies>
<Policy>
<Name></Name>
<CountClear></CountClear>
</Policy>
</GlobalPolicies>
</CAR>

Table description
Item Description
Feature name ACL
Table name GlobalPolicies
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
Global CAR Length: 1 to 31 characters.
Name Index N/A
policy name The string must start with an
English letter.
CountClear Resets counters N/A This column must be empty. N/A

1
Contents
CAR ······························································································1
CAR/CarLists ···························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
CAR/CarPolicies ························································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
CAR/GlobalPolicies ·················································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11

i
CAR
CAR/CarLists
This table contains information about committed access rate (CAR) lists.

XML structure
<CAR>
<CarLists>
<List>
<CarlID></CarlID>
<Mac></Mac>
<DscpList>
<Dscp></Dscp>
</DscpList>
<ExpList>
<Exp></Exp>
</ExpList>
<IPPrecedenceList>
<IPPrecedence></IPPrecedence>
</IPPrecedenceList>
<DestIPRange>
<DestIPStart></DestIPStart>
<DestIPEnd></DestIPEnd>
</DestIPRange>
<SrcIPRange>
<SrcIPStart></SrcIPStart>
<SrcIPEnd></SrcIPEnd>
</SrcIPRange>
<DestIPSubnet>
<DestSubnetIP></DestSubnetIP>
<DestMaskLength></DestMaskLength>
</DestIPSubnet>
<SrcIPSubnet>
<SrcSubnetIP></SrcSubnetIP>
<SrcMaskLength></SrcMaskLength>
</SrcIPSubnet>
<SrcIPObjGroup></SrcIPObjGroup>
<DestIPObjGroup></DestIPObjGroup>
<Mode></Mode>
<Trange></Trange>
</List>
</CarLists>
</CAR>

1
Table description
Item Description
Feature name CAR
Table name CarLists
Table type Multi-instance table
Row name List
Restrictions Only one match column can be configured once.
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
CarlID CAR list number Index N/A
Value range: 1 to 199.
Six groups of two
Match the MAC Example:
Mac N/A hexadecimal digits,
address 00-0c-af-e3-5d-c0.
hyphen-separated.

Match DSCP Unsigned integer. You can specify up to 8

Dscp N/A
values. Dscp for a rule
Value range: 0 to 63.

Match MPLS Unsigned integer. You can specify up to 8

Exp N/A
EXP value. Exp for a rule
Value range: 0 to 7.

Match IP Unsigned integer. You can specify up to 8

IPPrecedence N/A
precedence. IPPrecedence for a rule
Value range: 0 to 7.

Match Members include:

Data The two members must
DestIPRange destination IP by
structure • DestIPStart both be specified.
range. • DestIPEnd

DestIPStart Start IP of range. N/A String, dotted decimal Example: 10.153.93.54.

notation.
Example: 10.153.93.60.
DestIPEnd End IP of range. N/A String, dotted decimal DestIPEnd must be
notation. bigger than DestIPStart.
Members include:
Match source IP Data The two members must
SrcIPRange
by range. structure • SrcIPStart both be specified.
• SrcIPEnd

SrcIPStart Start IP of range. N/A String, dotted decimal Example: 10.153.93.54.

notation.
Example: 10.153.93.60.
SrcIPEnd End IP of range. N/A String, dotted decimal SrcIPEnd must be bigger
notation. than SrcIPStart.

2
 Match Members include:
Data The two members must
DestIPSubnet destination IP by
structure • DestSubnetIP both be specified.
subnet. • DestMaskLength

DestSubnetIP Subnet IP. N/A String, dotted decimal Example: 10.153.93.60.

notation.
The maximum value is 31.
DestMaskLen
MaskLength. N/A Unsigned integer. The minimum value varies
gth
by device model.
Members include:
Match source IP Data The two members must
SrcIPSubnet
by subnet. structure • SrcSubnetIP both be specified.
• SrcMaskLength

SrcSubnetIP Subnet IP. N/A String, dotted decimal Example: 10.153.93.60.

notation.
The maximum value is 31.
SrcMaskLeng
MaskLength. N/A Unsigned integer. The minimum value varies
th
by device model.
The object group name
can’t contain ‘?’.
SrcIPObjGrou Match source IP String case insensitive. The character ‘\r\n’ in
N/A
p by object group. Length: 1 to 31 characters. object group name can’t
be treated as escape
character.
The object group name
can’t contain ‘?’.
Match
DestIPObjGro String case insensitive. The character ‘\r\n’ in
destination IP by N/A
up Length: 1 to 31 object group name can’t
object group.
be treated as escape
character.
It can be specified when
SrcIPSubnet or
DestIPSubnet or
SrcIPRange or
DestIPRange is specified.
When the Mode column is
1, Per-IP address rate is
limited within the network
Enumeration: segment, and traffic of all
IP addresses within the
Mode Match Mode. N/A • 1—PerAddress. network segment doesn’t
• 2—SharedBandwidth. share the remaining
bandwidth.
When the Mode column is
2, Per-IP address rate is
limited within the network
segment, and traffic of all
IP addresses within the
network segment shares
the remaining bandwidth.
The time range name
String, case-insensitive. cannot be all and the ‘?’
Name of the time should not be used.
Trange N/A
range Length: 1 to 32 characters.
The character ‘\r\n’ in time
range name can’t be

3
 treated as escape
character.

CAR/CarPolicies
This table contains information about CAR policies.

XML structure
<CAR>
<CarPolicies>
<Policy>
<IfIndex></IfIndex>
<Direction></Direction>
<Type></Type>
<Value></Value>
<BandwithUnit></BandwithUnit>
<Name></Name>
<CIR></CIR>
<CBS></CBS>
<EBS></EBS>
<PIR></PIR>
<GreenAction>
<GreenActionType></GreenActionType>
<GreenActionValue></GreenActionValue>
</GreenAction>
<YellowAction>
<YellowActionType></YellowActionType>
<YellowActionValue></YellowActionValue>
</YellowAction>
<RedAction>
<RedActionType></RedActionType>
<RedActionValue></RedActionValue>
</RedAction>
</Policy>
</CarPolicies>
</CAR>

Table description
Item Description
Feature name CAR
Table name CarPolicies
Table type Multi-instance table
Row name Policy

4
 Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Some versions support
interface name. For
IfIndex Interface index Index Unsigned integer. relevant information, see
the XSD document of your
product.
Enumeration:
Application
Direction
direction
Index • 0—Inbound. N/A
• 1—Outbound.
Enumeration :
• 1—IPv4Acl
Type Match type Index • 2—IPv6Acl N/A
• 3—Carl
• 4—Any
When Type is 1, the value
is 2000~5999.
When Type is 2, the value
is 2000~3999.
Value Match type value Index Unsigned integer. When Type is 3, the value
is 1~199.
When Type is 4, this
column only can be
configured as 0.
Enumeration: If this column is not
Specify the
BandwithUnit
bandwidth unit
N/A • 2—kbps configured, the default
• 3—percent. bandwith unit is kbps.

String. This column cannot be

configured together with
Aggregate CAR Length: 1 to 31 characters. the other column.
Name N/A
policy name The string must start with an This column support only
English letter. when BandwithUnit is 3.
Required when the Name
is not specified.
Committed
CIR N/A Unsigned integer. When BandwithUnit is 3,
information rate
the value range is 1 to
100.
When BandwithUnit is 3,
Committed burst
CBS N/A Unsigned integer. the value range is 50 to
size
2000.
If CBS or PIR is not
configured, EBS cannot
Excess burst be configured.
EBS N/A Unsigned integer.
size
When BandwithUnit is 3,
the value range is 0 to

5
Column Column Column
Data type and restrictions Remarks
name description type
2000.
When BandwithUnit is 3,
Peak information
PIR N/A Unsigned integer. the value range is 1 to
rate
100.

Members include: GreenActionValue is

Specify behavior Data required when
GreenAction
for green packets structure • GreenActionType GreenActionType is not 1,
• GreenActionValue 10 or 19.
The default
GreenActionType is pass.
When GreenActionType
is 1, send the packet.
When GreenActionType
is 2, remark DSCP value
of the packet and send it.
When GreenActionType
is 3, remark IP
Enumeration: precedence of the packet
• 1—pass. and send it.
• 2—remark-dscp-pass When GreenActionType
• 3—remark-precedence- is 4, remark EXP of the
pass MPLS packet and send it.
• 4—remark-mpls-exp-pa When GreenActionType
ss is 5, remark 802.1p
• 5—remark-dot1p-pass priority value of the packet
and send it.
• 6—remark-atm-clp-pass
• 7—remark-fr-de-pass When GreenActionType
is 6, remark CLP bit of the
• 8—remark-local-prec-p
ATM packet and send it.
ass
• 10—discard When GreenActionType
GreenActionT is 7, remark DE bit of the
Action type N/A • 11—remark-dscp-contin FR packet and send it.
ype
ue
When GreenActionType
• 12—remark-precedenc
is 8, drop the packet.
e-continue
• 13—remark-mpls-exp-c When GreenActionType
ontinue is 10, remark local
precedence of the packet
• 14—remark-dot1p-conti and send it.
nue
When GreenActionType
• 15—remark-atm-clp-co
is 11, remark DSCP value
ntinue.
of the packet and continue
• 16—remark-fr-de-contin to process it using the
ue. next CAR policy.
• 17—remark-local-prec-c When GreenActionType
ontinue. is 12, remark IP
• 19—continue. precedence of the packet
and continue to process it
using the next CAR policy.
When GreenActionType
is 13, remark EXP of the
MPLS packet and
continue to process it
using the next CAR policy.
When GreenActionType
is 14, remark 802.1p

6
Column Column Column
Data type and restrictions Remarks
name description type
priority value of the packet
and continue to process it
using the next CAR policy.
When GreenActionType
is 15, remark CLP bit of
the ATM packet and
continue to process it
using the next CAR policy.
When GreenActionType
is 16, remark DE bit of the
FR packet and continue to
process it using the next
CAR policy.
When GreenActionType
is 17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When GreenActionType
is 19, continue to process
the packet using the next
CAR policy.
When GreenActionType
is 1, 10 or 19,
GreenActionValue is
invalid.
When GreenActionType
is 6, 7, 15, 16,
GreenActionValue is
GreenActionV Unsigned integer. 0~1.
Action value N/A
alue Value range: 0 to 63. When GreenActionType
is 3, 4, 5, 8, 12, 13, 14, 17,
GreenActionValue is
0~7.
When GreenActionType
is 2, 11,
GreenActionValue is
0~63.

Members include: YellowActionValue is

Specify behavior
Data required when
YellowAction for Yellow
structure • YellowActionType GreenActionType is not 1,
packets • YellowActionValue 10 or 19.

Enumeration: The default

YellowActionType is pass.
• 1—pass.
• 2—remark-dscp-pass When YellowActionType
is 1, send the packet.
• 3—remark-precedence-
pass When YellowActionType
is 2, remark DSCP value
• 4—remark-mpls-exp-pa
YellowAction of the packet and send it.
Action type N/A ss
Type When YellowActionType
• 5—remark-dot1p-pass
is 3, remark IP
• 6—remark-atm-clp-pass precedence of the packet
• 7—remark-fr-de-pass and send it.
• 8—remark-local-prec-p When YellowActionType
ass is 4, remark EXP of the
• 10—discard MPLS packet and send it.

7
Column Column Column
Data type and restrictions Remarks
name description type
• 11—remark-dscp-contin When YellowActionType
ue is 5, remark 802.1p
• 12—remark-precedenc priority value of the packet
e-continue and send it.
• 13—remark-mpls-exp-c When YellowActionType
ontinue is 6, remark CLP bit of the
• 14—remark-dot1p-conti ATM packet and send it.
nue When YellowActionType
• 15—remark-atm-clp-co is 7, remark DE bit of the
ntinue. FR packet and send it.
• 16—remark-fr-de-contin When YellowActionType
ue. is 8, drop the packet.
• 17—remark-local-prec-c When YellowActionType
ontinue. is 10, remark local
• 19—continue. precedence of the packet
and send it.
When YellowActionType
is 11, remark DSCP value
of the packet and continue
to process it using the
next CAR policy.
When YellowActionType
is 12, remark IP
precedence of the packet
and continue to process it
using the next CAR policy.
When YellowActionType
is 13, remark EXP of the
MPLS packet and
continue to process it
using the next CAR policy.
When YellowActionType
is 14, remark 802.1p
priority value of the packet
and continue to process it
using the next CAR policy.
When YellowActionType
is 15, remark CLP bit of
the ATM packet and
continue to process it
using the next CAR policy.
When YellowActionType
is 16, remark DE bit of the
FR packet and continue to
process it using the next
CAR policy.
When YellowActionType
is 17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When YellowActionType
is 19, continue to process
the packet using the next
CAR policy.
YellowAction When YellowActionType
Action value N/A Unsigned integer.
Value is 1, 10 or 19,

8
Column Column Column
Data type and restrictions Remarks
name description type
Value range: 0 to 63. YellowActionValue is
invalid.
When YellowActionType
is 6, 7, 15, 16,
YellowActionValue is
0~1.
When YellowActionType
is 3, 4, 5, 8, 12, 13, 14, 17,
YellowActionValue is
0~7.
When YellowActionType
is 2, 11,
YellowActionValue is
0~63.

Members include: RedActionValue is

Specify behavior Data required when
RedAction
for Red packets structure • RedActionType GreenActionType is not 1,
• RedActionValue 10 or 19.
The default
RedActionType is discard.
When RedActionType is
1, send the packet.
Enumeration: When RedActionType is
• 1—pass. 2, remark DSCP value of
• 2—remark-dscp-pass the packet and send it.
• 3—remark-precedence- When RedActionType is
pass 3, remark IP precedence
• 4—remark-mpls-exp-pa of the packet and send it.
ss When RedActionType is
• 5—remark-dot1p-pass 4, remark EXP of the
MPLS packet and send it.
• 6—remark-atm-clp-pass
• 7—remark-fr-de-pass When RedActionType is
5, remark 802.1p priority
• 8—remark-local-prec-p
value of the packet and
ass
send it.
• 10—discard
RedActionTyp When RedActionType is
Action type N/A • 11—remark-dscp-contin 6, remark CLP bit of the
e
ue ATM packet and send it.
• 12—remark-precedenc
When RedActionType is
e-continue
7, remark DE bit of the FR
• 13—remark-mpls-exp-c packet and send it.
ontinue
When RedActionType is
• 14—remark-dot1p-conti 8, drop the packet.
nue
When RedActionType is
• 15—remark-atm-clp-co
10, remark local
ntinue
precedence of the packet
• 16—remark-fr-de-contin and send it.
ue
When RedActionType is
• 17—remark-local-prec-c 11, remark DSCP value of
ontinue. the packet and continue to
• 19—continue. process it using the next
CAR policy.
When RedActionType is
12, remark IP precedence
of the packet and continue

9
 Column Column Column
Data type and restrictions Remarks
name description type
to process it using the
next CAR policy.
When RedActionType is
13, remark EXP of the
MPLS packet and
continue to process it
using the next CAR policy.
When RedActionType is
14, remark 802.1p priority
value of the packet and
continue to process it
using the next CAR policy.
When RedActionType is
15, remark CLP bit of the
ATM packet and continue
to process it using the
next CAR policy.
When RedActionType is
16, remark DE bit of the
FR packet and continue to
process it using the next
CAR policy.
When RedActionType is
17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When RedActionType is
19, continue to process
the packet using the next
CAR policy.
When RedActionType is
1, 10 or 19,
RedActionValue is
invalid.
When RedActionType is
6, 7, 15, 16,
RedActionVal Unsigned integer.
Action value N/A RedActionValue is 0~1.
ue Value range: 0 to 63.
When RedActionType is
3, 4, 5, 8, 12, 13, 14, 17,
RedActionValue is 0~7.
When RedActionType is
2, 11, RedActionValue is
0~63.

CAR/GlobalPolicies
This table contains information about global CAR policies.

XML structure
<CAR>
<GlobalPolicies>

10
 <Policy>
<Name></Name>
<Type></Type>
<CIR></CIR>
<CBS></CBS>
<EBS></EBS>
<PIR></PIR>
<GreenAction>
<GreenActionType></GreenActionType>
<GreenActionValue></GreenActionValue>
</GreenAction>
<YellowAction>
<YellowActionType></YellowActionType>
<YellowActionValue></YellowActionValue>
</YellowAction>
<RedAction>
<RedActionType></RedActionType>
<RedActionValue></RedActionValue>
</RedAction>
</Policy>
</GlobalPolicies>
</CAR>

Table description
Item Description
Feature name CAR
Table name GlobalPolicies
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String.
Global CAR Length: 1 to 31 characters.
Name Index N/A
policy name The string must start with an
English letter.
Enumeration : Required.
Type Global CAR type N/A • 1—Aggregate CAR. This column cannot be
• 2—Hierarchical CAR. modified.

CIR Committed N/A Unsigned integer. Required.

11
Column Column Column Data type and
Remarks
name description type restrictions
information rate The value range for this
column depends on the
device model.
The value range for this
Committed burst
CBS N/A Unsigned integer. column depends on the
size
device model.
If CBS or PIR is not
configured, EBS cannot
Excess burst be configured.
EBS N/A Unsigned integer.
size The value range for this
column depends on the
device model.
The value range for this
Peak information
PIR N/A Unsigned integer. column depends on the
rate
device model.

Members include: GreenActionValue is

Specify behavior Data required when
GreenAction
for green packets structure • GreenActionType GreenActionType is not 1,
• GreenActionValue 10 or 19.
The default
GreenActionType is pass.
When GreenActionType
Enumeration: is 1, send the packet.
• 1—pass. When GreenActionType
• 2—remark-dscp-pass is 2, remark DSCP value
• 3—remark-precedence- of the packet and send it.
pass When GreenActionType
• 4—remark-mpls-exp-pa is 3, remark IP
ss precedence of the packet
and send it.
• 5—remark-dot1p-pass
• 6—remark-atm-clp-pass When GreenActionType
is 4, remark EXP of the
• 7—remark-fr-de-pass MPLS packet and send it.
• 8—remark-local-prec-p
When GreenActionType
ass
is 5, remark 802.1p
• 10—discard priority value of the packet
GreenActionT
Action type N/A • 11—remark-dscp-contin and send it.
ype
ue When GreenActionType
• 12—remark-precedenc is 6, remark CLP bit of the
e-continue ATM packet and send it.
• 13—remark-mpls-exp-c When GreenActionType
ontinue is 7, remark DE bit of the
• 14—remark-dot1p-conti FR packet and send it.
nue When GreenActionType
• 15—remark-atm-clp-co is 8, drop the packet.
ntinue.
When GreenActionType
• 16—remark-fr-de-contin is 10, remark local
ue. precedence of the packet
• 17—remark-local-prec-c and send it.
ontinue.
When GreenActionType
• 19—continue. is 11, remark DSCP value
of the packet and continue
to process it using the
next CAR policy.

12
Column Column Column Data type and
Remarks
name description type restrictions
When GreenActionType
is 12, remark IP
precedence of the packet
and continue to process it
using the next CAR policy.
When GreenActionType
is 13, remark EXP of the
MPLS packet and
continue to process it
using the next CAR policy.
When GreenActionType
is 14, remark 802.1p
priority value of the packet
and continue to process it
using the next CAR policy.
When GreenActionType
is 15, remark CLP bit of
the ATM packet and
continue to process it
using the next CAR policy.
When GreenActionType
is 16, remark DE bit of the
FR packet and continue to
process it using the next
CAR policy.
When GreenActionType
is 17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When GreenActionType
is 19, continue to process
the packet using the next
CAR policy.
When GreenActionType
is 1, 10 or 19,
GreenActionValue is
invalid.
When GreenActionType
is 6, 7, 15, 16,
GreenActionValue is
GreenActionV Unsigned integer. 0~1.
Action value N/A
alue Value range: 0 to 63. When GreenActionType
is 3, 4, 5, 8, 12, 13, 14, 17,
GreenActionValue is
0~7.
When GreenActionType
is 2, 11,
GreenActionValue is
0~63.

Members include: YellowActionValue is

Specify behavior
Data required when
YellowAction for yellow
structure • YellowActionType GreenActionType is not 1,
packets • YellowActionValue 10 or 19.

YellowAction Enumeration: The default

Action type N/A
Type • 1—pass. YellowActionType is pass.

13
Column Column Column Data type and
Remarks
name description type restrictions
• 2—remark-dscp-pass When YellowActionType
• 3—remark-precedence- is 1, send the packet.
pass When YellowActionType
• 4—remark-mpls-exp-pa is 2, remark DSCP value
ss of the packet and send it.
• 5—remark-dot1p-pass When YellowActionType
• 6—remark-atm-clp-pass is 3, remark IP
precedence of the packet
• 7—remark-fr-de-pass
and send it.
• 8—remark-local-prec-p
ass When YellowActionType
is 4, remark EXP of the
• 10—discard
MPLS packet and send it.
• 11—remark-dscp-contin
ue When YellowActionType
is 5, remark 802.1p
• 12—remark-precedenc priority value of the packet
e-continue and send it.
• 13—remark-mpls-exp-c
When YellowActionType
ontinue
is 6, remark CLP bit of the
• 14—remark-dot1p-conti ATM packet and send it.
nue
When YellowActionType
• 15—remark-atm-clp-co is 7, remark DE bit of the
ntinue. FR packet and send it.
• 16—remark-fr-de-contin
When YellowActionType
ue.
is 8, drop the packet.
• 17—remark-local-prec-c
ontinue. When YellowActionType
is 10, remark local
• 19—continue. precedence of the packet
and send it.
When YellowActionType
is 11, remark DSCP value
of the packet and continue
to process it using the
next CAR policy.
When YellowActionType
is 12, remark IP
precedence of the packet
and continue to process it
using the next CAR policy.
When YellowActionType
is 13, remark EXP of the
MPLS packet and
continue to process it
using the next CAR policy.
When YellowActionType
is 14, remark 802.1p
priority value of the packet
and continue to process it
using the next CAR policy.
When YellowActionType
is 15, remark CLP bit of
the ATM packet and
continue to process it
using the next CAR policy.
When YellowActionType
is 16, remark DE bit of the
FR packet and continue to
process it using the next

14
Column Column Column Data type and
Remarks
name description type restrictions
CAR policy.
When YellowActionType
is 17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When YellowActionType
is 19, continue to process
the packet using the next
CAR policy.
When YellowActionType
is 1, 10 or 19,
YellowActionValue is
invalid.
When YellowActionType
is 6, 7, 15, 16,
YellowActionValue is
YellowAction Unsigned integer. 0~1.
Action value N/A
Value Value range: 0 to 63. When YellowActionType
is 3, 4, 5, 8, 12, 13, 14, 17,
YellowActionValue is
0~7.
When YellowActionType
is 2, 11,
YellowActionValue is
0~63.

Members include: RedActionValue is

Specify behavior Data required when
RedAction
for red packets structure • RedActionType GreenActionType is not 1,
• RedActionValue 10 or 19.

Enumeration: The default

RedActionType is discard.
• 1—pass.
When RedActionType is
• 2—remark-dscp-pass
1, send the packet.
• 3—remark-precedence-
pass When RedActionType is
2, remark DSCP value of
• 4—remark-mpls-exp-pa the packet and send it.
ss
When RedActionType is
• 5—remark-dot1p-pass
3, remark IP precedence
• 6—remark-atm-clp-pass of the packet and send it.
• 7—remark-fr-de-pass
When RedActionType is
• 8—remark-local-prec-p 4, remark EXP of the
RedActionTyp ass
Action type N/A MPLS packet and send it.
e
• 10—discard When RedActionType is
• 11—remark-dscp-contin 5, remark 802.1p priority
ue value of the packet and
• 12—remark-precedenc send it.
e-continue When RedActionType is
• 13—remark-mpls-exp-c 6, remark CLP bit of the
ontinue ATM packet and send it.
• 14—remark-dot1p-conti When RedActionType is
nue 7, remark DE bit of the FR
• 15—remark-atm-clp-co packet and send it.
ntinue When RedActionType is
• 16—remark-fr-de-contin 8, drop the packet.

15
Column Column Column Data type and
Remarks
name description type restrictions
ue When RedActionType is
• 17—remark-local-prec-c 10, remark local
ontinue. precedence of the packet
• 19—continue. and send it.
When RedActionType is
11, remark DSCP value of
the packet and continue to
process it using the next
CAR policy.
When RedActionType is
12, remark IP precedence
of the packet and continue
to process it using the
next CAR policy.
When RedActionType is
13, remark EXP of the
MPLS packet and
continue to process it
using the next CAR policy.
When RedActionType is
14, remark 802.1p priority
value of the packet and
continue to process it
using the next CAR policy.
When RedActionType is
15, remark CLP bit of the
ATM packet and continue
to process it using the
next CAR policy.
When RedActionType is
16, remark DE bit of the
FR packet and continue to
process it using the next
CAR policy.
When RedActionType is
17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When RedActionType is
19, continue to process
the packet using the next
CAR policy.
When RedActionType is
1, 10 or 19,
RedActionValue is
invalid.
When RedActionType is
6, 7, 15, 16,
RedActionVal Unsigned integer.
Action value N/A RedActionValue is 0~1.
ue Value range: 0 to 63.
When RedActionType is
3, 4, 5, 8, 12, 13, 14, 17,
RedActionValue is 0~7.
When RedActionType is
2, 11, RedActionValue is
0~63.

16
17
Contents
CAR ······························································································1
CAR/CarLists ···························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
CAR/CarPolicies ························································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
CAR/Capability ························································································································ 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
CAR/GlobalPolicies ·················································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 13
Columns ·························································································································· 13

i
CAR
CAR/CarLists
This table contains information about committed-access-rate list.

XML structure
<CAR>
<CarLists>
<List>
<CarlID></CarlID>
<Mac></Mac>
<DscpList>
<Dscp></Dscp>
</DscpList>
<ExpList>
<Exp></Exp>
</ExpList>
<IPPrecedenceList>
<IPPrecedence></IPPrecedence>
</IPPrecedenceList>
<DestIPRange>
<DestIPStart></DestIPStart>
<DestIPEnd></DestIPEnd>
</DestIPRange>
<SrcIPRange>
<SrcIPStart></SrcIPStart>
<SrcIPEnd></SrcIPEnd>
</SrcIPRange>
<DestIPSubnet>
<DestSubnetIP></DestSubnetIP>
<DestMaskLength></DestMaskLength>
</DestIPSubnet>
<SrcIPSubnet>
<SrcSubnetIP></SrcSubnetIP>
<SrcMaskLength></SrcMaskLength>
</SrcIPSubnet>
<SrcIPObjGroup></SrcIPObjGroup>
<DestIPObjGroup></DestIPObjGroup>
<Mode></Mode>
<Trange></Trange>
</List>
</CarLists>
</CAR>

1
Table description
Item Description
Feature name CAR
Table name CarLists
Table type Multi-instance table
Row name List
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
CarlID CAR list number Index N/A
Value range: 1 to 199.
Six groups of two
Match the MAC Example:
Mac N/A hexadecimal digits,
address 00-0c-af-e3-5d-c0.
hyphen-separated.

Match DSCP Unsigned integer. You can specify up to 8

Dscp N/A
values. Dscp for a rule
Value range: 0 to 63.

Match MPLS Unsigned integer. You can specify up to 8

Exp N/A
EXP value. Exp for a rule
Value range: 0 to 7.

Match IP Unsigned integer. You can specify up to 8

IPPrecedence N/A
precedence. IPPrecedence for a rule
Value range: 0 to 7.

Match Members include:

Data The two members must
DestIPRange destination IP by
structure • DestIPStart both be specified.
range. • DestIPEnd

DestIPStart Start IP of range. N/A String, dotted decimal Example: 10.153.93.54.

notation.
Example: 10.153.93.60.
DestIPEnd End IP of range. N/A String, dotted decimal DestIPEnd must be
notation. bigger than DestIPStart.
Members include:
Match source IP Data The two members must
SrcIPRange
by range. structure • SrcIPStart both be specified.
• SrcIPEnd

SrcIPStart Start IP of range. N/A String, dotted decimal Example: 10.153.93.54.

notation.
Example: 10.153.93.60.
SrcIPEnd End IP of range. N/A String, dotted decimal SrcIPEnd must be bigger
notation. than SrcIPStart.

Match Data Members include: The two members must

DestIPSubnet
destination IP by structure • DestSubnetIP both be specified.

2
 subnet. • DestMaskLength

DestSubnetIP Subnet IP. N/A String, dotted decimal Example: 10.153.93.60.

notation.
The maximum value is 31.
DestMaskLen
MaskLength. N/A Unsigned integer. The minimum value varies
gth
by device model.
Members include:
Match source IP Data The two members must
SrcIPSubnet
by subnet. structure • SrcSubnetIP both be specified.
• SrcMaskLength

SrcSubnetIP Subnet IP. N/A String, dotted decimal Example: 10.153.93.60.

notation.
The maximum value is 31.
SrcMaskLeng
MaskLength. N/A Unsigned integer. The minimum value varies
th
by device model.
The object group name
cannot contain ‘?’.
SrcIPObjGrou Match source IP String case insensitive. The character ‘\r\n’ in
N/A
p by object group. Length: 1 to 31 characters. object group name can’t
be treated as escape
character.
The object group name
can’t contain ‘?’.
Match
DestIPObjGro String case insensitive. The character ‘\r\n’ in
destination IP by N/A
up Length: 1 to 31 object group name can’t
object group.
be treated as escape
character.
When the Mode column is
1, Per-IP address rate is
limited within the network
segment, and traffic of all
IP addresses within the
network segment doesn’t
Enumeration: share the remaining
bandwidth.
Mode Match Mode. N/A • 1—PerAddress.
• 2—SharedBandwidth. When the Mode column is
2, Per-IP address rate is
limited within the network
segment, and traffic of all
IP addresses within the
network segment shares
the remaining bandwidth.
The time range name
cannot be all and the ‘?’
should not be used.
Name of the time String, case-insensitive.
Trange N/A The character ‘\r\n’ in time
range Length: 1 to 32 characters.
range name can’t be
treated as escape
character.

3
CAR/CarPolicies
This table contains information about committed-access-rate policy.

XML structure
<CAR>
<CarPolicies>
<Policy>
<IfIndex></IfIndex>
<Direction></Direction>
<Type></Type>
<Value></Value>
<BandwithUnit></BandwithUnit>
<Name></Name>
<CIR></CIR>
<CBS></CBS>
<EBS></EBS>
<PIR></PIR>
<GreenAction>
<GreenActionType></GreenActionType>
<GreenActionValue></GreenActionValue>
</GreenAction>
<YellowAction>
<YellowActionType></YellowActionType>
<YellowActionValue></YellowActionValue>
</YellowAction>
<RedAction>
<RedActionType></RedActionType>
<RedActionValue></RedActionValue>
</RedAction>
<GreenPkts></GreenPkts>
<GreenBytes></GreenBytes>
<YellowPkts></YellowPkts>
<YellowBytes></YellowBytes>
<RedPkts></RedPkts>
<RedBytes></RedBytes>
</Policy>
</CarPolicies>
</CAR>

Table description
Item Description
Feature name CAR
Table name CarPolicies
Table type Multi-instance table

4
 Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Some versions support
interface name. For
IfIndex Interface index Index Unsigned integer. relevant information,
see the XSD document
of your product.
Enumeration:
Application
Direction
direction
Index • 0—Inbound. N/A
• 1—Outbound.
Enumeration :
• 1—IPv4Acl
Type Match type Index • 2—IPv6Acl N/A
• 3—Carl
• 4—Any
Value Match type value Index Unsigned integer. N/A

Enumeration:
Specify the
BandwithUnit
bandwidth unit
N/A • 2—kbps N/A
• 3—percent.
String.
Length: 1 to 31 characters.
Aggregate CAR
Name N/A N/A
policy name The string must start with an
English letter.
Committed
CIR N/A Unsigned integer. N/A
information rate
Committed burst
CBS N/A Unsigned integer. N/A
size
Excess burst
EBS N/A Unsigned integer. N/A
size
Peak information
PIR N/A Unsigned integer. N/A
rate
Members include:
Specify behavior Data
GreenAction
for green packets structure • GreenActionType N/A
• GreenActionValue

Enumeration: When GreenActionType

is 1, send the packet.
• 1—pass.
When GreenActionType
• 2—remark--dscp--pass
is 2, remark DSCP value
GreenActionT
Action type N/A • 3—remark--precedence of the packet and send it.
ype --pass
When GreenActionType
• 4—remark--mpls--exp-- is 3, remark IP
pass precedence of the packet
• 5—remark-dot1p-pass and send it.
5
Column Column Column
Data type and restrictions Remarks
name description type
• 6—remark-atm-clp-pass When GreenActionType
• 7—remark-fr-de-pass is 4, remark EXP of the
MPLS packet and send it.
• 8—remark-local-prec-p
ass When GreenActionType
• 10—discard is 5, remark 802.1p
priority value of the packet
• 11—remark-dscp-contin and send it.
ue
When GreenActionType
• 12—remark-precedenc
is 6, remark CLP bit of the
e-continue
ATM packet and send it.
• 13—remark-mpls-exp-c
ontinue When GreenActionType
is 7, remark DE bit of the
• 14—remark-dot1p-conti
FR packet and send it.
nue
• 15—remark-atm-clp-co When GreenActionType
ntinue. is 8, drop the packet.
• 16—remark-fr-de-contin When GreenActionType
ue. is 10, remark local
precedence of the packet
• 17—remark-local-prec-c
and send it.
ontinue.
• 19—continue When GreenActionType
is 11, remark DSCP value
of the packet and continue
to process it using the
next CAR policy.
When GreenActionType
is 12, remark IP
precedence of the packet
and continue to process it
using the next CAR policy.
When GreenActionType
is 13, remark EXP of the
MPLS packet and
continue to process it
using the next CAR policy.
When GreenActionType
is 14, remark 802.1p
priority value of the packet
and continue to process it
using the next CAR policy.
When GreenActionType
is 15, remark CLP bit of
the ATM packet and
continue to process it
using the next CAR policy.
When GreenActionType
is 16, remark DE bit of the
FR packet and continue to
process it using the next
CAR policy.
When GreenActionType
is 17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When GreenActionType
is 19, continue to process
the packet using the next
CAR policy.
6
Column Column Column
Data type and restrictions Remarks
name description type
When GreenActionType
is 1, 10 or 19,
GreenActionValue is
invalid.
When GreenActionType
is 6, 7, 15, 16,
GreenActionValue is
GreenActionV Unsigned integer. 0~1.
Action value N/A
alue Value range: 0 to 63. When GreenActionType
is 3, 4, 5, 8, 12, 13, 14, 17,
GreenActionValue is
0~7.
When GreenActionType
is 2, 11,
GreenActionValue is
0~63.

Specify behavior Members include:

Data
YellowAction for yellow
structure • YellowActionType N/A
packets • YellowActionValue
When YellowActionType
is 1, send the packet.
When YellowActionType
is 2, remark DSCP value
Enumeration: of the packet and send it.
• 1—pass. When YellowActionType
• 2—remark-dscp-pass is 3, remark IP
• 3—remark-precedence- precedence of the packet
pass and send it.
• 4—remark-mpls-exp-pa When YellowActionType
ss is 4, remark EXP of the
• 5—remark-dot1p-pass MPLS packet and send it.
• 6—remark-atm-clp-pass When YellowActionType
is 5, remark 802.1p
• 7—remark-fr-de-pass
priority value of the packet
• 8—remark-local-prec-p and send it.
ass
When YellowActionType
• 10—discard is 6, remark CLP bit of the
YellowAction
Action type N/A • 11—remark-dscp-contin ATM packet and send it.
Type
ue
When YellowActionType
• 12—remark-precedenc is 7, remark DE bit of the
e-continue FR packet and send it.
• 13—remark-mpls-exp-c When YellowActionType
ontinue is 8, drop the packet.
• 14—remark-dot1p-conti
When YellowActionType
nue
is 10, remark local
• 15—remark-atm-clp-co precedence of the packet
ntinue. and send it.
• 16—remark-fr-de-contin When YellowActionType
ue. is 11, remark DSCP value
• 17—remark-local-prec-c of the packet and continue
ontinue. to process it using the
• 19—continue next CAR policy.
When YellowActionType
is 12, remark IP
precedence of the packet
and continue to process it
7
Column Column Column
Data type and restrictions Remarks
name description type
using the next CAR policy.
When YellowActionType
is 13, remark EXP of the
MPLS packet and
continue to process it
using the next CAR policy.
When YellowActionType
is 14, remark 802.1p
priority value of the packet
and continue to process it
using the next CAR policy.
When YellowActionType
is 15, remark CLP bit of
the ATM packet and
continue to process it
using the next CAR policy.
When YellowActionType
is 16, remark DE bit of the
FR packet and continue to
process it using the next
CAR policy.
When YellowActionType
is 17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When YellowActionType
is 19, continue to process
the packet using the next
CAR policy.
When YellowActionType
is 1, 10 or 19,
YellowActionValue is
invalid.
When YellowActionType
is 6, 7, 15, 16,
YellowActionValue is
YellowAction Unsigned integer. 0~1.
Action value N/A
Value Value range: 0 to 63. When YellowActionType
is 3, 4, 5, 8, 12, 13, 14, 17,
YellowActionValue is
0~7.
When YellowActionType
is 2, 11,
YellowActionValue is
0~63.
Members include:
Specify behavior Data
RedAction
for red packets structure • RedActionType N/A
• RedActionValue
Enumeration: When RedActionType is
• 1—pass. 1, send the packet.

RedActionTyp • 2—remark-dscp-pass When RedActionType is

Action type N/A • 3—remark-precedence- 2, remark DSCP value of
e
pass the packet and send it.
• 4—remark-mpls-exp-pa When RedActionType is
ss 3, remark IP precedence

8
Column Column Column
Data type and restrictions Remarks
name description type
• 5—remark-dot1p-pass of the packet and send it.
• 6—remark-atm-clp-pass When RedActionType is
• 7—remark-fr-de-pass 4, remark EXP of the
MPLS packet and send it.
• 8—remark-local-prec-p
ass When RedActionType is
• 10—discard 5, remark 802.1p priority
value of the packet and
• 11—remark-dscp-contin send it.
ue
When RedActionType is
• 12—remark-precedenc
6, remark CLP bit of the
e-continue
ATM packet and send it.
• 13—remark-mpls-exp-c
ontinue When RedActionType is
7, remark DE bit of the FR
• 14—remark-dot1p-conti packet and send it.
nue
When RedActionType is
• 15—remark-atm-clp-co
8, drop the packet.
ntinue.
• 16—remark-fr-de-contin When RedActionType is
ue. 10, remark local
precedence of the packet
• 17—remark-local-prec-c and send it.
ontinue.
When RedActionType is
• 19—continue
11, remark DSCP value of
the packet and continue to
process it using the next
CAR policy.
When RedActionType is
12, remark IP precedence
of the packet and continue
to process it using the
next CAR policy.
When RedActionType is
13, remark EXP of the
MPLS packet and
continue to process it
using the next CAR policy.
When RedActionType is
14, remark 802.1p priority
value of the packet and
continue to process it
using the next CAR policy.
When RedActionType is
15, remark CLP bit of the
ATM packet and continue
to process it using the
next CAR policy.
When RedActionType is
16, remark DE bit of the
FR packet and continue to
process it using the next
CAR policy.
When RedActionType is
17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When RedActionType is
19, continue to process
the packet using the next
9
 Column Column Column
Data type and restrictions Remarks
name description type
CAR policy.
When RedActionType is
1, 10 or 19,
RedActionValue is
invalid.
When RedActionType is
6, 7, 15, 16,
RedActionVal Unsigned integer.
Action value N/A RedActionValue is 0~1.
ue Value range: 0 to 63.
When RedActionType is
3, 4, 5, 8, 12, 13, 14, 17,
RedActionValue is 0~7.
When RedActionType is
2, 11, RedActionValue is
0~63.

Number of green Unsigned integer.

GreenPkts N/A 64 N/A
packets Value range: 0 to 2 - 1.

Bytes of green Unsigned integer.

GreenBytes N/A 64 N/A
packets Value range: 0 to 2 - 1.

Number of yellow Unsigned integer.

YellowPkts N/A 64 N/A
packets Value range: 0 to 2 - 1.

Bytes of yellow Unsigned integer.

YellowBytes N/A 64 N/A
packets Value range: 0 to 2 - 1.

Number of red Unsigned integer.

RedPkts N/A 64 N/A
packets Value range: 0 to 2 - 1.

Bytes of red Unsigned integer.

RedBytes N/A 64 N/A
packets Value range: 0 to 2 - 1.

CAR/Capability
This table contains capability information about committed-access-rate.

XML structure
<CAR>
<Capability>
<MQCTokenPara></MQCTokenPara>
<CIRMin></CIRMin>
<CIRMax></CIRMax>
<CIRGranularity></CIRGranularity>
<CBSMin></CBSMin>
<CBSMax></CBSMax>
<CBSGranularity></CBSGranularity>
<EBSMin></EBSMin>
<EBSMax></EBSMax>
<EBSGranularity></EBSGranularity>
<PIRMin></PIRMin>
<PIRMax></PIRMax>
10
 <PIRGranularity></PIRGranularity>
</Capability>
</CAR>

Table description
Item Description
Feature name CAR
Table name Capability
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column
Column description Data type and restrictions Remarks
name type
Each bit represents a type as
follows: The value of this
MQCTokenPa Token bucket column depends
N/A • 1—CBS
ra capability on the device
• 2—EBS model.
• 4—PIR
The value of this
Minimum CIR value in column depends
CIRMin N/A Unsigned integer.
kbps on the device
model.

The value of this

Maximum CIR value column depends
CIRMax N/A Unsigned integer.
in kbps on the device
model.

The value of this

CIRGranularit Granularity of CIR in column depends
N/A Unsigned integer.
y kbps on the device
model.

The value of this

Minimum CBS value column depends
CBSMin N/A Unsigned integer.
in bytes on the device
model.

The value of this

Maximum CBS value column depends
CBSMax N/A Unsigned integer.
in bytes on the device
model.
The value of this
CBSGranulari Granularity of CBS in column depends
N/A Unsigned integer.
ty bytes on the device
model.

11
 Column Column
Column description Data type and restrictions Remarks
name type
The value of this
Minimum EBS value column depends
EBSMin N/A Unsigned integer.
in bytes on the device
model.
The value of this
Maximum EBS value column depends
EBSMax N/A Unsigned integer.
in bytes on the device
model.
The value of this
EBSGranularit Granularity of EBS in column depends
N/A Unsigned integer.
y bytes on the device
model.
The value of this
Minimum PIR value in column depends
PIRMin N/A Unsigned integer.
kbps on the device
model.
The value of this
column depends
Maximum PIR value
PIRMax N/A Unsigned integer. on the device
in kbps
model and
interface type.
The value of this
column depends
PIRGranularit Granularity of PIR in
N/A Unsigned integer. on the device
y kbps
model and
interface type.

CAR/GlobalPolicies
This table contains information about global committed access rate (CAR) policies.

XML structure
<CAR>
<GlobalPolicies>
<Policy>
<Name></Name>
<Type></Type>
<CIR></CIR>
<CBS></CBS>
<EBS></EBS>
<PIR></PIR>
<GreenAction>
<GreenActionType></GreenActionType>
<GreenActionValue></GreenActionValue>
</GreenAction>
<YellowAction>
<YellowActionType></YellowActionType>
<YellowActionValue></YellowActionValue>

12
 </YellowAction>
<RedAction>
<RedActionType></RedActionType>
<RedActionValue></RedActionValue>
</RedAction>
<GreenPkts></GreenPkts>
<GreenBytes></GreenBytes>
<YellowPkts></YellowPkts>
<YellowBytes></YellowBytes>
<RedPkts></RedPkts>
<RedBytes></RedBytes>
</Policy>
</GlobalPolicies>
</CAR>

Table description
Item Description
Feature name CAR
Table name GlobalPolicies
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
Global CAR Length: 1 to 31 characters.
Name Index N/A
policy name The string must start with an
English letter.
Enumeration :
Type CAR type N/A • 1—Aggregate CAR. Required.
• 2—Hierarchical CAR.
Committed
CIR N/A Unsigned integer. Required.
information rate
Committed burst
CBS N/A Unsigned integer. N/A
size
If CBS or PIR is not
Excess burst
EBS N/A Unsigned integer. configured, EBS cannot
size
be configured.
Peak information
PIR N/A Unsigned integer. N/A
rate

Specify behavior Data Members include: GreenActionValue is

GreenAction required when
for green packets structure • GreenActionType GreenActionType is not 1,
13
Column Column Column
Data type and restrictions Remarks
name description type
• GreenActionValue 10 or 19.

When GreenActionType
is 1, send the packet.
When GreenActionType
is 2, remark DSCP value
of the packet and send it.
When GreenActionType
is 3, remark IP
precedence of the packet
and send it.
When GreenActionType
is 4, remark EXP of the
MPLS packet and send it.
When GreenActionType
Enumeration: is 5, remark 802.1p
• 1—pass. priority value of the packet
and send it.
• 2—remark-dscp-pass
• 3—remark-precedence- When GreenActionType
pass is 6, remark CLP bit of the
ATM packet and send it.
• 4—remark-mpls-exp-pa
ss When GreenActionType
is 7, remark DE bit of the
• 5—remark-dot1p-pass
FR packet and send it.
• 6—remark-atm-clp-pass
When GreenActionType
• 7—remark-fr-de-pass is 8, drop the packet.
• 8—remark-local-prec-p
When GreenActionType
ass
is 10, remark local
• 10—discard precedence of the packet
GreenActionT
Action type N/A • 11—remark-dscp-contin and send it.
ype
ue When GreenActionType
• 12—remark-precedenc is 11, remark DSCP value
e-continue of the packet and continue
• 13—remark-mpls-exp-c to process it using the
ontinue next CAR policy.
• 14—remark-dot1p-conti When GreenActionType
nue is 12, remark IP
• 15—remark-atm-clp-co precedence of the packet
ntinue. and continue to process it
using the next CAR policy.
• 16—remark-fr-de-contin
ue. When GreenActionType
• 17—remark-local-prec-c is 13, remark EXP of the
ontinue. MPLS packet and
continue to process it
• 19—continue. using the next CAR policy.
When GreenActionType
is 14, remark 802.1p
priority value of the packet
and continue to process it
using the next CAR policy.
When GreenActionType
is 15, remark CLP bit of
the ATM packet and
continue to process it
using the next CAR policy.
When GreenActionType
is 16, remark DE bit of the
FR packet and continue to

14
Column Column Column
Data type and restrictions Remarks
name description type
process it using the next
CAR policy.
When GreenActionType
is 17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When GreenActionType
is 19, continue to process
the packet using the next
CAR policy.
When GreenActionType
is 1, 10 or 19,
GreenActionValue is
invalid.
When GreenActionType
is 6, 7, 15, 16,
GreenActionValue is
GreenActionV Unsigned integer. 0~1.
Action value N/A
alue Value range: 0 to 63. When GreenActionType
is 3, 4, 5, 8, 12, 13, 14, 17,
GreenActionValue is
0~7.
When GreenActionType
is 2, 11,
GreenActionValue is
0~63.

Members include: YellowActionValue is

Specify behavior
Data required when
YellowAction for yellow
structure • YellowActionType GreenActionType is not 1,
packets • YellowActionValue 10 or 19.

Enumeration: When YellowActionType

is 1, send the packet.
• 1—pass.
• 2—remark-dscp-pass When YellowActionType
is 2, remark DSCP value
• 3—remark-precedence- of the packet and send it.
pass
When YellowActionType
• 4—remark-mpls-exp-pa
is 3, remark IP
ss
precedence of the packet
• 5—remark-dot1p-pass and send it.
• 6—remark-atm-clp-pass When YellowActionType
• 7—remark-fr-de-pass is 4, remark EXP of the
• 8—remark-local-prec-p MPLS packet and send it.
YellowAction ass
Action type N/A When YellowActionType
Type
• 10—discard is 5, remark 802.1p
• 11—remark-dscp-contin priority value of the packet
ue and send it.
• 12—remark-precedenc When YellowActionType
e-continue is 6, remark CLP bit of the
• 13—remark-mpls-exp-c ATM packet and send it.
ontinue When YellowActionType
• 14—remark-dot1p-conti is 7, remark DE bit of the
nue FR packet and send it.
• 15—remark-atm-clp-co When YellowActionType
ntinue. is 8, drop the packet.
• 16—remark-fr-de-contin When YellowActionType

15
Column Column Column
Data type and restrictions Remarks
name description type
ue. is 10, remark local
• 17—remark-local-prec-c precedence of the packet
ontinue. and send it.
• 19—continue. When YellowActionType
is 11, remark DSCP value
of the packet and continue
to process it using the
next CAR policy.
When YellowActionType
is 12, remark IP
precedence of the packet
and continue to process it
using the next CAR policy.
When YellowActionType
is 13, remark EXP of the
MPLS packet and
continue to process it
using the next CAR policy.
When YellowActionType
is 14, remark 802.1p
priority value of the packet
and continue to process it
using the next CAR policy.
When YellowActionType
is 15, remark CLP bit of
the ATM packet and
continue to process it
using the next CAR policy.
When YellowActionType
is 16, remark DE bit of the
FR packet and continue to
process it using the next
CAR policy.
When YellowActionType
is 17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When YellowActionType
is 19, continue to process
the packet using the next
CAR policy.
When YellowActionType
is 1, 10 or 19,
YellowActionValue is
invalid.
When YellowActionType
is 6, 7, 15, 16,
YellowActionValue is
YellowAction Unsigned integer. 0~1.
Action value N/A
Value Value range: 0 to 63. When YellowActionType
is 3, 4, 5, 8, 12, 13, 14, 17,
YellowActionValue is
0~7.
When YellowActionType
is 2, 11,
YellowActionValue is
0~63.

16
Column Column Column
Data type and restrictions Remarks
name description type
Members include: RedActionValue is
Specify behavior Data required when
RedAction
for red packets structure • RedActionType GreenActionType is not 1,
• RedActionValue 10 or 19.
When RedActionType is
1, send the packet.
When RedActionType is
2, remark DSCP value of
the packet and send it.
When RedActionType is
3, remark IP precedence
of the packet and send it.
When RedActionType is
4, remark EXP of the
MPLS packet and send it.

Enumeration: When RedActionType is

5, remark 802.1p priority
• 1—pass. value of the packet and
• 2—remark-dscp-pass send it.
• 3—remark-precedence- When RedActionType is
pass 6, remark CLP bit of the
• 4—remark-mpls-exp-pa ATM packet and send it.
ss When RedActionType is
• 5—remark-dot1p-pass 7, remark DE bit of the FR
• 6—remark-atm-clp-pass packet and send it.
• 7—remark-fr-de-pass When RedActionType is
• 8—remark-local-prec-p 8, drop the packet.
ass When RedActionType is
• 10—discard 10, remark local
RedActionTyp precedence of the packet
Action type N/A • 11—remark-dscp-contin
e and send it.
ue
• 12—remark-precedenc When RedActionType is
e-continue 11, remark DSCP value of
the packet and continue to
• 13—remark-mpls-exp-c process it using the next
ontinue CAR policy.
• 14—remark-dot1p-conti
When RedActionType is
nue
12, remark IP precedence
• 15—remark-atm-clp-co of the packet and continue
ntinue to process it using the
• 16—remark-fr-de-contin next CAR policy.
ue When RedActionType is
• 17—remark-local-prec-c 13, remark EXP of the
ontinue. MPLS packet and
• 19—continue. continue to process it
using the next CAR policy.
When RedActionType is
14, remark 802.1p priority
value of the packet and
continue to process it
using the next CAR policy.
When RedActionType is
15, remark CLP bit of the
ATM packet and continue
to process it using the
next CAR policy.
When RedActionType is
17
Column Column Column
Data type and restrictions Remarks
name description type
16, remark DE bit of the
FR packet and continue to
process it using the next
CAR policy.
When RedActionType is
17, remark local
precedence of the packet
and continue to process it
using the next CAR policy.
When RedActionType is
19, continue to process
the packet using the next
CAR policy.
When RedActionType is
1, 10 or 19,
RedActionValue is
invalid.
When RedActionType is
6, 7, 15, 16,
RedActionVal Unsigned integer.
Action value N/A RedActionValue is 0~1.
ue Value range: 0 to 63.
When RedActionType is
3, 4, 5, 8, 12, 13, 14, 17,
RedActionValue is 0~7.
When RedActionType is
2, 11, RedActionValue is
0~63.

Number of green Unsigned integer.

GreenPkts N/A 64 N/A
packets Value range: 0 to 2 - 1.

Bytes of green Unsigned integer.

GreenBytes N/A 64 N/A
packets Value range: 0 to 2 - 1.

Number of yellow Unsigned integer.

YellowPkts N/A 64 N/A
packets Value range: 0 to 2 - 1.

Bytes of yellow Unsigned integer.

YellowBytes N/A 64 N/A
packets Value range: 0 to 2 - 1.

Number of red Unsigned integer.

RedPkts N/A 64 N/A
packets Value range: 0 to 2 - 1.

Bytes of red Unsigned integer.

RedBytes N/A 64 N/A
packets Value range: 0 to 2 - 1.

18
Contents
CAR ······························································································1
CAR ········································································································································ 1

i
CAR
CAR
Message Explanation
PIR can't be smaller than CIR. Configure a CAR action, PIR can't be smaller than CIR.
PIR的值不能小于CIR。 配置流量监管动作，峰值速率不能小于承诺信息速率。

The end address should be larger than the start Configure a CAR list, The end address should be larger than the
address. start address.
结束地址值应该大于起始地址值。 配置CAR列表，IP地址段终止地址必须大于IP地址段起始地址。

The number of IP addresses in the IP address Configure a CAR list, The number of IP addresses in the IP
range exceeds %u. address range has max number.
IP地址的数量超出了个数为%u的限制。 配置CAR列表，IP地址段数量存在上限。

Total UNI bandwidth can't be greater than NNI

Total UNI bandwidth can't be greater than NNI bandwidth.
bandwidth.
配置带宽保证组，下行接口总带宽不能超过上行接口带宽。
下行接口总带宽不能超过上行接口带宽。

Please remove UNI configuration of this interface

Del if CAR, remove UNI configuration of this interface first.
first.
删除接口CAR配置时需要保证此接口不是带宽保证组的下行口。
请先删除下行接口配置。

The maximum number of CAR policies that can be The maximum number of CAR policies that can be configured has
configured has been reached. been reached.
CAR策略的数目已经达到最大值。 接口下配置流量监管的数量存在上限。

CIR or PIR must be configured in the same unit

(percentage or kbps) as it was previously CIR or PIR must be configured in the same unit (percentage or
configured. kbps) as it was previously configured.
必须与之前配置的CIR或者PIR配置相同单位 接口下配置流量监管的单位需要保持一致。
（percentage or kbps）

Percentage-based CAR can be only used on

Percentage-based CAR can be only used on interface.
interface.
百分比CAR只能被应用到接口。
百分比CAR只能被应用到接口。

1
Contents
CCdefense ·····················································································1
CCdefense/MovePolicyRule ········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
CCdefense
CCdefense/MovePolicyRule
This table is used to number the rules in a CC attack defense policy.

XML structure
<CCdefense>
<MovePolicyRule>
<Move>
<PolicyName></PolicyName>
<RuleId></RuleId>
<NextRuleId></NextRuleId>
</Move>
</MovePolicyRule>
</CCdefense>

Table description
Item Description
Feature name CCdefense
Table name MovePolicyRule
Table type Single-instance table
Row name Move
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String, case-insensitive.
PolicyName Index N/A
policy Length: 1 to 31 characters.
Unsigned integer.
RuleId Rule ID Index Single value.
Value range: 1 to 64.

ID of the next Unsigned integer.

NextRuleId N/A Single value.
rule Value range: 1 to 64.

1
Contents
CCdefense ·····················································································1
CCdefense/Policies ···················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
CCdefense/RuleInPolicy ·············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
CCdefense/CcOnWafPolicy ········································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4

i
CCdefense
CCdefense/Policies
This table contains Challenge Collapsar (CC) attack defense policy information.

XML structure
<CCdefense>
<Policies>
<Policy>
<PolicyName></PolicyName>
<Description></Description>
<Frequency></Frequency>
<ExceptionIPv4List>
<Ipv4address></Ipv4address>
</ExceptionIPv4List>
<ExceptionIPv6List>
<Ipv6address></Ipv6address>
</ExceptionIPv6List>
</Policy>
</Policies>
</CCdefense>

Table description
Item Description
Feature name CCdefense
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String, case-insensitive.
PolicyName Index N/A
policy Length: 1 to 31 characters.

Description of String, case-sensitive.

Description N/A N/A
the policy Length: 1 to 255 characters.

1
 Column Column Column
Data type and restrictions Remarks
name description type
Value of the Unsigned integer.
Frequency N/A Default is 300.
frequency Value range: 10 to 720.

Source IPv4 String, decimal notation.

Ipv4address N/A N/A
address Length: 1 to 15 characters.
Hexadecimal string,
Source IPv6 colon-separated.
Ipv6address N/A N/A
address
Length: 1 to 45 characters.

CCdefense/RuleInPolicy
This table contains information about the rules in a CC attack defense policy.

XML structure
<CCdefense>
<RuleInPolicy>
<Rule>
<PolicyName></PolicyName>
<RuleID></RuleID>
<RuleName></RuleName>
<RequestMethod></RequestMethod>
<SrcIpType></SrcIpType>
<RequestRate></RequestRate>
<RequestConcentration></RequestConcentration>
<RequestNumber></RequestNumber>
<Action></Action>
<BlockTime></BlockTime>
<LoggingEnable></LoggingEnable>
<DestIPv4List>
<DestIpv4Address></DestIpv4Address>
</DestIPv4List>
<DestIPv6List>
<DestIpv6Address></DestIpv6Address>
</DestIPv6List>
<DestPortList>
<DestPort></DestPort>
</DestPortList>
<UriStringList>
<UriString></UriString>
</UriStringList>
</Rule>
</RuleInPolicy>
</CCdefense>

2
Table description
Item Description
Feature name CCdefense
Table name RuleInPolicy
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column
Column name Data type and restrictions Remarks
description type
String, case-insensitive.
PolicyName Name Index N/A
Length: 1 to 31 characters.
Unsigned integer.
RuleID RuleID Index N/A
Value range: 1 to 64.
String, case-insensitive.
RuleName Rule Name N/A N/A
Length: 1 to 31 characters.

Request Unsigned integer.

RequestMethod N/A N/A
method name Value range: 0 to 255.
Enumeration:
SrcIpType Host type N/A • 0—Convention. Default is 0.
• 1—X-Forwarded-For.
Unsigned integer.
RequestRate Request rate N/A N/A
Value range: 0 to 65535.

RequestConcent Request Unsigned Integer.

N/A N/A
ration concentration Value range: 0 to 100.

Request Unsigned Integer.

RequestNumber N/A N/A
number Value range: 10 to 65535.
Enumeration:
Actions for the
Action
rule in policy
N/A • 1—Permit. N/A
• 2—Block.

Lifetime of the Unsigned integer.

BlockTime N/A N/A
cached entries Value range: 0 to 86400.
Enumeration:
LoggingEnable logging switch N/A • 0—Disable. Default is 0.
• 1—Enable.

DestIpv4Addres Destination String, decimal notation.

N/A N/A
s IPv6 address Length: 1 to 15 characters.
DestIpv6Addres Destination Hexadecimal string,
N/A N/A
s IPv6 address colon-separated.

3
 Column Column
Column name Data type and restrictions Remarks
description type
Length: 1 to 45 characters.

Destination Unsigned integer.

DestPort N/A N/A
port Value range: 1 to 65535.
String, case-insensitive.
UriString URI string N/A N/A
Length: 1 to 255 characters.

CCdefense/CcOnWafPolicy
This table contains information about a CC attack defense policy used by a Waf policy.

XML structure
<CCdefense>
<CCOnWafPolicy>
<Policy>
<WafPolicyName></WafPolicyName>
<CCPolicyName></CCPolicyName>
</Policy>
</CCOnWafPolicy>
</CCdefense>

Table description
Item Description
Feature name CCdefense
Table name CcOnWafPolicy
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
WafPolicyNa Name of the String, case-insensitive.
Index N/A
me WAF policy Length: 1 to 63 characters.

CCPolicyNam Name of the CC String, case-insensitive.

N/A N/A
e policy Length: 1 to 31 characters.

4
Contents
CCdefense ·····················································································1
CCdefense/Policies ···················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
CCdefense/RuleInPolicy ·············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
CCdefense/CcOnWafPolicy ········································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4

i
CCdefense
CCdefense/Policies
This table contains Challenge Collapsar (CC) attack defense policy information.

XML structure
<CCdefense>
<Policies>
<Policy>
<PolicyName></PolicyName>
<Description></Description>
<Frequency></Frequency>
<ExceptionIPv4List>
<Ipv4address></Ipv4address>
</ExceptionIPv4List>
<ExceptionIPv6List>
<Ipv6address></Ipv6address>
</ExceptionIPv6List>
</Policy>
</Policies>
</CCdefense>

Table description

Item Description
Feature name CC defense
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns

Column Column Column

Data type and restrictions Remarks
name description type
Name of the String, case-insensitive.
PolicyName Index N/A
policy Length: 1 to 31 characters.
Description Description of N/A String, case-sensitive. N/A

1
 Column Column Column
Data type and restrictions Remarks
name description type
the policy Length: 1 to 255 characters.

Value of the Unsigned integer.

Frequency N/A Default is 300.
frequency Value range: 10 to 720.

Source IPv4 String, decimal notation.

Ipv4address N/A N/A
address Length: 1 to 15 characters.
Hexadecimal string,
Source IPv6 colon-separated.
Ipv6address N/A N/A
address
Length: 1 to 45 characters.

CCdefense/RuleInPolicy
This table contains information about the rules in a CC attack defense policy.

XML structure
<CCdefense>
<RuleInPolicy>
<Rule>
<PolicyName></PolicyName>
<RuleID></RuleID>
<RuleName></RuleName>
<RequestMethod></RequestMethod>
<SrcIpType></SrcIpType>
<RequestRate></RequestRate>
<RequestConcentration></RequestConcentration>
<RequestNumber></RequestNumber>
<Action></Action>
<BlockTime></BlockTime>
<LoggingEnable></LoggingEnable>
<DestIPv4List>
<DestIpv4Address></DestIpv4Address>
</DestIPv4List>
<DestIPv6List>
<DestIpv6Address></DestIpv6Address>
</DestIPv6List>
<DestPortList>
<DestPort></DestPort>
</DestPortList>
<UriStringList>
<UriString></UriString>
</UriStringList>
</Rule>
</RuleInPolicy>

2
 </CCdefense>

Table description

Item Description
Feature name CCdefense
Table name RuleInPolicy
Table type Multi-instance table
Row name Rule
Restrictions None

Columns

Column Column
Column name Data type and restrictions Remarks
description type
String, case-insensitive.
PolicyName Name Index N/A
Length: 1 to 31 characters.
Unsigned integer.
RuleID RuleID Index N/A
Value range: 0 to 64.
String, case-insensitive.
RuleName Rule Name N/A N/A
Length: 1 to 31 characters.

Request Unsigned integer.

RequestMethod N/A N/A
method name Value range: 0 to 255.
Enumeration:
SrcIpType Host type N/A • 0—Convention. Default is 0.
• 1—X-Forwarded-For.
Unsigned integer.
RequestRate Request rate N/A N/A
Value range: 0 to 65535.

RequestConcent Request Unsigned Integer.

N/A N/A
ration concentration Value range: 0 to 100.

Request Unsigned Integer.

RequestNumber N/A N/A
number Value range: 10 to 65535.
Enumeration:
Actions for the
Action
rule in policy
N/A • 1—Permit. Default is 1.
• 2—Block.

Lifetime of the Unsigned integer.

BlockTime N/A Default is 300.
cached entries Value range: 0 to 86400.
Enumeration:
LoggingEnable logging switch N/A • 0—Disable. Default is 0.
• 1—Enable.
DestIpv4Addres Destination N/A String, decimal notation. N/A

3
 Column Column
Column name Data type and restrictions Remarks
description type
s IPv6 address Length: 1 to 15 characters.
Hexadecimal string,
DestIpv6Addres Destination colon-separated.
N/A N/A
s IPv6 address
Length: 1 to 45 characters.

Destination Unsigned integer.

DestPort N/A N/A
port Value range: 1 to 65535.
String, case-insensitive.
UriString URI string N/A N/A
Length: 1 to 255 characters.

CCdefense/CcOnWafPolicy
This table contains information about a CC attack defense policy used by a WAF policy..

XML structure
<CCdefense>
<CCOnWafPolicy>
<Policy>
<WafPolicyName></WafPolicyName>
<CCPolicyName></CCPolicyName>
</Policy>
</CCOnWafPolicy>
</CCdefense>

Table description
Item Description
Feature name CC defense
Table name CcOnWafPolicy
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Name of the WAF String, case-insensitive.
WafPolicyName Index N/A
policy Length: 1 to 63 characters.

Name of the CC String, case-insensitive.

CCPolicyName N/A N/A
policy Length: 1 to 31 characters.

4
Contents

CELLULAR ······································································································································································ 1
CELLULAR/CellularVerificationEnable ···························································································································· 1
XML structure ····························································································································································· 1
Table description ······················································································································································ 1
Columns ····································································································································································· 1

i
CELLULAR
CELLULAR/CellularVerificationEnable
This table is used to enable or disable pin verification in a specific cellular interface.

XML structure
<Cellular>
<CellularVerificationEnable>
<VerificationEnable>
<IfIndex></IfIndex>
<Enable></Enable>
<PinCode></PinCode>
</VerificationEnable>
</CellularVerificationEnable>
</Cellular>

Table description
Item Description
Feature name Cellular
Table name CellularVerificationEnable
Table type Multi-instance table
Row name VerificationEnable
This table supports interface types:
Restrictions
Cellular interface

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Some versions support
interface name. For
relevant information, see
the XSD document of your
IfIndex Interface Index Index Unsigned integer. product. For information
about IfIndex, see
"Appendix" in Ifmgr
NETCONF XML API
Configuration Reference.

1
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
Enable or disable
Enable N/A • false—Disable N/A
pin verification
• true—Enable
Pin code may be
String of digits
PinCode Pin Code N/A required, It is determined
Length: 4 to 6
by the device.

2
Contents

CELLULAR ······································································································································································ 1
CELLULAR/CellularMode·················································································································································· 1
XML structure ····························································································································································· 1
Table description ······················································································································································ 1
Columns ····································································································································································· 1
CELLULAR/CellularApnProfile ·········································································································································· 2
XML structure ····························································································································································· 2
Table description ······················································································································································ 2
Columns ····································································································································································· 3
CELLULAR/CellularApplyProfile ······································································································································· 3
XML structure ····························································································································································· 3
Table description ······················································································································································ 4
Columns ····································································································································································· 4
CELLULAR/CellularProfile ················································································································································· 4
XML structure ····························································································································································· 4
Table description ······················································································································································ 5
Columns ····································································································································································· 5

i
CELLULAR
CELLULAR/CellularMode
This table contains the information about network connection mode.

XML structure
<Cellular>
<CellularMode>
<Mode>
<IfIndex></IfIndex>
<ModeType></ModeType>
</Mode>
</CellularMode>
</Cellular>

Table description
Item Description
Feature name Cellular
Table name CellularMode
Table type Multi-instance table
Row name Mode
This table supports interface types:
Restrictions
Cellular interface
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.

1
 Column Column Data type and
Column name Remarks
description type restrictions
Enumeration:
• 1—1XRTT.
• 2—EVDO.
• 3—HYBRID.
Which mode is
• 4—GSMONLY.
supported depends on
• 5—GSMPREFER. the device.
network
ModeType N/A • 6—WCDMAONLY.
connection mode The default ModeType
• 7—WCDMAPREFER depends on the modem
. model.
• 8—TDONLY.
• 9—TDPREFER.
• 10—LTEONLY.
• 11—AUTO.

CELLULAR/CellularApnProfile
This table contains the information about network cellular apn-profile.

XML structure
<Cellular>
<CellularApnProfile>
<ApnProfile>
<ProfileName></ProfileName>
<ProfileType></ProfileType>
<Apn></Apn>
<AuthType></AuthType>
<UserName></UserName>
<PassWord></PassWord>
</ApnProfile>
</CellularApnProfile>
</Cellular>

Table description
Item Description
Feature name Cellular
Table name CellularApnProfile
Table type Multi-instance table
Row name ApnProfile
Restrictions N/A
Support for row creation and deletion Yes

2
Columns
Column Column Data type and
Column name Remarks
description type restrictions
String. case-sensitive.
ProfileName Profile name Index Length: 1 to 31 N/A
characters.

Enumeration: When the ProfileType is

dynamic, apn is not
ProfileType Access point type N/A • 0—dynamic.
needed, otherwise apn is
• 1—static. required.
String. case-sensitive. Only when the
Apn Access point name N/A Length: 1 to 100 ProfileType is static, the
characters. Apn is required.

Enumeration: When choosing the

Specifies the
• 1—pap. AuthType, UserName
AuthType authentication N/A
• 2—chap. and PassWord is
mode
required.
• 3—pap and chap
String. case-sensitive.
UserName User name N/A Length: 1 to 32 N/A
characters.
String. case-sensitive.
PassWord Password string N/A Length: 1 to 32 N/A
characters.

CELLULAR/CellularApplyProfile
This table contains the information about cellular apply profile to an interface.

XML structure
<Cellular>
<CellularApplyProfile>
<ApplyProfile>
<IfIndex></IfIndex>
<MainProfile></MainProfile>
<BackupProfile></BackupProfile>
</ApplyProfile>
</CellularApplyProfile>
</Cellular>

3
Table description
Item Description
Feature name Cellular
Table name CellularApplyProfile
Table type Multi-instance table
Row name ApplyProfile
Restrictions N/A
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
String. case-sensitive.
Main parameter Configure the main apn
MainProfile N/A Length: 1 to 31
profile profile first.
characters.
String. case-sensitive.
Backup parameter
BackupProfile N/A Length: 1 to 31 N/A
profile
characters.

CELLULAR/CellularProfile
This table contains the information about network cellular profile.

XML structure
<Cellular>
<CellularProfile>
<Profile>
<IfIndex></IfIndex>
<ProfileNum></ProfileNum>
<ProfileType></ProfileType>
<Apn></Apn>

4
 <AuthType></AuthType>
<UserName></UserName>
<PassWord></PassWord>
</Profile>
</CellularProfile>
</Cellular>

Table description
Item Description
Feature name Cellular
Table name CellularProfile
Table type Multi-instance table
Row name Profile

This table supports interface types:

Restrictions
Cellular interface

Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.
Modem parameter Unsigned integer
ProfileNum Index N/A
number Value range:1 to 255.

Enumeration: When the ProfileType is

dynamic, apn is not
ProfileType Access point type N/A • 0—dynamic.
needed, otherwise apn is
• 1—static. required.
String. case-sensitive. Only when the
Apn Access point name N/A Length: 1 to 100 ProfileType is static, the
characters. Apn is required.

AuthType Specifies the N/A Enumeration: When AuthType is none,

5
 Column Column Data type and
Column name Remarks
description type restrictions
authentication • 0—none. UserName is not
mode • 1—pap. required, otherwise
UserName is required.
• 2— chap
• 3— pap and chap

String. case-sensitive.
UserName User name N/A Length: 1 to 32 N/A
characters.
String. case-sensitive. PassWord can not be
PassWord Password string N/A Length: 1 to 32 returned when you get
characters. data.

6
Contents

CELLULAR ······································································································································································ 1
CELLULAR/CellularMode·················································································································································· 1
XML structure ····························································································································································· 1
Table description ······················································································································································ 1
Columns ····································································································································································· 1
CELLULAR/CellularVerificationDis ··································································································································· 2
XML structure ····························································································································································· 2
Table description ······················································································································································ 3
Columns ····································································································································································· 3
CELLULAR/CellularApnProfile ·········································································································································· 3
XML structure ····························································································································································· 3
Table description ······················································································································································ 4
Columns ····································································································································································· 4
CELLULAR/CellularApplyProfile ······································································································································· 4
XML structure ····························································································································································· 5
Table description ······················································································································································ 5
Columns ····································································································································································· 5
CELLULAR/CellularProfile ················································································································································· 6
XML structure ····························································································································································· 6
Table description ······················································································································································ 6
Columns ····································································································································································· 6

i
CELLULAR
CELLULAR/CellularMode
This table contains the information about network connection mode.

XML structure
<Cellular>
<CellularMode>
<Mode>
<IfIndex></IfIndex>
<ModeType></ModeType>
<ModeSupport></ModeSupport>
</Mode>
</CellularMode>
</Cellular>

Table description
Item Description
Feature name Cellular
Table name CellularMode
Table type Multi-instance table
Row name Mode
This table supports interface types:
Restrictions
Cellular interface

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.

1
 Column Column Data type and
Column name Remarks
description type restrictions
Enumeration:
• 0—Unknown.
• 1—CDMA-1x RTT.
• 2—CDMA-EVDO.
• 3—Hybrid.
• 4—GSM. Some devices get the
Network ModeType is unknown,
ModeType N/A • 5—GSM-Preference.
connection mode when they don’t have
• 6—WCDMA. SIM/UIM card.
• 7—WCD-Preference.
• 8—TD-SCDMA.
• 9—TD-Preference.
• 10—LTE.
• 11—Auto.
ModeSupport is bitmap.
Only be used to get the
support network
connection mode.
Auto: 1
CDMA-1x RTT: 1 << 1
CDMA-EVDO: 1 << 2
The modem Hybrid: 1 << 3
ModeSupport N/A Unsigned integer.
support mode GSM: 1 << 4
GSM-Preference: 1<<5
WCDMA: 1<<6
WCD-Preference: 1<<7
TD-SCDMA: 1 <<8
TD-Preference: 1<<9
LTE: 1<<10

CELLULAR/CellularVerificationDis
This table contains the information about pin verification.

XML structure
<Cellular>
<CellularVerificationDis>
<VerificationDis>
<IfIndex></IfIndex>
<Enable></Enable>
<UimStatus></UimStatus>
<RemainNum></RemainNum>
</VerificationDis>

2
 </CellularVerificationDis>
</Cellular>

Table description
Item Description
Feature name Cellular
Table name CellularVerificationDis
Table type Multi-instance table
Row name VerificationDis
This table supports interface types:
Restrictions
Cellular interface

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Boolean:
Enable or disable
Enable N/A • false—Disable N/A
pin verification
• true—Enable
UimStatus PIN status N/A Unsigned integer. N/A
Remaining retries
available for
RemainNum N/A Unsigned integer. N/A
entering the PIN
or PUK.

CELLULAR/CellularApnProfile
This table contains the information about network cellular apn-profile.

XML structure
<Cellular>
<CellularApnProfile>
<ApnProfile>

3
 <ProfileName></ProfileName>
<ProfileType></ProfileType>
<Apn></Apn>
<AuthType></AuthType>
<UserName></UserName>
<PassWord></PassWord>
</ApnProfile>
</CellularApnProfile>
</Cellular>

Table description
Item Description
Feature name Cellular
Table name CellularApnProfile
Table type Multi-instance table
Row name ApnProfile
Restrictions N/A

Columns
Column
Column name Column type Data type and restrictions
description
String. case-sensitive.
ProfileName Profile name Index
Length: 1 to 31 characters.
Enumeration:
ProfileType Access point type N/A • 0—dynamic.
• 1—static.
String. case-sensitive.
Apn Access point name N/A
Length: 1 to 100 characters.
Enumeration:
Specifies the • 1—pap.
AuthType N/A
authentication mode • 2—chap.
• 3—pap and chap
String. case-sensitive.
UserName User name N/A
Length: 1 to 80 characters.
String. case-sensitive.
PassWord Password string N/A
Length: 1 to 32 characters.

CELLULAR/CellularApplyProfile
This table contains the information about cellular apply profile to an interface.

4
XML structure
<Cellular>
<CellularApplyProfile>
<ApplyProfile>
<IfIndex></IfIndex>
<MainProfile></MainProfile>
<BackupProfile></BackupProfile>
</ApplyProfile>
</CellularApplyProfile>
</Cellular>

Table description
Item Description
Feature name Cellular
Table name CellularApplyProfile
Table type Multi-instance table
Row name ApplyProfile
Restrictions N/A

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
String. case-sensitive.
Main parameter
MainProfile N/A Length: 1 to 31 N/A
profile
characters.
String. case-sensitive.
Backup parameter
BackupProfile N/A Length: 1 to 31 N/A
profile
characters.

5
CELLULAR/CellularProfile
This table contains the information about network cellular profile.

XML structure
<Cellular>
<CellularProfile>
<Profile>
<IfIndex></IfIndex>
<ProfileNum></ProfileNum>
<ProfileType></ProfileType>
<Apn></Apn>
<AuthType></AuthType>
<UserName></UserName>
<PassWord></PassWord>
</Profile>
</CellularProfile>
</Cellular>

Table description
Item Description
Feature name Cellular
Table name CellularProfile
Table type Multi-instance table
Row name Profile
This table supports interface types:
Restrictions
Cellular interface

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.

6
 Column Column Data type and
Column name Remarks
description type restrictions
Modem parameter Unsigned integer
ProfileNum Index N/A
number Value range:1 to 255.

Enumeration: When the ProfileType is

dynamic, apn is not
ProfileType Access point type N/A • 0—dynamic.
needed, otherwise apn is
• 1—static. required.
String. case-sensitive. Only when the
Apn Access point name N/A Length: 1 to 100 ProfileType is static, the
characters. Apn is required.

Enumeration:
• 0—none. When AuthType is none,
Specifies the
UserName is not
AuthType authentication N/A • 1—pap.
required, otherwise
mode • 2—chap UserName is required.
• 3—pap and chap
String. case-sensitive.
UserName User name N/A Length: 1 to 32 N/A
characters.
String. case-sensitive. PassWord can not be
PassWord Password string N/A Length: 1 to 32 returned when you get
characters. data.

7
Contents

Comware 7 Cellular NETCONF XML API Error Message Reference······································································· 1

Cellular/CellularVerify ····················································································································································· 1
Cellular/UnLock ································································································································································ 2
Cellular/CellularVerificationEnable ································································································································ 2
Cellular/CellularMode ····················································································································································· 3
Cellular/CellularVerificationDis ······································································································································· 4
Cellular/CellularProfile ····················································································································································· 4
Cellular/CellularApnProfile ·············································································································································· 5
Cellular/CellularApplyProfile ··········································································································································· 5
Cellular/CellularModemReboot ······································································································································ 5

i
Comware 7 Cellular NETCONF XML API Error
Message Reference
Cellular/CellularVerify
Message Explanation
Failed to process the command, because another
Anther command is being processed.
command is being processed.
有未执行完的配置。
正在使用中，配置失败。
This command is not supported. The device does not support this command.
不支持此命令。 设备不支持这个命令。
CELLULAR is not configured. The cellular need to be configured.
CELLULAR口未配置。 需要配置cellular接口。
UIM card has been locked. Please verify PIN first. UIM card has been locked.
UIM卡锁定，请先解锁。 UIM卡被锁定。
SIM card has been locked. Please verify PIN first. SIM card has been locked.
SIM卡锁定，请先解锁。 SIM卡被锁定。
Please enable PIN verification first. Need to be enable PIN verification.
请先使能PIN认证功能 需要使能PIN认证。
Failed to change the PIN, and the number of retries The SIM card will be locked after a certain number of failed to
remaining is x. change the PIN
改变PIN码失败剩余次数x次。 更改PIN失败x次后SIM卡会被锁定。
Failed to change the PIN. Failed to change the PIN.
改变PIN码失败。 改变PIN码失败。
PIN has been locked. Please use PUK to unlock PIN. PIN has been locked.
PIN锁定，请先使用PUK解锁。 PIN被锁定。
3G Modem has no PIN verification requirement. It does not need to be enable PIN verification.
3G上网卡没有PIN认证需求。 不需要PIN认证。
Failed to verify PIN, and the number of retries The SIM card will be locked after a certain number of failed to
remaining is x. verify PIN
认证PIN失败剩余次数x次。 认证PIN失败x次后SIM卡会被锁定。
Failed to verify PIN. PIN Code is error.
认证PIN失败。 PIN码错误。
No 3G/4G modem on this interface. No 3G/4G modem on this interface.
3G/4G Modem不存在。 3G/4G Modem不存在。
3G/4G Modem is being initialized. Please wait. 3G/4G Modem is in the process of being started.
正在初始化3G/4G上网卡，请稍等片刻。 3G/4G上网卡正在启动。
3G/4G Modem is abnormal. 3G/4G Modem is in wrong state.

1
 3G/4G上网卡异常。 3G/4G上网卡状态异常。

Cellular/UnLock
Message Explanation
Operation failed because there is no PIN unlocking
3G modem has no PIN unlocking requirement.
requirement.
3G Modem没有PIN码解锁要求。
操作失败，没有PIN码解锁请求。
Failed to unlock the PIN, and the number of retries The SIM card will be locked after a certain number of failed to
remaining is x. unlock the PIN
解锁失败，剩余解锁次数x。. 解锁PIN失败x次后SIM卡会被锁定。
Failed to unlock the PIN. PIN Code is error.
PIN码解锁失败。 PIN码错误。
PIN Code is invalid. PIN Code is error.
PIN码不合法。 PIN码错误。
PUK Code is invalid. PUK Code is error.
PUK码不合法。 PUK码错误。
The operation can’t be userd on the interface which has not a
No 3G/4G modem on this interface.
3G/4G modem.
3G/4G Modem不存在。
没有3G/4G modem的接口不能执行这个操作。
3G/4G Modem is being initialized. Please wait. 3G/4G Modem is in the process of being started.
正在初始化3G/4G上网卡，请稍等。 3G/4G上网卡正在启动。
3G/4G Modem is abnormal. 3G/4G Modem is in wrong state.
3G/4G上网卡异常。 3G/4G上网卡状态异常。
Failed to process the command, because another
Anther command is being processed.
command is being processed.
有未执行完的配置。
正在使用中，配置失败。
This command is not supported. The device does not support this command.
不支持此命令。 设备不支持这个命令。

Cellular/CellularVerificationEnable
Message Explanation
UIM card has been locked. Please verify PIN first. UIM card has been locked.
UIM卡锁定，请先解锁。 UIM卡被锁定。
SIM card has been locked. Please verify PIN first. SIM card has been locked.
SIM卡锁定，请先解锁。 SIM卡锁定。
PIN has been locked. Please use PUK to unlock PIN. PIN has been locked.
PIN锁定，请先使用PUK解锁。 PIN码被锁定。

2
 PIN is not required. No need to enter a PIN.
不需要PIN码。 不需要输入PIN码。
PIN is required. need to enter a PIN.
需要PIN码。 需要输入PIN码。
Failed to enable PIN verification, and the number of The SIM card will be locked after a certain number of failed to
retries remaining is x. enable PIN verification.
开启PIN认证失败，剩余次数：x次。 开启认证PIN失败x次后，SIM卡会被锁定。
Failed to disable PIN verification, and the number of The SIM card will be locked after a certain number of failed to
retries remaining is x. disable PIN verification.
关闭PIN认证失败，剩余次数：x次。 关闭认证PIN失败x次后，SIM卡会被锁定。
Failed to enable PIN verification. Failed to enable PIN verification.
开启PIN认证失败。 开启PIN认证失败。
Failed to disable PIN verification. Failed to disable PIN verification.
关闭PIN认证失败。 关闭PIN认证失败。

The configuration doesn't meet the requirements. 不 The configuration parameter is incomplete.
符合配置要求。 配置参数不全。
PIN Code is invalid. PIN Code is error.
PIN码不合法。 PIN码错误。
The operation can’t be userd on the interface which has not a
No 3G/4G modem on this interface.
3G/4G modem.
3G/4G Modem不存在。
没有3G/4G modem的接口不能执行这个操作。
3G/4G Modem is being initialized. Please wait. 3G/4G Modem is in the process of being started.
正在初始化3G/4G上网卡，请稍等片刻。 3G/4G上网卡正在启动。
3G/4G Modem is abnormal. 3G/4G Modem is in wrong state.
3G/4G上网卡异常。 3G/4G上网卡状态异常。
Failed to process the command, because another
Anther command is being processed.
command is being processed.
有未执行完的配置。
正在使用中，配置失败。
This command is not supported. The device does not support this command.
不支持此命令。 设备不支持这个命令。

Cellular/CellularMode
Message Explanation
Failed to get the network connection mode. Failed to get the network connection mode.
获取网络连接模式失败。 获取网络连接模式失败。
Don't support the mode. Don't support the mode.
不支持此连接模式。 不支持此连接模式。
No 3G/4G modem on this interface. The operation can’t be userd on the interface which has not a
3G/4G Modem不存在。 3G/4G modem.

3
 没有3G/4G modem的接口不能执行这个操作。
3G/4G Modem is being initialized. Please wait. 3G/4G Modem is in the process of being started.
正在初始化3G/4G上网卡，请稍等片刻。 3G/4G上网卡正在启动。
3G/4G Modem is abnormal. 3G/4G Modem is in wrong state.
3G/4G上网卡异常。 3G/4G上网卡状态异常。
Failed to process the command, because another
Anther command is being processed.
command is being processed.
有未执行完的配置。
正在使用中，配置失败。
This command is not supported. The device does not support this command.
不支持此命令。 设备不支持这个命令。

Cellular/CellularVerificationDis
Message Explanation
Failed to get pin verification. Failed to get pin verification.
获取PIN认证失败。 获取PIN认证失败。
The operation can’t be userd on the interface which has not a
No 3G/4G modem on this interface.
3G/4G modem.
3G/4G Modem不存在。
没有3G/4G modem的接口不能执行这个操作。
3G/4G Modem is being initialized. Please wait. 3G/4G Modem is in the process of being started.
正在初始化3G/4G上网卡，请稍等片刻。 3G/4G上网卡正在启动。
3G/4G Modem is abnormal. 3G/4G Modem is in wrong state.
3G/4G上网卡异常。 3G/4G上网卡状态异常。
Failed to process the command, because another
Anther command is being processed.
command is being processed.
有未执行完的配置。
正在使用中，配置失败。
This command is not supported. The device does not support this command.
不支持此命令。 设备不支持这个命令。

Cellular/CellularProfile
Message Explanation
Failed to create a parameter profile of 3G/4G
Failed to create a parameter profile of 3G/4G Modem.
Modem.
创建3G/4G Modem参数模板失败。
创建3G/4G Modem参数模板失败。
Failed to delete a parameter profile of 3G/4G
Failed to delete a parameter profile of 3G/4G Modem.
Modem.
删除3G/4G Modem参数模板失败。
删除3G/4G Modem参数模板失败。

The configuration doesn't meet the requirements. 不 The configuration parameter is incomplete.
符合配置要求。 配置参数不全。

4
 The operation can’t be userd on the interface which has not a
No 3G/4G modem on this interface. 3G/4G modem.

3G/4G Modem不存在。 没有3G/4G modem的接口不能执行这个操作。

3G/4G Modem is being initialized. Please wait. 3G/4G Modem is in the process of being started.
正在初始化3G/4G上网卡，请稍等片刻。 3G/4G上网卡正在启动。
3G/4G Modem is abnormal. 3G/4G Modem is in wrong state.
3G/4G上网卡异常。 3G/4G上网卡状态异常。
Failed to process the command, because another
Anther command is being processed.
command is being processed.
有未执行完的配置。
正在使用中，配置失败。
This command is not supported. The device does not support this command.
不支持此命令。 设备不支持这个命令。

Cellular/CellularApnProfile
Message Explanation
The configuration doesn't meet the requirements. 不 The configuration parameter is incomplete.
符合配置要求。 配置参数不全。
The apn profile has been applied by interface,
The apn profile has been applied by interface.
delete the applying first.
模板已在其他接口上使用。
该参数模板已被接口应用，请先删除应用。

Cellular/CellularApplyProfile
Message Explanation
The configuration doesn't meet the requirements. 不 The configuration parameter is incomplete.
符合配置要求。 配置参数不全。
Please configure the apn profile first. This message means apn profile not be configured.
请先配置参数模板。 apn profile模板不存在。

Cellular/CellularModemReboot
Message Explanation
Cellular feature is not enabled. This message means cellular not be configured.
CELLULAR特性未启动。 没有cellular特性。
Failed to reboot 3G/4G Modem. 3G/4G Modem reboot failed.
3G/4G Modem重启失败。 3G/4G Modem重启失败。

5
6
Contents
CFD ······························································································1
CFD/Y1731Statistics····················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 2
Columns ······························································································································ 2
CFD/Y1731Statistics/DmTwoways ·································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
CFD/Y1731Statistics/DmTwoways/MepIDs ······················································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 4
CFD/Y1731Statistics/Slms ············································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 5
CFD/Y1731Statistics/Slms/MepIDs ·································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 5
CFD/Y1731Statistics/Dlms ············································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 6
CFD/Y1731Statistics/Dlms/MepIDs ································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 7

i
CFD
CFD/Y1731Statistics
This table contains CFD Statistics information.

XML structure
<CFD>
<Y1731Statistics>
<DmTwoways>
<DmTwoway>
<ServiceInstance></ServiceInstance>
<MepIDs>
<MepID>
<MepID></MepID>
<DelayStatistics>
<TestIndex></TestIndex>
<Delay></Delay>
<DelayVar></DelayVar>
</DelayStatistics>
<AverageDelay></AverageDelay>
<AverageDelayVar></AverageDelayVar>
</MepID>
</MepIDs>
</DmTwoway>
</DmTwoways>
<Slms>
<Slm>
<ServiceInstance></ServiceInstance>
<MepIDs>
<MepID>
<MepID></MepID>
<LossStatistics>
<TestIndex></TestIndex>
<FarEndLoss></FarEndLoss>
<FarEndLossRate></FarEndLossRate>
<NearEndLoss></NearEndLoss>
<NearEndLossRate></NearEndLossRate>
</LossStatistics>
<FarEndLossAverage></FarEndLossAverage>
<FarEndLossAverageRate></FarEndLossAverageRate>
<NearEndLossAverage></NearEndLossAverage>
<NearEndLossAverageRate></NearEndLossAverageRate>
</MepID>
</MepIDs>

1
 </Slm>
</Slms>
<Dlms>
<Dlm>
<ServiceInstance></ServiceInstance>
<MepIDs>
<MepID>
<MepID></MepID>
<LossStatistics>
<TestIndex></TestIndex>
<FarEndLoss></FarEndLoss>
<FarEndLossRate></FarEndLossRate>
<NearEndLoss></NearEndLoss>
<NearEndLossRate></NearEndLossRate>
</LossStatistics>
<FarEndLossAverage></FarEndLossAverage>
<FarEndLossAverageRate></FarEndLossAverageRate>
<NearEndLossAverage></NearEndLossAverage>
<NearEndLossAverageRate></NearEndLossAverageRate>
</MepID>
</MepIDs>
</Dlm>
</Dlms>
</Y1731Statistics>
</CFD>

Table description
Item Description
Feature name CFD
Table name Y1731Statistics
Table type Single-instance table
Row name N/A
Restrictions NO

Columns
Column Column
Column name Data type and restrictions
description type
DmTwoways DmTwoways table Sublist N/A
Slms Slms table Sublist N/A
Dlms Dlms table Sublist N/A

2
CFD/Y1731Statistics/DmTwoways
This table contains two-way DM information.

XML structure
Please refer to the XML structure of Y1731Statistics.

Table description
Item Description
Feature name CFD
Table name DmTwoways
Table type Multi-instance table
Row name DmTwoway
Restrictions NO

Columns
Column Column
Column name Data type and restrictions
description type
Specify a service Unsigned integer:
ServiceInstance index
instance Value range:1 to 32767
MepIDs MEP ID Sublist N/A

CFD/Y1731Statistics/DmTwoways/MepIDs
This table contains two-way DM information for a MEP.

XML structure
Please refer to the XML structure of Y1731Statistics.

Table description
Item Description
Feature name CFD
Table name MepIDs
Table type Multi-instance table
Row name MepID
Restrictions NO

3
Columns
Column Column
Column name Data type and restrictions
description type
Unsigned short.
MepID Specify a MEP Index
Value range:1 to 8191.
Members include:
Data • TestIndex.
DelayStatistics N/A
structure • Delay.
• DelayVar.
Unsigned integer:
TestIndex Specify a test index N/A
Length:32bits

Specify delay time in Unsigned integer:

Delay N/A
us Length: 64 bits.

Specify delay time Unsigned integer:

DelayVar N/A
variation in us Length: 64 bits.

Specify average delay Unsigned integer:

AverageDelay N/A
time in us Length: 64 bits.

Specify average delay Unsigned integer:

AverageDelayVar N/A
time variation in us Length: 64 bits.

CFD/Y1731Statistics/Slms
This table contains SLM information.

XML structure
Please refer to the XML structure of Y1731Statistics.

Table description
Item Description
Feature name CFD
Table name Slms
Table type Multi-instance table
Row name Slm
Restrictions NO

4
Columns
Column Column
Column name Data type and restrictions
description type
Specify a service Unsigned integer:
ServiceInstance index
instance Value range:1 to 32767
MepIDs MEP ID Sublist N/A

CFD/Y1731Statistics/Slms/MepIDs
This table contains SLM information for a MEP.

XML structure
Please refer to the XML structure of Y1731Statistics.

Table description
Item Description
Feature name CFD
Table name MepIDs
Table type Multi-instance table
Row name MepID
Restrictions NO

Columns
Column Column
Column name Data type and restrictions
description type
Unsigned short.
MepID Specify a MEP Index
Value range:1 to 8191.
Members include:
• TestIndex.
Data • FarEndLoss
LossStatistics N/A
structure • NearEndLoss
• FarEndLossRate
• NearEndLossRate
Unsigned integer:
TestIndex Specify a test index N/A
Length:32bits

Specify packet loss Unsigned integer:

FarEndLoss N/A
on the target MEP Length: 32 bits

Specify packet loss Unsigned integer:

NearEndLoss N/A
on the source MEP Length:32bits

5
 Column Column
Column name Data type and restrictions
description type
Specify packet loss
FarEndLossRate rate on the target N/A String
MEP
Specify packet loss
NearEndLossRate rate on the source N/A String
MEP

Specify average Unsigned integer:

FarEndLossAverage packet loss on the N/A
target MEP Length:32bits

Specify average Unsigned integer:

NearEndLossAverage packet loss on the N/A
source MEP Length:32bits

Specify average
FarEndLossAverageRate packet loss rate on N/A String
the target MEP
Specify average
NearEndLossAverageRate packet loss rate on N/A String
the source MEP

CFD/Y1731Statistics/Dlms
This table contains DLM information.

XML structure
Please refer to the XML structure of Y1731Statistics.

Table description
Item Description
Feature name CFD
Table name Dlms
Table type Multi-instance table
Row name Dlm
Restrictions NO

Columns
Column Column
Column name Data type and restrictions
description type
Specify a service Unsigned integer:
ServiceInstance index
instance Value range:1 to 32767
MepIDs MEP ID Sublist N/A

6
CFD/Y1731Statistics/Dlms/MepIDs
This table contains DLM information for a MEP.

XML structure
Please refer to the XML structure of Y1731Statistics.

Table description
Item Description
Feature name CFD
Table name MepIDs
Table type Multi-instance table
Row name MepID
Restrictions NO

Columns
Column Column
Column name Data type and restrictions
description type
Unsigned short.
MepID Specify a MEP index
Value range:1 to 8191.
Members include:
• TestIndex.
Data • FarEndLoss
LossStatistics N/A
structure • NearEndLoss
• FarEndLossRate
• NearEndLossRate
Unsigned integer:
TestIndex Specify a test index N/A
Length:32bits

Specify packet loss Unsigned integer:

FarEndLoss N/A
on the target MEP Length:32bits

Specify packet loss Unsigned integer:

NearEndLoss N/A
on the source MEP Length:32bits
Specify packet loss
FarEndLossRate rate on the target N/A String
MEP
Specify packet loss
NearEndLossRate rate on the source N/A String
MEP
Specify average Unsigned integer:
FarEndLossAverage packet loss on the N/A
target MEP Length:32bits

7
 Column Column
Column name Data type and restrictions
description type
Specify average Unsigned integer:
NearEndLossAverage packet loss on the N/A
source MEP Length:32bits

Specify average
FarEndLossAverageRate packet loss rate on N/A String
the target MEP

Specify average
NearEndLossAverageRate packet loss rate on N/A String
the source MEP

8
Contents
CMTNLMGR ···················································································1
Cmtnlmgr/CloudDomainName ······································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Cmtnlmgr/CloudBackupDomain ···································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
Cmtnlmgr/CloudPort ··················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3

i
CMTNLMGR
Cmtnlmgr/CloudDomainName
This table contains information about cloud domains.

XML structure
<Cmtnlmgr>
<CloudDomainName>
<DomainName></DomainName>
</CloudDomainName>
</Cmtnlmgr>

Table description
Item Description
Feature name Cmtnlmgr
Table name CloudDomainName
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Data type and
Column name Column type Remarks
description restrictions
Name of the String, case-sensitive.
DomainName N/A N/A
cloud domain. Length: 1 to 253 characters.

Cmtnlmgr/CloudBackupDomain
This table contains information about cloud backup domains.

XML structure
<Cmtnlmgr>
<CloudBackupDomain>
<Domain>
<DomainName></DomainName>
</Domain>

1
 </CloudBackupDomain>
</Cmtnlmgr>

Table description
Item Description
Feature name Cmtnlmgr
Table name CloudBackupDomain
Table type Multi-instance table
Row name Domain
Restrictions None
Support for row creation and deletion Yes

Columns
Column Data type and
Column name Column type Remarks
description restrictions
Name of the String, case-sensitive.
DomainName backup cloud Index N/A
domain. Length: 1 to 253 characters.

Cmtnlmgr/CloudPort
This table contains information about cloud server port.

XML structure
<Cmtnlmgr>
<CloudPort>
<Port></Port>
</CloudPort>
</Cmtnlmgr>

Table description
Item Description
Feature name Cmtnlmgr
Table name CloudPort
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

2
Columns
Column
Column name Column type Data type and restrictions Remarks
description
Unsigned integer.
Cloud server
Port N/A Value range: 1 to 65535. N/A
port.
Default: 19443.

3
Contents
CMTNLMGR ···················································································1
Cmtnlmgr/CloudAccount ·············································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Cmtnlmgr/CloudConnect ············································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
Cmtnlmgr/CloudDomainName ······································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
Cmtnlmgr/CloudBackupDomain ···································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
Cmtnlmgr/CloudPort ··················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4

i
CMTNLMGR
Cmtnlmgr/CloudAccount
This table contains information about cloud accounts.

XML structure
<Cmtnlmgr>
<CloudAccount>
<CloudAccountEntry>
<CloudAccountName></CloudAccountName>
<CloudConnectionState></CloudConnectionState>
</CloudAccountEntry>
</CloudAccount>
</Cmtnlmgr>

Table description
Item Description
Feature name Cmtnlmgr
Table name CloudAccount
Table type Single-instance table
Row name CloudAccountEntry
Restrictions None

Columns
Column Data type and
Column name Column type Remarks
description restrictions
String, case-sensitive.
Name of the
CloudAccountName Index Length: 1 to 128 N/A
cloud account.
characters.
Enumeration.
Connection
CloudConnectionState state of the N/A • 1—Online N/A
cloud.
• 2—Offline

Cmtnlmgr/CloudConnect
This table contains connection information for the cloud.

1
XML structure
<Cmtnlmgr>
<CloudConnect>
<CloudConnectEntry>
<LastConnectTime></LastConnectTime>
<LastSyncTime></LastSyncTime>
</CloudConnectEntry>
</CloudConnect>
</Cmtnlmgr>

Table description
Item Description
Feature name Cmtnlmgr
Table name CloudConnect
Table type Single-instance table
Row name CloudConnectEntry
Restrictions None

Columns
Column
Column name Column type Data type and restrictions Remarks
description
Last connection String, case-sensitive.
LastConnectTime N/A N/A
time of the device. Length: 1 to 128 characters.
Last String, case-sensitive.
LastSyncTime synchronization N/A N/A
time of the device. Length: 1 to 128 characters.

Cmtnlmgr/CloudDomainName
This table contains information about cloud domains.

XML structure
<Cmtnlmgr>
<CloudDomainName>
<DomainName></DomainName>
</CloudDomainName>
</Cmtnlmgr>

2
Table description
Item Description
Feature name Cmtnlmgr
Table name CloudDomainName
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Data type and Remarks
Column type
name description restrictions
String, case-sensitive.
Name of the
DomainName N/A Length: 1 to 253 N/A
cloud domain
characters.

Cmtnlmgr/CloudBackupDomain
This table contains information about cloud backup domains.

XML structure
<Cmtnlmgr>
<CloudBackupDomain>
<Domain>
<DomainName></DomainName>
</Domain>
</CloudBackupDomain>
</Cmtnlmgr>

Table description
Item Description
Feature name Cmtnlmgr
Table name CloudBackupDomain
Table type Multi-instance table
Row name Domain
Restrictions None

3
Columns
Column Column Data type and Remarks
Column type
name description restrictions
Name of the String, case-sensitive.
DomainName backup cloud Index Length: 1 to 253 N/A
domain characters.

Cmtnlmgr/CloudPort
This table contains information about cloud server port.

XML structure
<Cmtnlmgr>
<CloudPort>
<Port></Port>
</CloudPort>
</Cmtnlmgr>

Table description
Item Description
Feature name Cmtnlmgr
Table name CloudPort
Table type Single-instance table
Row name None
Restrictions None

Columns
Column
Column name Column type Data type and restrictions Remarks
description
Cloud server Unsigned integer.
Port N/A N/A
port. Value range: 1 to 65535.

4
Contents
CMTNLMGR ···················································································1
Cmtnlmgr/CloudDomainName ······································································································ 1
Cmtnlmgr/CloudBackupDomain ···································································································· 1

i
CMTNLMGR
Cmtnlmgr/CloudDomainName
Message Explanation
The configuration conflicts with that of other
cloud servers. The configuration conflicts with that of other cloud servers.
配置与其他云服务器冲突。
配置与其他云服务器冲突。

Cmtnlmgr/CloudBackupDomain
Message Explanation
The number of backup cloud servers has reached
the limit. The number of backup cloud servers has reached the limit.
备服务器数量已达到上限。
备服务器数量已达到上限。

The configuration conflicts with that of other

The configuration conflicts with that of other cloud servers.
cloud servers.
配置与其他云服务器冲突。
配置与其他云服务器冲突。

1
Contents
Collaboration/ClearInactivePorts ··································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
Collaboration/ClearInactivePorts
This table remove ineffective ports from all collaboration groups

XML structure
<Collaboration>
<ClearInactivePorts>
<Clear></Clear>
</ClearInactivePorts>
</Collaboration>

Table description
Item Description
Feature name Collaboration
Table name ClearInactivePorts
Table type Single-instance table
Row name None
Restrictions None

Columns
Column
Column name Column description Data type and restrictions
type

Remove ineffective ports

Clear from all collaboration N/A This column must be empty.
groups

1
Contents
Collaboration ···················································································1
Collaboration/Global ··················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Collaboration/Groups ·················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
Collaboration/Interfaces··············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3

i
Collaboration
Collaboration/Global
This table contains Collaboration group global information.

XML structure
<Collaboration>
<Global>
<Enable></Enable>
</Global>
</Collaboration>

Table description
Item Description
Feature name Collaboration
Table name Global
Table type Single-instance table
Row name None
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column
Column name Data type and restrictions
description type
Enable Whether Boolean:
Collaboration
group is enabled
N/A • true—Enabled. (default).
globally. • false—Disabled.

Collaboration/Groups
This table contains information about Collaboration group.

XML structure
<Collaboration>
<Groups>
<Group>

1
 <ID></ID>
<UpDelay></UpDelay>
</Group>
</Groups>
</Collaboration>

Table description
Item Description
Feature name Collaboration
Table name Groups
Table type Multi-instance table
Row name Group
Restrictions The maximum collaboration group ID varies by device model.
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type

Unsigned integer The maximum

Collaboration
ID Index collaboration group ID
group ID. Length: 32 bits. varies by device model.

The up delay is the time

Unsigned integer. that the interfaces in the
Updelay timer in
UpDelay
seconds
N/A • Value range: 0 to 3600. collaboration group wait
• Default: 0. before they come up
when the device restarts.

Collaboration/Interfaces
This table contains information about port of Collaboration group.

XML structure
<Collaboration>
<Interfaces>
<Interface>
<IfIndex></IfIndex>
<ID></ID>
</Interface>
</Interfaces>
</Collaboration>

2
Table description
Item Description
Feature name Collaboration
Table name Interfaces
Table type Multi-instance table
Row name Interface
This table supports Layer 2/3 Ethernet interface, Layer 2/3
Restrictions
aggregate interface
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
In certain versions, this
column supports
Unsigned integer. interface name-to-index
IfIndex Interface index Index conversion. See the
product xsd before use.
See Table 1 for the
format.

Unsigned integer. The maximum

Collaboration
ID N/A collaboration group ID
group ID. • Default: 0. varies by device model..

Table 1 Interface operation status

Value Operation status Remarks

Single interface
1 <IfIndex>1</IfIndex>
index
Single interface
2 <IfIndex>GigabitEthernet 0/0/2</IfIndex>
name
Multiple interface <IfIndex>GigabitEthernet 0/0/2 to GigabitEthernet 0/0/3, GigabitEthernet
3
names 1/0/2 to GigabitEthernet 1/0/3, serial0/0/2</IfIndex>
Interface range
4 <IfIndex>RangeName</IfIndex>
name
Mixture of interface
<IfIndex>RangeName ,GigabitEthernet 0/0/2 to GigabitEthernet 0/0/3,
5 range name and
GigabitEthernet 1/0/2 to GigabitEthernet 1/0/3, serial0/0/2</IfIndex>
interface names

3
Contents
Collaboration ···················································································1
Collaboration/Global ··················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Collaboration/Groups ·················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
Collaboration/Interfaces··············································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3

i
Collaboration
Collaboration/Global
This table contains Collaboration group global information.

XML structure
<Collaboration>
<Global>
<Enable></Enable>
<MaxGroupId></MaxGroupId>
</Global>
</Collaboration>

Table description
Item Description
Feature name Collaboration
Table name Global
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column
Column name Data type and restrictions
description type
Enable Whether Boolean:
Collaboration
group is enabled
N/A • true—Enabled.
globally. • false—Disabled.

MaxGroupId The max Unsigned integer

Collaboration N/A
group id Length: 32 bits.

Collaboration/Groups
This table contains information about Collaboration group.

XML structure
<Collaboration>
<Groups>

1
 <Group>
<ID></ID>
<Status></Status>
<UpDelay></UpDelay>
<LastUpTime></LastUpTime>
<LastDownTime></LastDownTime>
</Group>
</Groups>
</Collaboration>

Table description
Item Description
Feature name Collaboration
Table name Groups
Table type Multi-instance table
Row name Group
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type

Unsigned integer The maximum

Collaboration
ID Index collaboration group ID
group ID. Length: 32 bits. varies by device model.

Unsigned integer.
Length: 8 bits.
The status of Enumeration:
Status Collaboration N/A • 0—N/A. N/A
group
• 1—DOWN.
• 2—UP
• 3—UP-Pending.
The up delay is the time
Unsigned integer. that the interfaces in the
Updelay timer in
UpDelay
seconds
N/A • Value range: 0 to 3600. collaboration group wait
• Default: 0. before they come up
when the device restarts.
LastUpTime Group last up
N/A DateTime. N/A
time

LastDownTim Group last down

N/A DateTime. N/A
e time

2
Collaboration/Interfaces
This table contains information about port of Collaboration group.

XML structure
<Collaboration>
<Interfaces>
<Interface>
<IfIndex></IfIndex>
<ID></ID>
<Status></Status>
</Interface>
</Interfaces>
</Collaboration>

Table description
Item Description
Feature name Collaboration
Table name Interfaces
Table type Multi-instance table
Row name Interface
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
In certain versions, this
column supports
interface
name-to-index
IfIndex Interface index Index Unsigned integer.
conversion. See the
product xsd before use.
See Table 1 for the
format.

Unsigned integer The maximum

Collaboration
ID N/A collaboration group ID
group ID. Length: 32 bits. varies by device model.
Unsigned integer.
Length: 8 bits.
Enumeration:
The status of
Status
ports
N/A • 0—UP.
• 1—DOWN.
• 2—Collaboration-down
• 3—Not available

3
Table 1 Interface operation status

Value Operation status Remarks

Single interface
1 <IfIndex>1</IfIndex>
index
Single interface
2 <IfIndex>GigabitEthernet 0/0/2</IfIndex>
name
Multiple interface <IfIndex>GigabitEthernet 0/0/2 to GigabitEthernet 0/0/3, GigabitEthernet
3
names 1/0/2 to GigabitEthernet 1/0/3, serial0/0/2</IfIndex>
Interface range
4 <IfIndex>RangeName</IfIndex>
name
Mixture of interface
<IfIndex>RangeName ,GigabitEthernet 0/0/2 to GigabitEthernet 0/0/3,
5 range name and
GigabitEthernet 1/0/2 to GigabitEthernet 1/0/3, serial0/0/2</IfIndex>
interface names

4
Contents
Configuration···················································································1
Configuration/Files ····················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Configuration/MDCOrContextFiles ································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2

i
Configuration
Configuration/Files
This table contains configuration file information.

XML structure
<Configuration>
<Files>
<File>
<Name></Name>
<NextMain></NextMain>
<NextBackup></NextBackup>
</File>
</Files>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name Files
Table type Multi-instance table

Row name File

Configuration file must have the suffix .cfg, and must already exist
Restrictions
in the root directory of storage medium.

Columns
Column name Column description Column type Data type and restrictions
Full path and filename.
Example:
String.
Name flash:/startup.cfg Index
Length: 1 to 255 characters.
chassis3#slot1#flash:/main
.cfg

Whether the configuration Boolean:

NextMain file is the main next-startup N/A • true
configuration file. • false
Whether the configuration Boolean:
file is the backup
NextBackup
next-startup configuration
N/A • true
file. • false

1
Configuration/MDCOrContextFiles
This table contains information about an MDC or a context.

XML structure
<Configuration>
<MDCOrContextFiles>
<MDCOrContextFile>
<MDCOrContextID></MDCOrContextID>
<Name></Name>
<Save></Save>
<Overwrite></Overwrite>
</MDCOrContextFile>
</MDCOrContextFiles>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name MDCOrContextFiles
Table type Multi-instance table
Row name MDCOrContextFile
On the default MDC or context, all MDCs or contexts can be
operated.
Restrictions
On a non-default MDC or context, only the current MDC or context
can be operated.

Columns
Column
Column name Column description Data type and restrictions
type
MDCOrContextID MDC or context index Index Unsigned integer.

Full path and filename. String.

Example: Length: 1 to 300 characters.

chassis3#slot1#flash:/main This directory must be the root

Name Index directory of the active MPU.
.cfg
flash:/startup.cfg The filename (without the
chassiN#slotN# field) must not
main.cfg exceed 255 characters.
Save Save configuration. N/A This column must be empty.

Whether to overwrite the Boolean:

Overwrite configuration file if it has N/A • true
already existed. • false

2
 Column
Column name Column description Data type and restrictions
type
This column must coexist with the
Save column.

3
Contents
Configuration···················································································1
Configuration/System·················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Configuration/ArchiveLocal ·········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
Configuration/ArchiveServer ········································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
Configuration/ReplaceServer ········································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5

i
Configuration
Configuration/System
This table contains configuration information.

XML structure
<Configuration>
<System>
<Encryption></Encryption>
</System>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name System
Table type Single-instance
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column name Column description Column type Data type and restrictions
Enumeration:
• 0—Unencrypted
Encryption Encryption mode N/A
• 1—Private-key encryption
• 2—Public-key encryption

Configuration/ArchiveLocal
This table contains configuration local archivel information.

XML structure
<Configuration>
<ArchiveLocal>
<Interval></Interval>
<Count></Count>

1
 <DirPath></DirPath>
<Prefix></Prefix>
</ArchiveLocal>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name ArchiveLocal
Table type Single-instance
Row name None
Restrictions None
Support for row creation and deletion Yes

Columns
Column name Column description Column type Data type and restrictions
Time interval to automatic Unsigned integer.
Interval N/A
backup. Value range: 10 to 525600.

Save the maximum number Unsigned integer.

Count N/A
of backup files locally. Value range: 1 to 10.
String.
DirPath Local save path. N/A
Length: 1 to 63 characters.
String.
Prefix Local save file prefix. N/A
Length: 1 to 30 characters.

Configuration/ArchiveServer
This table contains configuration server archive information.

XML structure
<Configuration>
<ArchiveServer>
<ArchiveHost>
<ServerType></ServerType>
<AddressType></AddressType>
<Address></Address>
<VRF></VRF>
<Interval></Interval>
<UserName></UserName>
<Password></Password>
<Port></Port>

2
 <DirPath></DirPath>
<Prefix></Prefix>
</ArchiveHost>
</ArchiveServer>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name ArchiveServer
Table type Single-instance
Row name ArchiveHost
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
ServerType Type of the server. Index • 1—FTP N/A
• 2—TFTP
Enumeration:
Type of the
AddressType
address.
N/A • 1—IPV4 N/A
• 2—IPV6

String. IPv4 example: 1.1.1.1.

Address of the
Address Index Length: 1 to 253 IPv6 example:
remote manage.
characters. 1:2:3:4:5:6:7:8.
String.
VRF VRF name. Index Length: 0 to 31 N/A
characters.
Unsigned integer.
Time interval to
Interval N/A Value range: 10 to N/A
automatic backup.
525600.
String.
UserName User name. N/A Length: 1 to 63 N/A
characters.
String.
Password Password. N/A Length: 1 to 63 N/A
characters.
Unsigned integer.
Port Port Number. N/A N/A
Value range: 1 to 65535.
DirPath Server save path. N/A String. N/A

3
 Column Column Column Data type and
Remarks
name description type restrictions
Length: 1 to 63
characters.
String.
Server save file
Prefix N/A Length: 1 to 30 N/A
prefix.
characters.

Configuration/ReplaceServer
This table contains configuration server replace information.

XML structure
<Configuration>
<ReplaceServer>
<ReplaceHost>
<ServerType></ServerType>
<AddressType></AddressType>
<Address></Address>
<VRF></VRF>
<UserName></UserName>
<Password></Password>
<Port></Port>
<DirPath></DirPath>
<RollbackName></RollbackName>
</ReplaceHost>
</ReplaceServer>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name ReplaceServer
Table type Single-instance
Row name ReplaceHost
Restrictions None
Support for row creation and deletion Yes

4
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
ServerType Type of the server. Index • 1—FTP N/A
• 2—TFTP
Enumeration:
Type of the
AddressType
address.
N/A • 1—IPV4 N/A
• 2—IPV6

String. IPv4 example: 1.1.1.1.

Address of the
Address Index Length: 1 to 253 IPv6 example:
remote manage.
characters. 1:2:3:4:5:6:7:8.
String.
VRF VRF name. Index Length: 0 to 31 N/A
characters.
String.
UserName User name. N/A Length: 1 to 63 N/A
characters.
String.
Password Password. N/A Length: 1 to 63 N/A
characters.
Unsigned integer.
Port Port Number. N/A N/A
Value range: 1 to 65535.
String.
DirPath Server save path. N/A Length: 1 to 63 N/A
characters.
String.
RollbackNam
Server Rollback. N/A Length: 1 to 255 N/A
e
characters.

5
Contents
Configuration···················································································1
Configuration/System·················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Configuration/Files ····················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
Configuration/MDCOrContextFiles ································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
Configuration/ArchiveLocal ·········································································································· 3
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
Configuration/ArchiveServer ········································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5
Configuration/ReplaceServer ········································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7

i
Configuration
Configuration/System
This table contains configuration information.

XML structure
<Configuration>
<System>
<Encryption></Encryption>
</System>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name System
Table type Single-instance
Row name None
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
Enumeration:
• 0—Unencrypted
Encryption Encryption mode. N/A
• 1—Private-key encryption
• 2—Public-key encryption

Configuration/Files
This table contains configuration file information.

XML structure
<Configuration>
<Files>
<File>
<Name></Name>
<Running></Running>
<NextMain></NextMain>

1
 <NextBackup></NextBackup>
</File>
</Files>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name Files
Table type Multi-instance table
Row name File
Configuration file must have the suffix .cfg, and must already exist
Restrictions
in the root directory of storage medium.

Columns
Column name Column description Column type Data type and restrictions
Full path and filename.
Example: String.
Name • flash:/startup.cfg Index
Length: 1 to 255 characters.
• chassis3#slot1#flash:/
main.cfg

Whether the configuration Boolean:

Running file is the current startup N/A • true
configuration file. • false

Whether the configuration Boolean:

NextMain file is the main next-startup N/A • true
configuration file. • false
Whether the configuration Boolean:
file is the backup
NextBackup
next-startup configuration
N/A • true
file. • false

Configuration/MDCOrContextFiles
This table contains configuration file information for an MDC or a context.

XML structure
<Configuration>
<MDCOrContextFiles>
<MDCOrContextFile>
<MDCOrContextID></MDCOrContextID>
<Name></Name>

2
 <Running></Running>
<NextMain></NextMain>
<NextBackup></NextBackup>
</MDCOrContextFile>
</MDCOrContextFiles>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name MDCOrContextFiles
Table type Multi-instance table
Row name MDCOrContextFile
On the default MDC or context, information about all MDCs or
contexts can be queried.
Restrictions
On a non-default MDC or context, only information about the
current MDC or context can be queried.

Columns
Column
Column name Column description Data type and restrictions
type
MDCOrContextID MDC or context index Index Unsigned integer.
Full path and filename.
Example: String.
Name • flash:/startup.cfg Index
Length: 1 to 300 characters.
• chassis3#slot1#flash:/
main.cfg

Whether the configuration Boolean:

Running file is the current startup N/A • true
configuration file. • false

Whether the configuration Boolean:

NextMain file is the main next-startup N/A • true
configuration file. • false
Whether the configuration Boolean:
file is the backup
NextBackup
next-startup configuration
N/A • true
file. • false

Configuration/ArchiveLocal
This table contains configuration local archivel information.

3
XML structure
<Configuration>
<ArchiveLocal>
<Interval></Interval>
<Count></Count>
<DirPath></DirPath>
<Prefix></Prefix>
</ArchiveLocal>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name ArchiveLocal
Table type Single-instance
Row name None
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
Time interval to automatic Unsigned integer.
Interval N/A
backup. Value range: 10 to 525600.

Save the maximum number Unsigned integer.

Count N/A
of backup files locally. Value range: 1 to 10.
String.
DirPath Local save path. N/A
Length: 1 to 63 characters.
String.
Prefix Local save file prefix. N/A
Length: 1 to 30 characters.

Configuration/ArchiveServer
This table contains configuration server archive information.

XML structure
<Configuration>
<ArchiveServer>
<ArchiveHost>
<ServerType></ServerType>
<AddressType></AddressType>
<Address></Address>

4
 <VRF></VRF>
<Interval></Interval>
<UserName></UserName>
<Password></Password>
<Port></Port>
<DirPath></DirPath>
<Prefix></Prefix>
</ArchiveHost>
</ArchiveServer>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name ArchiveServer
Table type Single-instance
Row name ArchiveHost
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
ServerType Type of the server. Index • 1—FTP N/A
• 2—TFTP
Enumeration:
Type of the
AddressType
address.
N/A • 1—IPV4 N/A
• 2—IPV6

String. IPv4 example: 1.1.1.1.

Address of the
Address Index Length: 1 to 253 IPv6 example:
remote manage.
characters. 1:2:3:4:5:6:7:8.
String.
VRF VRF name. Index Length: 0 to 31 N/A
characters.
Unsigned integer.
Time interval to
Interval N/A Value range: 10 to N/A
automatic backup.
525600.
String.
UserName User name. N/A Length: 1 to 63 N/A
characters.
String.
Password Password. N/A Length: 1 to 63 N/A
characters.

5
 Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
Port Port Number. N/A N/A
Value range: 1 to 65535.
String.
DirPath Server save path. N/A Length: 1 to 63 N/A
characters.
String.
Server save file
Prefix N/A Length: 1 to 30 N/A
prefix.
characters.

Configuration/ReplaceServer
This table contains configuration server replace information.

XML structure
<Configuration>
<ReplaceServer>
<ReplaceHost>
<ServerType></ServerType>
<AddressType></AddressType>
<Address></Address>
<VRF></VRF>
<UserName></UserName>
<Password></Password>
<Port></Port>
<DirPath></DirPath>
<RollbackName></RollbackName>
</ReplaceHost>
</ReplaceServer>
</Configuration>

Table description
Item Description
Feature name Configuration
Table name ReplaceServer
Table type Single-instance
Row name ReplaceHost
Restrictions None

6
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
ServerType Type of the server. Index • 1—FTP N/A
• 2—TFTP
Enumeration:
Type of the
AddressType
address.
N/A • 1—IPV4 N/A
• 2—IPV6

String. IPv4 example: 1.1.1.1.

Address of the
Address Index Length: 1 to 253 IPv6 example:
remote manage.
characters. 1:2:3:4:5:6:7:8.
String.
VRF VRF name. Index Length: 0 to 31 N/A
characters.
String.
UserName User name. N/A Length: 1 to 63 N/A
characters.
String.
Password Password. N/A Length: 1 to 63 N/A
characters.
Unsigned integer.
Port Port Number. N/A N/A
Value range: 1 to 65535.
String.
DirPath Server save path. N/A Length: 1 to 63 N/A
characters.
String.
RollbackNam
Server Rollback. N/A Length: 1 to 255 N/A
e
characters.

7
Contents
Configuration···················································································2
Configuration/Files ····················································································································· 2

i
Configuration
Configuration/Files
Message Explanation
The file name is invalid or the file is not in the root
directory! Startup configuration file must be in the root directory.
文件名称不合法或者文件不在主用主控板存储介质 文件名有非法字符或者文件不在主用主控板存储介质的根目录下.
的根目录下.

The file does not exist or is not as the same as the

file on the active MPU. Startup configuration file must be the same on all boards.
文件不存在或者备用主控板的文件与主用主控板的 主用主控板和备用控制板的启动配置文件保持完全相同。
文件不同.

Please specify one or both of the NextMain and Please specify the main next-startup configuration file or the
NextBackup columns. backup next-startup configuration file.
未配置NextMain或NextBackup列. 请配置NextMain或NextBackup配置文件。

2
Contents
Configuration event stream ································································1
SaveEvent event ······················································································································· 1
XML structure for event subscription ························································································ 1
XML structure for event report ································································································ 1
ConfigurationEvent event············································································································· 2
XML structure for event subscription ························································································ 2
XML structure for event report ································································································ 2

i
Configuration event stream
SaveEvent event
This event is used to report configuration saving operations.

XML structure for event subscription

<SaveEvent>
</SaveEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>Configuration</stream>
<filter type="subtree">
<SaveEvent xmlns="http://www.h3c.com/netconf/event:1.0/Configuration:1.0">
</SaveEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name Configuration
Event name SaveEvent
Event namespace http://www.h3c.com/netconf/event:1.0/Configuration:1.0
Support for extended query No

XML structure for event report

<SaveEvent>
<FileName>
</FileName>
</SaveEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<SaveEvent xmlns="http://www.h3c.com/netconf/event:1.0/Configuration:1.0">
<FileName>flash:/123.cfg</FileName>
</SaveEvent>
</notification>

1
Columns

Column name Column description Data type and restrictions

String.
FileName File path and name
Length: 1 to 511 characters.

ConfigurationEvent event
This event is used to report configuration change information.

XML structure for event subscription

<ConfigurationEvent>
</ConfigurationEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>Configuration</stream>
<filter type="subtree">
<ConfigurationEvent
xmlns="http://www.h3c.com/netconf/event:1.0/Configuration:1.0">
</ConfigurationEvent >
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name Configuration
Event name ConfigurationEvent
Event namespace http://www.h3c.com/netconf/event:1.0/Configuration:1.0
Support for extended query No

XML structure for event report

<ConfigurationEvent>
<User></User>
<IpAddress></IpAddress>
<ConfigSource></ConfigSource>
<ConfigResult></ConfigResult>
<Context></Context>
</ConfigurationEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">

2
 <eventTime>2016-07-21T09:10:51</eventTime>
<ConfigurationEvent xmlns="http://www.h3c.com/netconf/event:1.0/Configuration:1.0">
<User>**</User>
<IpAddress>**</IpAddress>
<ConfigSource>CLI</ConfigSource>
<ConfigResult>Success</ConfigResult>
<Context>[system]:display this</Context>
</ConfigurationEvent>
</notification>

Columns

Column name Column description Data type and restrictions Remarks

If the user logged in
User-name of the String. through, for example, a
User
configuration operator Length: 1 to 255 characters. console port, the value of
this field is **
If the user logged in
IP address of the String. through, for example, a
IpAddress
configuration operator Length: 1 to 255 characters. console port, the value of
this field is **

String. The device supports only

Source of the
ConfigSource the CLI in the current
configuration Length: 1 to 255 characters. software version.
String. The values include
ConfigResult Configuration result
Length: 1 to 255 characters. Success and Failed.

Executed command String.

Context and the view of the N/A
command Length: 1 to 1023 characters.

3
Contents
Context ··························································································1
Context/ContextInformations ········································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Context/Resources/Disks············································································································· 2
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
Context/Resources/Memories ······································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
Context/Resources/CPUs ············································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6
Context/Resource/Throughputs····································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7
Context/Resource/ObjectPolicyRules ····························································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 8
Context/Resource/Sessions ········································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 8
Context/Allocations····················································································································· 9
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ···························································································································· 9
Context/LocationBladeControllerTeams(discard) ············································································ 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
Context/Resource/SSLVPNs ······································································································ 11
XML structure ··················································································································· 11
Table description ··············································································································· 12
Columns ·························································································································· 12

i
Context

Context/ContextInformations
This table is used to configure contexts for a device and show context's state.

XML structure
<Context>
<ContextInformations>
<ContextInformation>
<ContextID></ContextID>
<Name></Name>
<State></State>
<Description></Description>
<Mode></Mode>
<Belongto></Belongto>
<BladeControllerTeam></BladeControllerTeam>
</ContextInformation>
</ContextInformations>
</Context>

Table description
Item Description
Feature name Context
Table name ContextInformations
Table type Multi-instance table
Row name ContextInformation
firewall card:to start or stop a context should act in mdc the context
belongedto ;Other actions only support default MDC.
Restrictions
centralized firewall and packaging firewall:Only support default
Context.
Support for row creation and deletion YES

Columns
Column Column Column
Data type and restrictions Remarks
name description type
0 means the
ContextID Context index Index Unsigned integer. system assigns the
lowest ID number

1
 Column Column Column
Data type and restrictions Remarks
name description type
among the
available IDs to the
Context.
firewall card: There
is no default
context.
Full name of an String. centralized firewall
Name N/A
context Length: 1 to 15 characters. and packaging
firewall:The name
of default context is
Admin

Enumeration: start—Start the

context.
State State of the MDC N/A 1: start
stop—Stop the
2: stop context.

Description of String.
Description N/A N/A
context Length: 1 to 255 characters.
firewall card: Name
of context’s
Name of String. parentMDC.
Belongto context’s N/A
parentMDC Length: 1 to 15 characters. centralized firewall
and packaging
firewall:not support
VLAN shared:Vlans
can be allocated to
different context
sharely.
VLAN unshared:4k
vlans belongto the
Enumeration: context unsharely.
Vlan mode of a Default : mode is
Mode N/A 1: VLAN shared
context. VLAN SHARED,
2: VLAN unshared firewall card and
centralized firewall:
the mode can't be
customized
packaging firewall:
the mode can be
customized.
Location: Authorize
the context
BladeControll BladeControllerT Unsigned integer. to use the resource
N/A
erTeam eam ID Value range: 1 to 256. of
BladeControllerTea
ms.

Context/Resources/Disks
This table contains disk infomation.

2
XML structure
<Context>
<Resources>
<Disks>
<Disk>
<ContextID></ContextID>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<ReservedRatio></ReservedRatio>
<QuotaRatio></QuotaRatio>
</Disk>
</Disks>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name Disks
Table type Multi-instance table
Row name Disk
firewall card: Only can be configurated in default MDC.
Restrictions centralized firewall and packaging firewall:Disk resource of user
contexts can be configurated by the default context, while disk
resource of default context can’t be configurated.
Support for row creation and deletion No

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID Context index Index Unsigned integer. N/A

Chassis number of Unsigned integer.

Chassis Index N/A
disk resource Value range: 0 to 65535.

Slot number of disk Unsigned integer.

Slot Index N/A
resource Value range: 0 to 65535.
N/A
CPU ID of disk Unsigned integer.
CPUID Index
resource Value range: 0 to 65535.

ReservedR reserve resources of N/A Unsigned integer. Not support yet.

3
 Column Column Column Data type and
Remarks
name description type restrictions
atio disk(%) Value range: 0 to 100.

The total limit

QuotaRatio resources of N/A Positive integer. The default value is 100.
disk.(%) Value range: 1 to 100.

Context/Resources/Memories
This table contains memory infomation.

XML structure
<Context>
<Resources>
<Memories>
<Memory>
<ContextID></ContextID>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<ReservedRatio></ReservedRatio>
<QuotaRatio></QuotaRatio>
</Memory>
</Memories>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name Memories
Table type Multi-instance table
Row name Memory
firewall card: Only can be configurated in default MDC.
Restrictions centralized firewall and packaging firewall:Memory resource of
user contexts can be configurated by the default context, while
memory resource of default context can’t be configurated.
Support for row creation and deletion No

4
Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID Context index Index Unsigned integer. N/A

Chassis number of Unsigned integer.

Chassis Index N/A
memory resource Value range: 0 to 65535.

Slot number of Unsigned integer.

Slot Index N/A
memory resource Value range: 0 to 65535.
N/A
CPU ID of memory Unsigned integer.
CPUID Index
resource Value range: 0 to 65535.

ReservedR reserve resources Unsigned integer.

N/A Not support yet.
atio of memory(%) Value range: 0 to 100.
The total limit Unsigned integer.
QuotaRatio resources of N/A The default value is 100.
memory(%) Value range: 1 to 100.

Context/Resources/CPUs
This table contains cpu infomation.

XML structure
<Context>
<Resources>
<CPUs>
<CPU>
<ContextID></ContextID>
<Weight></Weight>
</CPU>
</CPUs>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name CPUs
Table type Multi-instance table
Row name CPU
Restrictions firewall card: Only can be configurated in default MDC.

5
 centralized firewall and packaging firewall:CPU resource of user
contexts can be configurated by the default context, while CPU
resource of default context can’t be configurated.
Support for row creation and deletion No

Columns
Column Column
Column description Data type and restrictions Remarks
name type
ContextID Context index Index Unsigned integer. N/A
CPU
Limit maxmum of cpu
weight-maximum of
Positive integer. resource.
Weight available resources N/A
of CPU. Value range:1-10 Default:Each context has
a CPU weight of 10.
UNITS : weight

Context/Resource/Throughputs
This table contains infomation of throughputs.

XML structure
<Context>
<Resources>
<Throughputs>
<Throughput>
<ContextID></ContextID>
<ThroughputValue>
<Unit></Unit>
<Value></Value>
</ThroughputValue>
</Throughput>
</Throughputs>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name Throughputs
Table type Multi-instance table
Row name Throughput
Restrictions Only the default context supports.

6
 Support for row creation and deletion No

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A
Members include:
ThroughputVa Throughputs Data “Unit” should be configed
lue value structure • Unit. together with “value”
• Value.
Enumeration:
Unit of
Unit N/A • 1: kbps N/A
throughput
• 2: pps
Unsigned integer.
Value of
Value N/A Value range: 1000 to N/A
throughput
100000000.

Context/Resource/ObjectPolicyRules
This table contains infomation of Object Policy Rules.

XML structure
<Context>
<Resources>
<ObjectPolicyRules>
<ObjectPolicyRule>
<ContextID></ContextID>
<Max></Max>
</ObjectPolicyRule>
</ObjectPolicyRules>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name ObjectPolicyRules
Table type Multi-instance table
Row name ObjectPolicyRule
Restrictions Only the default context supports.
Support for row creation and deletion No

7
Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A
Maxnum of
The value range depends
Max ObjectPolicyRule N/A Positive integer.
on the device model.
s

Context/Resource/Sessions
This table contains infomation of sessions.

XML structure
<Context>
<Resources>
<Sessions>
<Session>
<ContextID></ContextID>
<MaxNum></MaxNum>
<MaxRate></MaxRate>
</Session>
</Sessions>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name Sessions
Table type Multi-instance table
Row name Session
Restrictions Only the default context supports.
Support for row creation and deletion No

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A
Maxnum of
MaxNum N/A Positive integer. N/A
sessions

8
 Column Column Column Data type and
Remarks
name description type restrictions
Maxnum of
MaxRate N/A Positive integer. N/A
transfer rate:1/s

Context/Allocations
This table contains physical interface.

XML structure
<Context>
<Allocations>
<Allocation>
<ContextID></ContextID>
<UnsharedInterfaceList></UnsharedInterfaceList>
<SharedInterfaceList></SharedInterfaceList>
<VLAN></VLAN>
</Allocation>
</Allocations>
</Context>

Table description
Item Description
Feature name Context
Table name Allocations
Table type Multi-instance table
Row name Allocation
firewall card : only support MDC.
Restrictions centralized firewall and packaging firewall:Only support default
Context.
Support for row creation and deletion No

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID Context ID N/A Unsigned integer. N/A
firewall card :not support
UnsharedIn List of unshared
N/A String. centralized firewall and
terfaceList interfaces
packaging firewall:allocate

9
 Column Column Column Data type and
Remarks
name description type restrictions
unshared interfaces.
Different interfaces
combinations(a sigle
interface or interface
list)are separated by
comma‘,’,interface lists are
separated by ‘to ‘(There is
a apace on both sides of
the word ‘to’).
reference:
GigabitEthernet4/5/0/1 to
GigabitEthernet4/5/0/24 ,
GigabitEthernet4/5/0/48
firewall card :not support
centralized firewall and
packaging firewall:allocate
shared interfaces.
Different interfaces
combinations(a sigle
interface or interface
SharedInte List of shared list)are separated by
N/A String.
rfaceList interfaces comma‘,’,interface lists are
separated by ‘ to’(There is
a apace on both sides of
the word ‘to’).
reference:
GigabitEthernet4/5/0/1 to
GigabitEthernet4/5/0/24 ,
GigabitEthernet4/5/0/48
VLAN Vlan list N/A Numeric string separated N/A
by comma and minus,end
of which can’t be comma
or minux,can’t contain
blank.
Such as: 1,2,3,5-8,10-20

Context/LocationBladeControllerTeams(discard)
This table contains location state of a BladeControllerTeam.

XML structure
<Context>
<LocationBladeControllerTeams>
<LocationBCT>
<ContextID></ContextID>
<BladeControllerTeam></BladeControllerTeam>
<State></State>
</LocationBCT>
</LocationBladeControllerTeams>
</Context>

10
Table description
Item Description
Feature name Context
Table name LocationBladeControllerTeams
Table type Multi-instance table
Row name LocationBCT
firewall card: query all contexts’ infomation in the default MDC.
Restrictions centralized firewall and packaging firewall:query all contexts’
infomation in the default Context.
Support for row creation and deletion No

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A

BladeContr BladeControllerTea Unsigned integer.

Index
ollerTeam m ID Value range: 1to 256.
Location: Authorize the
context
Enumeration: to use the resource of
Configure State of BladeControllerTeams.
State N/A 1: location
location the default context is
2: undo location
authorized to use resource
of all the
bladecontrollerteams

Context/Resource/SSLVPNs
This table contains infomation about SSL VPNs.

XML structure
<Context>
<Resources>
<SSLVPNs>
<SSLVPN>
<ContextID></ContextID>
<MaxUserNum></MaxUserNum>
</SSLVPN>
</SSLVPNs>
</Resources>
</Context>

11
Table description
Item Description
Feature name Context
Table name SSLVPNs
Table type Multi-instance table
Row name SSLVPN
Restrictions Only the default context supports SSL VPN.
Support for row creation and deletion No

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A

Maximum Unsigned integer.

MaxUserNum number of SSL N/A Value range: 1 to N/A
VPN users 1048575.

12
Contents
Context ··························································································1
Context/ContextInformations ········································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Context/Resources/Disks············································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
Context/Resources/Memories ······································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5
Context/Resources/CPUs ············································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
Context/Resource/Throughputs····································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 8
Context/Resource/ObjectPolicyRules ····························································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 9
Context/Resource/Sessions ········································································································· 9
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ···························································································································· 9
Context/InterfaceAllocations ······································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 10
Columns ·························································································································· 10
Context/VLANAllocations ··········································································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 11
Context/Capabilities·················································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 12
Context/LocationBladeControllerTeams(discard) ············································································ 13
XML structure ··················································································································· 13
Table description ··············································································································· 13
Columns ·························································································································· 13
Context/Resource/SSLVPNs ······································································································ 14
XML structure ··················································································································· 14
Table description ··············································································································· 14
Columns ·························································································································· 14

i
Context

Context/ContextInformations
This table is used to configure contexts for a device and show context's state.

XML structure
<Context>
<ContextInformations>
<ContextInformation>
<ContextID></ContextID>
<Name></Name>
<Description></Description>
<Belongto></Belongto>
<Mode></Mode>
<Status></Status>
<BladeControllerTeam></BladeControllerTeam>
</ContextInformation>
</ContextInformations>
</Context>

Table description
Item Description
Feature name Context
Table name ContextInformations
Table type Multi-instance table
Row name ContextInformation
firewall card:query contexts’ infomation in mdc the context
belongedto ; query all contexts’ information in the default MDC.
Restrictions
centralized firewall and packaging firewall:query all contexts’
information in the default Context.

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ContextID Context index Index Unsigned integer. N/A

String. firewall card:There

Full name of an
Name N/A is no default
Context Length: 1 to 15 characters. context.

1
Column Column Column
Data type and restrictions Remarks
name description type
centralized firewall
and packaging
firewall:The name
of default context is
Admin

Description of String.
Description N/A N/A
context Length: 1 to 255 characters.
firewall card: Name
of context’s
Name of String. parentMDC.
Belongto context’s N/A
parentMDC Length: 1 to 15 characters. centralized firewall
and packaging
firewall:blank
VLAN shared:Vlans
can be allocated to
different context
sharely.
VLAN unshared:4k
vlans belongto the
Enumeration: context unsharely.
Vlan mode of a Default : mode is
Mode N/A 1: VLAN shared
context. VLAN SHARED,
2: VLAN unshared firewall card and
centralized firewall:
the mode can't be
customized
packaging firewall:
the mode can be
customized.
• inactive—The
context is
stopped or not
started yet.
• starting—The
device is
executing the
context start
command to
Enumeration: start the
• 1: inactive context.
• 2: starting • active—The
Status of the
Status N/A context is
context • 3: active operating
• 4: stopping correctly.
• 5: updating • stopping—The
device is
executing the
undo context
start command
to stop the
context.
• updating—The
context is
updating.
BladeControll BladeControllerT N/A Unsigned integer. Location: Authorize

2
 Column Column Column
Data type and restrictions Remarks
name description type
erTeam eam ID Value range: 0 to 256. the context
to use the resource
of
BladeControllerTea
ms.
0 means the
context dose not
location
bladecontrollerteam

Context/Resources/Disks
This table contains disk infomation.

XML structure
<Context>
<Resources>
<Disks>
<Disk>
<ContextID></ContextID>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<Partition></Partition>
<Quota></Quota>
<Reserved></Reserved>
<Used></Used>
<Available></Available>
</Disk>
</Disks>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name Disks
Table type Multi-instance table
Row name Disk
firewall card:query contexts’disk resource in mdc the context
Restrictions
belonged to ; query all contexts’ disk resource in the default MDC.

3
 Item Description
centralized firewall and packaging firewall:query all contexts’ disk
resource in the default Context.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID Context index Index Unsigned integer. N/A

Chassis number of Unsigned integer.

Chassis Index N/A
disk resource Value range: 0 to 65535.

Slot number of disk Unsigned integer.

Slot Index N/A
resource Value range: 0 to 65535.

CPU ID of disk Unsigned integer.

CPUID Index N/A
resource Value range: 0 to 65535.
String.
Instance name of
Partition Index Length: 1 to 31 N/A
disk resource
characters.

The total limit Unsigned integer.

Limit maxmum of disk
Quota resources of N/A Value range: 0 to resource.
disk(KB) 4294967295.
Limit minimum of disk
resource.
reserve resources of
Reserved N/A Unsigned integer. 0 means the context
disk(KB)
doesn’t have reserve
resource of disk.
Current usage of
Used N/A Unsigned integer. N/A
disk resources(KB)
Current available The minimum
Available resources of N/A Unsigned integer. between(Quota-Used)and
disk(KB) idle resource of disk.

Context/Resources/Memories
This table contains memory infomation.

XML structure
<Context>
<Resources>
<Memories>
<Memory>
<ContextID></ContextID>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>

4
 <Quota></Quota>
<Reserved></Reserved>
<Used></Used>
<Available></Available>
</Memory>
</Memories>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name Memories
Table type Multi-instance table
Row name Memory
firewall card:query contexts’ memory resource in mdc the context
belonged to ; query all contexts’ memory resource in the default
Restrictions MDC.
centralized firewall and packaging firewall:query all contexts’
memory resource in the default Context.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID Context index Index Unsigned integer. N/A

Chassis number of Unsigned integer.

Chassis Index N/A
memory resource Value range: 0 to 65535.

Slot number of Unsigned integer.

Slot Index N/A
memory resource Value range: 0 to 65535.

CPU ID of memory Unsigned integer.

CPUID Index N/A
resource Value range: 0 to 65535.

The total limit Unsigned integer.

Limit maxmum of disk
Quota resources of N/A Value range: 0 to resource.
memory(KB) 4294967295.
Limit minimum of disk
resource.
reserve resources
Reserved N/A Unsigned integer. 0 means the context
of memory(KB)
doesn’t have reserve
resource of memory.
Current usage of
Used memory N/A Unsigned integer. N/A
resources(KB)
Available Current available N/A Unsigned integer. The minimum

5
 Column Column Column Data type and
Remarks
name description type restrictions
resources of between(Quota-Used)and
memory(KB) idle resource of disk.

Context/Resources/CPUs
This table contains cpu infomation.

XML structure
<Context>
<Resources>
<CPUs>
<CPU>
<ContextID></ContextID>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<Weight></Weight>
<Usage></Usage>
</CPU>
</CPUs>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name CPUs
Table type Multi-instance table
Row name CPU
firewall card:query contexts’ cpu resource in mdc the context
belonged to ; query all contexts’ cpu resource in the default MDC.
Restrictions
centralized firewall and packaging firewall:query all contexts’ cpu
resource in the default Context.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID Context index Index Unsigned integer. N/A
Chassis Chassis number of Index Unsigned integer. N/A

6
 Column Column Column Data type and
Remarks
name description type restrictions
CPU resource Value range: 0 to 65535.

Slot number of Unsigned integer.

Slot Index N/A
CPU resource Value range: 0 to 65535.

CPU ID of CPU Unsigned integer.

CPUID Index N/A
resource Value range: 0 to 65535.

CPU Limit maxmum of cpu

weight-maximum of Positive integer. resource.
Weight N/A
available resources Value range:1-10 Default:Each context has
of CPU(weight) a CPU weight of 10.

Current usage of Unsigned integer.

Usage N/A N/A
CPUresources(%) Value range: 0 to 100.

Context/Resource/Throughputs
This table contains infomation of throughputs.

XML structure
<Context>
<Resources>
<Throughputs>
<Throughput>
<ContextID></ContextID>
<ThroughputValue>
<Unit></Unit>
<Value></Value>
</ThroughputValue>
</Throughput>
</Throughputs>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name Throughputs
Table type Multi-instance table
Row name Throughput
Restrictions Only the default context supports.

7
Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A
Members include:
ThroughputV Throughputs Data
alue value structure • Unit. N/A
• Value.
Enumeration:
Unit of
Unit N/A • 1: kbps N/A
throughput
• 2: pps
Unsigned integer.
Value of
Value N/A Value range: 1000 to 0 means no restrictions
throughput
100000000.

Context/Resource/ObjectPolicyRules
This table contains infomation of Object Policy Rules.

XML structure
<Context>
<Resources>
<ObjectPolicyRules>
<ObjectPolicyRule>
<ContextID></ContextID>
<Max></Max>
</ObjectPolicyRule>
</ObjectPolicyRules>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name ObjectPolicyRules
Table type Multi-instance table
Row name ObjectPolicyRule
Restrictions Only the default context supports.

8
Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A

Maxnum of The value range depends

Max ObjectPolicyRul N/A Positive integer. on the device model.
es 0 means no restrictions

Context/Resource/Sessions
This table contains infomation of sessions.

XML structure
<Context>
<Resources>
<Sessions>
<Session>
<ContextID></ContextID>
<MaxNum></MaxNum>
<MaxRate></MaxRate>
</Session>
</Sessions>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name Sessions
Table type Multi-instance table
Row name Session
Restrictions Only the default context supports.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A
Maxnum of
MaxNum N/A Positive integer. 0 means no restrictions
sessions
MaxRate Maxnum of N/A Positive integer. 0 means no restrictions

9
 Column Column Column Data type and
Remarks
name description type restrictions
transfer rate:1/s

Context/InterfaceAllocations
This table contains physical interface.

XML structure
<Context>
<InterfaceAllocations>
<InterfaceAllocation>
<IfName></IfName>
<ContextID></ContextID>
<AllocType></AllocType>
</InterfaceAllocation>
</InterfaceAllocations>
</Context>

Table description
Item Description
Feature name Context
Table name InterfaceAllocations
Table type Multi-instance table
Row name Interface
Default Context can query thel contexts’ information of all te
Restrictions
interfaces.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String.
Full name of an
IfName Index Length: 2 to 47 N/A
interface
characters.
ContextID Context ID Index Unsigned integer. N/A
Enumeration:
• 0: Invalid
Interface
AllocType
assignment type
N/A • 1: The interface N/A
has not been
allocated.

10
 Column Column Column Data type and
Remarks
name description type restrictions
• 2: The allocation
type is shared.
• 3: The allocation
type is exclusive.

Context/VLANAllocations
This table contains informations of vlans.

XML structure
<Context>
<VLANAllocations>
<VLANAllocation>
<VLANID></VLANID>
<ContextID></ContextID>
<ContextIDList></ContextIDList>
</VLANAllocation>
</VLANAllocations>
</Context>

Table description
Item Description
Feature name Context
Table name VLANAllocations
Table type Multi-instance table
Row name VLANAllocation
Restrictions Default Context can query thel contexts’ information of all te vlans.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
firewall card :There is not
default context.
VLANID Vlan Index Index Positive integer. centralized firewall and
packaging firewall:the
default Context’s ID is 1.
The minimal Context ID of
ContextID Context ID N/A Unsigned integer.
the VLAN
ContextIDList Context ID List N/A String. Example: 2,3,5-8,10-20.

11
 Column Column Column Data type and
Remarks
name description type restrictions
Length: 1to 65535 Available Context IDs are
characters. in the ContextID column in
It is a comma-separated the
list of Context ID items. An Context/ContextInformatio
item can be an individual ns table.
Context ID or a Context ID
range. Use a hyphen (-) to
separate the start and end
Context IDs of a range.
The string cannot end with
a comma or hyphen, or
include any whitespace
characters.

Context/Capabilities
This table contains capability information of context.

XML structure
<Context>
<Capabilitys>
<BelongtoSupport></BelongtoSupport>
<ModeSupport></ModeSupport>
</Capabilitys>
</Context>

Table description
Item Description
Feature name Context
Table name Capabilities
Table type Multi-instance table
Row name N/A
Restrictions Only support the default context.

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Check whether Boolean:
BelongtoSupp
belongto can be N/A • true N/A
ort
configured. • false

Check whether Boolean:

ModeSupport vlan mode can N/A • true N/A
be configured. • false

12
Context/LocationBladeControllerTeams(discard)
This table contains location state of a BladeControllerTeam.

XML structure
<Context>
<LocationBladeControllerTeams>
<LocationBCT>
<ContextID></ContextID>
<BladeControllerTeam></BladeControllerTeam>
<State></State>
</LocationBCT>
</LocationBladeControllerTeams>
</Context>

Table description
Item Description
Feature name Context
Table name LocationBladeControllerTeams
Table type Multi-instance table
Row name LocationBCT
firewall card: query all contexts’ infomation in the default MDC.
Restrictions centralized firewall and packaging firewall:query all contexts’
infomation in the default Context.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A

BladeContr BladeControllerTea Unsigned integer.

N/A
ollerTeam m ID Value range: 1to 256.
Location: Authorize the
context
Enumeration: to use the resource of
Configure State of BladeControllerTeams.
State N/A 1: location
location the default context is
2: undo location
authorized to use
resource of all the
bladecontrollerteams

13
Context/Resource/SSLVPNs
This table contains infomation about SSL VPNs.

XML structure
<Context>
<Resources>
<SSLVPNs>
<SSLVPN>
<ContextID></ContextID>
<MaxUserNum></MaxUserNum>
</SSLVPN>
</SSLVPNs>
</Resources>
</Context>

Table description
Item Description
Feature name Context
Table name SSLVPNs
Table type Multi-instance table
Row name SSLVPN
Restrictions Only the default context supports SSL VPN.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A

Maximum Unsigned integer. 0 means no limit on the

MaxUserNum number of SSL N/A Value range: 1 to number of SSL VPN
VPN users 1048575. users.

14
Contents
Context ··························································································1
Context/ContextInformations ········································································································ 1
Context/Resources/Disks············································································································· 2
Context/Resources/Memories ······································································································· 2
Context/Resources/CPUs ············································································································ 2
Context/LocationBladeControllerTeams(discard) ·············································································· 3
Context/Allocation ······················································································································ 3

i
Context

Context/ContextInformations
Message Explanation
Not enough resources available for this context. Not enough resources available for this context.
资源不足，操作失败。 资源不足，操作失败。

Number of contexts exceeded the limit.

Number of contexts exceeded the limit.
创建Context失败，因为创建的Context数目已经达到
创建Context失败，因为创建的Context数目已经达到上限。
上限。

Another context is using the ID when creating a context. Please

Another context is using the ID. switch a new one.
另外一个Context正在使用该ID。 当创建context时，另外一个Context正在使用该ID。请换一个新的
id。

The name is already exists. The name is already exists when creating a new context.
该名称已经存在。 当创建context时，该名称已经存在。

Operation failed. The context is already started.

Operation failed. The context is already started.
设置Context归属于某个MDC失败，因为Context已
设置Context归属于某个MDC失败，因为Context已经启动。
经启动。

The MDC is not authorized to use the blade

The MDC is not authorized to use the blade controller team.
controller team. "
设置Context归属于某个MDC失败，因为指定MDC并没有进驻该
设置Context归属于某个MDC失败，因为指定MDC
Context已经进驻的安全引擎组。
并没有进驻该Context已经进驻的安全引擎组。

The context doesn't belong to the MDC.

The context doesn't belong to the MDC.
启动Context失败，因为该Context并不属于当前
启动Context失败，因为该Context并不属于当前MDC。
MDC。

This context has been assigned to another blade

This context has been assigned to another blade controller team.
controller team.
该Context已经进驻其他安全引擎组。
该Context已经进驻其他安全引擎组。

Restoring context configuration. Please try again

Restoring context configuration. Please try again later.
later.
Context正在配置恢复，请稍候。
Context正在配置恢复，请稍候。

The context is starting or stopping. Please try again later if need

Context is busy. Please try again later.
do some set operations.
Context正在忙，请稍后重试。
Context正在启动或者停止，如果要做配置操作请稍后重试。

The context name and ID must identify the same

The context name and ID must identify the same context.
context.
输入的Context名称有误，请输入与ID对应的名称。
输入的Context名称有误，请输入与ID对应的名称。

The mode is wrong. Please input the right mode The mode is wrong. Please input the right mode according to the
according to the context ID. context ID.
输入的mode值有误，请输入与ID对应的mode值。 输入的Vlan mode值有误，请输入与ID对应的Vlan mode值。

Invalid context ID or context name. Invalid context ID or context name.

1
输入了无效的Context ID 或者名称。 输入了无效的Context ID 或者名称。

The default context can't be deleted. The default context can't be deleted.
不允许删除缺省Context。 不允许删除缺省Context。

The default context can't be deleted. The default context can't be deleted.
不允许删除缺省Context。 不允许删除缺省Context。

Context/Resources/Disks
Message Explanation
Not enough disk space available when limit the disk space.
Not enough disk space available.
Please set the limit bigger.
磁盘资源不足。
磁盘资源不足， 请设置大一点的磁盘空间。

The context is not authorized to use this blade The context is not authorized to use this blade controller. So it
controller. cannot be limited the disk resource.
Context没有进驻该安全引擎。 Context没有进驻该安全引擎，所以不能设置磁盘资源。

Restoring context configuration. Please try again

Restoring context configuration. Please try again later.
later.
Context正在配置恢复，请稍候。
Context正在配置恢复，请稍候。

The context is starting or stopping. Please try again later if need

Context is busy. Please try again later.
do some set operations.
Context正在忙，请稍后重试。
Context正在启动或者停止，如果要做配置操作请稍后重试。

Context/Resources/Memories
Message Explanation
The context is not authorized to use this blade The context is not authorized to use this blade controller. So it
controller. cannot be limited the memory resource.
Context没有进驻该安全引擎。 Context没有进驻该安全引擎，所以不能设置内存资源。

Restoring context configuration. Please try again

Restoring context configuration. Please try again later.
later.
Context正在配置恢复，请稍候。
Context正在配置恢复，请稍候。

The context is starting or stopping. Please try again later if need

Context is busy. Please try again later.
do some set operations.
Context正在忙，请稍后重试。
Context正在启动或者停止，如果要做配置操作请稍后重试。

Context/Resources/CPUs
Message Explanation
Restoring context configuration. Please try again
Restoring context configuration. Please try again later.
later.
Context正在配置恢复，请稍候。
Context正在配置恢复，请稍候。

2
 The context is starting or stopping. Please try again later if need
Context is busy. Please try again later.
do some set operations.
Context正在忙，请稍后重试。
Context正在启动或者停止，如果要做配置操作请稍后重试。

Context/LocationBladeControllerTeams(discard)
Message Explanation
Authorization failed. Invalid blade-controller-team
Authorization failed. Invalid blade-controller-team ID.
ID.
操作失败，该安全引擎组ID无效。
操作失败，该安全引擎组ID无效。

This context has been assigned to another blade

This context has been assigned to another blade controller team.
controller team.
该Context已经进驻其他安全引擎组。
该Context已经进驻其他安全引擎组。

The MDC this context belongs to is not authorized The MDC this context belongs to is not authorized to use the
to use the blade controller team. blade controller team.
该Context的归属MDC没有进驻该安全引擎组。 该Context的归属MDC没有进驻该安全引擎组。

Restoring context configuration. Please try again

Restoring context configuration. Please try again later.
later.
Context正在配置恢复，请稍候。
Context正在配置恢复，请稍候。

The context is starting or stopping. Please try again later if need

Context is busy. Please try again later.
do some set operations.
Context正在忙，请稍后重试。
Context正在启动或者停止，如果要做配置操作请稍后重试。

Context/Allocation
Message Explanation
Some interfaces are duplicated. Some interfaces are duplicated.
接口列表中包含重复的接口。 接口列表中包含重复的接口。

Some VLANs are used by another context. Some VLANs are used by another context.
VLAN列表中有VLAN已经被分配到其它Context。 VLAN列表中有VLAN已经被分配到其它Context。

Some interfaces name are invalid. Some interfaces name are invalid.
接口列表中包含非法的接口名。 接口列表中包含非法的接口名。

Some interfaces have been allocated as other

mode. Some interfaces have been allocated as other mode.
接口列表中有接口已经被分配为其它模式，分配模 接口列表中有接口已经被分配为其它模式，分配模式冲突。
式冲突。

Some type of interfaces can not be allocated to a

Some type of interfaces can not be allocated to a context
context exclusively.
exclusively.
接口列表中有接口已经被分配为其它模式，分配模
接口列表中有接口已经被分配为其它模式，分配模式冲突。
式冲突。

Layer-2 Ethernet interface can not be allocated to a Layer-2 Ethernet interface can not be allocated to a VLAN-shared
VLAN-shared context exclusively. context exclusively.
二层接口不能独占分配给VLAN-shared Context。 二层接口不能独占分配给VLAN-shared Context。

3
Layer-2 Ethernet interface can not be allocated to a Layer-2 Ethernet interface can not be allocated to a
VLAN-unshared context in sharing mode. VLAN-unshared context in sharing mode.
二层接口不能共享分配给VLAN-unshared Context。 二层接口不能共享分配给VLAN-unshared Context。

Subinterfaces can not be allocated exclusively. Subinterfaces can not be allocated exclusively.
接口列表中包含的子接口不能再被独占分配。 接口列表中包含的子接口不能再被独占分配。

Some interfaces' sub interface has been allocated.

Some interfaces' sub interface has been allocated.
接口列表中有接口的子接口已经被分配，接口不能
接口列表中有接口的子接口已经被分配，接口不能再被分配。
再被分配。

Some interfaces' aggregate interface has been

Some interfaces' aggregate interface has been allocated.
allocated.
接口列表中有聚合成员口的聚合口已经被分配，聚合成员口不能再
接口列表中有聚合成员口的聚合口已经被分配，聚
被分配。
合成员口不能再被分配。

Some interfaces' member interface has been

allocated. Some interfaces' member interface has been allocated.
接口列表中有聚合口的成员口已经被分配，聚合口 接口列表中有聚合口的成员口已经被分配，聚合口不能再被分配。
不能再被分配。

Failed to allocate nonexistent VLANs. Failed to allocate nonexistent VLANs.

无法分配不存在的VLAN。 无法分配不存在的VLAN。

Default VLAN can not be allocated. Default VLAN can not be allocated.
默认VLAN不能被分配 默认VLAN不能被分配

Failed to allocate VLANs because some of them Failed to allocate VLANs because some of them are configured
are configured as port PVIDs. as port PVIDs.
VLAN分配失败，其中部分由于已配置成端口PVID VLAN分配失败，其中部分由于已配置成端口PVID

Failed to allocate VLANs because some of them

Failed to allocate VLANs because some of them have VLAN
have VLAN interfaces.
interfaces.
VLAN分配失败，其中部分由于已存在对应的VLAN
VLAN分配失败，其中部分由于已存在对应的VLAN接口
接口

VLAN interface can not be allocated to a VLAN interface can not be allocated to a VLAN-unshared context
VLAN-unshared context in sharing mode. in sharing mode.
VLAN分配失败，VLAN接口不能共享分配给 VLAN分配失败，VLAN接口不能共享分配给VLAN-unshared
VLAN-unshared Context Context
Failed to allocate the interfaces in sharing mode
Failed to allocate the interfaces in sharing mode because some of
because some of them are members of Reth
them are members of Reth groups.
groups.
指定的接口中包含冗余组的成员接口，冗余组成员接口不能被共享
指定的接口中包含冗余组的成员接口，冗余组成员
分配。
接口不能被共享分配。

Failed to allocate the interfaces in sharing mode

Failed to allocate the interfaces in sharing mode because some of
because some of them are members of
them are members of aggregation groups.
aggregation groups.
指定的接口中包含聚合组的成员接口，聚合组成员接口不能被共享
指定的接口中包含聚合组的成员接口，聚合组成员
分配。
接口不能被共享分配。

4
5
Contents
CP ································································································1
CP/ClearPolicyStats ··················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
CP/ClearAllPolicyStats ················································································································ 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
CP/ClearPolicies ························································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
CP/ClearAllPolicies ···················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4

i
CP
CP/ClearPolicyStats
This table is used to clear statistics for the caching policy.

XML structure
<CP>
<ClearPolicyStats>
<ClearPolicyStat>
<Name></Name>
<Clear></Clear>
</ClearPolicyStat>
</ClearPolicyStats>
</CP>

Table description
Item Description
Feature name CP
Table name ClearPolicyStats
Table type Multi-instance table
Row name ClearPolicyStat
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type

Name of the String, case insensitive.

Name Index N/A
caching policy. Length: 1 to 63 characters.
Clears statistics
Clear for the specified N/A This column must be empty. N/A
policy.

CP/ClearAllPolicyStats
This table is used to clear statistics for all caching policies.

1
XML structure
<CP>
<ClearAllPolicyStats>
<Clear></Clear>
</ClearAllPolicyStats>
</CP>

Table description
Item Description
Feature name CP
Table name ClearAllPolicyStats
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Clears statistics
Clear for all caching N/A This column must be empty. N/A
policies.

CP/ClearPolicies
This table is used to clear the caching policy.

XML structure
<CP>
<ClearPolicies>
<ClearPolicy>
<Name></Name>
<Clear></Clear>
</ClearPolicy>
</ClearPolicies>
</CP>

2
Table description
Item Description
Feature name CP
Table name ClearPolicies
Table type Multi-instance table
Row name ClearPolicy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type

Name of the String, case insensitive.

Name Index N/A
caching policy. Length: 1 to 63 characters.
Clears files the
Clear N/A This column must be empty. N/A
specified policy.

CP/ClearAllPolicies
This table is used to clear all caching policies.

XML structure
<CP>
<ClearAllPolicies>
<Clear></Clear>
</ClearAllPolicies>
</CP>

Table description
Item Description
Feature name CP
Table name ClearAllPolicies
Table type Single-instance table
Row name N/A
Restrictions None

3
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Clears files for all
Clear N/A This column must be empty. N/A
caching policies.

4
Contents
CP ································································································1
CP/Policys ································································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
CP/HTTPMatchRules·················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3

i
CP
CP/Policys
This table contains information about a caching policy.

XML structure
<CP>
<Policys>
<Policy>
<Name></Name>
<Type></Type>
<Size></Size>
<FileSize></FileSize>
<DefaultAgeTime></DefaultAgeTime>
</Policy>
</Policys>
</CP>

Table description

Item Description
Feature name CP
Table name Policys
Table type Multi-instance table
Row name Policy
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String,
Name of the case-insensitive.
Name Index N/A
caching policy. Length: 1 to 63
characters.
This column is required.
Type of the Enumeration:
Type N/A Once created, this column cannot be
caching policy. • 0—HTTP.
changed..

Size of the Unsigned integer.

Size N/A N/A
caching policy. Value range: 8 to 64.

1
 Column Column Column Data type and
Remarks
name description type restrictions
Unit: MB.
By default, the value
is 64M.
Unsigned integer.
Maximum total Value range: 1 to
size of the files 4096.
FileSize N/A N/A
that can be Unit: KB.
cached.
By default, the value
is 2048KB.
Unsigned integer.
Value range: 1 to
Default aging 1440.
DefaultAgeT
time of the N/A N/A
ime Unit: Minute.
caching policy.
By default, the value
is 60.

CP/HTTPMatchRules
This table contains information about an HTTP match rule.

XML structure
<CP>
<HTTPMatchRules>
<HTTPMatchRule>
<Policy></Policy>
<ID></ID>
<Type></Type>
<URI></URI>
</HTTPMatchRule>
</HTTPMatchRules>
</CP>

Table description

Item Description
Feature name CP
Table name HTTPMatchRules
Table type Multi-instance table
Row name HTTPMatchRule
Support for row creation and deletion Yes

2
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String,
Name of the case-insensitive.
Policy Index N/A
policy. Length: 1 to 63
characters.
Unsigned integer.
ID of the
ID Index Value range:1 to N/A
match rule.
65535.

Type of the Enumeration:

Type N/A N/A
match rule. • 0—URI.
Regular String.
expression This column can be configured only
URI N/A Length: 1 to 255
matched the when the type is URI (0).
URI. characters.

3
Contents
CP ································································································1
CP/Policys ································································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
CP/HTTPMatchRules·················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
CP/PolicyStats ·························································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4

i
CP
CP/Policys
This table contains information about a caching policy.

XML structure
<CP>
<Policys>
<Policy>
<Name></Name>
<Type></Type>
<Size></Size>
<FileSize></FileSize>
<DefaultAgeTime></DefaultAgeTime>
</Policy>
</Policys>
</CP>

Table description
Item Description
Feature name CP
Table name Policys
Table type Multi-instance table
Row name Policy

Columns
Column Column Data type and
Column name Remarks
description type restrictions
String, case
Name of the insensitive.
Name Index N/A
caching policy. Length: 1 to 63
characters.
This column is required.
Type of the Enumeration:
Type N/A Once created, this column cannot
caching policy. • 0—HTTP.
be changed.
Unsigned
Size of the integer.
Size N/A N/A
caching policy. Value range: 8
to 64.

1
 Column Column Data type and
Column name Remarks
description type restrictions
Unit: MB.
Unsigned
Maximum total integer.
size of the files
FileSize N/A Value range: 1 N/A
that can be
to 4096.
cached.
Unit: KB.
Unsigned
Default aging integer.
DefaultAgeTime time of the N/A Value range: 1 N/A
caching policy. to 1440.
Unit: minutes.

CP/HTTPMatchRules
This table contains information about an HTTP match rule.

XML structure
<CP>
<HTTPMatchRules>
<HTTPMatchRule>
<Policy></Policy>
<ID></ID>
<Type></Type>
<URI></URI>
</HTTPMatchRule>
</HTTPMatchRules>
</CP>

Table description
Item Description
Feature name CP
Table name HTTPMatchRules
Table type Multi-instance table
Row name HTTPMatchRule

2
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case
Name of the insensitive.
Policy Index N/A
policy. Length: 1 to 63
characters.
Unsigned integer.
ID of the
ID Index Value range: 1 to N/A
match rule.
65535.

Type of the Enumeration:

Type N/A N/A
match rule. • 0—URI.
Regular String.
expression This column can be configured only if
URI N/A Length: 1 to 255
used for URI the type is URI (0).
matching. characters.

CP/PolicyStats
This table contains statistics about the caching Policy.

XML structure
<CP>
<PolicyStats>
<PolicyStat>
<Name></Name>
<ChassisID></ChassisID>
<SlotID></SlotID>
<CPUID></CPUID>
<MatchedReqs></MatchedReqs>
</PolicyStat>
</PolicyStats>
</CP>

Table description
Item Description
Feature name CP
Table name PolicyStats
Table type Multi-instance table
Row name PolicyStat

3
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String,
Name of the case-insensitive.
Name Index N/A
caching policy. Length: 1 to 63
characters.

Member ID of Unsigned integer.

ChassisID the device in Index Value range: 0 to N/A
the IRF fabric. 255.
Unsigned integer.
Slot number of
SlotID Index Value range: 0 to N/A
the card.
255.
Unsigned integer.
CPUID CPU number. Index Value range: 0 to N/A
255.
Unsigned integer.
Number of
MatchedReqs N/A Value range: 0 to N/A
matches 64
2 -1.

4
Contents
CP ································································································1
CP/Policys ·································································································································· 1
CP/HTTPMatchRules···················································································································· 1

i
CP
CP/Policys
Message Explanation
The cache policy name has been used
The cache policy name has been used by another
by another cache policy.
cache policy.
缓存策略名称与已存在的其他类型缓存策
缓存策略名称与已存在的其他类型缓存策略重名。
略重名。

CP/HTTPMatchRules
Message Explanation
The URI already exists. The URI already exists.
URI已存在。 URI 已存在。

1
Contents
CustomLog ·····················································································1
CustomLog/LogHost ··················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 2
CustomLog/LogAttribute ·············································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5

i
CustomLog
CustomLog/LogHost
This table contains custom log hosts information.

XML structure
<CustomLog>
<LogHosts>
<Host>
<Address></Address>
<VRF></VRF>
<Port></Port>
<OutputLog>
<CmccSessionlog></CmccSessionlog>
<CmccUserlog></CmccUserlog>
<TelecomSessionlog></TelecomSessionlog>
<TelecomUserlog></TelecomUserlog>
<UnicomSessionlog></UnicomSessionlog>
<UnicomUserlog></UnicomUserlog>
<Sessionlog></Sessionlog>
<PacketFilterlog></PacketFilterlog>
<ATKlog></ATKlog>
<AFTlog></AFTlog>
<DPIAuditlog></DPIAuditlog>
<DPIUfltlog></DPIUfltlog>
<DPINetSharelog></DPINetSharelog>
<SCDlog></SCDlog>
<DPIIPSlog></DPIIPSlog>
<DPIIPReputationlog></DPIIPReputationlog>
<DPIAVClog></DPIAVClog>
<DPISandboxlog></DPISandboxlog>
</OutputLog>
</Host>
</LogHosts>
</CustomLog>

Table description
Item Description
Feature name CustomLog
Table name LogHosts
Table type Multi-instance table
Row name Host

1
 Restrictions The device supports up to four log hosts.
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
IPv4: String, dotted decimal
notation.
IPv4 example: 1.1.1.1
IPv6: Hexadecimal string,
Address of the colon-separated. IPv6 example:
Address Index 1:2:3:4:5:6:7:8
log host
Host name: Case-insensitive
string. HostName example:
www. example.com
Host name length: 1 to 253
characters.
If the log host is on the
VPN instance String. public network, the
VRF Index
name Length: 0 to 31 characters. length of characters is
0.
Unsigned integer.
Port number of
Port Index Value range: 1 to 65535. N/A
the log host
Default: 514.
Members include:
• CmccSessionlog
• CmccUserlog
• TelecomSessionlog
• TelecomUserlog
• UnicomSessionlog
• UnicomUserlog
• Sessionlog
Type of logs to • PacketFilterlog
Data
OutputLog be sent to the log
structure • ATKlog N/A
host • AFTlog
• DPIAuditlog
• DPIUfltlog
• DPINetSharelog
• SCDlog
• DPIIPSlog
• DPIIPReputationlog
• DPIAVClog
• DPISandboxlog
Enabling status
of outputting
session-based Boolean:
CmccSessionl
og
custom NAT444 N/A • true—Enabled. N/A
logs in CMCC • false—Disabled.
format to the log
host

2
Column Column Column
Data type and restrictions Remarks
name description type
Enabling status
of outputting
user-based Boolean:
CmccUserlog custom NAT444 N/A • true—Enabled. N/A
logs in CMCC • false—Disabled.
format to the log
host
Enabling status
of outputting
session-based Boolean:
TelecomSessi
onlog
custom NAT444 N/A • true—Enabled. N/A
logs in Telecom • false—Disabled.
format to the log
host
Enabling status
of outputting
user-based Boolean:
TelecomUserl
og
custom NAT444 N/A • true—Enabled. N/A
logs in Telecom • false—Disabled.
format to the log
host
Enabling status
of outputting
session-based Boolean:
UnicomSessio
nlog
custom NAT444 N/A • true—Enabled. N/A
logs in Unicom • false—Disabled.
format to the log
host
Enabling status
of outputting
user-based Boolean:
UnicomUserlo
g
custom NAT444 N/A • true—Enabled. N/A
logs in Unicom • false—Disabled.
format to the log
host
Enabling status Boolean:
of outputting
Sessionlog
session logs to
N/A • true—Enabled. N/A
the log host • false—Disabled.

Enabling status Boolean:

PacketFilterlo of outputting
g packet filter logs
N/A • true—Enabled. N/A
to the log host • false—Disabled.

Enabling status Boolean:

of outputting ATK
ATKlog
logs to the log
N/A • true—Enabled. N/A
host • false—Disabled.

Enabling status Boolean:

of outputting AFT
AFTlog
logs to the log
N/A • true—Enabled. N/A
host • false—Disabled.

Enabling status Boolean:

of outputting DPI
DPIAuditlog
audit logs to the
N/A • true—Enabled. N/A
log host • false—Disabled.

3
 Column Column Column
Data type and restrictions Remarks
name description type
Enabling status Boolean:
of outputting DPI
DPIUfltlog
URL filter logs to
N/A • true—Enabled. N/A
the log host • false—Disabled.

Enabling status
of outputting DPI Boolean:
DPINetSharel
og
netshare control N/A • true—Enabled. N/A
logs to the log • false—Disabled.
host
Enabling status
of outputting Boolean:
server
SCDlog
connection
N/A • true—Enabled. N/A
detection logs to • false—Disabled.
the log host
Enabling status Boolean:
of outputting DPI
DPIIPSlog
IPS logs to the
N/A • true—Enabled. N/A
log host • false—Disabled.

Enabling status
of outputting DPI Boolean:
DPIIPReputati
onlog
IPReputation N/A • true—Enabled. N/A
logs to the log • false—Disabled.
host
Enabling status Boolean:
of outputting DPI
DPIAVClog
AVC logs to the
N/A • true—Enabled. N/A
log host • false—Disabled.

Enabling status Boolean:

DPISandboxlo of outputting DPI
g Sandbox logs to
N/A • true—Enabled. N/A
the log host • false—Disabled.

CustomLog/LogAttribute
This table contains global attributes about custom log.

XML structure
<CustomLog>
<LogAttribute>
<LogFormat></LogFormat>
<Timestamp></Timestamp>
<SourceInterface></SourceInterface>
<SessionLogFormat></SessionLogFormat>
<PacketFilterLogFormat></PacketFilterLogFormat>
<ATKLogFormat></ATKLogFormat>
<AFTLogFormat></AFTLogFormat>
<DPIAuditLogFormat></DPIAuditLogFormat>
<DPIUfltLogFormat></DPIUfltLogFormat>

4
 <DPINetShareLogFormat></DPINetShareLogFormat>
<SCDLogFormat></SCDLogFormat>
<DPIIPSLogFormat></DPIIPSLogFormat>

<DPIIPSUpdateLogFormat></DPIIPSUpdateLogFormat><DPIIPReputationLogFormat></DPIIPReput
ationLogFormat>
<DPIAVCLogFormat></DPIAVCLogFormat>
<DPISandboxLogFormat></DPISandboxLogFormat>
</LogAttribute>
</CustomLog>

Table description
Item Description
Feature name CustomLog
Table name LogAttribute
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 0—Output NAT444 logs
with Unicom format.
Format for
outputting • 1—Output NAT444 logs
LogFormat N/A with Telecom format. N/A
NAT444 custom
logs • 2—Output NAT444 logs
with CMCC format.
• 3—Do not output NAT444
logs. (Default).
Enumeration:
Timestamp type
Timestamp of NAT444 N/A • 0—Greenwich Mean N/A
custom log Time(GMT). (Default)
• 1—Local time of device.

Name of source Example: Ethernet0/0/0

Interface String Only interfaces that
SourceInterfac
address for N/A support IP address
e Length: 2 to 47 characters.
output custom configuration can be
NAT444 logs specified.
Enumeration:
Format for
SessionLogFo outputting • 0—Output standard H3C
N/A format session logs. N/A
rmat session custom
logs • 1—Do not output session
logs (Default).

5
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:

PacketFilterLo
Format for • 0—Output standard H3C
outputting packet N/A format packet filter logs. N/A
gFormat
filter custom logs • 1—Do not output packet
filter logs (Default).
Enumeration:

ATKLogForma
Format for • 0—Output standard H3C
outputting ATK N/A format ATK logs. N/A
t
custom logs • 1—Do not output ATK
logs (Default).
Enumeration:

AFTLogForma
Format for • 0—Output standard H3C
outputting AFT N/A format AFT logs. N/A
t
custom logs • 1—Do not output AFT
logs (Default).
Enumeration:
Format for
DPIAuditLogF outputting DPI • 0—Output standard H3C
N/A format DPI audit logs. N/A
ormat audit custom
logs • 1—Do not output DPI
audit logs (Default).
Enumeration:
Format for
DPIUfltLogFor outputting DPI • 0—Output standard H3C
N/A format DPI URL filter logs. N/A
mat URL filter custom
logs • 1—Do not output DPI
URL filter logs (Default).
Enumeration:

Format for • 0—Output standard H3C

DPINetShareL outputting DPI format DPI netshare
N/A control logs. N/A
ogFormat netshare control
logs • 1—Do not output DPI
netshare control logs
(default).
Enumeration:

Format for • 0—Output standard H3C

SCDLogForm outputting server format server connection
N/A detection logs. N/A
at connection
detection logs • 1—Do not output server
connection detection logs
(default).
Enumeration:
• 0—Output standard H3C
Format for format DPI IPS logs.
DPIIPSLogFor
mat
outputting DPI N/A • 1—Do not output DPI IPS N/A
IPS custom logs logs (default).
• 2—Output SGCC format
DPI IPS logs.
Enumeration:
Format for
DPIIPSUpdate outputting DPI • 0—Output SGCC format
N/A DPI IPS signature update N/A
LogFormat IPS signature
update logs logs.
• 1—Do not output DPI IPS

6
Column Column Column
Data type and restrictions Remarks
name description type
signature update logs
(default).
Enumeration:

Format for • 0—Output standard H3C

DPIIPReputati outputting DPI format DPI IPReputation
N/A logs. N/A
onLogFormat IPReputation
logs • 1—Do not output DPI
IPReputation logs
(default).
Enumeration:
• 0—Output standard H3C
Format for format DPI bandwidth
DPIAVCLogF
outputting DPI N/A management logs. N/A
ormat
AVC logs • 1—Do not output DPI
bandwidth management
logs (default).
Enumeration:

Format for • 0—Output standard H3C

DPISandboxL format DPI Sandbox
outputting DPI N/A N/A
ogFormat logs.
Sandbox logs
• 1—Do not output DPI
Sandbox logs (default).

7
Contents
CustomLog ·····················································································1
CustomLog/LogHost ··················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 2
CustomLog/LogAttribute ·············································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5

i
CustomLog
CustomLog/LogHost
This table contains custom log hosts information.

XML structure
<CustomLog>
<LogHosts>
<Host>
<Address></Address>
<VRF></VRF>
<Port></Port>
<OutputLog>
<CmccSessionlog></CmccSessionlog>
<CmccUserlog></CmccUserlog>
<TelecomSessionlog></TelecomSessionlog>
<TelecomUserlog></TelecomUserlog>
<UnicomSessionlog></UnicomSessionlog>
<UnicomUserlog></UnicomUserlog>
<Sessionlog></Sessionlog>
<PacketFilterlog></PacketFilterlog>
<ATKlog></ATKlog>
<AFTlog></AFTlog>
<DPIAuditlog></DPIAuditlog>
<DPIUfltlog></DPIUfltlog>
<DPINetSharelog></DPINetSharelog>
<SCDlog></SCDlog>
<DPIIPSlog></DPIIPSlog>
<DPIIPReputationlog></DPIIPReputationlog>
<DPIAVClog></DPIAVClog>
<DPISandboxlog></DPISandboxlog>
</OutputLog>
</Host>
</LogHosts>
</CustomLog>

Table description
Item Description
Feature name CustomLog
Table name LogHosts
Table type Multi-instance table
Row name Host

1
 Restrictions The device supports up to four log hosts.

Columns
Column Column Column
Data type and restrictions Remarks
name description type
IPv4: String, dotted decimal
notation.
IPv4 example: 1.1.1.1
IPv6: Hexadecimal string,
Address of the colon-separated. IPv6 example:
Address Index 1:2:3:4:5:6:7:8
log host
Host name: Case-insensitive
string. HostName example:
www. example.com
Host name length: 1 to 253
characters.
If the log host is on the
VPN instance String. public network, the
VRF Index
name Length: 0 to 31 characters. length of characters is
0.

Port number of Unsigned integer.

Port Index N/A
the log host Value range: 1 to 65535.
Members include:
• CmccSessionlog
• CmccUserlog
• TelecomSessionlog
• TelecomUserlog
• UnicomSessionlog
• UnicomUserlog
• Sessionlog
Type of logs to • PacketFilterlog
Data
OutputLog be sent to the log
structure • ATKlog N/A
host • AFTlog
• DPIAuditlog
• DPIUfltlog
• DPINetSharelog
• SCDlog
• DPIIPSlog
• DPIIPReputationlog
• DPIAVClog
• DPISandboxlog
Enabling status
of outputting
session-based Boolean:
CmccSessionl
og
custom NAT444 N/A • true—Enabled. N/A
logs in CMCC • false—Disabled.
format to the log
host

2
Column Column Column
Data type and restrictions Remarks
name description type
Enabling status
of outputting
user-based Boolean:
CmccUserlog custom NAT444 N/A • true—Enabled. N/A
logs in CMCC • false—Disabled.
format to the log
host
Enabling status
of outputting
session-based Boolean:
TelecomSessi
onlog
custom NAT444 N/A • true—Enabled. N/A
logs in Telecom • false—Disabled.
format to the log
host
Enabling status
of outputting
user-based Boolean:
TelecomUserl
og
custom NAT444 N/A • true—Enabled. N/A
logs in Telecom • false—Disabled.
format to the log
host
Enabling status
of outputting
session-based Boolean:
UnicomSessio
nlog
custom NAT444 N/A • true—Enabled. N/A
logs in Unicom • false—Disabled.
format to the log
host
Enabling status
of outputting
user-based Boolean:
UnicomUserlo
g
custom NAT444 N/A • true—Enabled. N/A
logs in Unicom • false—Disabled.
format to the log
host
Enabling status Boolean:
of outputting
Sessionlog
session logs to
N/A • true—Enabled. N/A
the log host • false—Disabled.

Enabling status Boolean:

PacketFilterlo of outputting
g packet filter logs
N/A • true—Enabled. N/A
to the log host • false—Disabled.

Enabling status
of outputting Boolean:
ATKlog attack defense N/A • true—Enabled. N/A
logs to the log • false—Disabled.
host
Enabling status Boolean:
of outputting AFT
AFTlog
logs to the log
N/A • true—Enabled. N/A
host • false—Disabled.

Enabling status Boolean:

DPIAuditlog of outputting DPI N/A • true—Enabled. N/A
audit logs to the • false—Disabled.

3
 Column Column Column
Data type and restrictions Remarks
name description type
log host
Enabling status Boolean:
of outputting DPI
DPIUfltlog
URL filter logs to
N/A • true—Enabled. N/A
the log host • false—Disabled.

Enabling status
of outputting DPI Boolean:
DPINetSharel
og
netshare control N/A • true—Enabled. N/A
logs to the log • false—Disabled.
host
Enabling status
of outputting Boolean:
server
SCDlog
connection
N/A • true—Enabled. N/A
detection logs to • false—Disabled.
the log host
Enabling status Boolean:
of outputting DPI
DPIIPSlog
IPS logs to the
N/A • true—Enabled. N/A
log host • false—Disabled.

Enabling status
of outputting DPI Boolean:
DPIIPReputati
onlog
IPReputation N/A • true—Enabled. N/A
logs to the log • false—Disabled.
host
Enabling status Boolean:
of outputting DPI
DPIAVClog
AVC logs to the
N/A • true—Enabled. N/A
log host • false—Disabled.

Enabling status Boolean:

DPISandboxlo of outputting DPI
g Sandbox logs to
N/A • true—Enabled. N/A
the log host • false—Disabled.

CustomLog/LogAttribute
This table contains global attributes about custom log.

XML structure
<CustomLog>
<LogAttribute>
<LogFormat></LogFormat>
<Timestamp></Timestamp>
<SourceInterface></SourceInterface>
<SessionLogFormat></SessionLogFormat>
<PacketFilterLogFormat></PacketFilterLogFormat>
<ATKLogFormat></ATKLogFormat>
<AFTLogFormat></AFTLogFormat>
<DPIAuditLogFormat></DPIAuditLogFormat>

4
 <DPIUfltLogFormat></DPIUfltLogFormat>
<DPINetShareLogFormat></DPINetShareLogFormat>
<SCDLogFormat></SCDLogFormat>
<DPIIPSLogFormat></DPIIPSLogFormat>

<DPIIPSUpdateLogFormat></DPIIPSUpdateLogFormat><DPIIPReputationLogFormat></DPIIPReput
ationLogFormat>
<DPIAVCLogFormat></DPIAVCLogFormat>
<DPISandboxLogFormat></DPISandboxLogFormat>
</LogAttribute>
</CustomLog>

Table description
Item Description
Feature name CustomLog
Table name LogAttribute
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 0—Output NAT444 logs
with Unicom format.
The format for
outputting • 1—Output NAT444 logs
LogFormat N/A with Telecom format. N/A
NAT444 custom
logs • 2—Output NAT444 logs
with CMCC format.
• 3—Do not output NAT444
logs.
Enumeration:
The timestamp
Timestamp type of NAT444 N/A • 0—Greenwich Mean Time N/A
custom log (GMT).
• 1—Local time of device.
Example: Ethernet0/0/0
The name of
SourceInterfac source Interface String Only interfaces that
N/A support IP address
e for output custom Length: 2 to 47 characters.
NAT444 logs configuration can be
specified.
Enumeration:
Format for
SessionLogFo outputting • 0—Output standard H3C
N/A format session logs. N/A
rmat session custom
logs • 1—Do not output session
logs.

5
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:

PacketFilterLo
Format for • 0—Output standard H3C
outputting packet N/A format packet filter logs. N/A
gFormat
filter custom logs • 1—Do not output packet
filter logs.
Enumeration:

ATKLogForma
Format for • 0—Output standard H3C
outputting ATK N/A format ATK logs. N/A
t
custom logs • 1—Do not output ATK
logs.
Enumeration:

AFTLogForma
Format for • 0—Output standard H3C
outputting AFT N/A format AFT logs. N/A
t
custom logs • 1—Do not output AFT
logs.
Enumeration:
Format for
DPIAuditLogF outputting DPI • 0—Output standard H3C
N/A format DPI audit logs. N/A
ormat audit custom
logs • 1—Do not output DPI
audit logs.
Enumeration:
Format for
DPIUfltLogFor outputting DPI • 0—Output standard H3C
N/A format DPI URL filter logs. N/A
mat URL filter custom
logs • 1—Do not output DPI url
filter logs.
Enumeration:
Format for • 0—Output standard H3C
DPINetShareL outputting DPI format DPI netshare
N/A N/A
ogFormat netshare control control logs.
logs • 1—Do not output DPI
netshare control logs.
Enumeration:
Format for • 0—Output standard H3C
SCDLogForm outputting server format server connection
N/A N/A
at connection detection logs.
detection logs • 1—Do not output server
connection detection logs.
Enumeration:
• 0—Output standard H3C
Format for format DPI IPS logs.
DPIIPSLogFor
mat
outputting DPI N/A • 1—Do not output DPI IPS N/A
IPS custom logs logs.
• 2—Output SGCC format
DPI IPS logs.
Enumeration:
Format for • 0—Output SGCC format
DPIIPSUpdate outputting DPI DPI IPS signature update
N/A N/A
LogFormat IPS signature logs.
update logs • 1—Do not output DPI IPS
signature update logs.

6
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
Format for • 0—Output standard H3C
DPIIPReputati outputting DPI format DPI IPReputation
N/A N/A
onLogFormat IPReputation logs.
logs • 1—Do not output DPI
IPReputation logs.
Enumeration:
• 0—Output standard H3C
Format for format DPI bandwidth
DPIAVCLogF
outputting DPI N/A management logs. N/A
ormat
AVC logs • 1—Do not output DPI
bandwidth management
ogs.
Enumeration:

DPISandboxL
Format for • 0—Output standard H3C
outputting DPI N/A format DPI Sandbox logs. N/A
ogFormat
Sandbox logs • 1—Do not output DPI
Sandbox logs.

7
Contents
CWMP ···························································································1
CWMP/Configuration ·················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
CWMP
CWMP/Configuration
This table contains information about the CWMP Global Settings.

XML structure
<CWMP>
<Configuration>
<Status></Status>
<ACS>
<URL></URL>
<UserName></UserName>
<Password></Password>
</ACS>
<CPE>
<UserName></UserName>
<Password></Password>
<ConnectInterface></ConnectInterface>
<InformPeriodicStatus></InformPeriodicStatus>
<InformPeriodicInterval></InformPeriodicInterval>
</CPE>
</Configuration >
</CWMP>

Table description
Item Description
Feature name CWMP
Table name Configuration
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns

Column name Column description Column type Data type and restrictions

Enumeration:
Status Status of the CWMP N/A • enable.
• disable(default).

1
Column name Column description Column type Data type and restrictions

Members include:
• URL.
ACS ACS Settings Data structure
• UserName.
• Password.
String.
Length: 8 to 255 characters.
Status of the log
URL
buffer
N/A Must match the following formats:
http://host[:port]/path or
https://host[:port]/path

User name to access String.

UserName N/A
ACS Length: 1 to 255 characters.

String.
Password to access
Password N/A Length: 1 to 255 characters. Only support
ACS
password in plain text.

Members include:
• UserName.
• Password.
CPE CPE Settings Data structure
• ConnectInterface.
• InformPeriodicStatus.
• InformPeriodicInterval.
String.
User name to access Length: 1 to 255 characters.
UserName N/A Case-insensitive and contains no
CPE
comma(,),equal(=),double quotation
marks(“) ,

String.
Password to access
Password N/A Length: 1 to 255 characters. Only support
CPE
password in plain text.

ConnectInterfac CPE use this interface String.

N/A
e to send packets Length: 2 to 47 characters.

Enable or disable the Enumeration:

InformPeriodicS
tatus
periodic Inform N/A • enable.
feature of the CPE. • disable(default).

Configure the periodic Unsigned integer.

InformPeriodicI
Inform interval of the N/A
nterval Value range: 10 to 86400.
CPE.

2
Contents
CWMP ···························································································1
CWMP/Configuration ·················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
CWMP
CWMP/Configuration
This table contains information about the CWMP Global Settings.

XML structure
<CWMP>
<Configuration>
<Status></Status>
<ACS>
<URL></URL>
<UserName></UserName>
</ACS>
<CPE>
<UserName></UserName>
<ConnectInterface></ConnectInterface>
<InformPeriodicStatus></InformPeriodicStatus>
<InformPeriodicInterval></InformPeriodicInterval>
</CPE>
</Configuration>
</CWMP>

Table description
Item Description
Feature name CWMP
Table name Configuration
Table type Single-instance table
Row name None
Restrictions None

Columns

Column name Column description Column type Data type and restrictions

Enumeration:
Status Status of the CWMP N/A • enable.
• disable(default).

Members include:
ACS ACS Settings Data structure • URL.
• UserName.

1
Column name Column description Column type Data type and restrictions

Status of the log String.

URL N/A
buffer Length: 8 to 255 characters.

User name to access String.

UserName N/A
ACS Length: 1 to 255 characters.

Members include:
• UserName.
CPE CPE Settings Data structure • ConnectInterface.
• InformPeriodicStatus.
• InformPeriodicInterval.

User name to access String.

UserName N/A
CPE Length: 1 to 255 characters.

ConnectInterfac CPE use this interface String.

N/A
e to send packets Length: 2 to 47 characters.

Enable or disable the Enumeration:

InformPeriodicS
tatus
periodic Inform N/A • enable.
feature of the CPE. • disable(default).

Configure the periodic Unsigned integer.

InformPeriodicI
Inform interval of the N/A
nterval Value range: 10 to 86400.
CPE.

2
Contents
CWMP ···························································································2
CWMP/Configuration ·················································································································· 2

i
CWMP
CWMP/Configuration
Message Explanation
Failed to enable CWMP. Failed to start CWMP.
CWMP启动失败。 启动 CWMP 服务失败。

First enable CWMP to do the replace, remove and delete

Please enable CWMP first.
operation.
请先使能CWMP。
请先使能CWMP，再做replace、remove或delete操作。

Please check that CWMP is enabled and the

When CWMP is set to disable, it is forbidden to set other
operations do not include disabling CWMP.
parameters.
CWMP未使能或者包含了关闭CWMP操作导致失
CWMP未使能时，不能设置CWMP相关参数。
败。

The specified interface is not supported. The specified interface type is not supported.
指定的接口不支持。 设备不支持制定接口类型。

2
Contents
DaeProxy ·······················································································1
DaeProxy/DaeProxyService ········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DaeProxy/DaeProxyClients ·········································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2

i
DaeProxy
DaeProxy/DaeProxyService
The status table of the RADIUS Dynamic Authorization Extensions (DAE) proxy service.

XML structure
<DaeProxy>
<DaeProxyService>
<Status></Status>
<ServerPort></ServerPort>
</DaeProxyService>
</DaeProxy>

Table description
Item Description
Feature name DaeProxy
Table name DaeProxyService
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and
No
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Status of the Boolean:
Status RADIUS DAE N/A • true—Enabled. Default: false.
proxy service. • false—Disabled.

UDP port Default: 3799.

number of the Unsigned integer. This column takes
ServerPort N/A
RADIUS DAE Value range: 1 to 65535. effect only when the
server feature. Status column is true.

DaeProxy/DaeProxyClients
Client information table of the RADIUS DAE proxy service.

1
XML structure
<DaeProxy>
<DaeProxyClients>
<DaeProxyClient>
<IpType></IpType>
<IpAddress></IpAddress>
<Key></Key>
</DaeProxyClient>
</DaeProxyClients>
</DaeProxy>

Table description
Item Description
Feature name DaeProxy
Table name DaeProxyClients
Table type Multi-instance table
Row name DaeProxyClient
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
Type of the DAE Only support IPv4 at
IpType
client IP address.
Index • 0—IPv4.
present.
• 1—IPv6

If the IpType value is

0, this column
represents the IPv4
address of the
IPv4: String, dotted decimal client. For example,
IP address of the notation. 1.0.0.1.
IpAddress Index
DAE client. IPv6: Hexadecimal string, If the IpType value is
colon-separated.
1, this column
represents the IPv6
address of the
client. For example,
2001:12::1:2.
Shared key of In non-FIPS mode, a plaintext
the RADIUS shared key is a string of 1 to 64
Key packets N/A characters. The shared key is in
exchanged plain text.
between the In FIPS mode, a plaintext
DAE server and shared key is a string of 15 to

2
Column Column Column
Data type and restrictions Remarks
name description type
client. 64 characters that must
contain digits, uppercase
letters, lowercase letters, and
special characters.

3
Contents
DaeProxy ·······················································································1
DaeProxy/DaeProxyService ········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DaeProxy/DaeProxyClients ·········································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
DaeProxy/Statistic ······················································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3

i
DaeProxy
DaeProxy/DaeProxyService
The status table of the RADIUS Dynamic Authorization Extensions (DAE) proxy service.

XML structure
<DaeProxy>
<DaeProxyService>
<Status></Status>
<ServerPort></ServerPort>
</DaeProxyService>
</DaeProxy>

Table description
Item Description
Feature name DaeProxy
Table name DaeProxyService
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and
No
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Status of the Boolean:
Status RADIUS DAE N/A • true—Enabled. Default: false.
proxy service. • false—Disabled.

UDP port Default: 3799.

number of the Unsigned integer. This column takes
ServerPort N/A
RADIUS DAE Value range: 1 to 65535. effect only when the
server feature. Status column is true.

DaeProxy/DaeProxyClients
Client information table of the RADIUS DAE proxy service.

1
XML structure
<DaeProxy>
<DaeProxyClients>
<DaeProxyClient>
<IpType></IpType>
<IpAddress></IpAddress>
<Key></Key>
</DaeProxyClient>
</DaeProxyClients>
</DaeProxy>

Table description
Item Description
Feature name DaeProxy
Table name DaeProxyClients
Table type Multi-instance table
Row name DaeProxyClient
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
Type of the DAE Only support IPv4 at
IpType
client IP address.
Index • 0—IPv4. present.
• 1—IPv6.

If the IpType value is

0, this column
represents the IPv4
IPv4: String, dotted decimal address of the
IP address of the notation. client. For example,
IpAddress Index 1.0.0.1.
DAE client. IPv6: Hexadecimal string,
colon-separated. If the IpType value is 1,
this column represents
the IPv6 address of the
client. For example,
2001:12::1:2.

Shared key of In non-FIPS mode, a plaintext

the RADIUS shared key is a string of 1 to 64
packets characters.
The shared key is in
Key exchanged N/A In FIPS mode, a plaintext plain text.
between the shared key is a string of 15 to
DAE server and 64 characters that must
client. contain digits, uppercase

2
 Column Column Column
Data type and restrictions Remarks
name description type
letters, lowercase letters, and
special characters.

DaeProxy/Statistic
RADIUS DAE proxy statistics table.

XML structure
<DaeProxy>
<Statistic>
<DmReq></DmReq>
<DmAck></DmAck>
<DmNak></DmNak>
<CoaReq></CoaReq>
<CoaAck></CoaAck>
<CoaNak></CoaNak>
<ReTrans></ReTrans>
<FindNasFail></FindNasFail>
<SendToNasFail></SendToNasFail>
</Statistic>
</DaeProxy>

Table description
Item Description
Feature name DaeProxy
Table name Statistic
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and
No
deletion

Columns
Column Column Column
Data type and restrictions
name description type
Number of DM
DmReq N/A Unsigned integer.
request packets.
Number of DM
DmAck N/A Unsigned integer.
ACK packets.
DmNak Number of DM N/A Unsigned integer.

3
Column Column Column
Data type and restrictions
name description type
NAK packets.
Number of CoA
CoaReq N/A Unsigned integer.
request packets.
Number of CoA
CoaAck N/A Unsigned integer.
ACK packets.
Number of CoA
CoaNak N/A Unsigned integer.
NAK packets.
Number of
packets that the
ReTrans DAE client N/A Unsigned integer.
retransmits to the
DAE server.
Number of
packets for which
FindNasFail the device can't N/A Unsigned integer.
locate the DAE
server.
Number of
SendToNasF packets failed to
N/A Unsigned integer.
ail send to the DAE
server.

4
Contents
DaeProxy ·······················································································2
DaeProxy/DaeProxyService ········································································································· 2
DaeProxy/DaeProxyClients ·········································································································· 2

i
DaeProxy
DaeProxy/DaeProxyService
Message Explanation
Can't set the DAE listening port when disabling Can't set the DAE listening port when disabling RADIUS DAE
RADIUS DAE proxy. " proxy. "
关闭RADIUS DAE代理功能的同时不能设置DAE服 关闭RADIUS DAE代理功能的同时不能设置DAE服务器的监听端
务器的监听端口。 口。

Can't set the DAE listening port when RADIUS Can't set the DAE listening port when RADIUS DAE proxy is
DAE proxy is disabled. disabled.
RADIUS DAE代理功能处于关闭状态时不能设置 RADIUS DAE代理功能处于关闭状态时不能设置DAE服务器的监
DAE服务器的监听端口。 听端口。

DaeProxy/DaeProxyClients
Message Explanation
Invalid IP address. Invalid IP address.
无效IP地址。 无效IP地址。

2
Contents
DFILTER ························································································1
DFILTER/Policy ························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DFILTER/PolicyInProfile ·············································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
DFILTER/RuleInPolicy ················································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
DFILTER/KGroup······················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
DFILTER/PatternInKGroup ·········································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5
DFILTER/PrePatternInKGroup ······································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6

i
DFILTER
DFILTER/Policy
This table contains data filter policie information.

XML structure
<DFILTER>
<Policies>
<Policy>
<PolicyName></PolicyName>
<PolicyDescription></PolicyDescription>
</Policy>
</Policies>
</DFILTER>

Table description
Item Description
Feature name DFILTER
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the data String, case-insensitive
PolicyName Index N/A
filter policy Length: 1 to 31 characters.
Description of String, case-sensitive
PolicyDescrip
the data filter N/A N/A
tion Length: 1 to 255 characters.
policy

DFILTER/PolicyInProfile
This table contains data filter policies applied to the profile.

1
XML structure
<DFILTER>
<PolicyInProfile>
<Profile>
<ProfileName></ProfileName>
<PolicyName></PolicyName>
</Profile>
</PolicyInProfile>
</DFILTER>

Table description
Item Description
Feature name DFILTER
Table name PolicyInProfile
Table type Multi-instance table
Row name Profile
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the String, case-insensitive
ProfileName Index N/A
profile Length: 1 to 100 characters.

Name of the String, case-insensitive

PolicyName NA N/A
policy Length: 1 to 31 characters.

DFILTER/RuleInPolicy
This table contains the information of rules in a data filter policy.

XML structure
<DFILTER>
<RuleInPolicy>
<Rule>
<PolicyName></PolicyName>
<RuleName></RuleName>
<KGroupName></KGroupName>
<Application></Application>
<Direction></Direction>

2
 <Action></Action>
<Logging></Logging>
</Rule>
</RuleInPolicy>
</DFILTER>

Table description
Item Description
Feature name DFILTER
Table name RuleInPolicy
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the String, case-insensitive.
PolicyName Index N/A
policy Length: 1 to 31 characters.
String, case-insensitive.
RuleName Name of the rule Index N/A
Length: 1 to 31 characters.

Name of the String, case-insensitive.

KGroupName N/A N/A
keyword-group Length: 0 to 31 characters.
Enumeration:
• 1—HTTP
• 2—FTP
• 4—SMTP Examples:
Application of the
Application
rule
N/A • 8—IMAP 3—Application is HTTP
• 16—POP3 and FTP.
• 32—NFS
• 64—SMB
• 128—RTMP
Enumeration:
Direction of the • 0—upload
Direction N/A Default is 0.
rule • 1—download
• 2—both

Action for Enumeration:

Action packets N/A • 0—drop Default is 0.
matching the rule • 1—permit
Boolean:
Logging Logging or not N/A • true N/A
• false

3
DFILTER/KGroup
This table contains data filter keyword group information.

XML structure
<DFILTER>
<KGroups>
<KGroup>
<KGroupName></KGroupName>
<KGroupDescription></KGroupDescription>
</KGroup>
</KGroups>
</DFILTER>

Table description
Item Description
Feature name DFILTER
Table name KGroups
Table type Multi-instance table
Row name KGroup
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the String, case-insensitive.
KGroupName Index N/A
keyword group Length: 1 to 31 characters.
Description of String, case-sensitive
KGroupDescri
the keyword N/A N/A
ption Length: 1 to 255 characters.
group

DFILTER/PatternInKGroup
This table contains information about user-defined pattern in a data filter keyword group.

XML structure
<DFILTER>
<PatternInKGroups>

4
 <PatternInKGroup>
<KGroupName></KGroupName>
<PatternName></PatternName>
<PatternType></PatternType>
<PatternValue></PatternValue>
</PatternInKGroup>
</PatternInKGroups>
</DFILTER>

Table description
Item Description
Feature name DFILTER
Table name PatternInKGroups
Table type Multi-instance table
Row name PatternInKGroup
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the String, case-insensitive.
KGroupName Index N/A
keyword group Length: 1 to 31 characters.
Name of the String, case-insensitive.
PatternName user-defined Index N/A
pattern Length: 1 to 31 characters.

Type of the Enumeration:

PatternType user-defined N/A • 0—Text. N/A
pattern • 1—Regex.
Value of the String.
PatternValue user-defined N/A N/A
pattern Length: 3 to 245 characters.

DFILTER/PrePatternInKGroup
This table contains information about pre-defined pattern in a data filter keyword group.

XML structure
<DFILTER>
<PrePatternInKGroups>
<PrePatternInKGroup>
<KGroupName></KGroupName>

5
 <PatternName></PatternName>
</PrePatternInKGroup>
</PrePatternInKGroups>
</DFILTER>

Table description
Item Description
Feature name DFILTER
Table name PrePatternInKGroups
Table type Multi-instance table
Row name PrePatternInKGroup
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the String, case-insensitive.
KGroupName Index N/A
keyword group Length: 1 to 31 characters.
The pattern name
Name of the String, case-insensitive. includes
PatternName pre-defined Index bank-card-number,credit-
pattern Length: 1 to 31 characters. card-number,id-card-num
ber and phone-number

6
Contents
DFILTER ························································································1
DFILTER/Policy ························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DFILTER/PolicyInProfile ·············································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
DFILTER/RuleInPolicy ················································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
DFILTER/KGroup······················································································································· 3
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
DFILTER/PatternInKGroup ·········································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5
DFILTER/PrePatternInKGroup ······································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6

i
DFILTER
DFILTER/Policy
This table contains data filter policie information.

XML structure
<DFILTER>
<Policies>
<Policy>
<PolicyName></PolicyName>
<PolicyDescription></PolicyDescription>
</Policy>
</Policies>
</DFILTER>

Table description
Item Description
Feature name DFILTER
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the data String, case-insensitive
PolicyName Index N/A
filter policy Length: 1 to 31 characters.
Description of String, case-sensitive
PolicyDescrip
the data filter N/A N/A
tion Length: 1 to 255 characters.
policy

DFILTER/PolicyInProfile
This table contains data filter policies applied to the profile.

XML structure
<DFILTER>

1
 <PolicyInProfile>
<Profile>
<ProfileName></ProfileName>
<PolicyName></PolicyName>
</Profile>
</PolicyInProfile>
</DFILTER>

Table description
Item Description
Feature name DFILTER
Table name PolicyInProfile
Table type Multi-instance table
Row name Profile
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the String, case-insensitive
ProfileName Index N/A
profile Length: 1 to 100 characters.

Name of the String, case-insensitive

PolicyName NA N/A
policy Length: 1 to 31 characters.

DFILTER/RuleInPolicy
This table contains information about rules in a data filter policy.

XML structure
<DFILTER>
<RuleInPolicy>
<Rule>
<PolicyName></PolicyName>
<RuleName></RuleName>
<KGroupName></KGroupName>
<Application></Application>
<Direction></Direction>
<Action></Action>
<Logging></Logging>
</Rule>
</RuleInPolicy>
</DFILTER>

2
Table description
Item Description
Feature name DFILTER
Table name RuleInPolicy
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the String, case-insensitive.
PolicyName Index N/A
policy Length: 1 to 31 characters.
String, case-insensitive.
RuleName Name of the rule Index N/A
Length: 1 to 31 characters.

Name of the String, case-insensitive.

KGroupName N/A N/A
keyword-group Length: 0 to 31 characters.
Enumeration:
• 1—HTTP
• 2—FTP
• 4—SMTP Examples:
Application of the
Application
rule
N/A • 8—IMAP • 3—Application is
• 16—POP3 HTTP and FTP.
• 32—NFS
• 64—SMB
• 128—RTMP
Enumeration:
Direction of the • 0—upload.
Direction N/A Default is 0.
rule • 1—download
• 2—both

Action for Enumeration:

Action packets N/A • 0—drop. Default is 0.
matching the rule • 1—permit
Boolean:
Logging Logging or not N/A • true. N/A
• false.

DFILTER/KGroup
This table contains data filter keyword groups information.

3
XML structure
<DFILTER>
<KGroups>
<KGroup>
<KGroupName></KGroupName>
<KGroupDescription></KGroupDescription>
</KGroup>
</KGroups>
</DFILTER>

Table description
Item Description
Feature name DFILTER
Table name KGroups
Table type Multi-instance table
Row name KGroup
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the String, case-insensitive.
KGroupName Index N/A
keyword group Length: 1 to 31 characters.
Description of String, case-sensitive
KGroupDescri
the keyword N/A N/A
ption Length: 1 to 255 characters.
group

DFILTER/PatternInKGroup
This table contains information about user-defined pattern in a data filter keyword group.

XML structure
<DFILTER>
<PatternInKGroups>
<PatternInKGroup>
<KGroupName></KGroupName>
<PatternName></PatternName>
<PatternType></PatternType>
<PatternValue></PatternValue>
</PatternInKGroup>
</PatternInKGroups>

4
 </DFILTER>

Table description
Item Description
Feature name DFILTER
Table name PatternInKGroups
Table type Multi-instance table
Row name PatternInKGroup
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the String, case-insensitive.
KGroupName Index N/A
keyword group Length: 1 to 31 characters.
Name of the String, case-insensitive.
PatternName user-defined Index N/A
pattern Length: 1 to 31 characters.

Type of the Enumeration:

PatternType user-defined N/A • 0—Text. N/A
pattern • 1—Regex.
Value of the String.
PatternValue user-defined N/A N/A
pattern Length: 3 to 245 characters.

DFILTER/PrePatternInKGroup
This table contains information about pre-defined pattern in a data filter keyword group.

XML structure
<DFILTER>
<PrePatternInKGroups>
<PrePatternInKGroup>
<KGroupName></KGroupName>
<PatternName></PatternName>
</PrePatternInKGroup>
</PrePatternInKGroups>
</DFILTER>

5
Table description
Item Description
Feature name DFILTER
Table name PrePatternInKGroups
Table type Multi-instance table
Row name PrePatternInKGroup
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the String, case-insensitive.
KGroupName Index N/A
keyword group Length: 1 to 31 characters.
The pattern name
Name of the String, case-insensitive. includes
PatternName pre-defined Index bank-card-number,credit-
pattern Length: 1 to 31 characters. card-number,id-card-num
ber and phone-number

6
Contents
DFILTER ························································································1
DFILTER/Policy ························································································································· 1
DFILTER/RuleInPolicy ················································································································ 1
DFILTER/KGroup······················································································································· 1

i
DFILTER
DFILTER/Policy
Message Explanation
The signature file is updating. Please try again
Please try later.
later.
正在升级，稍后再试。
特征库正在升级，请稍等。

The default policy cannot be created. The default policy cannot be created.
默认策略不允许创建。 默认策略不允许创建。

The default policy cannot be deleted. The default policy cannot be deleted.
默认策略不允许删除。 默认策略不允许删除。

The default policy cannot be modified. The default policy cannot be modified.
默认策略不允许修改。 默认策略不允许修改。

The policy is being used by a DPI application profile A policy cannot be deleted when it is being used by a DPI
and cannot be deleted. application profile.
策略已被某个App-profile引用，不能被删除。 不能删除被引用的策略。

DFILTER/RuleInPolicy
Message Explanation
The signature file is updating. Please try later. Please try later.
特征库正在升级，请稍等。 正在升级，稍后再试。

Maximum number of rules has already reached. The maximum number of rules has already reached.
策略下的规则数目已达到上限。 可配置的规则数已达上限。

DFILTER/KGroup
Message Explanation
The signature file is updating. Please try later. Please try later.
特征库正在升级，请稍等。 正在升级，稍后再试。

The default keyword group cannot be created. The default keyword group cannot be created.
默认关键字组不允许创建。 默认关键字组不允许创建。

The default keyword group cannot be deleted. The default keyword group cannot be deleted.
默认关键字组不允许删除。 默认关键字组不允许删除。

The default keyword group cannot be used by a The default keyword group cannot be used by a non-default
non-default policy. policy.
默认关键字组不允许被非默认策略引用。 默认关键字组不允许被非默认策略引用。

The default keyword group cannot be modified. The default keyword group cannot be modified.

1
默认关键字组不允许修改。 默认关键字组不允许修改。

The keyword group is being used by a rule and

A keyword group cannot be deleted when it is used by a rule.
cannot be deleted.
不能删除被引用的关键字组。
关键字组已被某个规则引用，不能被删除。

Maximum number of patterns has already reached. The maximum number of patterns has already reached.
关键字组下的关键字数目已达到上限。 可配置的关键字数已达上限。

Invalid regular pattern expression. The regular pattern is not valid.

无效的正则表达式。 配置的正则表达式不合法。

2
Contents
DDNS ····························································································1
DDNS/DDNSPolicy ···················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DDNS/DDNSIfApply ··················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5

i
DDNS
DDNS/DDNSPolicy
This table contains DNS policy configuration information.

XML structure
<DDNS>
<DDNSPolicy>
<Policy>
<PolicyName></PolicyName>
<URL></URL>
<IntervalDay></IntervalDay>
<IntervalHour></IntervalHour>
<IntervalMinute></IntervalMinute>
<Username></Username>
<Password></Password>
<Method></Method>
<SSLClientPolicy></SSLClientPolicy>
</Policy>
</DDNSPolicy>
</DDNS>

Table description
Item Description
Feature name DDNS
Table name DDNSPolicy
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case
PolicyNam DDNS policy insensitive.
Index N/A
e name Length: 1 to 32
characters.
URL URL address N/A String, case The URL addresses configured for update requests depend

1
Column Column Column Data type and
Remarks
name description type restrictions
for DDNS sensitive. on the DDNS servers. Common DDNS server URL address
update Length: 1 to format are shown in following table.
requests 240 characters. DDNS URL addresses for DDNS update requests
server
www. http://members.3322.org/dyndns/update?syste
3322. m=dyndns&hostname=<h>&myip=<a>
org
DYND http://members.dyndns.org/nic/update?system=
NS dyndns&hostname=<h>&myip=<a>
DYNS http://www.dyns.cx/postscript.php?host=<h>&ip
=<a>
ZONE http://dynamic.zoneedit.com/auth/dynamic.html
EDIT ?host=<h>&dnsto=<a>
TZO http://cgi.tzo.com/webclient/signedon.html?TZO
Name=<h>IPAddress=<a>
EASY http://members.easydns.com/dyn/ez-ipupdate.p
DNS hp?action=edit&myip=<a>&host_id=<h>
HEIP http://dyn.dns.he.net/nic/update?hostname=<h
V6TB >&myip=<a>
CHAN http://nic.changeip.com/nic/update?hostname=
GE-IP <h>&offline=1
NO-IP http://dynupdate.no-ip.com/nic/update?hostna
me=<h>&myip=<a>
DHS http://members.dhs.org/nic/hosts?domain=dyn.
dhs.org&hostname=<h>&hostscmd=edit&hosts
cmdstage=2&type=1&ip=<a>
HP https://server-name/nic/update?group=group-n
ame&myip=<a>
ODS ods://update.ods.org
GNU gnudip://server-name
DIP
Peanu oray://phservice2.oray.net
tHull
No username or password is included in the URL address. To
configure the username and password, use the username
command and the password command.
HP and GNUDIP are common DDNS update protocols. The
server-name parameter is the domain name or IP address of
the service provider's server using one of the update
protocols.
The URL address for an update request can start with:
http://—The HTTP-based DDNS server.
https://—The HTTPS-based DDNS server.
ods://—The TCP-based ODS server.
gnudip://—The TCP-based GNUDIP server.
oray://—The TCP-based DDNS server.
members.3322.org and phservice2.oray.net are the domain
names of DDNS servers. The domain names of PeanutHull
DDNS servers can be phservice2.oray.net,

2
Column Column Column Data type and
Remarks
name description type restrictions
phddns60.oray.net, client.oray.net, ph031.oray.net, and so
on. Determine the domain name in the URL according to the
actual situation.
The port number in the URL address is optional. If no port
number is specified, the default port number is used. HTTP
uses port 80, HTTPS uses port 443, and the PeanutHull
server uses port 6060.
The system automatically performs the following operations:
Fills <h> with the FQDN that is specified when the DDNS
policy is applied to the interface.
Fills <a> with the primary IP address of the interface to which
the DDNS policy is applied.
You might also manually specify an FQDN and an IP address
in <h> and <a>, respectively. After that, the FQDN that is
specified when the DDNS policy is applied becomes
ineffective. However, manual configuration of <h> and <a> is
not recommended.
You cannot specify an FQDN and IP address in the URL
address for contacting the PeanutHull server. Alternatively,
you can specify an FQDN when applying the DDNS policy to
an interface. The system automatically uses the primary IP
address of the interface to which the DDNS policy is applied
as the IP address for DDNS update.
To avoid misinterpretation, do not include colons (:), at signs
(@), and question marks (?) in your login ID or password,
even if you can do so.
If you use the url command multiple times with different URL
addresses, the most recent configuration takes effect.
Interval for It must be configured together with the IntervalHour column
sending and IntervalMinute column.
DDNS Unsigned integer. If you set the interval to 0, the device does not periodically
update
IntervalDa Value range: 0 to initiate DDNS update request. However, it initiates a DDNS
requests after N/A
y 365 days. update request in either of the following situations:
DDNS
update is Default: 0. • When the primary IP address of the interface changes.
enabled • When the link state of the interface changes from down
(Day) to up.
Interval for
sending
DDNS Unsigned integer.
update
IntervalHo Value range: 0 to It must be configured together with the IntervalDay column
requests after N/A
ur 23 hours. and IntervalMinute column.
DDNS
update is Default: 1.
enabled
(Hour)
Interval for
sending
DDNS Unsigned integer.
update
IntervalMi Value range: 0 to It must be configured together with the IntervalDay column
requests after N/A
nute 59 minutes. and IntervalHour column.
DDNS
update is Default: 0.
enabled
(minute)

3
 Column Column Column Data type and
Remarks
name description type restrictions
Username to
be included in String, case
the URL sensitive.
Username address for N/A N/A
DDNS Length: 1 to 32
update characters.
requests
Password to
be included in String, case
the URL sensitive.
Password address for N/A Support for configuring in plain text only.
DDNS Length: 1 to 32
update characters.
requests
Transmission
method for
sending
DDNS Enumeration:

Method
update
N/A • 0—Http-get N/A
requests to (default).
HTTP/HTTP • 1—Http-post.
S-based
DDNS
servers
Associate a String, case
specific SSL insensitive.
SSLClient The SSL client policy is effective only for HTTPS-based
client policy N/A
Policy Length: 1 to 31 DDNS update requests.
with a DDNS
policy characters.

DDNS/DDNSIfApply
This table contains DDNS policy applying configuration information.

XML structure
<DDNS>
<DDNSIfApply>
<IfApply>
<IfIndex></IfIndex>
<PolicyName></PolicyName>
<FQDN></FQDN>
</IfApply>
</DDNSIfApply>
</DDNS>

Table description
Item Description
Feature name DDNS

4
 Table name DDNSIfApply
Table type Multi-instance table
Row name IfApply
Restrictions This table supports only Layer 3 interfaces.
Support for row creation and deletion Yes

Columns

Column Column Column Data type and

Remarks
name description type restrictions
Only Layer 3 interfaces
are supported.
Some versions support
interface name. For
relevant information, see
IfIndex Interface index. Index Unsigned integer. the XSD document of
your product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

DDNS policy String, case insensitive.

PolicyName Index N/A
name Length: 1 to 32 characters.
Specifies the FQDN to
replace <h> in the URL
String, case insensitive. for DDNS update.
Type of the DNS
FQDN N/A Length: 1 to 253 It can include letters,
server IP address
characters. digits, hyphens (-),
underscores (_), and
dots (.).

5
Contents
DDNS ····························································································1
DDNS/DDNSPolicy ···················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DDNS/DDNSIfApply ··················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5

i
DDNS
DDNS/DDNSPolicy
This table contains DNS policy configuration information.

XML structure
<DDNS>
<DDNSPolicy>
<Policy>
<PolicyName></PolicyName>
<URL></URL>
<IntervalDay></IntervalDay>
<IntervalHour></IntervalHour>
<IntervalMinute></IntervalMinute>
<Username></Username>
<Password></Password>
<Method></Method>
<SSLClientPolicy></SSLClientPolicy>
</Policy>
</DDNSPolicy>
</DDNS>

Table description
Item Description
Feature name DDNS
Table name DDNSPolicy
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case
PolicyNam DDNS policy insensitive.
Index N/A
e name Length: 1 to 32
characters.

URL address String, case The URL addresses configured for update requests depend
URL for DDNS N/A sensitive. on the DDNS servers. Common DDNS server URL address
update Length: 1 to format are shown in following table.

1
Column Column Column Data type and
Remarks
name description type restrictions
requests 240 characters.
DDNS URL addresses for DDNS update requests
server
www. http://members.3322.org/dyndns/update?syste
3322. m=dyndns&hostname=<h>&myip=<a>
org
DYND http://members.dyndns.org/nic/update?system=
NS dyndns&hostname=<h>&myip=<a>
DYNS http://www.dyns.cx/postscript.php?host=<h>&ip
=<a>
ZONE http://dynamic.zoneedit.com/auth/dynamic.html
EDIT ?host=<h>&dnsto=<a>
TZO http://cgi.tzo.com/webclient/signedon.html?TZO
Name=<h>IPAddress=<a>
EASY http://members.easydns.com/dyn/ez-ipupdate.p
DNS hp?action=edit&myip=<a>&host_id=<h>
HEIP http://dyn.dns.he.net/nic/update?hostname=<h
V6TB >&myip=<a>
CHAN http://nic.changeip.com/nic/update?hostname=
GE-IP <h>&offline=1
NO-IP http://dynupdate.no-ip.com/nic/update?hostna
me=<h>&myip=<a>
DHS http://members.dhs.org/nic/hosts?domain=dyn.
dhs.org&hostname=<h>&hostscmd=edit&hosts
cmdstage=2&type=1&ip=<a>
HP https://server-name/nic/update?group=group-n
ame&myip=<a>
ODS ods://update.ods.org
GNU gnudip://server-name
DIP
Peanu oray://phservice2.oray.net
tHull
No username or password is included in the URL address. To
configure the username and password, use the username
command and the password command.
HP and GNUDIP are common DDNS update protocols. The
server-name parameter is the domain name or IP address of
the service provider's server using one of the update
protocols.
The URL address for an update request can start with:
http://—The HTTP-based DDNS server.
https://—The HTTPS-based DDNS server.
ods://—The TCP-based ODS server.
gnudip://—The TCP-based GNUDIP server.
oray://—The TCP-based DDNS server.
members.3322.org and phservice2.oray.net are the domain
names of DDNS servers. The domain names of PeanutHull
DDNS servers can be phservice2.oray.net,
phddns60.oray.net, client.oray.net, ph031.oray.net, and so
on. Determine the domain name in the URL according to the

2
Column Column Column Data type and
Remarks
name description type restrictions
actual situation.
The port number in the URL address is optional. If no port
number is specified, the default port number is used. HTTP
uses port 80, HTTPS uses port 443, and the PeanutHull
server uses port 6060.
The system automatically performs the following operations:
Fills <h> with the FQDN that is specified when the DDNS
policy is applied to the interface.
Fills <a> with the primary IP address of the interface to which
the DDNS policy is applied.
You might also manually specify an FQDN and an IP address
in <h> and <a>, respectively. After that, the FQDN that is
specified when the DDNS policy is applied becomes
ineffective. However, manual configuration of <h> and <a> is
not recommended.
You cannot specify an FQDN and IP address in the URL
address for contacting the PeanutHull server. Alternatively,
you can specify an FQDN when applying the DDNS policy to
an interface. The system automatically uses the primary IP
address of the interface to which the DDNS policy is applied
as the IP address for DDNS update.
To avoid misinterpretation, do not include colons (:), at signs
(@), and question marks (?) in your login ID or password,
even if you can do so.
If you use the url command multiple times with different URL
addresses, the most recent configuration takes effect.
Interval for It must be configured together with the IntervalHour column
sending and IntervalMinute column.
DDNS
If you set the interval to 0, the device does not periodically
update Unsigned integer.
IntervalDa initiate DDNS update request. However, it initiates a DDNS
requests after N/A Value range: 0 to
y update request in either of the following situations:
DDNS 365 days.
update is • When the primary IP address of the interface changes.
enabled • When the link state of the interface changes from down
(Day) to up.
Interval for
sending
DDNS Unsigned integer.
update
IntervalHo Value range: 0 to It must be configured together with the IntervalDay column
requests after N/A
ur 23 hours. and IntervalMinute column.
DDNS
update is
enabled
(Hour)
Interval for
sending
DDNS Unsigned integer.
update
IntervalMi Value range: 0 to It must be configured together with the IntervalDay column
requests after N/A
nute 59 minutes. and IntervalHour column.
DDNS
update is
enabled
(minute)

3
 Column Column Column Data type and
Remarks
name description type restrictions
Username to
be included in String, case
the URL sensitive.
Username address for N/A N/A
DDNS Length: 1 to 32
update characters.
requests
Password to
be included in String, case
the URL sensitive.
Password address for N/A N/A
DDNS Length: 1 to 32
update characters.
requests
Transmission
method for
sending
DDNS Enumeration:
update
Method
requests to
N/A • 0—Http-get N/A
HTTP/HTTP • 1—Http-post.
S-based
DDNS
servers
Associate a String, case
specific SSL insensitive.
SSLClient The SSL client policy is effective only for HTTPS-based
client policy N/A
Policy Length: 1 to 31 DDNS update requests.
with a DDNS
policy characters.

DDNS/DDNSIfApply
This table contains DDNS policy applying configuration information.

XML structure
<DDNS>
<DDNSIfApply>
<IfApply>
<IfIndex></IfIndex>
<PolicyName></PolicyName>
<FQDN></FQDN>
</IfApply>
</DDNSIfApply>
</DDNS>

Table description
Item Description
Feature name DDNS

4
 Table name DDNSIfApply
Table type Multi-instance table
Row name IfApply
Restrictions This table supports only Layer 3 interfaces.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Only Layer 3 interfaces
IfIndex Interface index. Index Unsigned integer.
are supported.

DDNS policy String, case insensitive.

PolicyName Index N/A
name Length: 1 to 32 characters.
Specifies the FQDN to
replace <h> in the URL
String, case insensitive. for DDNS update.
Type of the DNS
FQDN N/A Length: 1 to 253 It can include letters,
server IP address
characters. digits, hyphens (-),
underscores (_), and
dots (.).

5
Contents
DDNS ····························································································1
DDNS/DDNSPolicy ···················································································································· 1
DDNS/DDNSIfApply ··················································································································· 1

i
DDNS
DDNS/DDNSPolicy
Message Explanation
The URL can't include the username or The URL can't include the username or password. Enter
password. Enter the username and password the username and password in the corresponding fields
in the corresponding fields. , please modify configuration under guidance.
服务器地址中不能包含登录用户名和登录密 服务器地址中不能包含登录用户名和登录密码，请在登录用
码，请在登录用户名和登录密码中填写。 户名和登录密码中填写，请按照配置说明修改
Maximum number of DDNS policies already Maximum number of DDNS policies already reached.
reached. Please check configuration or specifications
动态DNS策略个数超过上限。 动态DNS策略个数超过上限。请检查配置或者设备规格
The configuration doesn't meet the The configuration doesn't meet the requirements, please
requirements. modify configuration under guidance.
当前配置不符合配置要求。 当前配置不符合配置要求, 请按照配置说明修改

DDNS/DDNSIfApply
Message Explanation
Maximum number of DDNS policies applied on the
Maximum number of DDNS policies applied
interface already reached .Please check configuration or
on the interface already reached.
specifications
在该接口上应用的动态DNS策略个数超过上
在该接口上应用的动态DNS策略个数超过上限。 请检查配
限。
置或者设备规格
Failed to apply the DDNS policy, please modify
Failed to apply the DDNS policy.
configuration under guidance.
应用动态DNS策略失败。
应用动态DNS策略失败, 请按照配置说明修改

1
Contents

DDR ··············································································································································································· 1
DDR/DiaGroupRule ·························································································································································· 1
XML structure ····························································································································································· 1
Table description ······················································································································································ 1
Columns ····································································································································································· 1
DDR/Bundle ······································································································································································· 2
XML structure ····························································································································································· 2
Table description ······················································································································································ 2
Columns ····································································································································································· 3
DDR/IfDiaGroup ······························································································································································· 3
XML structure ····························································································································································· 3
Table description ······················································································································································ 3
Columns ····································································································································································· 4
DDR/DDRAutodial ···························································································································································· 4
XML structure ····························································································································································· 4
Table description ······················································································································································ 5
Columns ····································································································································································· 5
DDR/DDRIdle ····································································································································································· 5
XML structure ····························································································································································· 5
Table description ······················································································································································ 6
Columns ····································································································································································· 6
DDR/DDRCircularEnable·················································································································································· 7
XML structure ····························································································································································· 7
Table description ······················································································································································ 7
Columns ····································································································································································· 7
DDR/DDRDialNumber ······················································································································································ 8
XML structure ····························································································································································· 8
Table description ······················································································································································ 8
Columns ····································································································································································· 9

i
DDR
DDR/DiaGroupRule
This table contains dialer-group rule information.

XML structure
<DDR>
<DiaGroupRule>
<GroupRule>
<GroupNumber></GroupNumber>
<IpProtocol></IpProtocol>
<IpPermit></IpPermit>
<AclNum></AclNum>
<AclName></AclName>
</GroupRule>
</DiaGroupRule>
</DDR>

Table description
Item Description
Feature name DDR
Table name DiaGroupRule
Table type Multi-instance table
Row name GroupRule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Dialer-group rule Unsigned integer.
GroupNumber Index N/A
group-number Value range: 1 to 255
Enumeration:
Dialer-group rule
IpProtocol Index • 0—IPv4 protocol N/A
ip protocol
• 1—IPv6 protocol
Denies or permits IpPermit AclNum
IpPermit N/A Boolean:
packets of the AclName are mutually

1
 Column Column Data type and
Column name Remarks
description type restrictions
specified protocol • false exclusive relationship.
• true When executing the
create, merge, replace
operation must and only
be use one of IpPermit,
AclNum, AclName.
Whe performing the
delete, remove
operation, one of
IpPermit, AclNum,
AclName don’t need.
Unsigned integer.
Specifies an ACL
AclNum N/A Value range: 2000 to N/A
by its number
3999
The ACL name must start
String, case insensitive. with letter a to z or A to
Specifies an ACL Z. The ACL name cannot
AclName N/A Length: 1 to 63
by its name be all in any
characters. combination of upper-
and lower-case letters.

DDR/Bundle
This table contains the dialer bundle enable of DDR information.

XML structure
<DDR>
<Bundle>
<DiaBundle>
<IfIndex></IfIndex>
<Enable></Enable>
</DiaBundle>
</Bundle>
</DDR>

Table description
Item Description
Feature name DDR
Table name Bundle
Table type Multi-instance table
Row name DiaBundle

2
 Restrictions This table supports only Layer 3 interfaces.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
Some versions support
interface name. For
relevant information, see
IfIndex Interface index. Index Unsigned integer. the XSD document of
your product. For
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Before using
bundle DDR, use it Boolean:
Enable to enable bundle N/A • true N/A
DDR on a dialer • false (default)
interface.

DDR/IfDiaGroup
This table contains the dialer group of DDR information.

XML structure
<DDR>
<IfDiaGroup>
<DiaGroup>
<IfIndex></IfIndex>
<Num></Num>
</DiaGroup>
</IfDiaGroup>
</DDR>

Table description
Item Description
Feature name DDR
Table name IfDiaGroup

3
 Table type Multi-instance table
Row name DiaGroup
Restrictions This table supports only Layer 3 interfaces.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
Some versions support
interface name. For
relevant information, see
IfIndex Interface index. Index Unsigned integer. the XSD document of
your product. For
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Specifies a dialer
groupby its
number in the
range of 1 to 255. Unsigned interger.
Num N/A N/A
Before the Value range:1 to 255.
assignment, you
must create the
dialer group.

DDR/DDRAutodial
This table contains the information about using dialer timer autodial to set the auto-dial timer.

XML structure
<DDR>
<DDRAutodial>
<Autodial>
<IfIndex></IfIndex>
<Time></Time>
</Autodial>
</DDRAutodial>
</DDR>

4
Table description
Item Description
Feature name DDR
Table name DDRAutodial
Table type Multi-instance table
Row name Autodial
This table supports interface types:
am interface
bri interface/subinterface
asy interface
Restrictions
aux interface
serial interface
dialer interface
ethchannel interface
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Unsigned integer.
Specifies the interval
Value range: 1 to
Time Time of auto-dial N/A between auto-dial
604800.
attempts.
Default: 300.

DDR/DDRIdle
This table contains the information about using dialer timer idle to set the link idle-timeout timer.

XML structure
<DDR>

5
 <DDRIdle>
<Idle>
<IfIndex></IfIndex>
<Time></Time>
<Direct></Direct>
</Idle>
</DDRIdle>
</DDR>

Table description
Item Description
Feature name DDR
Table name DDRIdle
Table type Multi-instance table
Row name Idle
This table supports interface types:
am interface
bri interface/subinterface
asy interface
Restrictions
aux interface
serial interface
dialer interface
ethchannel interface
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Unsigned integer.
link idle-timeout Value range: 0 to Specifies the link
Time N/A
timer 65535. idle-timeout timer value.
Default: 120.

6
 Column Column Data type and
Column name Remarks
description type restrictions
Unsigned integer.
Direct of
• 1—OUT. Specifies the Direct of
Direct interesting packets N/A
• 2—IN. interesting packets timer.
timer
• 3—INOUT.

DDR/DDRCircularEnable
This table contains the information about using dialer circular enable to enable traditional DDR on a
dialup interface.

XML structure
<DDR>
<DDRCircularEnable>
<CircularEnable>
<IfIndex></IfIndex>
<Enable></Enable>
</CircularEnable>
</DDRCircularEnable>
</DDR>

Table description
Item Description
Feature name DDR
Table name DDRCircularEnable
Table type Multi-instance table
Row name CircularEnable
This table supports interface types:
Restrictions
Dialup interface
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
IfIndex Interface index. Index Unsigned integer.
relevant information, see
the XSD document of

7
 Column Column Data type and
Column name Remarks
description type restrictions
your product. For
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Before using
traditional DDR, Boolean:
use it to enable
Enable N/A • true N/A
traditional DDR on
the dialup • false (default)
interface.

DDR/DDRDialNumber
This table contains the information about using dialer number to configure a dial string for placing calls
to a single remote site.

XML structure
<DDR>
<DDRDialNumber>
<DialNumber>
<IfIndex></IfIndex>
<Num></Num>
<AutoDial></AutoDial>
</DialNumber>
</DDRDialNumber>
</DDR>

Table description
Item Description
Feature name DDR
Table name DDRDialNumber
Table type Multi-instance table
Row name DialNumber
This table supports interface types:
Restrictions
Dialup interface
Support for row creation and deletion No

8
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Specifies a dial string for
A dial string for String,case-insensitiv.
calling a remote site, a
Num calling a remote N/A Length: 1 to 30 case-insensitive string of
site characters. 1 to 30 characters.
Enables the interface to
automatically dial the
Unsigned integer. remote site by using the
specified dial string at
Automatically dial • 0—NOTAUTO(def
AutoDial N/A specified intervals. The
the remote site ault).
interval is set in the dialer
• 1—AUTO timer autodial command
and defaults to 300
seconds.

9
Contents

DDR ··············································································································································································· 1
DDR/DiaGroupRule ·························································································································································· 1
XML structure ····························································································································································· 1
Table description ······················································································································································ 1
Columns ····································································································································································· 1
DDR/Bundle ······································································································································································· 2
XML structure ····························································································································································· 2
Table description ······················································································································································ 2
Columns ····································································································································································· 2
DDR/IfDiaGroup ······························································································································································· 3
XML structure ····························································································································································· 3
Table description ······················································································································································ 3
Columns ····································································································································································· 3
DDR/DDRAutodial ···························································································································································· 4
XML structure ····························································································································································· 4
Table description ······················································································································································ 4
Columns ····································································································································································· 5
DDR/DDRIdle ····································································································································································· 5
XML structure ····························································································································································· 5
Table description ······················································································································································ 5
Columns ····································································································································································· 6
DDR/DDRCircularEnable·················································································································································· 6
XML structure ····························································································································································· 6
Table description ······················································································································································ 7
Columns ····································································································································································· 7
DDR/DDRDialNumber ······················································································································································ 7
XML structure ····························································································································································· 7
Table description ······················································································································································ 8
Columns ····································································································································································· 8

i
DDR
DDR/DiaGroupRule
This table contains dialer-group rule information.

XML structure
<DDR>
<DiaGroupRule>
<GroupRule>
<GroupNumber></GroupNumber>
<IpProtocol></IpProtocol>
<IpPermit></IpPermit>
<AclNum></AclNum>
<AclName></AclName>
</GroupRule>
</DiaGroupRule>
</DDR>

Table description
Item Description
Feature name DDR
Table name DiaGroupRule
Table type Multi-instance table
Row name GroupRule
Restrictions None

Columns
Column Column
Column name Data type and restrictions
description type
Dialer-group rule Unsigned integer.
GroupNumber Index
group-number Value range: 1 to 255
Enumeration:
Dialer-group rule
IpProtocol Index • 0—IPv4 protocol
ip protocol
• 1—IPv6 protocol
Denies or permits Boolean:
IpPermit packets of the N/A • false
specified protocol • true

1
 Column Column
Column name Data type and restrictions
description type
Specifies an ACL Unsigned integer.
AclNum N/A
by its number Value range: 2000 to 3999

Specifies an ACL String, case insensitive.

AclName N/A
by its name Length: 1 to 63 characters.

DDR/Bundle
This table contains the dialer bundle enable of DDR information.

XML structure
<DDR>
<Bundle>
<DiaBundle>
<IfIndex></IfIndex>
<Enable></Enable>
</DiaBundle>
</Bundle>
</DDR>

Table description
Item Description
Feature name DDR
Table name Bundle
Table type Multi-instance table
Row name DiaBundle
Restrictions This table supports only Layer 3 interfaces.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
Some versions support
IfIndex Interface index. Index Unsigned integer. interface name. For
relevant information, see
the XSD document of
your product. For
information about

2
 Column Column Data type and
Column name Remarks
description type restrictions
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Before using
bundle DDR, use it Boolean:
Enable to enable bundle N/A • true N/A
DDR on a dialer • false
interface.

DDR/IfDiaGroup
This table contains the dialer group of DDR information.

XML structure
<DDR>
<IfDiaGroup>
<DiaGroup>
<IfIndex></IfIndex>
<Num></Num>
</DiaGroup>
</IfDiaGroup>
</DDR>

Table description
Item Description
Feature name DDR
Table name IfDiaGroup
Table type Multi-instance table
Row name DiaGroup
Restrictions This table supports only Layer 3 interfaces.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
IfIndex Interface index. Index Unsigned integer.
Some versions support
interface name. For

3
 Column Column Data type and
Column name Remarks
description type restrictions
relevant information, see
the XSD document of
your product. For
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Specifies a dialer
groupby its
number in the
range of 1 to 255. Unsigned interger.
Num N/A N/A
Before the Value range:1 to 255.
assignment, you
must create the
dialer group.

DDR/DDRAutodial
This table contains the information about using dialer timer autodial to set the auto-dial timer.

XML structure
<DDR>
<DDRAutodial>
<Autodial>
<IfIndex></IfIndex>
<Time></Time>
</Autodial>
</DDRAutodial>
</DDR>

Table description
Item Description
Feature name DDR
Table name DDRAutodial
Table type Multi-instance table
Row name Autodial
This table supports interface types:
am interface
Restrictions
bri interface/subinterface
asy interface

4
 aux interface
serial interface
dialer interface
ethchannel interface

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Unsigned integer.
Time Time of uto-dial. N/A Value range: 1 to N/A
604800.

DDR/DDRIdle
This table contains the information about using dialer timer idle to set the link idle-timeout timer.

XML structure
<DDR>
<DDRIdle>
<Idle>
<IfIndex></IfIndex>
<Time></Time>
<Direct></Direct>
</Idle>
</DDRIdle>
</DDR>

Table description
Item Description
Feature name DDR
Table name DDRIdle

5
 Table type Multi-instance table
Row name Idle
This table supports interface types:
am interface
bri interface/subinterface
asy interface
Restrictions
aux interface
serial interface
dialer interface
ethchannel interface

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Unsigned integer.
link idle-timeout
Time N/A Value range: 0 to N/A
timer
65535.
Unsigned integer.
Direct of
• 1—OUT.
Direct interesting packets N/A N/A
timer • 2—IN.
• 3—INOUT.

DDR/DDRCircularEnable
This table contains the information about using dialer circular enable to enable traditional DDR on a
dialup interface.

XML structure
<DDR>
<DDRCircularEnable>
<CircularEnable>
<IfIndex></IfIndex>
<Enable></Enable>

6
 </CircularEnable>
</DDRCircularEnable>
</DDR>

Table description
Item Description
Feature name DDR
Table name DDRCircularEnable
Table type Multi-instance table
Row name CircularEnable
This table supports interface types:
Restrictions
Dialup interface

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.
Before using
traditional DDR, Boolean:
use it to enable
Enable N/A • true N/A
traditional DDR on
the dialup • false
interface.

DDR/DDRDialNumber
This table contains the information about using dialer number to configure a dial string for placing calls
to a single remote site.

XML structure
<DDR>
<DDRDialNumber>
<DialNumber>

7
 <IfIndex></IfIndex>
<Num></Num>
<AutoDial></AutoDial>
</DialNumber>
</DDRDialNumber>
</DDR>

Table description
Item Description
Feature name DDR
Table name DDRDialNumber
Table type Multi-instance table
Row name DialNumber
This table supports interface types:
Restrictions
Dialup interface

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see "Appendix"
in Ifmgr NETCONF XML
API Configuration
Reference.

A dial string for String,case-insensitiv.

Num calling a remote N/A Length: 1 to 30 N/A
site characters.
Unsigned integer.
Automatically dial
AutoDial N/A • 0—NOTAUTO N/A
the remote site
• 1—AUTO.

8
Contents
Comware 7 DDR NETCONF XML API Error Message Reference ···············1
DDR/DDRDialNumber················································································································· 1
DDR/DiaGroupRule ···················································································································· 1
DDR/DDRAutodial ····················································································································· 1
DDR/DDRIdle ··························································································································· 1
DDR/IfDiaGroup ························································································································ 1

i
Comware 7 DDR NETCONF XML API Error
Message Reference
DDR/DDRDialNumber
Message Explanation
The configuration doesn't meet the requirements. The configuration parameter is incomplete.
不符合配置要求。 配置参数不全。

Enable DDR first. This message means DDR not be configured.

DDR未使能。 没有DDR特性。

DDR/DiaGroupRule
Message Explanation
The configuration doesn't meet the requirements. The configuration parameter is incomplete.
不符合配置要求。 配置参数不全。

Invalid Acl Name. Invalid Acl Name.

非法的ACL名称。 非法的ACL名称。

DDR/DDRAutodial
Message Explanation
Enable DDR first. This message means DDR not be configured.
DDR未使能。 没有DDR特性。

DDR/DDRIdle
Message Explanation
Enable DDR first. This message means DDR not be configured.
DDR未使能。 没有DDR特性。

DDR/IfDiaGroup
Message Explanation
Enable DDR first. This message means DDR not be configured.
DDR未使能。 没有DDR特性。

1
Contents
Device ···························································································1
Device/Base ····························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Device/Transceivers ··················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
Device
Device/Base
This table contains device information.

XML structure
<Device>
<Base>
<LocalTime></LocalTime>
<RestoreFactoryDefault/>
</Base>
</Device>

Table description
Item Description
Feature name Device
Table name Base
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column
Column description Data type and restrictions
name
DateTime.
LocalTime System time on the device.
Format: YYYY-MM-DDTHH:MM:SS.
RestoreFacto Restore the factory-default
This column must be empty.
ryDefault configuration for the device.

Device/Transceivers
This table contains information about ITU channels supported on the transceiver that is connected
to this interface.

XML structure
<Device>
<Transceivers>
<Interface>
 <IfIndex></IfIndex>
<ActiveITUChannel></ActiveITUChannel>
</Interface>
</Transceivers>

</Device>

Table description
Item Description
Feature name Device
Table name TransceiversITUChannels
Table type Multi-instance table
Row name Interface
Restrictions None
Support for row creation and deletion No

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Interface
IfIndex Index Unsigned integer. N/A
index

The index of Unsigned integer.

The value
ActiveITUChannel the specified N/A depends on the
ITU channel Value range:1 to 4294967295.
device model.
Contents
Device ···························································································1
Device/Base ····························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Device/SummerTime ·················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
Device/FailoverGroups ················································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
Device/TemperatureSensors ········································································································ 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8

i
Device
Device/Base
This table contains device information.

XML structure
<Device>
<Base>
<HostName></HostName>
<ClockProtocol>
<Protocol></Protocol>
<MDCID></MDCID>
</ClockProtocol>
<TimeZone>
<Zone></Zone>
<ZoneName></ZoneName>
</TimeZone>
</Base>
</Device>

Table description
Item Description
Feature name Device
Table name Base
Table type Single-instance table
Row name N/A
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
HostName Device name N/A N/A
Length: 1 to 64 characters.
Members include: This data structure is
System time Data
ClockProtocol
source structure • Protocol. supported only on the
• MDCID. default MDC.

Protocol Time protocol N/A Enumeration: Required.

1
 Column Column Column
Data type and restrictions Remarks
name description type
• 2—None. Support for NTP and
• 3—NTP. PTP depends on the
device model.
• 4—PTP.
Supported and
ID of the MDC Unsigned integer. required on an
MDCID used as the time N/A
Value range: 1 to 65535. MDC-supported device
source
that uses NTP or PTP.
Members include:
Time zone and Data
TimeZone
its name structure • Zone. N/A
• ZoneName.
String.
Use one of the following
formats:
• Z for the UTC.
• +HH:MM:SS for east time
zone. MM and SS are
Zone Time zone N/A
• -HH:MM:SS for west time optional.
zone.
Value ranges:
• HH—0 to 23.
• MM—0 to 59.
• SS—0 to 59.
String.
ZoneName Time zone name N/A N/A
Length: 1 to 32 characters.

Device/SummerTime
This table contains summer-time information.

XML structure
<Device>
<SummerTime>
<Name></Name>
<AddTime></AddTime>
<DateBased>
<BeginMonth></BeginMonth>
<BeginDay></BeginDay>
<BeginHour></BeginHour>
<BeginMinute></BeginMinute>
<BeginSecond></BeginSecond>
<EndMonth></EndMonth>
<EndDay></EndDay>
<EndHour></EndHour>
<EndMinute></EndMinute>
<EndSecond></EndSecond>

2
 </DateBased>
<WeekBased>
<BeginMonth></BeginMonth>
<BeginWeek></BeginWeek>
<BeginWeekDay></BeginWeekDay>
<BeginHour></BeginHour>
<BeginMinute></BeginMinute>
<BeginSecond></BeginSecond>
<EndMonth></EndMonth>
<EndWeek></EndWeek>
<EndWeekDay></EndWeekDay>
<EndHour></EndHour>
<EndMinute></EndMinute>
<EndSecond></EndSecond>
</WeekBased>
</SummerTime>
</Device>

Table description
Item Description
Feature name Device
Table name SummerTime
Table type Single-instance table
Row name N/A
Group DateBased and WeekBased are two configuration
ways.
Only one way can take effect at the same time.
Restrictions
All the members of one group should be included when
tack configuration action.
New configuration will replace the existing one.
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name Name for the String.
daylight saving. N/A N/A
time. Length: 1 to 32 characters.

AddTime String. Value ranges:

The time to be
Format: • HH—0 to 23.
added to the N/A
standard time. • HH:MM:SS • MM—0 to 59.
• SS—0 to 59.
DateBased Daylight saving Data Members include:
N/A
time Structure • BeginMonth

3
Column Column Column
Data type and restrictions Remarks
name description type
configuration • BeginDay
based on date. • BeginHour
• BeginMinute
• BeginSecond
• EndMonth
• EndDay
• EndHour
• EndMinute
• EndSecond
BeginMonth Unsigned integer.
Begin month. N/A N/A
Value range: 1 to 12.
BeginDay Unsigned integer.
Begin day. N/A N/A
• Value range: 1 to 31.
BeginHour Unsigned integer.
Begin hour. N/A N/A
• Value range: 0 to 23.
BeginMinute Unsigned integer.
Begin minute. N/A N/A
Value range: 0 to 59.
BeginSecond Unsigned integer.
Begin second. N/A N/A
Value range: 0 to 59.
EndMonth Unsigned integer.
End month. N/A N/A
Value range: 1 to 12.
EndDay Unsigned integer.
End day. N/A N/A
Value range: 1 to 31.
EndHour Unsigned integer.
End hour. N/A N/A
Value range: 0 to 23.
EndMinute Unsigned integer.
End minute. N/A N/A
Value range: 0 to 59.
EndSecond Unsigned integer.
End second. N/A N/A
Value range: 0 to 59.
WeekBased Members include:
• BeginMonth
• BeginWeek
• BeginWeekDay
• BeginHour
Daylight saving • BeginMinute
time Data
configuration Structure • BeginSecond N/A
based on week. • EndMonth
• EndWeek
• EndWeekDay
• EndHour
• EndMinute
• EndSecond
BeginMonth Unsigned integer.
Begin month. N/A N/A
Value range: 1 to 12.

4
Column Column Column
Data type and restrictions Remarks
name description type
BeginWeek Enumeration:
• 1—The first week
• 2—The second week Non-existent weeks of
Begin week of
the month.
N/A • 3—The third week the month are treated
• 4—The fourth week as the last week.
• 5—The fifth week
• 6—The last week
BeginWeekD Enumeration:
ay • 0—Sunday
• 1—Monday
Begin day of • 2—Tuesday
N/A N/A
week. • 3—Wednesday
• 4—Thursday
• 5—Friday
• 6—Saturday
BeginHour Unsigned integer.
Begin hour . N/A N/A
Value range: 0 to 23.
BeginMinute Unsigned integer.
Begin minute. N/A N/A
Value range: 0 to 59.
BeginSecond Unsigned integer.
Begin second. N/A N/A
Value range: 0 to 59.
EndMonth Unsigned integer.
End month. N/A N/A
Value range: 1 to 12.
EndWeek Enumeration:
• 1—The first week
• 2—The second week Non-existent weeks of
End week of the
month.
N/A • 3—The third week the month are treated
• 4—The fourth week as the last week.
• 5—The fifth week
• 6—The last week
EndWeekDay Enumeration:
• 0—Sunday
• 1—Monday
• 2—Tuesday
End day of week. N/A N/A
• 3—Wednesday
• 4—Thursday
• 5—Friday
• 6—Saturday
EndHour Unsigned integer.
End hour . N/A N/A
Value range: 0 to 23.
EndMinute Unsigned integer.
End minute. N/A N/A
Value range: 0 to 59.
EndSecond Unsigned integer.
End second. N/A N/A
Value range: 0 to 59.

5
Device/FailoverGroups
This table contains failover group information.

XML structure
<Device>
<FailoverGroups>
<FailoverGroup>
<ID></ID>
<Name></Name>
<PrimaryNode>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</PrimaryNode>
<SecondaryNode>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</SecondaryNode>
</FailoverGroup>
</FailoverGroups>
</Device>

Table description
Item Description
Feature name Device
Table name FailoverGroups
Table type Multi-instance table
Row name FailoverGroup
Restrictions N/A
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ID Unsigned integer.
Failover group id index N/A
Value range: 0 to 31.

6
 Column Column Column
Data type and restrictions Remarks
name description type
Name Failover group String.
N/A N/A
name Length: 1 to 63 characters.
PrimaryNode Members include:
Primary node of
Data • Chassis
the failover N/A
group.
structure • Slot
• CPUID
Chassis Chassis ID of the Unsigned integer.
failover group N/A N/A
primary node. Value range: 0 to 65535.

Slot Slot ID of the Unsigned integer.

failover group N/A N/A
primary node. Value range: 0 to 65535.

CPUID CPU ID of the Unsigned integer.

failover group N/A N/A
primary node. Value range: 0 to 65535.

SecondaryNo Members include:

de Secondarynode
Data • Chassis
of the failover N/A
group.
structure • Slot
• CPUID
Chassis Chassis ID of the Unsigned integer.
failover group N/A N/A
secondary node. Value range: 0 to 65535.

Slot Slot ID of the Unsigned integer.

failover group N/A N/A
secondary node. Value range: 0 to 65535.

CPUID CPU ID of the Unsigned integer.

failover group N/A N/A
secondary node. Value range: 0 to 65535.

Device/TemperatureSensors
This table contains temperature sensor alarm settings.

XML structure
<Device>
<TemperatureSensors>
<Sensor>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<SensorType></SensorType>
<SensorIndex></SensorIndex>
<LowerLimit></LowerLimit>
<WarningLimit></WarningLimit>
<AlarmLimit></AlarmLimit>
</Sensor>

7
 </TemperatureSensors>
</Device>

Table description
Item Description
Feature name Device
Table name TemperatureSensors
Table type Multi-instance table
Row name Sensor
Restrictions None

Support for row creation and deletion No

Columns
Column Data type and
Column name Column description Remarks
type restrictions
Member ID of the Unsigned short.
Chassis member device where Index Value range: 0 to N/A
the entity resides 65535.

Unsigned integer.
Slot number of the
Slot Index Value range: 0 to N/A
device node
65535.
Unsigned integer.
CPUID ID of the CPU. Index Value range: 0 to N/A
65535.

Enumeration:
Type of the temperature • 0-Inflow
SensorType Index N/A
sensor • 1-Outflow
• 2- Hotspot

Unsigned integer.
Resource ID of the
SensorIndex Index Value range: 0 to N/A
temperature sensor.
65535.

The specific range

Low-temperature is different
threshold in Celsius N/A according to the
LowerLimit Short
degrees equipment, and
the beyond range
can not be set

8
 Column Data type and
Column name Column description Remarks
type restrictions

The specific range

is different
High-temperature
according to the
warning threshold in N/A Short
WarningLimit equipment, and
Celsius degrees
the beyond range
can not be set

The specific range

is different
High-temperature
according to the
AlarmLimit alarming threshold in N/A Short equipment, and
Celsius degrees
the beyond range
can not be set

9
 Contents
Contents ··································································································································· i
Device ···························································································1
Device/Base ····························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 2
Device/PhysicalEntities ··············································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
Device/ExtPhysicalEntities ··········································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7
Device/Transceivers ··················································································································· 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
Device/TransceiversChannels ···································································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 16
Columns ·························································································································· 16
Device/TransceiversITUChannels································································································ 17
XML structure ··················································································································· 17
Table description ··············································································································· 17
Columns ·························································································································· 18
Device/CPUs ·························································································································· 18
XML structure ··················································································································· 18
Table description ··············································································································· 19
Columns ·························································································································· 19
Device/SummerTime ················································································································ 19
XML structure ··················································································································· 19
Table description ··············································································································· 20
Columns ·························································································································· 20
Device/Boards ························································································································· 23
XML structure ··················································································································· 23
Table description ··············································································································· 23
Columns ·························································································································· 23
Device/Blades ························································································································· 24
XML structure ··················································································································· 24
Table description ··············································································································· 24
Columns ·························································································································· 25
Device/PEXes ························································································································· 25
XML structure ··················································································································· 25
Table description ··············································································································· 25
Columns ·························································································································· 26
Device/BladeCapabilities ··········································································································· 26
XML structure ··················································································································· 26
Table description ··············································································································· 26
Columns ·························································································································· 27
Device/PEXCapabilities ············································································································· 27
XML structure ··················································································································· 27
Table description ··············································································································· 27
Columns ·························································································································· 27
Device/FailoverGroupCapabilities ································································································ 27
XML structure ··················································································································· 28
Table description ··············································································································· 28

i
 Columns ·························································································································· 28
Device/FailoverGroups ·············································································································· 28
XML structure ··················································································································· 28
Table description ··············································································································· 29
Columns ·························································································································· 29
Device/Subcards ····················································································································· 30
XML structure ··················································································································· 30
Table description ··············································································································· 30
Columns ·························································································································· 30
Device/TemperatureSensors ······································································································ 31
XML structure ··················································································································· 31
Table description ··············································································································· 31
Columns ·························································································································· 32
Device/SystemStableStatus ······································································································· 33
XML structure ··················································································································· 33
Table description ··············································································································· 33
Columns ·························································································································· 33
Device/BoardStableStatus ········································································································· 33
XML structure ··················································································································· 33
Table description ··············································································································· 34
Columns ·························································································································· 34
Device/NetworkClockChassisStatus ····························································································· 35
XML structure ··················································································································· 35
Table description ··············································································································· 35
Columns ·························································································································· 35
Device/NetworkClockSrcStatus ··································································································· 36
XML structure ··················································································································· 36
Table description ··············································································································· 37
Columns ·························································································································· 37
Device/NetworkClockLPUPortStatus ···························································································· 38
XML structure ··················································································································· 38
Table description ··············································································································· 38
Columns ·························································································································· 38

ii
Device
Device/Base
This table contains device information.

XML structure
<Device>
<Base>
<Uptime></Uptime>
<HostName></HostName>
<HostDescription></HostDescription>
<HostOid></HostOid>
<MinChassisNum></MinChassisNum>
<MaxChassisNum></MaxChassisNum>
<MinSlotNum></MinSlotNum>
<MaxSlotNum></MaxSlotNum>
<MinCPUIDNum></MinCPUIDNum>
<MaxCPUIDNum></MaxCPUIDNum>
<LocalTime></LocalTime>
<ClockProtocol>
<Protocol></Protocol>
<MDCID></MDCID>
</ClockProtocol>
<TimeZone>
<Zone></Zone>
<ZoneName></ZoneName>
</TimeZone>
<BridgeMAC></BridgeMAC>
<LocalBridgeMAC></LocalBridgeMAC>
<VendorName></VendorName>
</Base>
</Device>

Table description
Item Description
Feature name Device
Table name Base
Table type Single-instance table
Row name N/A
Restrictions None

1
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Time that
elapsed after the
Uptime N/A Unsigned integer. N/A
device started
up, in seconds
String.
HostName Device name N/A N/A
Length: 1 to 64 characters.
HostDescripti Device String.
on N/A N/A
description Length: 0 to 255 characters.
HostOid System object ID
(OID )of the N/A String, dotted decimal notation. N/A
Device
MinChassisN Minimum Unsigned integer.
um number of the N/A N/A
chassis Value range: 0 to 65535.

MaxChassisN Maximum Unsigned integer.

um number of the N/A N/A
chassis Value range: 0 to 65535.

MinSlotNum Minimum Unsigned integer.

number of the N/A N/A
slot Value range: 0 to 65535.

MaxSlotNum Maximum Unsigned integer.

number of the N/A N/A
slot Value range: 0 to 65535.

MinCPUIDNu Minimum ID of Unsigned integer.

m N/A N/A
the CPU Value range: 0 to 65535.
MaxCPUIDN Maximum ID of Unsigned integer.
um N/A N/A
the CPU Value range: 0 to 65535.

Members include: This data structure

System time Data is supported only
ClockProtocol
source structure • Protocol. on the default
• MDCID. MDC.

Enumeration: Required.
• 2-None. Support for NTP
Protocol Time protocol N/A and PTP depends
• 3-NTP.
on the device
• 4-PTP. model.
Supported and
ID of the MDC Unsigned integer. required on an
MDCID used as the time N/A MDC-supported
source Value range: 1 to 65535. device that uses
NTP or PTP.
DateTime.
System time on
LocalTime N/A Format: N/A
the device
YYYY-MM-DDTHH:MM:SS.

Time zone and Data Members include:

TimeZone N/A
its name structure • Zone.

2
 Column Column Column
Data type and restrictions Remarks
name description type
• ZoneName.
String.
Use one of the following
formats:
• Z for the UTC.
• +HH:MM:SS for east time
zone. MM and SS are
Zone Time zone. N/A
• –HH:MM:SS for west time optional.
zone.
Value ranges:
• HH-0 to 23.
• MM-0 to 59.
• SS-0 to 59.
String.
ZoneName Time zone name N/A N/A
Length: 1 to 32 characters.
Bridge MAC
BridgeMAC N/A MacAddress N/A
Address
LocalBridgeM Local Bridge
N/A MacAddress N/A
AC MAC Address
String.
VendorName Vendor name N/A N/A
Length: 1 to 256 characters.

Device/PhysicalEntities
This table contains basic information about an entity.

XML structure
<Device>
<PhysicalEntities>
<Entity>
<PhysicalIndex></PhysicalIndex>
<Chassis></Chassis>
<Slot></Slot>
<SubSlot></SubSlot>
<Description></Description>
<VendorType></VendorType>
<ContainedIn></ContainedIn>
<Class></Class>
<ParentRelPos></ParentRelPos>
<Name></Name>
<HardwareRev></HardwareRev>
<FirmwareRev></FirmwareRev>
<SoftwareRev></SoftwareRev>
<SerialNumber></SerialNumber>

3
 <MfgName></MfgName>
<Model></Model>
<Alias></Alias>
<AssetID></AssetID>
<FRU></FRU>
<MfgDate></MfgDate>
<Uris></Uris>
</Entity>
</PhysicalEntities>
</Device>

Table description
Item Description
Feature name Device
Table name PhysicalEntities
Table type Multi-instance table
Row name Entity
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
PhysicalIndex Entity index Index Unsigned integer.
ID of the member Unsigned integer. If there is no
Chassis where the entity N/A chassis number,
resides Value range: 0 to 65535. return 0.

Unsigned integer. If there is no slot

Slot number of
Slot N/A number, return
the entity Value range: 0 to 65535. 65535.

Unsigned integer. If there is no slot

Subslot number
SubSlot N/A number, return
of the entity Value range: 0 to 65535. 65535.

String.
Description Entity description N/A N/A
Length: 0 to 255 characters.
Vendor type
VendorType (OID )of the N/A String, dotted decimal notation. N/A
entity
Position of the
ContainedIn N/A Unsigned integer. N/A
entity
Enumeration.
• 1-Others.
Class Entity type N/A • 2-Unknown. N/A
• 3-Frame.
• 4-Backplane.

4
Column Column Column
Data type and restrictions Remarks
name description type
• 5-Slot or subslot.
• 6-Power supply.
• 7-Fan.
• 8-Sensor.
• 9-Module. It might
indicates a card, a
subcard, or, for example,
a flash memory.
• 10-Port.
• 11-IRF fabric.
• 12-CPU.
Position of the Signed integer.
ParentRelPos entity's parent N/A N/A
node Minimum: –1.

String.
Name Entity name N/A N/A
Length: 0 to 255 characters.
Hardware String.
HardwareRev version of the N/A N/A
entity Length: 0 to 255 characters.

Firmware version String.

FirmwareRev N/A N/A
of the entity Length: 0 to 255 characters.

Software version String.

SoftwareRev N/A N/A
of the entity Length: 0 to 255 characters.

Serial number of String.

SerialNumber N/A N/A
the entity Length: 0 to 32 characters.
Manufacturer String.
MfgName name of the N/A N/A
entity Length: 0 to 32 characters.

String.
Model Entity model N/A N/A
Length: 0 to 255 characters.
String.
Alias Alias of the entity N/A N/A
Length: 0 to 32 characters.

Asset ID of the String.

AssetID N/A N/A
entity Length: 0 to 32 characters.

Whether the Enumeration:

FRU entity is a field N/A • True-Supports. N/A
replaceable unit • False-Does not support.

Manufacture Format:
MfgDate N/A N/A
time of the entity YYYY-MM-DDTHH:MM:SS.
String.
Uris CLEI code N/A N/A
Length: 0 to 32 characters.

5
Device/ExtPhysicalEntities
This table contains extended information about an entity.

XML structure
<Device>
<ExtPhysicalEntities>
<Entity>
<PhysicalIndex></PhysicalIndex>
<AdminState></AdminState>
<OperState></OperState>
<StandbyState></StandbyState>
<AlarmLight></AlarmLight>
<CpuUsage ></CpuUsage>
<CpuUsageThreshold></CpuUsageThreshold>
<MemUsage></MemUsage>
<MemUsageThreshold></MemUsageThreshold>
<MemSize></MemSize>
<Uptime></Uptime>
<Temperature></Temperature>
<TemperatureThreshold></TemperatureThreshold>
<Voltage></Voltage>
<VoltageLowThreshold></VoltageLowThreshold>
<VoltageHighThreshold></VoltageHighThreshold>
<TemperatureCriticalThreshold></TemperatureCriticalThreshold>
<MAC></MAC>
<ErrorStatus></ErrorStatus>
<CpuMaxUsage></CpuMaxUsage>
<TemperatureLowThreshold></TemperatureLowThreshold>
<TemperatureShutdownThreshold></TemperatureShutdownThreshold>
<PhyMemSize></PhyMemSize>
<CpuFrequency></CpuFrequency>
<FristUsedDate></FristUsedDate>
<CpuAvgUsage></CpuAvgUsage>
<MemAvgUsage></MemAvgUsage>
<MemType></MemType>
</Entity>
</ExtPhysicalEntities >
</Device>

Table description
Item Description
Feature name Device
Table name ExtPhysicalEntities

6
 Table type Multi-instance table
Row name Entity
Restrictions None

Columns
Column Column
Column name Data type and restrictions
description type
PhysicalIndex Entity index Index Unsigned integer.
Enumeration:
• 1-Unsupported.
Management
AdminState
status
N/A • 2-Disabled.
• 3-Shut down.
• 4-Enabled.
Enumeration:
• 1-Unsupported.
OperState Operation status N/A • 2-Unusable.
• 3-Usable.
• 4-Dangerous, cannot be used.
Enumeration:
• 1-Unsupported.
StandbyState Standby status N/A • 2-Hot standby.
• 3-Cold standby.
• 4-In service.
Alarm LED
AlarmLight N/A Unsigned integer.
status
Unsigned integer.
CpuUsage CPU usage (%) N/A
Value range: 0 to 100

CPU usage Unsigned integer.

CpuUsageThreshold N/A
threshold (%) Value range: 0 to 100

Memory usage Unsigned integer.

MemUsage N/A
(%) Value range: 0 to 100

Memory usage Unsigned integer.

MemUsageThreshold N/A
threshold (%) Value range: 0 to 100
Memory size
MemSize N/A Unsigned integer.
(bytes)
Time that
elapsed after
Uptime the entity N/A Unsigned integer.
started up
(seconds)
Temperature of
Temperature N/A Signed integer.
the entity (°C)
High-temperatur
TemperatureThreshold N/A Signed integer.
e threshold (°C)
Voltage Voltage of the N/A Unsigned integer.

7
 Column Column
Column name Data type and restrictions
description type
entity (V)
Low-voltage
VoltageLowThreshold N/A Unsigned integer.
threshold (V)
High-voltage
VoltageHighThreshold N/A Unsigned integer.
threshold (V)
Critical
TemperatureCriticalThreshold high-voltage N/A Signed integer.
threshold (°C)

MAC address of String.

MAC N/A
the entity Format: HH-HH-HH-HH-HH-HH
Unsigned integer, greater than 0.
Commonly used states:
• 1-Not supported.
• 2-Normal.
• 3-Power-on self test failure.
• 4-The entity is absent.
• 11-POE error.
• 21-Stack error.
• 22-IRF port is blocked.
Error status of
ErrorStatus
the entity
N/A • 23-IRF port failed.
• 31-SFP receiving error.
• 32-SFP sending error.
• 33-SFP error in both direction.
• 41-Fan error.
• 51-PSU error.
• 61-RPS error.
• 71-Module is faulty.
• 81-Sensor error.
• 91-Hardware is faulty.

Maximum CPU Unsigned integer.

CpuMaxUsage N/A
usage (%) Value range: 0 to 100
Low
TemperatureLowThreshold temperature N/A Signed integer.
threshold (°C)
Shutdown
TemperatureShutdownThreshol
temperature N/A Signed integer.
d
threshold (°C)
Physical Unsigned integer.
PhyMemSize memory size N/A 64
(bytes) Value range: 0 to 2 -1

CPU frequency
CpuFrequency N/A Unsigned integer.
(Hz)
Time when the DateTime.
FristUsedDate entity was used N/A
for the first time Format: YYYY-MM-DDTHH:MM:SS.

Average CPU Unsigned integer.

CpuAvgUsage N/A
usage (%) Value range: 0 to 100

8
 Column Column
Column name Data type and restrictions
description type
Average Unsigned integer.
MemAvgUsage memory usage N/A
(%) Value range: 0 to 100

String.
MemType Memory type N/A
Length: 0 to 32 characters.

Device/Transceivers
This table contains power information about a transceiver module.

XML structure
<Device>
<Transceivers>
<Interface>
<IfIndex></IfIndex>
<Name></Name>
<HardwareType></HardwareType>
<TransceiverType></TransceiverType>
<WaveLength></WaveLength>
<VendorName></VendorName>
<SerialNumber></SerialNumber>
<FiberDiameterType></FiberDiameterType>
<TransferDistance></TransferDistance>
<Diagnostic></Diagnostic>
<CurRxPower></CurRxPower>
<MaxRxPower></MaxRxPower>
<MinRxPower></MinRxPower>
<CurTxPower></CurTxPower>
<MaxTxPower></MaxTxPower>
<MinTxPower></MinTxPower>
<Temperature></Temperature>
<Voltage></Voltage>
<BiasCurrent></BiasCurrent>
<TemperatureHiAlarm></TemperatureHiAlarm>
<TemperatureLoAlarm></TemperatureLoAlarm>
<TemperatureHiWarn></TemperatureHiWarn>
<TemperatureLoWarn></TemperatureLoWarn>
<VccHiAlarm></VccHiAlarm>
<VccLoAlarm></VccLoAlarm>
<VccHiWarn></VccHiWarn>
<VccLoWarn></VccLoWarn>
<BiasHiAlarm></BiasHiAlarm>
<BiasLoAlarm></BiasLoAlarm>
<BiasHiWarn></BiasHiWarn>

9
 <BiasLoWarn></BiasLoWarn>
<PwrOutHiAlarm></PwrOutHiAlarm>
<PwrOutLoAlarm></PwrOutLoAlarm>
<PwrOutHiWarn></PwrOutHiWarn>
<PwrOutLoWarn></PwrOutLoWarn>
<RcvPwrHiAlarm></RcvPwrHiAlarm>
<RcvPwrLoAlarm></RcvPwrLoAlarm>
<RcvPwrHiWarn></RcvPwrHiWarn>
<RcvPwrLoWarn></RcvPwrLoWarn>
<TransceiverErrors></TransceiverErrors>
<VendorOUI></VendorOUI>
<RevisionNumber></RevisionNumber>
<Frequency></Frequency>
<ActiveITUChannel></ActiveITUChannel>
<CurWaveErr></CurWaveErr>
<WaveErrHiAlarm></WaveErrHiAlarm>
<WaveErrLoAlarm></WaveErrLoAlarm>
<CurFreqErr></CurFreqErr>
<FreqErrHiAlarm></FreqErrHiAlarm>
<FreqErrLoAlarm></FreqErrLoAlarm>
</Interface>
</Transceivers>
</Device>

Table description
Item Description
Feature name Device
Table name Transceiver
Table type Multi-instance table
Row name Interface
Restrictions Available only for interfaces that support a transceiver

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Some versions
support interface
name. For relevant
information, see
the XSD document
Interface
IfIndex Index Unsigned integer. of your product. For
index
information about
IfIndex, see Ifmgr
NETCONF XML
API Configuration
Reference.

10
 Column Column
Column name Data type and restrictions Remarks
description type
Interface String.
Name N/A N/A
name Length: 2 to 47 characters.

String. For example, SM

Hardware
HardwareType N/A indicates single
type Length: 0 to 63 characters. mode.

Transceiver String. For example, SFP,

TransceiverType N/A
type Length: 0 to 63 characters. XFP, and GBIC.

Wave length
WaveLength N/A Integer. N/A
(nm)
String.
VendorName Vendor name N/A N/A
Length: 0 to 63 characters.
String.
SerialNumber Serial number N/A N/A
Length: 0 to 63 characters.
Unsigned integer.
Commonly used values:
• 1-Fiber, 9 µm.
FiberDiameterTyp Fiber
e diameter type
N/A • 2-Fiber, 50 µm. N/A
• 3-Fiber, 62.5 µm.
• 4-Copper.
• 65535-Unknown.
Maximum
transmission
TransferDistance N/A Integer. N/A
distance
(meters)
Unsigned integer:
Diagnostic
Diagnostic
function
N/A • 1-Enabled. N/A
• 2-Disabled.
Current
2147483647
received
means the device
CurRxPower optical power N/A Integer.
doesn't support this
(hundredths
feature.
of dBm)
Maximum
2147483647
received
means the device
MaxRxPower optical power N/A Integer.
doesn't support this
(hundredths
feature.
of dBm)
Minimum
2147483647
received
means the device
MinRxPower optical power N/A Integer.
doesn't support this
(hundredths
feature.
of dBm)
Current
2147483647
transmitted
means the device
CurTxPower optical power N/A Integer.
doesn't support this
(hundredths
feature.
of dBm)

MaxTxPower Maximum N/A Integer. 2147483647

transmitted means the device

11
 Column Column
Column name Data type and restrictions Remarks
description type
optical power doesn't support this
(hundredths feature.
of dBm)
Minimum
2147483647
transmitted
means the device
MinTxPower optical power N/A Integer.
doesn't support this
(hundredths
feature.
of dBm)
Temperature
Temperature N/A Integer. N/A
(°C)
Voltage (one
Voltage hundredth of N/A Integer. N/A
a volt)
Current (one
BiasCurrent hundredth of N/A Integer. N/A
an mA)
Transceiver
temperature
high alarm
TemperatureHiAla
threshold N/A Integer. N/A
rm
(thousandths
of degrees
Celsius)
Transceiver
temperature
low alarm
TemperatureLoAla
threshold N/A Integer. N/A
rm
(thousandths
of degrees
Celsius)
Transceiver
temperature
high warning
TemperatureHiWa
threshold N/A Integer. N/A
rn
(thousandths
of degrees
Celsius)
Transceiver
temperature
low warning
TemperatureLoW
threshold N/A Integer. N/A
arn
(thousandths
of degrees
Celsius)
Transceiver
VCC high
alarm
VccHiAlarm N/A Integer. N/A
threshold
(hundreds of
microvolts)
Transceiver
VCC low
VccLoAlarm alarm N/A Integer. N/A
threshold
(hundreds of

12
 Column Column
Column name Data type and restrictions Remarks
description type
microvolts)
Transceiver
VCC high
warning
VccHiWarn N/A Integer. N/A
threshold
(hundreds of
microvolts)
Transceiver
VCC low
warning
VccLoWarn N/A Integer. N/A
threshold
(hundreds of
microvolts)
Transceiver
bias high
BiasHiAlarm alarm N/A Integer. N/A
threshold
(microamps)
Transceiver
bias low alarm
BiasLoAlarm N/A Integer. N/A
threshold
(microamps)
Transceiver
bias high
BiasHiWarn warning N/A Integer. N/A
threshold
(microamps)
Transceiver
bias low
BiasLoWarn warning N/A Integer. N/A
threshold
(microamps)
Transceiver
transmit
power high
PwrOutHiAlarm alarm N/A Integer. N/A
threshold
(tenths of
microwatts)
Transceiver
transmit
power low
PwrOutLoAlarm alarm N/A Integer. N/A
threshold
(tenths of
microwatts)
Transceiver
transmit
power high
PwrOutHiWarn warning N/A Integer. N/A
threshold
(tenths of
microwatts)

PwrOutLoWarn Transceiver N/A Integer. N/A

transmit

13
 Column Column
Column name Data type and restrictions Remarks
description type
power low
warning
thresholdt
(tenths of
microwatts)
Transceiver
receive power
high alarm
RcvPwrHiAlarm N/A Integer. N/A
threshold
(tenths of
microwatts)
Transceiver
receive power
low alarm
RcvPwrLoAlarm N/A Integer. N/A
threshold
(tenths of
microwatts)
Transceiver
receive power
high warning
RcvPwrHiWarn N/A Integer. N/A
threshold
(tenths of
microwatts)
Transceiver
receive power
low warning
RcvPwrLoWarn N/A Integer. N/A
threshold
(tenths of
microwattss)
1: xcvrIOError(0)
2: xcvrChecksum(1)
3:
xcvrTypeAndPortConfigMisma
tch(2)
4: xcvrTypeNotSupported(3)
5: wisLocalFault(4)
6: rcvOpticalPowerFault(5)
7:
pmapmdReceiverLocalFault(6)
Bitmask 8: pcsReceiveLocalFault(7)
indicating
TransceiverErrors N/A 9: phyXSReceiveLocalFault(8) N/A
transceiver
errors 10: laserBiasCurrentFault(9)
11: laserTemperatureFault(10)
12: laserOutputPowerFault(11)
13: txFault(12)
14:
pmapmdTransmitterLocalFault
(13)
15: pcsTransmitLocalFault(14)
16:
phyXSTransmitLocalFault(15)
17: rxLossOfSignal(16)

14
 Column Column
Column name Data type and restrictions Remarks
description type
18:tecError(17)
19:wavelengthUnlocked
(18)
20:txIsNotReadyDueToTuning
(19)

Vendor OUI of String.

VendorOUI N/A N/A
the interface Length: 0 to 255 characters.
Revision String.
RevisionNumber number of the N/A N/A
interface Length: 0 to 255 characters.

Frequency(hu
Frequency ndredths of N/A Integer. N/A
THz)
Index of the Unsigned integer.
ActiveITUChannel current ITU N/A N/A
channel Value range:1 to 4294967295.

Current wave
length
CurWaveErr N/A Integer. N/A
error(thousan
dths of nm)
High wave
length error
alarm
WaveErrHiAlarm N/A Integer. N/A
threshold
(thousandths
of nm)
Low wave
length error
alarm
WaveErrLoAlarm N/A Integer. N/A
threshold
(thousandths
of nm)
Current
frequency
CurFreqErr N/A Integer. N/A
error(tenths of
GHz)
High
frequency
error alarm
FreqErrHiAlarm N/A Integer. N/A
threshold
(tenths of
GHz)
Low
frequency
error alarm
FreqErrLoAlarm N/A Integer. N/A
threshold
(tenths of
GHz)

15
Device/TransceiversChannels
This table provides statistics for transceiver modules with multiple channels.

XML structure
<Device>
<TransceiversChannels>
<Interface>
<IfIndex></IfIndex>
<ChannelIndex></ChannelIndex>
<ChannelCurTXPower></ChannelCurTXPower>
<ChannelCurRXPower></ChannelCurRXPower>
<ChannelTemperature></ChannelTemperature>
<ChannelBiasCurrent></ChannelBiasCurrent>
</Interface>
</TransceiversChannels>
</Device>

Table description
Item Description
Feature name Device
Table name TransceiversChannels
Table type Multi-instance table
Row name Interface
Restrictions Available only for interfaces that support a transceiver module

Columns
Column Column Column
Data type and restrictions Remarks
name description type
This column is
available in some
versions. For more
information, see
the XSD document
for your product.
IfIndex Interface index Index Unsigned integer.
For information
about IfIndex, see
"Appendix" in Ifmgr
NETCONF XML
API Configuration
Reference.

Optical channel Unsigned integer.

ChannelIndex Index N/A
index Value range: 1 to 4294967295.

ChannelCurT Current N/A Integer. 2147483647

16
 Column Column Column
Data type and restrictions Remarks
name description type
XPower transmitted means the device
optical power of doesn't support this
the channel feature.
(hundredths of
dBm)
Current received
2147483647
optical power of
ChannelCurR means the device
the channel N/A Integer.
XPower doesn't support this
(hundredths of
feature.
dBm)
Some versions
support current
temperature. For
relevant
information, see
ChannelTem Temperature of
N/A Integer. the XSD document
perature the channel (°C)
of your
product.214748364
7 means the device
doesn't support this
feature.
Current of the 2147483647
ChannelBias channel (one means the device
N/A Integer.
Current hundredth of an doesn't support this
mA) feature.

Device/TransceiversITUChannels
This table contains information about ITU channels supported on the transceiver that is connected
to this interface.

XML structure
<Device>
<TransceiversITUChannels>
<Interface>
<IfIndex></IfIndex>
<ITUChannelIndex></ITUChannelIndex>
<ITUChannelFrequency></ITUChannelFrequency>
<ITUChannelWaveLength></ITUChannelWaveLength>
</Interface>
</TransceiversITUChannels>
</Device>

Table description
Item Description
Feature name Device
Table name TransceiversITUChannels

17
 Table type Multi-instance table
Row name Interface
Available only for ITU channels supported on the transceiver that
Restrictions
is connected to this interface

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Interface
IfIndex Index Unsigned integer. N/A
index
The index of Unsigned integer.
ITUChannelIndex the specified Index N/A
ITU channel Value range:1 to 4294967295.

The frequency
of the
ITUChannelFrequ specified ITU
N/A Integer. N/A
ency channel
(hundredths
of THz)
The wave
length of the
ITUChannelWave specified ITU
N/A Integer. N/A
Length channel
(thousandths
of nm)

Device/CPUs
This table contains usage information about the logical CPUs.

XML structure
<Device>
<CPUs>
<CPU>
<PhysicalIndex></PhysicalIndex>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<CPUUsage></CPUUsage>
</CPU>
</CPUs>
</Device>

18
Table description
Item Description
Feature name Device
Table name CPUs
Table type Multi-instance table
Row name CPU
Restrictions Available only for logical CPUs

Columns
Column
Column description Column type Data type and restrictions
name
PhysicalIndex Entity index Index Unsigned integer.

ID of the member where Unsigned integer.

Chassis N/A
the entity resides Value range: 0 to 65535.
Unsigned integer.
Slot Slot ID of the entity N/A
Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID N/A
Value range: 0 to 7.
Unsigned integer.
CPUUsage CPU usage (%) N/A
Value range: 0 to 100.

Device/SummerTime
This table contains summer-time information.

XML structure
<Device>
<SummerTime>
<Name></Name>
<AddTime></AddTime>
<DateBased>
<BeginMonth></BeginMonth>
<BeginDay></BeginDay>
<BeginHour></BeginHour>
<BeginMinute></BeginMinute>
<BeginSecond></BeginSecond>
<EndMonth></EndMonth>
<EndDay></EndDay>
<EndHour></EndHour>

19
 <EndMinute></EndMinute>
<EndSecond></EndSecond>
</DateBased>
<WeekBased>
<BeginMonth></BeginMonth>
<BeginWeek></BeginWeek>
<BeginWeekDay></BeginWeekDay>
<BeginHour></BeginHour>
<BeginMinute></BeginMinute>
<BeginSecond></BeginSecond>
<EndMonth></EndMonth>
<EndWeek></EndWeek>
<EndWeekDay></EndWeekDay>
<EndHour></EndHour>
<EndMinute></EndMinute>
<EndSecond></EndSecond>
</WeekBased>
</SummerTime>
</Device>

Table description
Item Description
Feature name Device
Table name SummerTime
Table type Single-instance table
Row name N/A
Group DateBased and WeekBased are two configuration
Restrictions ways.
Only one way can take effect at the same time.
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name Name for the String.
daylight saving N/A N/A
time. Length: 1 to 32 characters.

AddTime String. Value ranges:

The time to be
Formats: • HH-0 to 23.
added to the N/A
standard time. • HH:MM:SS • MM-0 to 59.
• SS-0 to 59.
DateBased Daylight saving Members include:
Data
time Structure • BeginMonth N/A
configuration • BeginDay

20
Column Column Column
Data type and restrictions Remarks
name description type
based on date. • BeginHour
• BeginMinute
• BeginSecond
• EndMonth
• EndDay
• EndHour
• EndMinute
• EndSecond
BeginMonth Unsigned integer.
Begin month. N/A N/A
Value range: 1 to 12.
BeginDay Unsigned integer.
Begin day. N/A N/A
• Value range: 1 to 31.
BeginHour Unsigned integer.
Begin hour. N/A N/A
• Value range: 0 to 23.
BeginMinute Unsigned integer.
Begin minute. N/A N/A
Value range: 0 to 59.
BeginSecond Unsigned integer.
Begin second. N/A N/A
Value range: 0 to 59.
EndMonth Unsigned integer.
End month. N/A N/A
Value range: 1 to 12.
EndDay Unsigned integer.
End day. N/A N/A
Value range: 1 to 31.
EndHour Unsigned integer.
End hour. N/A N/A
Value range: 0 to 23.
EndMinute Unsigned integer.
End minute. N/A N/A
Value range: 0 to 59.
EndSecond Unsigned integer.
End second. N/A N/A
Value range: 0 to 59.
WeekBased Members include:
• BeginMonth
• BeginWeek
• BeginWeekDay
• BeginHour
Daylight saving • BeginMinute
time Data
configuration Structure • BeginSecond N/A
based on week. • EndMonth
• EndWeek
• EndWeekDay
• EndHour
• EndMinute
• EndSecond
BeginMonth Unsigned integer.
Begin month. N/A N/A
Value range: 1 to 12.
BeginWeek Begin week of N/A Enumeration: Non-existent weeks of

21
Column Column Column
Data type and restrictions Remarks
name description type
the month. • 1-The first week the month are treated
• 2-The second week as the last week.
• 3-The third week
• 4-The fourth week
• 5-The fifth week
• 6-The last week
BeginWeekD Enumeration:
ay • 0-Sunday
• 1-Monday
Begin day of • 2-Tuesday
N/A N/A
week. • 3-Wednesday
• 4-Thursday
• 5-Friday
• 6-Saturday
BeginHour Unsigned integer.
Begin hour. N/A N/A
Value range: 0 to 23.
BeginMinute Unsigned integer.
Begin minute. N/A N/A
Value range: 0 to 59.
BeginSecond Unsigned integer.
Begin second. N/A N/A
Value range: 0 to 59.
EndMonth Unsigned integer.
End month. N/A N/A
Value range: 1 to 12.
EndWeek Enumeration:
• 1-The first week
• 2-The second week Non-existent weeks of
End week of the
month.
N/A • 3-The third week the month are treated
• 4-The fourth week as the last week.
• 5-The fifth week
• 6-The last week
EndWeekDay Enumeration:
• 0-Sunday
• 1-Monday
• 2-Tuesday
End day of week. N/A N/A
• 3-Wednesday
• 4-Thursday
• 5-Friday
• 6-Saturday
EndHour Unsigned integer.
End hour . N/A N/A
Value range: 0 to 23.
EndMinute Unsigned integer.
End minute. N/A N/A
Value range: 0 to 59.
EndSecond Unsigned integer.
End second. N/A N/A
Value range: 0 to 59.

22
Device/Boards
This table contains board information.

XML structure
<Device>
<Boards>
<Board>
<DeviceNode>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</DeviceNode>
<PhysicalIndex></PhysicalIndex>
<Status></Status>
<Role></Role>
<BelongtoCurMDC></BelongtoCurMDC>
</Board>
</Boards>
</Device>

Table description
Item Description
Feature name Device
Table name Boards
Table type Multi-instance table
Row name Board
Restrictions N/A

Columns
Column Column Column
Data type and restrictions Remarks
name description type
DeviceNo Position Members include:
de information of Data • Chassis
N/A
the device structure • Slot
Node.
• CPUID
Chassis ID of the
member where Unsigned integer.
Index N/A
the entity Value range: 0 to 65535.
resides.
Slot Slot ID of the Unsigned integer.
Index N/A
device node. Value range: 0 to 65535.

23
 Column Column Column
Data type and restrictions Remarks
name description type
CPUID Unsigned integer. 0 represent main CPU of
CPU ID. Index
Value range: 0 to 65535. current board.

PhysicalI The index is 0 when board is

Entity index. N/A Unsigned integer.
ndex absent.
Status Enumeration:
Status of the • 1-Absent
N/A N/A
device node. • 2-Normal
• 3-Fault
Role Enumeration:
• 1-Unknown
Role of the Role is Unknown when status
N/A • 2-ActiveMPU
device node. is Absent or Fault.
• 3-StandbyMPU
• 4-LPU
Belongto An MPU belongs to all MDCs.
CurMDC Whether the Boolean:
device node If you reclaim an LPU from
belongs to the
N/A • true the default MDC, the LPU
current MDC • false does not belong to the default
MDC.

Device/Blades
This table contains blade information.

XML structure
<Device>
<Blades>
<Blade>
<DeviceNode>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</DeviceNode>
<Model></Model>
</Blade>
</Blades>
</Device>

Table description
Item Description
Feature name Device
Table name Blades
Table type Multi-instance table

24
 Row name blade
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name
DeviceNode Members include:
Position of the device • Chassis
Data structure
Node. • Slot
• CPUID
Chassis ID of the member where Unsigned integer.
Index
the entity resides. Value range: 0 to 65535.
Slot Slot ID of the device Unsigned integer.
Index
node. Value range: 0 to 65535.
CPUID Unsigned integer.
CPU ID. Index
Value range: 0 to 65535.
Model Device model of blade String.
N/A
board. Length: 1 to 63 characters.

Device/PEXes
This table contains PEX board information.

XML structure
<Device>
<PEXes>
<PEX>
<DeviceNode>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</DeviceNode>
<Model></Model>
</PEX>
</PEXes>
</Device>

Table description
Item Description
Feature name Device
Table name PEXes

25
 Table type Multi-instance table
Row name PEX
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name
Members include:
DeviceNode Position of the device • Chassis
Data structure
Node. • Slot
• CPUID
Chassis ID of the member where Unsigned integer.
Index
the entity resides. Value range: 0 to 65535.
Slot Slot ID of the device Unsigned integer.
Index
node. Value range: 0 to 65535.
CPUID Unsigned integer.
CPU ID. Index
Value range: 0 to 65535.
Model Device model of PEX String.
N/A
board. Length: 1 to 63 characters.

Device/BladeCapabilities
This table contains capabilities of blade board.

XML structure
<Device>
<BladeCapabilities>
<Blade>
<Model></Model>
</Blade>
</BladeCapabilities>
</Device>

Table description
Item Description
Feature name Device
Table name BladeCapabilities
Table type Multi-instance table
Row name Blade
Restrictions N/A

26
Columns
Column
Column description Column type Data type and restrictions
name
Model Device model of blade String.
Index
board. Length: 1 to 63 characters.

Device/PEXCapabilities
This table contains capabilities of PEX board.

XML structure
<Device>
<PEXCapabilities>
<PEX>
<Model></Model>
</PEX>
</PEXCapabilities>
</Device>

Table description
Item Description
Feature name Device
Table name PEXCapabilities
Table type Multi-instance table
Row name PEX
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name
Model Device model of PEX String.
Index
board. Length: 1 to 63 characters.

Device/FailoverGroupCapabilities
This table contains capabilities of failover group.

27
XML structure
<Device>
<FailoverGroupCapabilities>
<FailoverGroupSupport></FailoverGroupSupport>
</FailoverGroupCapabilities>
</Device>

Table description
Item Description
Feature name Device
Table name FailoverGroupCapabilities
Table type Single -instance table
Row name N/A
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name
FailoverGrou Boolean:
pSupport Is support failover
group.
N/A • true
• false

Device/FailoverGroups
This table contains failover group information.

XML structure
<Device>
<FailoverGroups>
<FailoverGroup>
<ID></ID>
<Name></Name>
<PrimaryNode>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</PrimaryNode>
<SecondaryNode>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>

28
 </SecondaryNode>
<State></State>
</FailoverGroup>
</FailoverGroups>
</Device>

Table description
Item Description
Feature name Device
Table name FailoverGroups
Table type Multi-instance table
Row name FailoverGroup
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name
ID Unsigned integer.
Failover group id index
Value range: 0 to 31.
Name String.
Failover group name N/A
Length: 1 to 63 characters.
PrimaryNode Members include:
Primary node of the • Chassis
Data structure
failover group. • Slot
• CPUID
Chassis Chassis ID of the Unsigned integer.
failover group primary N/A
node. Value range: 0 to 65535.

Slot Slot ID of the failover Unsigned integer.

N/A
group primary node. Value range: 0 to 65535.
CPUID CPU ID of the failover Unsigned integer.
N/A
group primary node. Value range: 0 to 65535.
SecondaryNo Members include:
de Secondarynode of the • Chassis
Data structure
failover group. • Slot
• CPUID
Chassis Chassis ID of the Unsigned integer.
failover group N/A
secondary node. Value range: 0 to 65535.

Slot Slot ID of the failover Unsigned integer.

N/A
group secondary node. Value range: 0 to 65535.
CPUID CPU ID of the failover N/A Unsigned integer.

29
 Column
Column description Column type Data type and restrictions
name
group secondary node. Value range: 0 to 65535.
State Enumeration:
State of the failover • 1-Initial
N/A
group. • 2-Primary
• 3-Secondary

Device/Subcards
This table contains subcard information.

XML structure
<Device>
<Subcards>
<Subcard>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<SubSlot></SubSlot>
<PhysicalIndex></PhysicalIndex>
<Status></Status>
</Subcard>
</Subcards>
</Device>

Table description
Item Description
Feature name Device
Table name Subcards
Table type Multi-instance table
Row name Subcard
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name
Chassis ID of the member where Unsigned integer.
Index
the entity resides. Value range: 0 to 65535.
Slot Slot ID of the device Unsigned integer.
Index
node. Value range: 0 to 65535.

30
 Column
Column description Column type Data type and restrictions
name
CPUID Unsigned integer.
CPU ID. Index
Value range: 0 to 65535.
SubSlot Subslot number of the Unsigned integer.
Index
entity Value range: 0 to 65535.

Physical index of the Unsigned integer.

PhysicalIndex N/A
subslot Value range: 0 to 65535.
Status Enumeration:
• SubcardRemoved-The subcard has
been removed.
Status of the subcard N/A
• SubcardNormal-The subcard is
operating correctly.
• SubcardFault-The subcard is fault.

Device/TemperatureSensors
This table contains the temperature sensor information.

XML structure
<Device>
<TemperatureSensors>
<Sensor>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<SensorType></SensorType>
<SensorIndex></SensorIndex>
<SensorStatus></SensorStatus>
<CurrentTemperature></CurrentTemperature>
<LowerLimit></LowerLimit >
<WarningLimit></WarningLimit >
<AlarmLimit></AlarmLimit>
<ShutdownLimit></ShutdownLimit>
</Sensor>
</TemperatureSensors>
</Device>

Table description
Item Description
Feature name Device

31
 Table name TemperatureSensors
Table type Multi-instance table
Row name Sensor
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name
Chassis ID of the member where Unsigned integer.
Index
the entity resides. Value range: 0 to 65535.
Slot Slot ID of the device Unsigned integer.
Index
node. Value range: 0 to 65535.
CPUID Unsigned integer.
CPU ID. Index
Value range: 0 to 65535.
SensorType Enumeration:
Type of the temperature • 0-inflow
Index
sensor. • 1-outflow
• 2-Hotspot
SensorIndex Resource ID of the Unsigned integer.
Index
temperature sensor. Value range: 0 to 65535.
SensorStatus Enumeration:
• TemperatureNormal-The temperature
is normal.
• TemperatureLower-The temperature
dropped to or below the
low-temperature threshold.
Status of the • TemperatureWarnning-The
N/A temperature increased to or above the
temperature sensor
high-temperature warning threshold.
• TemperatureAlarm-The temperature
increased to or above the
high-temperature alarming threshold.
• TemperatureShutdown-The
temperature increased to or above the
high-temperature shutdown threshold.
CurrentTemp Current temperature
N/A Short
erature (°C)
LowerLimit Lower limit temperature
N/A Short
(°C)
WarningLimit Warnning limit
N/A Short
temperature (°C)
AlarmLimit Alarm limit temperature
N/A Short
(°C)
ShutdownLim Shutdown limit
N/A Short
it temperature (°C)

32
Device/SystemStableStatus
This table contains system stability and status information.

XML structure
<Device>
<SystemStableStatus>
<SystemStatus></SystemStatus>
<Redundancy></Redundancy>
</SystemStableStatus>
</Device>

Table description
Item Description
Feature name Device
Table name SystemStableStatus
Table type Single-instance table
Row name N/A
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name
Enumeration:
SystemStatu
System status N/A • Stable
s
• Not ready
Enumeration:
System redundancy • Stable
Redundancy N/A
status • No redundance
• Not ready

Device/BoardStableStatus
This table contains stability and status information for cards or member devices

XML structure
<Device>
<BoardStableStatus>
<StableState>
<Chassis></Chassis>
<Slot></Slot>

33
 <CPU></CPU>
<Role></Role>
<Status></Status>
</StableState>
</BoardStableStatus>
</Device>

Table description
Item Description
Feature name Device
Table name BoardStableStatus
Table type Multi-instance table
Row name StableState
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name
ID of the member Unsigned integer.
chassis Index
where the entity resides Value range: 0 to 65535.

Slot number of the Unsigned integer.

Slot Index
device node Value range: 0 to 65535.
Unsigned integer.
CPU ID of the CPU. Index
Value range: 0 to 65535.
Enumeration:
Role of the card or • Active
Role N/A
member device • Standby
• Other
Enumeration:
• Stable
• Board inserted
• Kernel initiating
• Service starting
Status of the card or • Service stopping
Status N/A
member device • HA Batch backup
• Interface data batch backup
• MDC starting
• MDC stopping
• Context starting
• Context stopping

34
Device/NetworkClockChassisStatus
This table contains network clock monitoring module status information.

XML structure
<Device>
<NetworkClockChassisStatus>
<ChassisStatus>
<Chassis></Chassis>
<Mode></Mode>
<LockMode></LockMode>
<SSMOutputLevel></SSMOutputLevel>
<ControlEnable></ControlEnable>
<ReferenceType></ReferenceType>
<ReferenceIndex></ReferenceIndex>
</ChassisStatus>
</NetworkClockChassisStatus>
</Device>

Table description
Item Description
Feature name Device
Table name NetworkClockChassisStatus
Table type Multi-instance table
Row name ChassisStatus
Restrictions N/A

Columns
Column Column Data type and
Column type Remarks
name description restrictions
ID of the Unsigned integer.
Chassis member where Index N/A
the entity resides Value range: 0 to 65535.

Enumeration:
Mode Work mode N/A • Auto N/A
• Manual
Enumeration:
• Freerun
LockMod Phase lock • Locked
N/A N/A
e status • Holdover
• Pre-Locked
• Pre-Locked2

35
 Column Column Data type and
Column type Remarks
name description restrictions
• Lost
• Unknown
Enumeration:
• PRC
Signal quality • SSU-A
SSMOut level of the clock
N/A • SSU-B N/A
putLevel source in the
SSM • SEC
• DNU
• Unknown
Enumeration:
ControlE SSM control
N/A • On N/A
nable enabling status
• Off
Used with
Enumeration: ReferenceIndex
Referenc
Reference type N/A • SrcClkmIndex When there is no
eType
• InterfaceIndex selected clock source,
this column is empty.
When ReferenceType is
SrcClkmIndex, this
field represents an
enumeration, which might
be:
• BITS0
Referenc Unsigned integer.
Reference index N/A • BITS1
eIndex Value range: 0 to 65535.
• PTP
Otherwise it represents
an interface index.
When there is no
selected clock source,
this column is empty.

Device/NetworkClockSrcStatus
This table contains clock source status information.

XML structure
<Device>
<NetworkClockSrcStatus>
<SrcStatus>
<Chassis></Chassis>
<ClockSource></ClockSource>
<State></State>
<Priority></Priority>
<SSMLevel></SSMLevel>
<ForceSSM></ForceSSM>
<SABit></SABit>
<Frequency></Frequency>

36
 </SrcStatus>
</NetworkClockSrcStatus>
</Device>

Table description
Item Description
Feature name Device
Table name NetworkClockSrcStatus
Table type Multi-instance table
Row name SrcStatus
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name
ID of the member Unsigned integer.
Chassis Index
where the entity resides Value range: 0 to 65535.
Enumeration:
• BITS0
ClockSource Clock source Index
• BITS1
• PTP
Enumeration:
• N/A
State Clock state N/A
• Normal
• Lost
Unsigned integer.
Priority Clock priority N/A
Value range: 0 to 255.
Enumeration:
• PRC
• SSU-A
Clock source quality
SSMLevel N/A • SSU-B
level in the SSM
• SEC
• DNU
• Unknown
Enumeration:
Whether or not get the
ForceSSM N/A • On
SSM level
• Off
Enumeration:
• N/A
• sa4
Sa bit used by BITS to
SABit N/A • sa5
transmit the SSM
• sa6
• sa7
• sa8

37
 Column
Column description Column type Data type and restrictions
name
Enumeration:
Frequency of the BITs • N/A
Frequency N/A
clock • 2Mbps
• 2MHz

Device/NetworkClockLPUPortStatus
This table contains line clock input port status information.

XML structure
<Device>
<NetworkClockLPUPortStatus>
<LPUPortStatus>
<Port></Port>
<Chassis></Chassis>
<State></State>
<Priority></Priority>
<SSMLevel></SSMLevel>
<ForceSSM></ForceSSM>
<LPUPort></LPUPort>
</LPUPortStatus>
</NetworkClockLPUPortStatus>
</Device>

Table description
Item Description
Feature name Device
Table name NetworkClockLPUPortStatus
Table type Multi-instance table
Row name LPUPortStatus
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name
Unsigned integer.
Port Interface index Index
Value range: 0 to 65535.

ID of the member Unsigned integer.

Chassis N/A
where the entity resides Value range: 0 to 65535.

38
Column
Column description Column type Data type and restrictions
name
Enumeration:
• N/A
State Clock state N/A
• Normal
• Lost
Unsigned integer.
Priority Clock priority N/A
Value range: 0 to 255.
Enumeration:
• PRC
Signal quality level of • SSU-A
SSMLevel the line clock input port N/A • SSU-B
in the SSM • SEC
• DNU
• Unknown
Enumeration:
Whether or not get the
ForceSSM N/A • On
SSM level
• Off
Enumeration:
Whether or not the line • Yes
LPUPort N/A
clock input port is up • No
• N/A

39
Contents
Device ···························································································2
Device/summer time ··················································································································· 2
Device/ failovergroup ·················································································································· 2
Device/ transceiver ····················································································································· 3

i
Device
Device/summer time
Message Explanation
When modify the time protocol by netconf, check the parameters
Unsupported parameter.
are not supported.
不支持此参数。 通过 netconf 配置时间协议时，检查到参数不支持。
When modify the time protocol by netconf, check the parameters
Incomplete parameter. are incomplete.
参数输入不完整。 通过netconf配置时间协议时，检查到参数不完整。

If it’s not allowed to set system time, please set clock protocol
Please set clock protocol manual mode first.
manual mode first.
请先将时间协议配置为手工模式。
如果不被允许设置系统时间，需要先将时间协议配置为手工模式。

End time must be later than start time, and the time
range determined can't be shorter than one day or
The prompt when failed to set summer time.
longer than one year.
设置夏令时失败时的提示。
结束时间必须晚于起始时间，并且时间范围不得短
于一天或长于一年。

When setting summer time, date and week can only choose one,
Please choose either datebased or weekbased to if both of them are not 0 , this prompt will be printed.
configure the summertime.
设置夏令时时，日期和周只能配置一个，如果日期和周的参数都不
请选择基于日期或者基于周的配置方式。
为0，则打印此提示。

When setting time source with PTP protocol, but the device
The device does not support PTP. doesn’t support PTP, this prompt will be printed.
当前设备不支持PTP协议。 设置设备通过PTP协议获取时间，但设备不支持PTP协议时，会打
印此提示。

Setting summer time with begin time and end time, if check out
that the begin time or the end time are not allowed, this prompt will
Invalid date be printed.
无效的日期 设置夏令时的起始和终止时间时，检查起始和终止时间不合法时，
打印此提示。

Device/ failovergroup
Message Explanation
Failed to create the failover group. The prompt when failed to create the failover group.
创建备份组失败。 创建备份组失败时的提示。

The prompt when the number of failover groups exceeded the

Number of failover groups exceeded the limit.
limit.
备份组个数达到最大值。
创建备份组时，备份组个数达到最大值。

This member has been configured as the primary When operate a member, if this member has been configured as
member for another failover group. Please specify the primary member for another failover group, this prompt will be
another member. printed.
这个节点已经指定为另一个备份组的主节点，请绑 对某一个节点进行操作时，如果这个节点已经被指定为另一个备份

2
定其他节点。 组的主节点，则打印此提示。

This member has been added with a different

When configuring attribute to a member, if this member has been
attribute to the group. To change the attribute,
added with a different attribute to the group, this prompt will be
remove the member and add the member with the
printed.
new attribute.
对某一节点配置属性时，如果已经配置为该备份组的另一属性，则
这个节点已配置为该备份组的另一属性。需要改变
打印此提示。
节点属性，请先移除该节点再以新的属性绑定。

When configuring attribute to a member, if this attribute has been

The attribute has been configured for another added to a different member of the group, this prompt will be
member in this failover group. printed.
备份组的这个属性已经配置了另一节点。 对某一节点配置属性时，如果该属性已经配置给了该备份组的另一
节点，则打印此提示。

Main and Standby conflict.

暂未使用
主备节点冲突。

When operate the failover group failed, and the reason is not
Operation failed.
clear, this prompt will be printed by default.
操作失败。
对备份组操作失败时，但又没有返回问题原因，则默认打印此提示。

The failovergroup name and ID must identify the When the name and ID is not matched to the failovergroup, this
same failovergroup. prompt will be printed.
输入的备份组名称有误，请输入与ID对应的名称。 如果获取的备份组名称和ID与备份组不匹配，则打印此提示。

Invalid failovergroup ID or Name. When the name and ID is invalid, this prompt will be printed.
输入的备份组ID或Name无效。 创建备份组时，输入的备份组ID或Name无效，则打印此提示。

Device/ transceiver
When failed to set ITU channel num to the driver, the reason is the
The transceiver is absent. transceiver is absent.
可插拔光模块不在位。 设置ITU channel 通道号到驱动失败时，驱动返回失败原因为可插
拔光模块不在位。

When failed to set ITU channel num to the driver, the reason is the
The transceiver does not support this function. transceiver does not support this function.
可插拔光模块不支持该功能。 设置ITU channel 通道号到驱动失败时，驱动返回失败原因为可插
拔光模块不支持该功能。

When failed to set ITU channel num to the driver, the reason is the
The port has no transceiver information. port has no transceiver information.
获取可插拔光模块信息失败。 设置ITU channel 通道号到驱动失败时，驱动返回失败原因为获取
可插拔光模块信息失败。

When failed to set ITU channel num to the driver, and the reason
Operation failed. does not given, this prompt will be printed by default.
操作失败。 设置ITU channel 通道号到驱动失败时，驱动没有返回失败原因，
则默认打印此提示。

3
Contents
Device event stream ·········································································1
BoardEvent event ······················································································································ 1
XML structure for event subscription ························································································ 1
XML structure for event report ································································································ 2
SubcardEvent event ··················································································································· 3
XML structure for event subscription ························································································ 3
XML structure for event report ································································································ 4
TemperatureEvent event ············································································································· 5
XML structure for event subscription ························································································ 5
XML structure for event report ································································································ 6
SystemStableStatusEvent event ··································································································· 8
XML structure for event subscription ························································································ 8
XML structure for event report ································································································ 8
BoardStableStatusEvent event ····································································································· 9
XML structure for event subscription ························································································ 9
XML structure for event report ······························································································ 10

i
Device event stream
BoardEvent event
This event is used to report card or member device alarm information.

XML structure for event subscription

<BoardEvent>
<Board>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</Board>
</BoardEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>Device</stream>
<filter type="subtree">
<BoardEvent xmlns="http://www.h3c.com/netconf/event:1.0/Device:1.0">
<Board>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
</Board>
</BoardEvent >
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name Device
Event name BoardEvent
Event namespace http://www.h3c.com/netconf/event:1.0/Device:1.0
Support for extended query No

Columns

Data type and Support for

Column name Column description
restrictions extended queries
Member ID of the member Unsigned integer.
Chassis No
device where the entity Value range: 0 to

1
 Data type and Support for
Column name Column description
restrictions extended queries
resides 65535.
Unsigned integer.
Slot number of the device
Slot Value range: 0 to No
node
65535.
Unsigned integer.
CPUID ID of the CPU. Value range: 0 to No
65535.

XML structure for event report

<BoardEvent>
<Board>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<PhysicalIndex></PhysicalIndex>
<BoardStatus></BoardStatus>
</Board>
</BoardEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<BoardEvent xmlns="http://www.h3c.com/netconf/event:1.0/Device:1.0">
<Board>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
<PhysicalIndex>100</PhysicalIndex>
<BoardStatus>BoardNormal</BoardStatus>
</Board>
</BoardEvent>
</notification>

Columns

Column
Column description Data type and restrictions
name
Member ID of the member Unsigned integer.
Chassis
device where the entity resides Value range: 0 to 65535.
Unsigned integer.
Slot Slot number of the device node
Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU
Value range: 0 to 65535.
PhysicalIndex Entity index. Unsigned integer.

2
 Column
Column description Data type and restrictions
name
Value range: 0 to 65535.
Enumeration:
• BoardRemoved-The card has been removed.
BoardStatus Status of the card
• BoardNormal-The card is operating correctly.
• BoardFault-The card is faulty.

SubcardEvent event
This event is used to report subcard alarm information.

XML structure for event subscription

<SubcardEvent>
<Subcard>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<SubSlot></SubSlot>
</Subcard>
</SubcardEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>Device</stream>
<filter type="subtree">
<SubcardEvent xmlns="http://www.h3c.com/netconf/event:1.0/Device:1.0">
<Subcard>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
<SubSlot>1</SubSlot>
</Subcard>
</SubcardEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name Device
Event name SubcardEvent
Event namespace http://www.h3c.com/netconf/event:1.0/Device:1.0

3
 Item Description
Support for extended query No

Columns

Support for
Column name Column description Data type and restrictions extended
queries
Member ID of the Unsigned integer.
Chassis member device where No
the entity resides Value range: 0 to 65535.

Slot number of the device Unsigned integer.

Slot No
node Value range: 0 to 65535.

Subslot number of the Unsigned integer.

SubSlot No
entity Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU. No
Value range: 0 to 65535.

XML structure for event report

<SubcardEvent>
<Subcard>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<SubSlot></SubSlot>
<PhysicalIndex></PhysicalIndex>
<SubcardStatus></SubcardStatus>
</Subcard>
</SubcardEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<SubcardEvent xmlns="http://www.h3c.com/netconf/event:1.0/Device:1.0">
<Subcard>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
<SubSlot>1</SubSlot>
<PhysicalIndex>100</PhysicalIndex>
<SubcardStatus>SubcardRemoved</SubcardStatus>
</Subcard>
</SubcardEvent>
</notification>

4
Columns

Column name Column description Data type and restrictions

Member ID of the member Unsigned integer.
Chassis device where the entity
resides Value range: 0 to 65535.

Slot number of the device Unsigned integer.

Slot
node Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU
Value range: 0 to 65535.
Unsigned integer.
SubSlot Subslot number of the entity
Value range: 0 to 65535.
PhysicalIndex Unsigned integer.
Entity index.
Value range: 0 to 65535.
Enumeration:
• SubcardRemoved-The subcard has been
removed.
SubcardStatus Status of the subcard
• SubcardNormal-The subcard is operating
correctly.
• SubcardFault-The subcard is fault.

TemperatureEvent event
This event is used to report temperature alarm information.

XML structure for event subscription

<TemperatureEvent>
<Temperature>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</Temperature>
</TemperatureEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>Device</stream>
<filter type="subtree">
<TemperatureEvent xmlns="http://www.h3c.com/netconf/event:1.0/Device:1.0">
<Temperature>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>

5
 </Temperature>
</TemperatureEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name Device
Event name TemperatureEvent
Event namespace http://www.h3c.com/netconf/event:1.0/Device:1.0
Support for extended query No

Columns

Support for
Column name Column description Data type and restrictions extended
queries
Member ID of the member Unsigned integer.
Chassis device where the entity No
resides Value range: 0 to 65535.

Slot number of the device Unsigned integer.

Slot No
node Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU. No
Value range: 0 to 65535.

XML structure for event report

<TemperatureEvent>
<Temperature>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<PhysicalIndex></PhysicalIndex>
<SensorType></SensorType>
<Status></Status>
<CurrentTemperature></CurrentTemperature>
<LowerLimitTemperature></LowerLimitTemperature>
<WarnningLimitTemperature></WarnningLimitTemperature>
<AlarmLimitTemperature></AlarmLimitTemperature>
<ShutdownLimitTemperature></ShutdownLimitTemperature>
</Temperature>
</TemperatureEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<TemperatureEvent xmlns="http://www.h3c.com/netconf/event:1.0/Device:1.0">

6
 <Temperature>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
<PhysicalIndex>100</PhysicalIndex>
<SensorType>Hotspot</SensorType>
<Status>TemperatureWarnning</Status>
<CurrentTemperature>73</CurrentTemperature>
<LowerLimitTemperature>0</LowerLimitTemperature>
<WarnningLimitTemperature>65</WarnningLimitTemperature>
<AlarmLimitTemperature>75</AlarmLimitTemperature>
<ShutdownLimitTemperature>90</ShutdownLimitTemperature>
</Temperature>
</TemperatureEvent>
</notification>

Columns

Column name Column description Data type and restrictions

Member ID of the Unsigned integer.
Chassis member device where
the entity resides Value range: 0 to 65535.

Slot number of the device Unsigned integer.

Slot
node Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU
Value range: 0 to 65535.
Physical index of the Unsigned integer.
PhysicalIndex
temperature sensor Value range: 0 to 65535.
Enumeration:
Type of the temperature • inflow
SensorType
sensor • outflow
• Hotspot
Enumeration:
• TemperatureNormal-The temperature is
normal.
• TemperatureLower-The temperature
dropped to or below the
low-temperature threshold.
Status of the temperature • TemperatureWarnning-The temperature
Status increased to or above the
sensor
high-temperature warning threshold.
• TemperatureAlarm-The temperature
increased to or above the
high-temperature alarming threshold.
TemperatureShutdown-The temperature
increased to or above the
high-temperature shutdown threshold
CurrentTemperature Current Temperature(℃) Short

Lower Limit
LowerLimitTemperature Short
Temperature(℃)
WarnningLimitTemperature Warnning Limit Short

7
 Column name Column description Data type and restrictions
Temperature(℃)
Alarm Limit
AlarmLimitTemperature Short
Temperature(℃)
Shutdown Limit
ShutdownLimitTemperature Short
Temperature(℃)

SystemStableStatusEvent event
This event is used to report system stability and status information.

XML structure for event subscription

<SystemStableStatusEvent>
</SystemStableStatusEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>Device</stream>
<filter type="subtree">
<SystemStableStatusEvent xmlns="http://www.h3c.com/netconf/event:1.0/Device:1.0">
</SystemStableStatusEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name Device
Event name SystemStableStatusEvent
Event namespace http://www.h3c.com/netconf/event:1.0/Device:1.0
Support for extended query No

Columns
None

XML structure for event report

<SystemStableStatusEvent>
<SystemStatus></SystemStatus>
<Redundancy></Redundancy>
</SystemStableStatusEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">

8
 <eventTime>2016-07-21T09:10:51</eventTime>
<SystemStableStatusEvent xmlns="http://www.h3c.com/netconf/event:1.0/Device:1.0">
<SystemStatus>Stable</SystemStatus>
<Redundancy>Stable</Redundancy>
</SystemStableStatusEvent>
</notification>

Columns

Column name Column description Data type and restrictions

Enumeration:
SystemStatus System stable status • Stable
• Not ready
Enumeration:
• Stable
Redundancy Status of active/standby
• No redundance
• Not ready

BoardStableStatusEvent event
This event is used to report card stability and status information.

XML structure for event subscription

<BoardStableStatusEvent>
<BoardStableStatus>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</BoardStableStatus>
</BoardStableStatusEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>Device</stream>
<filter type="subtree">
<BoardStableStatusEvent xmlns="http://www.h3c.com/netconf/event:1.0/Device:1.0">
<BoardStableStatus>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</BoardStableStatus>
</BoardStableStatusEvent>
</filter>
</create-subscription>
</rpc>

9
Table description

Item Description
Event stream name Device
Event name BoardStableStatusEvent
Event namespace http://www.h3c.com/netconf/event:1.0/Device:1.0
Support for extended query No

Columns

Data type and Support for

Column name Column description
restrictions extended queries
Member ID of the member Unsigned integer.
Chassis device where the entity No
resides Value range: 0 to 65535.

Slot number of the device Unsigned integer.

Slot No
node Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU. No
Value range: 0 to 65535.

XML structure for event report

<BoardStableStatusEvent>
<BoardStableStatus>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<Role></Role>
<Status></Status>
</BoardStableStatus>
</BoardStableStatusEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<BoardStableStatusEvent xmlns="http://www.h3c.com/netconf/event:1.0/Device:1.0">
<BoardStableStatus>
<Chassis>1</Chassis>
<Slot>1</Slot>
<CPUID>0</CPUID>
<Role>Standby</Role>
<Status>Stable</Status>
</BoardStableStatus>
</BoardStableStatusEvent>
</notification>

10
Columns

Column name Column description Data type and restrictions

Member ID of the member device where Unsigned integer.
Chassis
the entity resides Value range: 0 to 65535.
Unsigned integer.
Slot Slot number of the device node
Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU
Value range: 0 to 65535.
Enumeration:
• Active
Role Role of the board
• Standby
• Other
Enumeration:
• Stable
• Board inserted
• Kernel initiating
• Service starting
• Service stopping
Status Status of the board • HA Batch backup
• Interface data batch backup
• MDC starting
• MDC stopping
• Context starting
• Context stopping
• Removed(Stable)

11
Contents
address-pool event stream ·································································1
ama-register-to-controller event ···································································································· 1
XML structure for event subscription ························································································ 1
XML structure for event report ································································································ 1
ama-report-heart-beat-to-controller event ························································································ 2
XML structure for event subscription ························································································ 2
XML structure for event report ································································································ 2
address-pool-status event ············································································································ 3
XML structure for event subscription ························································································ 3
XML structure for event report ································································································ 3
ama-report-address-got-to-controller-ipv4 event ··············································································· 5
XML structure for event subscription ························································································ 5
XML structure for event report ································································································ 6
ama-report-address-got-to-controller-ipv6 event ··············································································· 7
XML structure for event subscription ························································································ 7
XML structure for event report ································································································ 7
ama-report-address-recycled-to-controller-ipv4 event ········································································ 8
XML structure for event subscription ························································································ 8
XML structure for event report ································································································ 9
ama-report-address-recycled-to-controller-ipv6 event ······································································ 10
XML structure for event subscription ······················································································ 10
XML structure for event report ······························································································ 10
ama-report-lack-of-address-block event ························································································ 11
XML structure for event subscription ······················································································ 11
XML structure for event report ······························································································ 12
address-pool event stream
ama-register-to-controller event
This event is used to notify controller that AMA registered successfully.

XML structure for event subscription

<ama-register-to-controller>
</ama-register-to-controller>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>address_pool</stream>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name address-pool
Event name ama-register-to-controller
Event namespace urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras
Support for extended query no

XML structure for event report

<ama-register-to-controller>
<device-id></device-id>
</ama-register-to-controller>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<ama-register-to-controller
xmlns="urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras">
<device-id>5</device-id>
</ama-register-to-controller>
</notification>

Table description

Column
Column description Data type and restrictions Remarks
name
device-id AMA device id assigned Unsigned Integer 32
 Column
Column description Data type and restrictions Remarks
name
by app Value range: 0 to 4294967295.

ama-report-heart-beat-to-controller event
This event is used to report heart beat to controller for AMA
Controller uses this to detect the inactive of AMA.
The period of heart beat is according to the configuration: flexbng-device-info
/controller-send-configuration-to-ama/ device-keep-alive-interval.
.

XML structure for event subscription

<ama-report-heart-beat-to-controller>
</ama-report-heart-beat-to-controller>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>address_pool</stream>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name address-pool
Event name ama-report-heart-beat-to-controller
Event namespace urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras
Support for extended query no

XML structure for event report

<ama-report-heart-beat-to-controller>
<ama-id>5</ama-id>
</ama-report-heart-beat-to-controller>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<ama-report-heart-beat-to-controller
xmlns="urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras">
<ama-id>5</ama-id>
</ama-report-heart-beat-to-controller>
</notification>
Table description

Column
Column description Data type and restrictions Remarks
name
AMA device id assigned Unsigned Integer 32.
ama-id
by app Value range: 0 to 4294967295.

address-pool-status event
This event is used to report address pool status.

XML structure for event subscription

<ama-register-to-controller >
</ama-register-to-controller>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>address_pool</stream>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name address-pool
Event name address-pool-status
Event namespace urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras
Support for extended query no

XML structure for event report

<address-pool-status>
<device-id></device-id>
<time></time>
<address-pool>
<address-pool-name></address-pool-name>
<address-pool-id></address-pool-id>
<domain-name></domain-name>
<address-pool-entries>
<ipv4-address-block>
<ipv4-address-block-name></ipv4-address-block-name>
<ipv4-address-block-id></ipv4-address-block-id>
<average-address-usage-ratio></average-address-usage-ratio>
</ipv4-address-block>
<ipv6-address-block>
 <ipv6-address-block-name></ipv6-address-block-name>
<ipv6-address-block-id></ipv6-address-block-id>
<average-address-usage-ratio></average-address-usage-ratio>
</ipv6-address-block>
</address-pool-entries>
</address-pool>
</address-pool-status>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<address-pool-status
xmlns="urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras">
<device-id>3</device-id>
<time>1478260941</time>
<address-pool>
<address-pool-name>pool1</address-pool-name>
<address-pool-id>1</address-pool-id>
<domain-name>pppoe</domain-name>
<address-pool-entries>
<ipv4-address-block>
<ipv4-address-block-name>network1</ipv4-address-block-name>
<ipv4-address-block-id>1</ipv4-address-block-id>
<average-address-usage-ratio>1</average-address-usage-ratio>
</ipv4-address-block>
</address-pool-entries>
</address-pool>
<address-pool>
<address-pool-name>pool2</address-pool-name>
<address-pool-id>2</address-pool-id>
<domain-name>pppoe</domain-name>
<address-pool-entries>
<ipv6-address-block>
<ipv6-address-block-name>network1</ipv6-address-block-name>
<ipv6-address-block-id>1</ipv6-address-block-id>
<average-address-usage-ratio>1</average-address-usage-ratio>
</ipv6-address-block>
</address-pool-entries>
</address-pool>
</address-pool-status>
</notification>

Table description

Column
Column description Data type and restrictions Remarks
name
AMA device id assigned Unsigned Integer 32.
device-id
by app Value range: 0 to 4294967295.
 Column
Column description Data type and restrictions Remarks
name
Timestamp of the Unsigned Integer 32.
time
notification Value range: 0 to 4294967295.

address-pool- Name of the address String

name pool String Length:1 to 63

address-pool-i Unsigned Integer 32.

Pool ID
d Value range: 0 to 4294967295.
String
domain-name Domain name
String Length:1 to 63

ipv4-address- String
Block name
block-name String Length:1 to 63

ipv4-address- Unsigned Integer 32.

Block ID
block-id Value range: 0 to 4294967295.
average-addr Unsigned Integer 32.
Usage ratio of address
ess-usage-rati
pool Value range: 0 to 4294967295.
o

Ipv6-address- IPv6 address block String

block-name name String Length:1 to 63

Ipv6-address- Unsigned Integer 32.

IPv6 address block ID
block-id Value range: 0 to 4294967295.

ama-report-address-got-to-controller-ipv4 event
This event is used to notify controller the distribution result of ipv4 address pools.

XML structure for event subscription

<ama-report-address-got-to-controller-ipv4>
</ama-report-address-got-to-controller-ipv4>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>address_pool</stream>
</create-subscription>
</rpc>

</rpc>

Table description

Item Description
Event stream name address-pool
Event name ama-report-address-got-to-controller-ipv4
Event namespace urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras
 Item Description
Support for extended query no

XML structure for event report

<ama-report-address-got-to-controller-ipv4>
<device-id></device-id>
<domain-name></domain-name>
<address-pool-id></address-pool-id>
<address-pool-name></address-pool-name>
<address-block-id></address-block-id>
<address-block-name></address-block-name>
<result></result>
</ama-report-address-got-to-controller-ipv4>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<ama-report-address-got-to-controller-ipv4
xmlns="urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras">
<device-id>5</device-id>
<domain-name>ppoe</domain-name>
<address-pool-id>2</address-pool-id>
<address-pool-name>pool2</address-pool-name>
<address-block-id>2</address-block-id>
<address-block-name>network2</address-block-name>
<result>sucess</result>
</ama-report-address-got-to-controller-ipv4>
</notification>

Table description

Column
Column description Data type and restrictions Remarks
name
Unsigned Integer 32
device-id Device ID
Value range: 0 to 4294967295.
OctectString
domain-name Domain name
String Length:1 to 63

address-pool-i Unsigned Integer 32.

Address pool ID
d Value range: 0 to 4294967295.

address-pool- OctectString
Address pool name
name String Length:1 to 63
address-block
Block ID Value range: 0 to 4294967295.
-id

address-block OctectString
Block name
-name String Length:1 to 63
 Column
Column description Data type and restrictions Remarks
name
Enumeration:
Distribution result of
result
ipv4 address pools • success
• fail

ama-report-address-got-to-controller-ipv6 event
This event is used to notify controller the distribution result of ipv6 address pools.

XML structure for event subscription

<ama-report-address-got-to-controller-ipv6>
</ama-report-address-got-to-controller-ipv6>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>address_pool</stream>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name address-pool
Event name ama-report-address-got-to-controller-ipv6
Event namespace urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras
Support for extended query no

XML structure for event report

<ama-report-address-got-to-controller-ipv6>
<device-id></device-id>
<domain-name></domain-name>
<address-pool-id></address-pool-id>
<address-pool-name></address-pool-name>
<address-block-id></address-block-id>
<address-block-name></address-block-name>
<result></result>
<ama-report-address-got-to-controller-ipv6>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
 <ama-report-address-got-to-controller-ipv6
xmlns="urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras">
<device-id>5</device-id>
<domain-name>ppoe</domain-name>
<address-pool-id>2</address-pool-id>
<address-pool-name>pool2</address-pool-name>
<address-block-id>2</address-block-id>
<address-block-name>network2</address-block-name>
<result>sucess</result>
</ama-report-address-got-to-controller-ipv6>
</notification>

Table description

Column
Column description Data type and restrictions Remarks
name
Unsigned Integer 32
device-id Device ID
Value range: 0 to 4294967295.
OctectString
domain-name Domain name
String Length:1 to 63

address-pool-i Unsigned Integer 32.

Address pool ID
d Value range: 0 to 4294967295.

address-pool- OctectString
Address pool name
name String Length:1 to 63
address-block
Block ID Value range: 0 to 4294967295.
-id

address-block OctectString
Block name
-name String Length:1 to 63
Enumeration:
Distribution result of
result
ipv6 address pools • success
• fail

ama-report-address-recycled-to-controller-ipv4
event
This event is used to notify controller the recycled result of ipv4 address pools.

XML structure for event subscription

<ama-report-address-recycled-to-controller-ipv4>
</ama-report-address-recycled-to-controller-ipv4>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>address_pool</stream>
 </create-subscription>
</rpc>

Table description

Item Description
Event stream name address-pool
Event name ama-report-address-recycled-to-controller-ipv4
Event namespace urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras
Support for extended query no

XML structure for event report

<ama-report-address-recycled-to-controller-ipv4>
<device-id></device-id>
<domain-name></domain-name>
<address-pool-id></address-pool-id>
<address-pool-name></address-pool-name>
<address-block-id></address-block-id>
<address-block-name></address-block-name>
<result></result>
</ama-report-address-recycled-to-controller-ipv4>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<ama-report-address-recycled-to-controller-ipv4
xmlns="urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras">
<device-id>5</device-id>
<domain-name>ppoe</domain-name>
<address-pool-id>2</address-pool-id>
<address-pool-name>pool2</address-pool-name>
<address-block-id>2</address-block-id>
<address-block-name>network2</address-block-name>
<result>sucess</result>
</ama-report-address-recycled-to-controller-ipv4>
</notification>

Table description

Column
Column description Data type and restrictions Remarks
name
device-id Device ID Unsigned Integer 32
domain-name Domain name OctectString

address-pool-i Unsigned Integer 32

Pool ID
d Value range: 0 to 4294967295.

address-pool- Pool name OctectString

 Column
Column description Data type and restrictions Remarks
name
name String Length:1 to 63

address-block Unsigned Integer 32

Block ID
-id Value range: 0 to 4294967295.

address-block OctectString
Block name
-name String Length:1 to 63
Enumeration:
Recycled result of ipv4
result
address pools • success
• fail

ama-report-address-recycled-to-controller-ipv6
event
This event is used to notify controller the recycled result of ipv6 address pools.

XML structure for event subscription

<ama-report-address-recycled-to-controller-ipv6>
</ama-report-address-recycled-to-controller-ipv6>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>address_pool</stream>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name address-pool
Event name ama-report-address-recycled-to-controller-ipv6
Event namespace urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras
Support for extended query no

XML structure for event report

<ama-report-address-recycled-to-controller-ipv6>
<device-id></device-id>
<domain-name></domain-name>
<address-pool-id></address-pool-id>
<address-pool-name></address-pool-name>
<address-block-id></address-block-id>
 <address-block-name></address-block-name>
<result></result>
</ama-report-address-recycled-to-controller-ipv6>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<ama-report-address-recycled-to-controller-ipv6
xmlns="urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras">
<device-id>5</device-id>
<domain-name>ppoe</domain-name>
<address-pool-id>2</address-pool-id>
<address-pool-name>pool2</address-pool-name>
<address-block-id>2</address-block-id>
<address-block-name>network2</address-block-name>
<result>sucess</result>
</ama-report-address-recycled-to-controller-ipv6>
</notification>

Table description

Column
Column description Data type and restrictions Remarks
name
device-id Device id Unsigned Integer 32
domain-name Domain name OctectString

address-pool-i Unsigned Integer 32

Pool id
d Value range: 0 to 4294967295.

address-pool- OctectString
Pool name
name String Length:1 to 63

address-block Unsigned Integer 32

Block id
-id Value range: 0 to 4294967295.

address-block OctectString
Block name
-name String Length:1 to 63
Enumeration:
Recycled result of ipv6
result
address pools • success
• fail

ama-report-lack-of-address-block event
This event is used to notify controller lack of IP address.When controller recieves this notification,it
distributes new address pools to device.

XML structure for event subscription

<ama-report-lack-of-address-block>
</ama-report-lack-of-address-block>

Example:
 <rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>address_pool</stream>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name address-pool
Event name ama-report-lack-of-address-block
Event namespace urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras
Support for extended query no

XML structure for event report

<ama-report-lack-of-address-block>
<device-id></device-id>
<domain-name></domain-name>
<protocol-type></protocol-type>
</ama-report-lack-of-address-block>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<ama-report-lack-of-address-block
xmlns="urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras">
<device-id>5</device-id>
<domain-name>ppoe</domain-name>
<protocol-type>ipv4</protocol-type>
</ama-report-lack-of-address-block>
</notification>

Table description

Column
Column description Data type and restrictions Remarks
name
Unsigned Integer 32.
device-id Device ID
Value range: 0 to 4294967295.
OctectString
domain-name Domain name
String Length:1 to 63
Enumeration:
Protocol-type Protocl type,ipv4/ipv6 • 1—ipv4.
• 0—ipv6.
Contents
flexbng-device-info ···········································································1
flexbng-device-info/controller-netconf-registration ············································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Example ···························································································································· 1
flexbng-device-info/controller-send-configuration-to-ama ···································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
Example ···························································································································· 3

i
flexbng-device-info
The namespace of flexbng-device-info is
"urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras".

flexbng-device-info/controller-netconf-registration
This table contains flexbng device registration information.

XML structure
<flexbng-device-info>
<controller-netconf-registration>
<device-id></device-id>
</controller-netconf-registration>
</flexbng-device-info>

Table description
Item Description
Feature name flexbng-device-info
Table name controller-netconf-registration
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions
name description type
AMA device id Unsigned Integer 32.
device-id N/A
assigned by app Value range: 0 to 4294967295.

Example
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<edit-config>
<target>
<running/>
</target>
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<v:controller-netconf-registration
xmlns:v="urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras">

1
 <v:device-id>5</v:device-id>
</v:controller-netconf-registration>
</config>
</edit-config>
</rpc>

flexbng-device-info/controller-send-configuration-
to-ama
This table is used to send configuration to ama for controller.

XML structure
<flexbng-device-info >
<controller-send-configuration-to-ama>
<device-keep-alive-interval></device-keep-alive-interval>
<ipv4-address-pool-usage-threshold></ipv4-address-pool-usage-threshold>
<ipv6-address-pool-usage-threshold></ipv6-address-pool-usage-threshold>
<state-update-interval></state-update-interval>
<device-sampling-interval></device-sampling-interval>
</controller-send-configuration-to-ama>
</flexbng-device-info>

Table description
Item Description
Feature name flexbng-device-info
Table name controller-send-configuration-to-ama
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column name Column description Column type Data type and restrictions
device-keep-alive-i Heartbeat interval of Unsigned Integer 32.
N/A
nterval confd service Value range: 0 to 4294967295.

ipv4-address-pool- IPv4 threshold of pool DOUBLE.

N/A
usage-threshold block usage ratio Value range: 0 to 100.

ipv6-address-pool- IPv6 threshold of pool DOUBLE.

N/A
usage-threshold block usage ratio Value range: 0 to 100.

state-update-interv Report interval for pool N/A Unsigned Integer 32.

2
 al block status Value range: 0 to 4294967295.

device-sampling-int Sampling interval for pool Unsigned Integer 32.

N/A
erval block usage ratio Value range: 0 to 4294967295.

Example
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<edit-config>
<target>
<running/>
</target>
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<v:controller-send-configuration-to-ama
xmlns:v="urn:ietf:params:xml:ns:yang:ietf-address-pool:flexbng:vbras">
<v:device-keep-alive-interval>3</v:device-keep-alive-interval>
<v:ipv4-address-pool-usage-threshold>0.8</v:ipv4-address-pool-usage-threshold>
<v:ipv6-address-pool-usage-threshold>0.8</v:ipv6-address-pool-usage-threshold>
<v:state-update-interval>5</v:state-update-interval>
<v:device-sampling-interval>0</v:device-sampling-interval>
</v:controller-send-configuration-to-ama>
</config>
</edit-config>
</rpc>

3
Contents
ietf-address-pool ··············································································1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
ietf-address-pool/address-pools/address-pool ·················································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
ietf-address-pool/address-pools/address-pool/ipv4-address-block ························································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
ietf-address-pool/address-pools/address-pool/ipv6-address-block ························································ 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
Example ···························································································································· 5

i
ietf-address-pool
The namespace of flexbng-device-info is "urn:ietf:params:xml:ns:yang:ietf-address-pool".
The Example on the end of this module sets an instance that the module can’t be under top node.
ietf-address-pool/address-pools.
This table contains address pool configuration information.

XML structure
<ietf-address-pool>
<address-pools>
<device-id></device-id>
<address-pool>
<address-pool-name></address-pool-name>
<address-pool-id></address-pool-id>
<domain-name></domain-name>
<ipv4-usergateway></ipv4-usergateway>
<ipv6-usergateway></ipv6-usergateway>
<gwnetmask></gwnetmask>
<leasing-time></leasing-time>
<primarydns></primarydns>
<secondarydns></secondarydns>
<address-pool-entries>
<ipv4-address-block>
<pool-name></pool-name>
<ipv4-address-block-name></ipv4-address-block-name>
<ipv4-address-block-id></ipv4-address-block-id>
<ipv4-prefix></ipv4-prefix>
<ipv4-prefix-length></ipv4-prefix-length>
<time></time>
</ipv4-address-block>
<ipv6-address-block>
<pool-name></pool-name>
<ipv6-address-block-name></ipv6-address-block-name>
<ipv6-address-block-id></ipv6-address-block-id>
<ipv6-prefix></ipv6-prefix>
<ipv6-prefix-length></ipv6-prefix-length>
<time></time>
</ipv6-address-block>
</address-pool-entries>
</address-pool>
</address-pools>
</ietf-address-pool>

1
Table description
Item Description
Feature name Ietf-address-pool
Table name address-pools
Table type Multi-instance table
Row name None
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions
name description type
AMA device id Unsigned Integer 32.
device-id assigned by N/A
app Value range:0 to 4294967295.

Information of
address-pool Sublist The details of the sublist refer to address-pool table.
the address pool

ietf-address-pool/address-pools/address-pool
This table contains address pool configuration information.

XML structure
Please refer to the XML Structure of ietf-address-pool/address-pools.

Table description
Item Description
Feature name Ietf-address-pool
Table name address-pool
Table type Multi-instance table
Row name None
Restrictions None
Support for row creation and deletion Yes

2
Columns
Column Column
Column name Data type and restrictions
description type
address-pool-na String
Name of address pool index
me Length: 1 to 63 characters
Unsigned Integer 32.
address-pool-id Address pool ID N/A
Value range: 0 to 4294967295.
String
domain-name Domain name N/A
Length:1 to 63 characters
Used for IPv4 user
ipv4-usergateway N/A IPv4 address
addressing
Used for IPv6 user
ipv6-usergateway N/A IPv6 address
addressing

Netmask for user Unsigned Integer 32.

gwnetmask N/A
gateway Value range: 1 to 128
Unsigned Integer 32.
Value range: 0 to 4294967295.
Leasing time with
leasing-time N/A The column can’t be changed.Its returned
default 3 days
value is always 3 ,no matter which number
it is configured for.
Primary DNS
primarydns N/A IP address
information
Secondary DNS
secondarydns N/A IP address
information
Ipv4-address-bloc Information of the ipv4 The details of the sublist refer to
Sublist
k address block ipv4-address-block table.

Ipv6-address-bloc Information of the ipv6 The details of the sublist refer to

Sublist
k address block ipv6-address-block table.

ietf-address-pool/address-pools/address-pool/ipv
4-address-block
This table contains address pool configuration information.

XML structure
Please refer to the XML Structure of ietf-address-pool/address-pools.

Table description
Item Description
Feature name Ietf-address-pool
Table name ipv4-address-block
Table type Multi-instance table

3
 Row name None
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
address-pool- Name of address String
index Index of present table
name pool Length:1 to 63 characters

ipv4-address- Name of IPv4 String

index N/A
block-name address block Length:1 to 63 characters

ipv4-address- ID of IPv4 Unsigned Integer 32.

N/A N/A
block-id address block Value range: 0 to 4294967295.
IPv4 address
ipv4-prefix N/A Ipv4Address N/A
prefix

ipv4-prefix-le IPv4 address Unsigned Integer 32.

N/A N/A
ngth prefix length Value range: 1 to 30.

Address block Unsigned Integer 32. For table:

time N/A
allocation time Value range: 0 to 4294967295 ipv4-address-block

ietf-address-pool/address-pools/address-pool/ipv
6-address-block
This table contains address-pool configuration information.

XML structure
Please refer to the XML Structure of ietf-address-pool/address-pools.

Table description
Item Description
Feature name Ietf-address-pool
Table name Ipv6-address-block
Table type Multi-instance table
Row name None
Restrictions None
Support for row creation and deletion Yes

4
Columns
Column Column Column
Data type and restrictions Remarks
name description type
address-pool- Name of address String
index Index of present table
name pool Length: 1 to 63 characters

Ipv6-address- Name of IPv6 String

index N/A
block-name address block Length: 1 to 63 characters

Ipv6-address- ID of IPv6 Unsigned Integer 32.

N/A N/A
block-id address block Value range: 0 to 4294967295.
IPv6 address
Ipv6-prefix N/A Ipv6Address N/A
prefix

Ipv6-prefix-le IPv6 address Unsigned Integer 32.

N/A N/A
ngth prefix length Value range: 1 to 128.

Address block Unsigned Integer 32. For table:

time N/A
allocation time Value range: 0 to 4294967295 ipv6-address-block

Example
配置一个 IPv4 地址池 pool4
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<edit-config>
<target>
<running/>
</target>
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<v:address-pools xc:operation="merge"
xmlns:v="urn:ietf:params:xml:ns:yang:ietf-address-pool">
<v:device-id>3</v:device-id>
<v:address-pool>
<v:address-pool-name>pool4</v:address-pool-name>
<v:address-pool-id>104</v:address-pool-id>
<v:domain-name>pppoe</v:domain-name>
<v:ipv4-usergateway>10.2.1.1</v:ipv4-usergateway>
<v:gwnetmask>24</v:gwnetmask>
<v:address-pool-entries>
<v:ipv4-address-block>
<v:ipv4-address-block-name>network-4</v:ipv4-address-block-name>
<v:ipv4-address-block-id>40</v:ipv4-address-block-id>
<v:ipv4-prefix>10.2.1.1</v:ipv4-prefix>
<v:ipv4-prefix-length>24</v:ipv4-prefix-length>
<v:time>3</v:time>
</v:ipv4-address-block>
</v:address-pool-entries>

5
 </v:address-pool>
</v:address-pools>
</config>
</edit-config>
</rpc>

配置一个 IPv6 地址池 pool1

<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<edit-config>
<target>
<running/>
</target>
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<v:address-pools xc:operation="merge"
xmlns:v="urn:ietf:params:xml:ns:yang:ietf-address-pool">
<v:device-id>3</v:device-id>
<v:address-pool>
<v:address-pool-name>pool1</v:address-pool-name>
<v:address-pool-id>101</v:address-pool-id>
<v:domain-name>pppoe</v:domain-name>
<v:ipv6-usergateway>10::3</v:ipv6-usergateway>
<v:gwnetmask>64</v:gwnetmask>
<v:primarydns>1::1</v:primarydns>
<v:secondarydns>1::2</v:secondarydns>
<v:address-pool-entries>
<v:ipv6-address-block>
<v:ipv6-address-block-name>network-0</v:ipv6-address-block-name>
<v:ipv6-address-block-id>10</v:ipv6-address-block-id>
<v:ipv6-prefix>10::1</v:ipv6-prefix>
<v:ipv6-prefix-length>64</v:ipv6-prefix-length>
<v:time>3</v:time>
</v:ipv6-address-block>
</v:address-pool-entries>
</v:address-pool>
</v:address-pools>
</config>
</edit-config>
</rpc>

获取地址池信息
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get>
<filter type="subtree">
<v:address-pools
xmlns:v="urn:ietf:params:xml:ns:yang:ietf-address-pool"></v:address-pools>
</filter>
</get>
</rpc>

6
7
Contents
DHCP ····························································································1
DHCP/DHCPRelayClearUserInfoByIfIndex ······················································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCP/DHCPServerClearIpInUseByPool ························································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
DHCP/DHCPServerClearIpInUse ·································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
DHCP/DHCPRelayClearUserInfo ·································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3

i
DHCP
DHCP/DHCPRelayClearUserInfoByIfIndex
This table is used to clear DHCP relay entries according to interface index.

XML structure
<DHCP>
<DHCPRelayClearUserInfoByIfIndex>
<RelayClearUserInfo>
<IfIndex></IfIndex>
</RelayClearUserInfo>
</DHCPRelayClearUserInfoByIfIndex>
</DHCP>

Table description
Item Description
Feature name DHCP
Table name DHCPRelayClearUserInfoByIfIndex
Table type Multi-instance table
Row name RelayClearUserInfo
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
If the length of the
IfIndex Interface Index Index Unsigned integer. column is set to 0, all
entries will be cleared.

DHCP/DHCPServerClearIpInUseByPool
This table is used to clear binding information about assigned IP addresses according to pool name.

XML structure
<DHCP>
<DHCPServerClearIpInUseByPool>
<ServerClearIpInUse>
<PoolName></PoolName>

1
 </ServerClearIpInUse>
</DHCPServerClearIpInUseByPool>
</DHCP>

Table description
Item Description
Feature name DHCP
Table name DHCPServerClearIpInUseByPool
Table type Multi-instance table
Row name ServerClearIpInUse
Restrictions None

Columns
Column
Column description Column type Data type and restrictions
name
DHCP address pool String, case insensitive.
PoolName Index
name Length: 1 to 63 characters.

DHCP/DHCPServerClearIpInUse
This table is used to clear binding information about assigned IP addresses.

XML structure
<DHCP>
<DHCPServerClearIpInUse>
<ServerClearIpInUse>
<PoolIndex></PoolIndex>
<Ipv4Address></Ipv4Address>
</ServerClearIpInUse>
</DHCPServerClearIpInUse>
</DHCP>

Table description
Item Description
Feature name DHCP
Table name DHCPServerClearIpInUse
Table type Multi-instance table
Row name ServerClearIpInUse
Restrictions None

2
Columns
Column Column Column Data type and
Remarks
name description type restrictions
DHCP address Unsigned integer.
PoolIndex Index N/A
pool index Value range: 1 to 4096.
String, dotted decimal
Ipv4Address IPv4 address Index N/A
notation.

DHCP/DHCPRelayClearUserInfo
This table is used to clear DHCP relay entries.

XML structure
<DHCP>
<DHCPRelayClearUserInfo>
<RelayClearUserInfo>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
</RelayClearUserInfo>
</DHCPRelayClearUserInfo>
</DHCP>

Table description
Item Description
Feature name DHCP
Table name DHCPRelayClearUserInfo
Table type Multi-instance table
Row name RelayClearUserInfo
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
VrfIndex Index of the VRF Index Unsigned integer. 0 means public network
String, dotted decimal
Ipv4Address IPv4 address Index N/A
notation.

3
Contents
DHCP ····························································································1
DHCP/DHCPServerIpPool ··········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 2
DHCP/DHCPServerPoolStatic ······································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
DHCP/DHCPConfig ···················································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ···························································································································· 9
DHCP/DHCPIfMode ················································································································· 11
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 12
DHCP/DHCPRelaySrvIPv4Address ····························································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 13
Columns ·························································································································· 14
DHCP/DHCPServerPoolOption ··································································································· 14
XML structure ··················································································································· 14
Table description ··············································································································· 15
Columns ·························································································································· 15
DHCP/DHCPRelaySourceAddress ······························································································ 16
XML structure ··················································································································· 16
Table description ··············································································································· 16
Columns ·························································································································· 16
DHCP/DHCPRelayInfoEnable ···································································································· 17
XML structure ··················································································································· 17
Table description ··············································································································· 18
Columns ·························································································································· 18
DHCP/DHCPServerForbiddenIp·································································································· 18
XML structure ··················································································································· 18
Table description ··············································································································· 19
Columns ·························································································································· 19
DHCP/DHCPRelayDiscReqFromTnlEnable ··················································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 20
DHCP/DHCPRelayMacFowardEnable ·························································································· 21
XML structure ··················································································································· 21
Table description ··············································································································· 21
Columns ·························································································································· 22
DHCP/DHCPRelayInfo ·············································································································· 22
XML structure ··················································································································· 22
Table description ··············································································································· 22
Columns ·························································································································· 23
DHCP/DHCPVsi ······················································································································ 23
XML structure ··················································································································· 23
Table description ··············································································································· 24
Columns ·························································································································· 24

i
DHCP
DHCP/DHCPServerIpPool
This table contains DHCP server IP pool information.

XML structure
<DHCP>
<DHCPServerIpPool>
<IpPool>
<PoolIndex></PoolIndex>
<PoolName></PoolName>
<NetworkIpv4Address></NetworkIpv4Address>
<NetworkIpv4Mask></NetworkIpv4Mask>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
<LeaseDay></LeaseDay>
<LeaseHour></LeaseHour>
<LeaseMinute></LeaseMinute>
<LeaseSecond></LeaseSecond>
<LeaseUnlimit></LeaseUnlimit>
<DomainName></DomainName>
<GatewayIpv4Address></GatewayIpv4Address>
<DNSIpv4Address></DNSIpv4Address>
<NetbiosType></NetbiosType>
<NbnsIpv4Address></NbnsIpv4Address>
<SubnetAlloc></SubnetAlloc>
<ForbiddenIp>
<StartForbiddenIpv4Address></StartForbiddenIpv4Address>
<EndForbiddenIpv4Address></EndForbiddenIpv4Address>
</ForbiddenIp>
</IpPool>
</DHCPServerIpPool>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerIpPool

1
 Table type Multi-instance table

Row name IpPool

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
For the merge, create
and replace operations,
0 means to
DHCP address Unsigned integer. automatically assign a
PoolIndex Index
pool index Value range: 0 to 4096. minimum unused index.

For the delete and

remove operations, 0
cannot be set.

String, case insensitive. Required when create a

DHCP address
PoolName N/A Length: 1 to 63 new row.
pool name
characters. Cannot be modified.

Modifying or removing
the network
NetworkIpv4Addr Primary subnet for String, dotted decimal configuration deletes the
N/A
ess dynamic allocation notation. assigned addresses
from the current address
pool.

Primary subnet If no mask is specified,

String, dotted decimal
NetworkIpv4Mask mask for dynamic N/A the natural mask will be
notation.
allocation used.

The address range

specified must be within
Start IP address of
the subnet. The
IP address range
String, dotted decimal addresses out of the
StartIpv4Address in a DHCP N/A
notation. address range cannot
address pool for
be assigned.
dynamic allocation
It must be configured
together with the

2
 Column Column Data type and
Column name Remarks
description type restrictions
EndIpv4Address
column.

End IP address of
It must be configured
IP address range
String, dotted decimal together with the
EndIpv4Address in a DHCP N/A
notation. StartIpv4Address
address pool for
column.
dynamic allocation

LeaseDay, LeaseHour,
LeaseMinute,
Unsigned integer. LeaseSecond must be
Days of lease
LeaseDay N/A Value range: 0 to 365. configured together.
duration
Default: 1. Can not be configured
together with
LeaseUnlimit.

Unsigned integer.
Hours of lease
LeaseHour N/A Value range: 0 to 23. N/A
duration
Default: 0.

Unsigned integer.
Minutes of lease
LeaseMinute N/A Value range: 0 to 59. N/A
duration
Default: 0.

Unsigned integer.
Seconds of lease
LeaseSecond N/A Value range: 0 to 59. N/A
duration
Default: 0.

Whether the Can not be configured

function of Boolean: together with LeaseDay,
LeaseUnlimit unlimited lease N/A • true LeaseHour,
duration is • false(default) LeaseMinute,
specified. LeaseSecond.

String, case sensitive.

DomainName Domain name N/A Length: 1 to 50 N/A
characters.

You can specify a

String, case insensitive.
GatewayIpv4Addr Gateway space-separated list of
N/A Length: 1 to 1024
ess addresses up to 64 addresses.
characters.
Example:

3
 Column Column Data type and
Column name Remarks
description type restrictions
1.1.1.1 2.2.2.2 3.3.3.3.

You can specify a

String, case insensitive. space-separated list of
DNS server up to eight addresses.
DNSIpv4Address N/A Length: 1 to 127
addresses
characters. Example:

1.1.1.1 2.2.2.2 3.3.3.3.

b-node: Specifies the

broadcast node. A
b-node client sends the
destination name in a
broadcast message to
get the name-to-IP
mapping from a server.

h-node: Specifies the

hybrid node. An h-node
client unicasts the
destination name to a
WINS server. If it does
not receive a response,
the h-node client
Enumeration: broadcasts the
• 1—b-node. destination name to get
NetBIOS node
NetbiosType N/A • 2—p-node. the mapping from a
type
• 3—m-node. server.

• 4—h-node. m-node: Specifies the

mixed node. An m-node
client broadcasts the
destination name. If it
does not receive a
response, the m-node
client unicasts the
destination name to the
WINS server to get the
mapping.

p-node: Specifies the

peer-to-peer node. A
p-node client sends the
destination name in a
unicast message to get

4
 Column Column Data type and
Column name Remarks
description type restrictions
the mapping from the
WINS server.

You can specify a

String, case insensitive. space-separated list of
WINS server up to eight addresses.
NbnsIpv4Address N/A Length: 1 to 127
addresses
characters. Example:

1.1.1.1 2.2.2.2 3.3.3.3.

Address pool type does

not support change
Enumeration: again.
The flag of • 0—normal pool Configuration
SubnetAlloc N/A
dynamic pool (default). StartIpv4Address and
• 1—dynamic pool. EndIpv4Address is not
supported when the
pool type is dynamic.

IPv4 adress Members include:

excluded from • StartForbiddenIpv You can specify an IPv4
Data
ForbiddenIp dynamic allocation 4Address address range excluded
structure
in the current IP • EndForbiddenIpv4 from dynamic allocation.
pool. Address

Start IP address of
an IP address
range that is
StartForbiddenIpv String, dotted decimal
excluded from N/A N/A
4Address notation.
dynamic allocation
in the current IP
pool

End IP address of
an IP address EndForbiddenIpv4Addre
range that is ss cannot be lower than
EndForbiddenIpv String, dotted decimal
excluded from N/A the
4Address notation.
dynamic allocation StartForbiddenIpv4Addr
in the current IP ess.
pool

5
DHCP/DHCPServerPoolStatic
This table contains static binding information of DHCP server IP pool.

XML structure
<DHCP>
<DHCPServerPoolStatic>
<IpPoolStatic>
<PoolIndex></PoolIndex>
<Ipv4Address></Ipv4Address>
<Ipv4Mask></Ipv4Mask>
<CID></CID>
<HAddress></HAddress>
<HType></HType>
<Description></Description>
</IpPoolStatic>
</DHCPServerPoolStatic>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerPoolStatic

Table type Multi-instance table

Row name IpPoolStatic

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions

DHCP address Unsigned integer. The specified PoolIndex

PoolIndex Index
pool index Value range: 0 to 4096. must already exist.

IP address of the String, dotted decimal

Ipv4Address Index N/A
static binding notation.

6
 Column Column Data type and
Column name Remarks
description type restrictions
IP address mask If no mask is specified,
String, dotted decimal
Ipv4Mask of the static N/A the natural mask will be
notation.
binding used.

The string can contain

only hexadecimal
numbers and hyphen
(-), in the format of
H-H-H…. The last H can
be a two-digit or
four-digit hexadecimal
number while the other
Hs must be all four-digit
hexadecimal numbers.
For example,
aabb-cccc-dd is correct,
String, case insensitive. and aabb-c-dddd and
Client ID of the aabb-cc-dddd are not
CID N/A Length: 4 to 254
static binding correct.
characters.
Can not be configured
together with HAddress,
HType column, but one
of the CID and
HAddress is required.

Can not modify

bindings. To change the
binding for a DHCP
client, you must delete
the existing binding first
and create a new
binding.

The string can contain

only hexadecimal
numbers and hyphen
Client hardware String, case insensitive. (-), in the format of
HAddress address of the N/A Length: 4 to 79 H-H-H…. The last H can
static binding characters. be a two-digit or
four-digit hexadecimal
number while the other
Hs must be all four-digit

7
 Column Column Data type and
Column name Remarks
description type restrictions
hexadecimal numbers.
For example,
aabb-cccc-dd is correct,
and aabb-c-dddd and
aabb-cc-dddd are not
correct.

Enumeration:
It must be configured
Client hardware • 1—Ethernet
HType N/A together with the
address type (default).
HAddress column.
• 2—TokenRing.

String, case insensitive.

Description of the
Description N/A Length: 1 to 255 N/A
static binding
characters.

DHCP/DHCPConfig
This table contains DHCP server and DHCP relay configuration information.

XML structure
<DHCP>
<DHCPConfig>
<DHCPEnable></DHCPEnable>
<ServerConfig>
<AlwaysBroadcast></AlwaysBroadcast>
<IgnoreBOOTP></IgnoreBOOTP>
<BOOTPReplyRFC1048></BOOTPReplyRFC1048>
<Opt82Enabled></Opt82Enabled>
<PingNumber></PingNumber>
<PingTimeout></PingTimeout>
</ServerConfig>
<RelayConfig>
<UserInfoRecord></UserInfoRecord>
<UserInfoRefresh></UserInfoRefresh>
<UserInfoFlushTime></UserInfoFlushTime>
</RelayConfig>
<FloodProtectionThreshold>
<NumberOfPackets></NumberOfPackets>
<DetectionTime></DetectionTime>
</FloodProtectionThreshold>

8
 <FloodProtectionAgeTime></FloodProtectionAgeTime>

<LogEnable></LogEnable>
</DHCPConfig>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPConfig

Table type Single-instance table

Row name None

Restrictions None

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions

Whether the Boolean:

DHCPEnable function of DHCP N/A • true N/A
is enabled. • false (default)

Members include:

• AlwaysBroadcast
Alert
• IgnoreBOOTP
The configuration Data
ServerConfig • BOOTPReplyRFC N/A
of DHCP server structure
1048
• Opt82Enabled
• PingNumber
• PingTimeout

Whether enable
Boolean:
the DHCP server
AlwaysBroadcast N/A • true N/A
to broadcast all
• false (default)
responses or not.

IgnoreBOOTP Whether ignore N/A Boolean: N/A

9
 Column Column Data type and
Column name Remarks
description type restrictions
BOOTP requests • true
or not. • false (default)

Whether enable
the DHCP server
to send BOOTP
responses in RFC
1048 format when Boolean:
BOOTPReplyRF
it receives RFC N/A • true N/A
C1048
1048-incompliant • false (default)
BOOTP requests
for statically
bound addresses
or not.

Whether enable
Boolean:
the DHCP server
Opt82Enabled N/A • true (default) N/A
to handle Option
• false
82 or not.

Unsigned integer. To disable the address

Maximum number
PingNumber N/A Value range: 0 to 10. conflict detection, set
of ping packets
Default: 1. the value to 0.

Unsigned integer. To disable the ping

Ping response Value range: 0 to 10000 operation for address
PingTimeout timeout time on N/A milliseconds. conflict detection, set
the DHCP server Default: 500 the value to 0

milliseconds. milliseconds.

Members include:

• UserInfoRecord
Configuration of Data
RelayConfig • UserInfoRefresh N/A
DHCP relay structure
• UserInfoFlushTim
e

Whether the
function of
Boolean:
recording client
UserInfoRecord N/A • true N/A
information in
• false(default)
relay entries is
enabled.

10
 Column Column Data type and
Column name Remarks
description type restrictions
Whether enable
the relay agent to
Boolean:
periodically
UserInfoRefresh N/A • true(default) N/A
refresh dynamic
• false
relay entries or
not.

Interval at which Unsigned integer. To automatically

the DHCP relay
UserInfoFlushTim Value range: 0 to 120 calculate the refresh
agent periodically N/A
e seconds. interval, set the value to
refreshes relay
Default: 0 seconds. 0 seconds.
entries

Threshold of Members include:

FloodProtectionThreshol Data
DHCP flood • NumberOfPackets N/A
d structure
protection • DetectionTime.

Number of
DHCP packets
allowed to be Unsigned integer.

NumberOfPackets received within N/A Value range: 2 to 200. N/A

detection time Default: 6.
and not judged
as an attack.

Unsigned integer.

Detection time in Value range: 1000 to

DetectionTime N/A N/A
milliseconds. 10000.

Default: 5000.

Aging time of Unsigned integer.

DHCP flood
FloodProtectionAgeTime N/A Value range: 30 to 600. N/A
protection
entries Default: 300.

Whether the
Boolean:
function of
LogEnable N/A • true N/A
DHCP logging is
• false(default)
enabled

DHCP/DHCPIfMode
This table contains DHCP interface mode information.

11
XML structure
<DHCP>
<DHCPIfMode>
<IfMode>
<IfIndex></IfIndex>
<Mode></Mode>
<ClientDetect></ClientDetect>
<FloodProtectionEnable></FloodProtectionEnable>

</IfMode>
</DHCPIfMode>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPIfMode

Table type Multi-instance table

Row name IfMode

Restrictions This table supports only Layer 3 interfaces.

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.

Mode DHCP mode N/A Enumeration: N/A

12
 Column Column Data type and
Column name Remarks
description type restrictions
• 0—None.
• 1—Server
(default).
• 2—Relay.
• 3—RelayProxy.

Whether to enable Boolean:

ClientDetect client offline N/A • true N/A
detection • false (default)

Whether enable Boolean:

FloodProtectionE
DHCP flood N/A • true N/A
nable
protection. • false (default).

DHCP/DHCPRelaySrvIPv4Address
This table contains DHCP servers on the DHCP relay agent information.

XML structure
<DHCP>
<DHCPRelaySrvIPv4Address>
<RelaySrvIPv4>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
</RelaySrvIPv4>
</DHCPRelaySrvIPv4Address>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelaySrvIPv4Address

Table type Multi-instance table

Row name RelaySrvIPv4

Restrictions This table supports only Layer 3 interfaces.

13
 Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.

DHCP servers IP
String, dotted decimal
Ipv4Address address on the Index N/A
notation.
DHCP relay agent

DHCP/DHCPServerPoolOption
This table contains DHCP server IP pool options information.

XML structure
<DHCP>
<DHCPServerPoolOption>
<IpPoolOption>
<PoolIndex></PoolIndex>
<OptionCode></OptionCode>
<OptionValueHex></OptionValueHex>
<OptionValueAscii></OptionValueAscii>
<OptionValueIpAddresses></OptionValueIpAddresses>
</IpPoolOption>
</DHCPServerPoolOption>
</DHCP>

14
Table description

Item Description
Feature name DHCP

Table name DHCPServerPoolOption

Table type Multi-instance table

Row name IpPoolOption

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions

DHCP address Unsigned integer. The specified PoolIndex

PoolIndex Index
pool index Value range: 0 to 4096. must already exist.

Excluding 50 through
Number of the Unsigned integer.
OptionCode Index 54, 56, 58, 59, 61, and
customized option Value range: 2 to 254.
82.

Only one of
OptionValueHex,
OptionValueAscii and
String, case insensitive.
Hex string as the OptionValueIpAddresse
OptionValueHex N/A Length: 2 to 256
option content s can be set.
characters.
Hex string of even
numbers from 2 to 256
as the option content.

String, case sensitive.

ASCII string as
OptionValueAscii N/A Length: 1 to 255 N/A
the option content
characters.

If there are multiple

String, case insensitive. addresses, separated
OptionValueIpAd IP addresses as them by space.
N/A Length: 1 to 127
dresses the option content
characters. Example:

1.1.1.1 2.2.2.2 3.3.3.3.

15
DHCP/DHCPRelaySourceAddress
This table contains information about source IP addresses of the packets sent by the DHCP relay
agent.

XML structure
<DHCP>
<DHCPRelaySourceAddress>
<RelaySrcAddr>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
<SourceIfIndex></SourceIfIndex>
</RelaySrcAddr>
</DHCPRelaySourceAddress>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelaySourceAddress

Table type Multi-instance table

Row name RelaySrcAddr

Restrictions This table supports only Layer 3 interfaces.

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
IfIndex Interface index Index Unsigned integer. see the XSD document
of your product. For
information about
IfIndex, see “Appendix”

16
 Column Column Data type and
Column name Remarks
description type restrictions
in Ifmgr NETCONF XML
API Configuration
Reference.

Source IP
addresses of the Ipv4Address and
String, dotted decimal
Ipv4Address packets sent by N/A SourceIfIndex can not
notation.
the DHCP relay be set at the same time.
agent

Ipv4Address and
SourceIfIndex cannot be
set at the same time.

Some versions support

Index of the interface name. For
interface from relevant information,
SourceIfIndex which the DHCP N/A Unsigned integer. see the XSD document
relay agent sends of your product. For
packets. information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.

DHCP/DHCPRelayInfoEnable
This table contains information about whether the DHCP relay agent support Option 82.

XML structure
<DHCP>
<DHCPRelayInfoEnable>
<RelayInfoEnable>
<IfIndex></IfIndex>
<InfoEnable></InfoEnable>
</RelayInfoEnable>
</DHCPRelayInfoEnable>
</DHCP>

17
Table description

Item Description
Feature name DHCP

Table name DHCPRelayInfoEnable

Table type Multi-instance table

Row name RelayInfoEnable

Restrictions This table supports only Layer 3 interfaces.

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
related information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.

Whether the Boolean:

InfoEnable DHCP relay agent N/A • true N/A
support Option 82. • false (default)

DHCP/DHCPServerForbiddenIp
This table contains information about IP addresses excluded from dynamic allocation globally.

XML structure
<DHCP>
<DHCPServerForbiddenIp>

18
 <ForbiddenIp>
<VRF></VRF>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
</ForbiddenIp>
</DHCPServerForbiddenIp>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerForbiddenIp

Table type Multi-instance table

Row name ForbiddenIp

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
String, case-sensitive. If the lease is on the
VRF instance
VRF Index Length: 1 to 31 public network, the
name
characters. length of characters is 0.

Start IP address of
an IP address
range that is String, dotted decimal
StartIpv4Address Index N/A
excluded from notation.
dynamic allocation
globally

End IP address of
an IP address
EndIpv4Address cannot
range that is String, dotted decimal
EndIpv4Address Index be lower than the
excluded from notation.
StartIpv4Address.
dynamic allocation
globally

19
DHCP/DHCPRelayDiscReqFromTnlEnable
This table contains information about whether the DHCP relay discard request from tunnel.

XML structure
<DHCP>
<DHCPRelayDiscReqFromTnlEnable>
<RelayDiscardReqFromTnlEnable>
<IfIndex></IfIndex>
<DiscardReqFromTnlEnable></DiscardReqFromTnlEnable>
</RelayDiscardReqFromTnlEnable>
</DHCPRelayDiscReqFromTnlEnable>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelayDiscReqFromTnlEnable

Table type Multi-instance table

Row name RelayDiscardReqFromTnlEnable

Restrictions This table supports only interface of VSI type

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
related information, see
the XSD document of
IfIndex Interface index. Index Unsigned integer. your product. For
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration

20
 Column Column Data type and
Column name Remarks
description type restrictions
Reference.

Whether the
DHCP relay agent Boolean:
DiscardReqFrom
support discard N/A • true N/A
TnlEnable
request packet • false (default)
from tunnel .

DHCP/DHCPRelayMacFowardEnable
This table contains information about whether the DHCP Relay support forward ACK or OFFER
packet by Mac Address

XML structure
<DHCP>
<DHCPRelayMacFowardEnable>
<RelayMacForwardEnable>
<MacEnable></MacEnable>
<MacBroadCast></MacBroadCast>
</RelayMacForwardEnable>
</DHCPRelayMacFowardEnable>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelayMacFowardEnable

Table type Multi-instance table

Row name RelayMacForwardEnable

Restrictions This table supports only Layer 3 interfaces.

Support for row creation and deletion No

21
Columns

Column Column Data type and

Column name Remarks
description type restrictions
If mac forward is enable,
Boolean:
Whether enable DHCP server OFFER or
MacEnable N/A • true
mac forward ACK packet will forward
• false (default)
via unicast.

Boolean: It must configured with

Whether enable
MacBroadCast • true MacEnable and Mac
mac broadcast
• false (default) Enable must be true.

DHCP/DHCPRelayInfo
This table contains information about the DHCP relay agent option (Option 82).

XML structure
<DHCP>
<DHCPRelayInfo>
<RelayInfo>
<IfIndex></IfIndex>
<CircuitIdMode></CircuitIdMode>
</RelayInfo>
</DHCPRelayInfo>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelayInfo

Table type Multi-instance table

Row name RelayInfo

Restrictions This table supports only Layer 3 interfaces.

Support for row creation and deletion No

22
Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
related information, see
the XSD document of
your product. For
IfIndex Interface index Index Unsigned integer.
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.

String, case-insensitive.

Mode of the Values include:

Circuit ID • NormalHex
CircuitIdMode N/A N/A
sub-option in (default)
Option 82 • NormalAscii
• VxlanPort

DHCP/DHCPVsi
This table contains the VSI configuration of DHCP.

XML structure
<DHCP>
<DHCPVsi>
<Vsi>
<VsiName></VsiName>
<FloodProtectionEnable></FloodProtectionEnable>
</Vsi>
</DHCPVsi>
</DHCP>

23
Table description

Item Description
Feature name DHCP

Table name DHCPVsi

Table type Multi-instance table

Row name Vsi

Restrictions None

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
String, case-sensitive.
VsiName VSI name Index N/A
Length: 1 to 31 characters.

Enabling status of Boolean:

FloodProtectionE
DHCP flood N/A • True N/A
nable
protection • False (default).

24
Contents
DHCP ····························································································1
DHCP/DHCPServerIpPool ··········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 2
DHCP/DHCPServerPoolStatic ······································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
DHCP/DHCPServerIpInUse ········································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 8
DHCP/DHCPConfig ·················································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
DHCP/DHCPIfMode ················································································································· 14
XML structure ··················································································································· 14
Table description ··············································································································· 14
Columns ·························································································································· 14
DHCP/DHCPRelaySrvIPv4Address ····························································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 15
Columns ·························································································································· 16
DHCP/DHCPRelayUserInfo ······································································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 16
Columns ·························································································································· 17
DHCP/DHCPServerPoolOption ··································································································· 17
XML structure ··················································································································· 17
Table description ··············································································································· 17
Columns ·························································································································· 18
DHCP/DHCPServerPoolStatistics ································································································ 18
XML structure ··················································································································· 18
Table description ··············································································································· 19
Columns ·························································································································· 19
DHCP/DHCPRelaySourceAddress ······························································································ 19
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 20
DHCP/DHCPRelayInfoEnable ···································································································· 21
XML structure ··················································································································· 21
Table description ··············································································································· 21
Columns ·························································································································· 22
DHCP/DHCPServerLeaseInfo ···································································································· 22
XML structure ··················································································································· 22
Table description ··············································································································· 23
Columns ·························································································································· 23
DHCP/DHCPServerForbiddenIp·································································································· 23
XML structure ··················································································································· 23
Table description ··············································································································· 24
Columns ·························································································································· 24
DHCP/DHCPServerSubnetInUse ································································································ 25
XML structure ··················································································································· 25
Table description ··············································································································· 25
Columns ·························································································································· 25

i
DHCP/DHCPRelayDiscReqFromTnlEnable ··················································································· 26
XML structure ··················································································································· 27
Table description ··············································································································· 27
Columns ·························································································································· 27
DHCP/DHCPRelayMacFowardEnable ·························································································· 28
XML structure ··················································································································· 28
Table description ··············································································································· 28
Columns ·························································································································· 28
DHCP/DHCPRelayInfo ·············································································································· 29
XML structure ··················································································································· 29
Table description ··············································································································· 29
Columns ·························································································································· 29
DHCP/DHCPVsi ······················································································································ 30
XML structure ··················································································································· 30
Table description ··············································································································· 30
Columns ·························································································································· 31

ii
DHCP
DHCP/DHCPServerIpPool
This table contains DHCP server IP pool information.

XML structure
<DHCP>
<DHCPServerIpPool>
<IpPool>
<PoolIndex></PoolIndex>
<PoolName></PoolName>
<NetworkIpv4Address></NetworkIpv4Address>
<NetworkIpv4Mask></NetworkIpv4Mask>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
<LeaseDay></LeaseDay>
<LeaseHour></LeaseHour>
<LeaseMinute></LeaseMinute>
<LeaseSecond></LeaseSecond>
<LeaseUnlimit></LeaseUnlimit>
<DomainName></DomainName>
<GatewayIpv4Address></GatewayIpv4Address>
<DNSIpv4Address></DNSIpv4Address>
<NetbiosType></NetbiosType>
<NbnsIpv4Address></NbnsIpv4Address>
<ForbiddenIp>
<StartForbiddenIpv4Address></StartForbiddenIpv4Address>
<EndForbiddenIpv4Address></EndForbiddenIpv4Address>
</ForbiddenIp>
</IpPool>
</DHCPServerIpPool>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerIpPool

Table type Multi-instance table

1
 Row name IpPool

Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions

DHCP address Unsigned integer.

PoolIndex Index N/A
pool index Value range: 0 to 4096.

String, case insensitive.

DHCP address
PoolName N/A Length: 1 to 63 N/A
pool name
characters.

NetworkIpv4Addr Primary subnet for String, dotted decimal

N/A N/A
ess dynamic allocation notation.

Primary subnet If no mask is specified,

String, dotted decimal
NetworkIpv4Mask mask for dynamic N/A the natural mask will be
notation.
allocation used.

Start IP address of
IP address range
String, dotted decimal
StartIpv4Address in a DHCP N/A N/A
notation.
address pool for
dynamic allocation

End IP address of
IP address range
String, dotted decimal
EndIpv4Address in a DHCP N/A N/A
notation.
address pool for
dynamic allocation

Days of lease Unsigned integer.

LeaseDay N/A N/A
duration Value range: 0 to 365.

Hours of lease Unsigned integer.

LeaseHour N/A N/A
duration Value range: 0 to 23.

Minutes of lease Unsigned integer.

LeaseMinute N/A N/A
duration Value range: 0 to 59.

Seconds of lease Unsigned integer.

LeaseSecond N/A N/A
duration Value range: 0 to 59.

2
 Column Column Data type and
Column name Remarks
description type restrictions
Whether the
function of Boolean:
LeaseUnlimit unlimited lease N/A • true N/A
duration is • false
specified.

String, case sensitive.

DomainName Domain name N/A Length: 1 to 50 N/A
characters.

You can specify a

String, case insensitive. space-separated list of
GatewayIpv4Addr Gateway up to 64 addresses.
N/A Length: 1 to 1024
ess addresses
characters. Example:

1.1.1.1 2.2.2.2 3.3.3.3.

You can specify a

String, case insensitive. space-separated list of
DNS server up to eight addresses.
DNSIpv4Address N/A Length: 1 to 127
addresses
characters. Example:

1.1.1.1 2.2.2.2 3.3.3.3.

b-node: Specifies the

broadcast node. A
b-node client sends the
destination name in a
broadcast message to
get the name-to-IP
mapping from a server.
Enumeration:
h-node: Specifies the
• 1—b-node. hybrid node. An h-node
NetBIOS node
NetbiosType N/A • 2—p-node. client unicasts the
type
• 3—m-node. destination name to a

• 4—h-node. WINS server. If it does

not receive a response,
the h-node client
broadcasts the
destination name to get
the mapping from a
server.

m-node: Specifies the

3
 Column Column Data type and
Column name Remarks
description type restrictions
mixed node. An m-node
client broadcasts the
destination name. If it
does not receive a
response, the m-node
client unicasts the
destination name to the
WINS server to get the
mapping.

p-node: Specifies the

peer-to-peer node. A
p-node client sends the
destination name in a
unicast message to get
the mapping from the
WINS server.

You can specify a

String, case insensitive. space-separated list of
WINS server up to eight addresses.
NbnsIpv4Address N/A Length: 1 to 127
addresses
characters. Example:

1.1.1.1 2.2.2.2 3.3.3.3.

IPv4 adress Members include:

excluded from • StartForbiddenIpv You can specify an IPv4
Data
ForbiddenIp dynamic allocation 4Address address range excluded
structure
in the current IP • EndForbiddenIpv4 from dynamic allocation.
pool. Address

Start IP address of
an IP address
range that is
StartForbiddenIpv String, dotted decimal
excluded from N/A N/A
4Address notation.
dynamic allocation
in the current IP
pool

End IP address of EndForbiddenIpv4Addre

an IP address ss cannot be lower than
EndForbiddenIpv String, dotted decimal
range that is N/A the
4Address notation.
excluded from StartForbiddenIpv4Addr
dynamic allocation ess.

4
 Column Column Data type and
Column name Remarks
description type restrictions
in the current IP
pool

DHCP/DHCPServerPoolStatic
This table contains static binding information of DHCP server IP pool.

XML structure
<DHCP>
<DHCPServerPoolStatic>
<IpPoolStatic>
<PoolIndex></PoolIndex>
<Ipv4Address></Ipv4Address>
<Ipv4Mask></Ipv4Mask>
<CID></CID>
<HAddress></HAddress>
<HType></HType>
<Description></Description>
</IpPoolStatic>
</DHCPServerPoolStatic>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerPoolStatic

Table type Multi-instance table

Row name IpPoolStatic

Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions
PoolIndex DHCP address Index Unsigned integer. The specified PoolIndex

5
 Column Column Data type and
Column name Remarks
description type restrictions
pool index Value range: 0 to 4096. must already exist.

IP address of the String, dotted decimal

Ipv4Address Index N/A
static binding notation.

IP address mask If no mask is specified,

String, dotted decimal
Ipv4Mask of the static N/A the natural mask will be
notation.
binding used.

The string can contain

only hexadecimal
numbers and hyphen
(-), in the format of
H-H-H…. The last H can
be a two-digit or
String, case insensitive. four-digit hexadecimal
Client ID of the
CID N/A Length: 4 to 254 number while the other
static binding
characters. Hs must be all four-digit
hexadecimal numbers.
For example,
aabb-cccc-dd is correct,
and aabb-c-dddd and
aabb-cc-dddd are not
correct.

The string can contain

only hexadecimal
numbers and hyphen
(-), in the format of
H-H-H…. The last H can
be a two-digit or
Client hardware String, case insensitive. four-digit hexadecimal
HAddress address of the N/A Length: 4 to 79 number while the other
static binding characters. Hs must be all four-digit
hexadecimal numbers.
For example,
aabb-cccc-dd is correct,
and aabb-c-dddd and
aabb-cc-dddd are not
correct.

Client hardware Enumeration:

HType N/A N/A
address type • 1—Ethernet.

6
 Column Column Data type and
Column name Remarks
description type restrictions
• 2—TokenRing.

String, case insensitive.

Description of the
Description N/A Length: 1 to 255 N/A
static binding
characters.

DHCP/DHCPServerIpInUse
This table contains binding information about assigned IP addresses.

XML structure
<DHCP>
<DHCPServerIpInUse>
<IpInUse>
<PoolIndex></PoolIndex>
<Ipv4Address></Ipv4Address>
<CID></CID>
<HAddress></HAddress>
<HType></HType>
<VLANID></VLANID>
<EndLease></EndLease>
<Type></Type>
<IfIndex></IfIndex>
</IpInUse>
</DHCPServerIpInUse>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerIpInUse

Table type Multi-instance table

Row name IpInUse

Restrictions None

7
Columns

Column Column Data type and

Column name Remarks
description type restrictions

DHCP address Unsigned integer.

PoolIndex Index N/A
pool index Value range: 0 to 4096.

IP address
String, dotted decimal
Ipv4Address allocated to N/A N/A
notation.
client

The string can contain

only hexadecimal
numbers and hyphen
(-), in the format of
H-H-H…. The last H
can be a two-digit or
four-digit hexadecimal
number while the
Client ID of the String, case-insensitive.
CID N/A other Hs must be all
static binding Length: 4 to 254 characters.
four-digit hexadecimal
numbers. For
example,
aabb-cccc-dd is
correct, and
aabb-c-dddd and
aabb-cc-dddd are not
correct.

The string can contain

only hexadecimal
numbers and hyphen
(-), in the format of
H-H-H…. The last H
can be a two-digit or
Client hardware
String, case-insensitive. four-digit hexadecimal
HAddress address of the N/A
Length: 4 to 79 characters. number while the
static binding
other Hs must be all
four-digit hexadecimal
numbers. For
example,
aabb-cccc-dd is
correct, and

8
 Column Column Data type and
Column name Remarks
description type restrictions
aabb-c-dddd and
aabb-cc-dddd are not
correct.

ethernet:the client
hardware address
Client hardware Enumeration:
type is Ethernet.
HType address of the N/A • 1—ethernet.
tokenRing: the client
static binding • 2—tokenRing.
hardware address
type as token ring.

Unsigned integer.
VLANID VLAN ID N/A N/A
Value range: 1 to 4094.

Format:

String, case-insensitive. month/day/year

EndLease N/A hour:minute:second
Length: 1 to 19 characters.
(MM/DD/YYYY
hh:mm:ss)

staticUnallocated: A
free static binding
whose IP address has
not been assigned.

staticOffered: An
offered static binding
whose IP address has
been selected and
Enumeration:
sent by the DHCP
1—staticUnallocated.
server in a
2—staticOffered. DHCP-OFFER packet
Type N/A
3—staticCommitted. to the client.

4—autoOffered. staticCommitted: A
committed static
5—autoCommitted.
binding whose IP
address has been
assigned to the DHCP
client.

autoOffered: An
offered temporary
dynamic binding
whose IP address has

9
 Column Column Data type and
Column name Remarks
description type restrictions
been dynamically
selected by the DHCP
server and sent in a
DHCP-OFFER packet
to the DHCP client.

autoCommitted: A
committed dynamic
binding whose IP
address has been
dynamically assigned
to the DHCP client.

IfIndex Interface index Unsigned integer. N/A

DHCP/DHCPConfig
This table contains DHCP server and DHCP relay configuration information.

XML structure
<DHCP>
<DHCPConfig>
<DHCPEnable></DHCPEnable>
<ServerConfig>
<AlwaysBroadcast></AlwaysBroadcast>
<IgnoreBOOTP></IgnoreBOOTP>
<BOOTPReplyRFC1048></BOOTPReplyRFC1048>
<Opt82Enabled></Opt82Enabled>
<PingNumber></PingNumber>
<PingTimeout></PingTimeout>
</ServerConfig>
<RelayConfig>
<UserInfoRecord></UserInfoRecord>
<UserInfoRefresh></UserInfoRefresh>
<UserInfoFlushTime></UserInfoFlushTime>
</RelayConfig>
<FloodProtectionThreshold>
<NumberOfPackets></NumberOfPackets>
<DetectionTime></DetectionTime>
</FloodProtectionThreshold>
<FloodProtectionAgeTime></FloodProtectionAgeTime>

<LogEnable></LogEnable>

10
 </DHCPConfig>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPConfig

Table type Single-instance table

Row name None

Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Whether the
Boolean:
function of
DHCPEnable N/A • true N/A
DHCP is
• false
enabled.

Members include:

• AlwaysBroadcast Alert
• IgnoreBOOTP
The
Data • BOOTPReplyRFC104
ServerConfig configuration of N/A
structure 8
DHCP server
• Opt82Enabled
• PingNumber
• PingTimeout

Whether
Enable the
Boolean:
DHCP server
AlwaysBroadcast N/A • true N/A
to broadcast all
• false
responses or
not.

Whether Ignore Boolean:

IgnoreBOOTP BOOTP N/A • true N/A
requests or • false

11
 Column Column Data type and
Column name Remarks
description type restrictions
not.

Whether
enable the
DHCP server
to send
BOOTP
responses in
RFC 1048 Boolean:
BOOTPReplyRFC1048 format when it N/A • true N/A
receives RFC • false
1048-incomplia
nt BOOTP
requests for
statically bound
addresses or
not.

Whether
enable the
Boolean:
DHCP server
Opt82Enabled N/A • true N/A
to handle
• false
Option 82 or
not.

To disable the
Maximum
Unsigned integer. address conflict
PingNumber number of ping N/A
Value range: 0 to 10. detection, set the
packets
value to 0.

To disable the
ping operation
Ping response
Unsigned integer. for address
timeout time on
PingTimeout N/A Value range: 0 to 10000 conflict
the DHCP
milliseconds. detection, set the
server
value to 0
milliseconds.

Members include:
The
Data • UserInfoRecord
RelayConfig configuration of N/A
structure • UserInfoRefresh
DHCP relay
• UserInfoFlushTime

UserInfoRecord Whether the N/A Boolean: N/A

12
 Column Column Data type and
Column name Remarks
description type restrictions
function of • true
recording client • false
information in
relay entries is
enabled.

Whether
enable the
relay agent to Boolean:
UserInfoRefresh periodically N/A • true N/A
refresh • false
dynamic relay
entries or not.

Interval at
which the To automatically
DHCP relay Unsigned integer. calculate the
UserInfoFlushTime agent N/A Value range: 0 to 120 refresh interval,
periodically seconds. set the value to 0
refreshes relay seconds.
entries

Threshold of Members include:

FloodProtectionThreshol Data
DHCP flood • NumberOfPackets N/A
d structure
protection. • DetectionTime.

Number of
DHCP packets
allowed to be
Unsigned integer.
NumberOfPackets received within N/A N/A
Value range: 2 to 200.
detection time
and not judged
as an attack.

Unsigned integer.
Detection time
DetectionTime N/A Value range: 1000 to N/A
in milliseconds.
10000.

Aging of DHCP
Unsigned integer.
FloodProtectionAgeTime flood protection N/A N/A
Value range: 30 to 600.
entries.

Whether the Boolean:

LogEnable N/A N/A
function of • true

13
 Column Column Data type and
Column name Remarks
description type restrictions
DHCP logging • false(default)
is enabled

DHCP/DHCPIfMode
This table contains DHCP interface mode information.

XML structure
<DHCP>
<DHCPIfMode>
<IfMode>
<IfIndex></IfIndex>
<Mode></Mode>
<ClientDetect></ClientDetect>
<FloodProtectionEnable></FloodProtectionEnable>
</IfMode>
</DHCPIfMode>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPIfMode

Table type Multi-instance table

Row name IfMode

Restrictions This table supports only Layer 3 interfaces.

Columns

Column Column Data type and

Column name Remarks
description type restrictions
IfIndex Interface index. Index Unsigned integer. N/A

Enumeration:
Mode DHCP mode N/A N/A
• 0—None.

14
 Column Column Data type and
Column name Remarks
description type restrictions
• 1—Server.
• 2—Relay.
• 3—RelayProxy.

Whether to enable Boolean:

ClientDetect client offline N/A • true N/A
detection • false

Enalbing status of Boolean:

FloodProtectionE
DHCP flood N/A • true N/A
nable
protection • false

DHCP/DHCPRelaySrvIPv4Address
This table contains DHCP servers on the DHCP relay agent information.

XML structure
<DHCP>
<DHCPRelaySrvIPv4Address>
<RelaySrvIPv4>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
</RelaySrvIPv4>
</DHCPRelaySrvIPv4Address>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelaySrvIPv4Address

Table type Multi-instance table

Row name RelaySrvIPv4

Restrictions This table supports only Layer 3 interfaces.

15
Columns

Column Column Data type and

Column name Remarks
description type restrictions
IfIndex Interface index. Index Unsigned integer. N/A

DHCP servers IP
String, dotted decimal
Ipv4Address address on the Index N/A
notation.
DHCP relay agent

DHCP/DHCPRelayUserInfo
This table contains DHCP relay entries information.

XML structure
<DHCP>
<DHCPRelayUserInfo>
<RelayUserInfo>
<VrfIndex></VrfIndex>
<Ipv4Address></Ipv4Address>
<MacAddress></MacAddress>
<IfIndex></IfIndex>
</RelayUserInfo>
</DHCPRelayUserInfo>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelayUserInfo

Table type Multi-instance table

Row name RelayUserInfo

Restrictions None

16
Columns

Column Column Data type and

Column name Remarks
description type restrictions
VrfIndex Index of the VRF Index Unsigned integer. 0 means public network.

DHCP servers IP
String, dotted decimal
Ipv4Address address on the Index N/A
notation.
DHCP relay agent

Six groups of two

MacAddress MAC address N/A hexadecimal digits, N/A
hyphen-separated.

0 means no interface
IfIndex Interface Index N/A Unsigned integer.
information.

DHCP/DHCPServerPoolOption
This table contains DHCP server IP pool options information.

XML structure
<DHCP>
<DHCPServerPoolOption>
<IpPoolOption>
<PoolIndex></PoolIndex>
<OptionCode></OptionCode>
<OptionValueHex></OptionValueHex>
<OptionValueAscii></OptionValueAscii>
<OptionValueIpAddresses></OptionValueIpAddresses>
</IpPoolOption>
</DHCPServerPoolOption>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerPoolOption

Table type Multi-instance table

17
 Row name IpPoolOption

Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions

DHCP address Unsigned integer. The specified PoolIndex

PoolIndex Index
pool index Value range: 0 to 4096. must already exist.

Excluding 50 through
Number of the Unsigned integer.
OptionCode Index 54, 56, 58, 59, 61, and
customized option Value range: 2 to 254.
82.

String, case insensitive. Hex string of even

Hex string as the
OptionValueHex N/A Length: 2 to 256 numbers from 2 to 256
option content
characters. as the option content.

String, case sensitive.

ASCII string as
OptionValueAscii N/A Length: 1 to 255 N/A
the option content
characters.

Separated by space if
String, case insensitive. there are multiple
OptionValueIpAd IP addresses as addresses.
N/A Length: 1 to 127
dresses the option content
characters. Example:

1.1.1.1 2.2.2.2 3.3.3.3.

DHCP/DHCPServerPoolStatistics
This table contains DHCP server pool statistics information.

XML structure
<DHCP>
<DHCPServerPoolStatistics>
<IpPoolStatistics>
<PoolName></PoolName>
<UsedIpNumber></UsedIpNumber>
<ExpiredIpNumber></ExpiredIpNumber>
<TotalIpNumber></TotalIpNumber>

18
 </IpPoolStatistics>
</DHCPServerPoolStatistics>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerPoolStatistics

Table type Multi-instance table

Row name IpPoolStatistics

Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions
PoolName DHCP pool name Index String. N/A

Number of used
UsedIpNumber IP addresses in N/A Unsigned integer. N/A
the address pool

Number of expired
IP address leases
ExpiredIpNumber N/A Unsigned integer. N/A
in the address
pool

Total number of IP
TotalIpNumber addresses in the N/A Unsigned integer. N/A
address pool

DHCP/DHCPRelaySourceAddress
This table contains information about source IP addresses of the packets sent by the DHCP relay
agent.

19
XML structure
<DHCP>
<DHCPRelaySourceAddress>
<RelaySrcAddr>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
<SourceIfIndex></SourceIfIndex>
</RelaySrcAddr>
</DHCPRelaySourceAddress>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelaySourceAddress

Table type Multi-instance table

Row name RelaySrcAddr

Restrictions This table supports only Layer 3 interfaces.

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
IfIndex Interface index Index Unsigned integer.
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.

Source IP
Ipv4Address and
addresses of the String, dotted decimal
Ipv4Address N/A SourceIfIndex cannot be
packets sent by notation.
set at the same time.
the DHCP relay

20
 Column Column Data type and
Column name Remarks
description type restrictions
agent

Ipv4Address and
SourceIfIndex cannot be
set at the same time.

Some versions support

Index of the interface name. For
interface from relevant information,
SourceIfIndex which the DHCP N/A Unsigned integer. see the XSD document
relay agent sends of your product. For
packets. information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.

DHCP/DHCPRelayInfoEnable
This table contains information about whether the DHCP relay agent support Option 82.

XML structure
<DHCP>
<DHCPRelayInfoEnable>
<RelayInfoEnable>
<IfIndex></IfIndex>
<InfoEnable></InfoEnable>
</RelayInfoEnable>
</DHCPRelayInfoEnable>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelayInfoEnable

Table type Multi-instance table

Row name RelayInfoEnable

21
 Restrictions This table supports only Layer 3 interfaces.

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
related information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.

Whether the Boolean:

InfoEnable DHCP relay agent N/A • true N/A
support Option 82. • false

DHCP/DHCPServerLeaseInfo
This table contains DHCP server lease information.

XML structure
<DHCP>
<DHCPServerLeaseInfo>
<LeaseInfo>
<VRF></VRF>
<Ipv4Address></Ipv4Address>
<MacAddress></MacAddress>
<HostName></HostName>
<Option55></Option55>
</LeaseInfo>
</DHCPServerLeaseInfo>
</DHCP>

22
Table description

Item Description
Feature name DHCP

Table name DHCPServerLeaseInfo

Table type Multi-instance table

Row name LeaseInfo

Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions
String, case-sensitive. If the lease is on the
VRF instance
VRF Index Length: 1 to 31 public network, the
name
characters. length of characters is 0.

IP address String, dotted decimal

Ipv4Address Index N/A
allocated to client notation.

Six groups of two

MacAddress MAC address N/A hexadecimal digits, N/A
hyphen-separated.

String, case insensitive. The length of characters

Host name of the
HostName N/A Length: 1 to 253 is 0 when a specific
client
characters. client is used.

String, case insensitive. The length of characters

Parameter
Option55 N/A Length: 2 to 510 is 0 when a specific
request list
characters. client is used.

DHCP/DHCPServerForbiddenIp
This table contains information about IP addresses excluded from dynamic allocation globally.

XML structure
<DHCP>

23
 <DHCPServerForbiddenIp>
<ForbiddenIp>
<VRF></VRF>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
</ForbiddenIp>
</DHCPServerForbiddenIp>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerForbiddenIp

Table type Multi-instance table

Row name ForbiddenIp

Restrictions None

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
String, case-sensitive. If the lease is on the
VRF instance
VRF Index Length: 1 to 31 public network, the
name
characters. length of characters is 0.

Start IP address of
an IP address
range that is String, dotted decimal
StartIpv4Address Index N/A
excluded from notation.
dynamic allocation
globally

End IP address of
an IP address
EndIpv4Address cannot
range that is String, dotted decimal
EndIpv4Address Index be lower than the
excluded from notation.
StartIpv4Address.
dynamic allocation
globally

24
DHCP/DHCPServerSubnetInUse
This table contains information about subnet allocation IP addresses.

XML structure
<DHCP>
<DHCPServerSubnetInUse>
<SubnetInUse>
<VRF></VRF>
<NetworkAddress></NetworkAddress>
<NetworkMask></NetworkMask>
<SubAllocMode></SubAllocMode>
<VXLANID></VXLANID>
<DPAddress></DPAddress>
<UsedIpNumber></UsedIpNumber>
<ExpiredIpNumber></ExpiredIpNumber>
<TotalIpNumber></TotalIpNumber>
<PoolName></PoolName>
</SubnetInUse>
</DHCPServerSubnetInUse>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerSubnetInUse

Table type Multi-instance table

Row name SubnetInUse

Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions
If the lease is on the
VRF instance String, case-sensitive. public network, the
VRF Index
name Length: 0 to 31 characters. length of characters is
0.

25
 Column Column Data type and
Column name Remarks
description type restrictions
String, dotted decimal
Network Address Subnet Address Index N/A
notation.

Unsigned integer.
NetworkMask Subnet Mask Index N/A
Value range: 1 to 30.

If the subnet alloc by

the vxlanId mode, the
DP address cannot be
Enumeration:
Subnet Alloc displayed.
SubAllocMode N/A • 0—vxlanId.
Mode If the subnet alloc by
• 1—dp-address.
the dp-address
mode, the vxlanId
cannot be displayed.

Unsigned integer.
VXLAN ID VXLAN ID N/A N/A
Value range: 1 to 16777215.

String, dotted decimal

DPAddress DP Address N/A N/A
notation.

Number of used
UsedIpNumber IP addresses in N/A Unsigned integer. N/A
subnet.

Number of
expired IP
ExpiredIpNumber N/A Unsigned integer. N/A
addresses in
subnet.

Total Number of
allocated IP
TotalIpNumber N/A Unsigned integer. N/A
addresses in
subnet

Subnet-alloc
PoolName N/A String. N/A
Pool Name

DHCP/DHCPRelayDiscReqFromTnlEnable
This table contains information about whether the DHCP relay discard request from tunnel.

26
XML structure
<DHCP>
<DHCPRelayDiscReqFromTnlEnable>
<RelayDiscardReqFromTnlEnable>
<IfIndex></IfIndex>
<DiscardReqFromTnlEnable></DiscardReqFromTnlEnable>
</RelayDiscardReqFromTnlEnable>
</DHCPRelayDiscReqFromTnlEnable>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelayDiscReqFromTnlEnable

Table type Multi-instance table

Row name RelayDiscardReqFromTnlEnable

Restrictions This table supports only interface of VSI type

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
related information, see
the XSD document of
your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.

Whether the
Boolean:
DiscardReqFrom DHCP relay agent
N/A • true N/A
TnlEnable support discard
• false
request packet

27
 Column Column Data type and
Column name Remarks
description type restrictions
from tunnel .

DHCP/DHCPRelayMacFowardEnable
This table contains information about whether the DHCP Relay support forward ACK or OFFER
packet by Mac Address.

XML structure
<DHCP>
<DHCPRelayMacFowardEnable>
<RelayMacForwardEnable>
<MacEnable></MacEnable>
<MacBroadCast></MacBroadCast>
</RelayMacForwardEnable>
</DHCPRelayMacFowardEnable>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelayMacFowardEnable

Table type Multi-instance table

Row name RelayMacForwardEnable

Restrictions This table supports only Layer 3 interfaces.

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Boolean: If mac forward is enable,
Whether enable
MacEnable N/A • true DHCP server OFFER or
mac forward
• false ACK packet will forward

28
 Column Column Data type and
Column name Remarks
description type restrictions
via unicast.

Boolean: It must configured with

Whether enable
MacBroadCast • true MacEnable and Mac
mac broadcast
• false Enable must be true.

DHCP/DHCPRelayInfo
This table contains information about the DHCP relay agent option (Option 82).

XML structure
<DHCP>
<DHCPRelayInfo>
<RelayInfo>
<IfIndex></IfIndex>
<CircuitIdMode></CircuitIdMode>
</RelayInfo>
</DHCPRelayInfo>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPRelayInfo

Table type Multi-instance table

Row name RelayInfo

Restrictions This table supports only Layer 3 interfaces.

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
IfIndex Interface index Index Unsigned integer.
interface name. For

29
 Column Column Data type and
Column name Remarks
description type restrictions
related information, see
the XSD document of
your product. For
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.

String, case-insensitive.
Mode of the
Values include:
Circuit ID
CircuitIdMode N/A • NormalHex N/A
sub-option in
Option 82 • NormalAscii
• VxlanPort

DHCP/DHCPVsi
This table contains the VSI configuration informain of DHCP.

XML structure
<DHCP>
<DHCPVsi>
<Vsi>
<VsiName></VsiName>
<FloodProtectionEnable></FloodProtectionEnable>
</Vsi>
</DHCPVsi>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPVsi

Table type Multi-instance table

Row name RelayInfo

30
 Item Description
Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions
String, case-sensitive.
VsiName VSI name Index Length: 1 to 31 N/A
characters.

Enabling status of Boolean:

FloodProtectionE
DHCP flood N/A • True N/A
nable
protection • false.

31
Contents
DHCP ····························································································1
DHCP/dhcp ······························································································································ 1

i
DHCP
DHCP/dhcp
Message Explanation
Maximum number of DHCP address pools already
reached. Maximum number of DHCP address pools already reached, when
created more than 8192 pools before.
DHCP地址池个数超过上限。

Invalid network address.

Invalid network address. Please examine your network address.
无效的网段地址。

Mask length must be in the range of 1 to 30.

The mask length is Invalid.
掩码长度范围必须为1到30。

Invalid start IP address.

Invalid start IP address, please check your IP address.
无效的起始IP地址。

Invalid end IP address.

Invalid end IP address, please check your IP address.
无效的结束IP地址。

The start IP address can’t be greater than the end

IP address. Please make certain that the start IP address is not be greater
than the end IP address.
起始IP地址必须小于或等于结束IP地址。

Lease duration can’t be zero.

Invalid Lease duration. Please check your Lease duration.
IP地址租约有效期限不能为零。

Failed to set the response timeout time for ping

requests. The setting about the response timeout time for ping requests is
为IP地址冲突检测指定等待回显响应超时时间失 failed.
效。

Failed to enable DHCP.

DHCP process is not activated.
开启DHCP功能失败。

Invalid IP address.
Invalid IP address. Please check your IP address.
无效的IP地址。

Invalid mask.
Invalid mask. Please check your IP address.
无效的掩码。

Maximum number of statically bound IP address Maximum number of statically bound IP address already reached,
already reached. when the number of statically bound IP address is greater than
静态绑定地址个数超过上限。 8192.

The IP address is bound to another DHCP client. The IP address is bound to another DHCP client, please try
该IP地址已经被绑定在一台DHCP客户端上。 another IP address.

Failed to set the mode.

The setting about the mode is failed.
指定处理模式失败。

Failed to set the address pool name.

The setting about the address pool name is failed.
指定地址池名称失败。

Another address pool is using the name. The name of address pool is already used.

1
地址池名称已经存在。

The configuration doesn’t meet the requirements. The configuration doesn’t meet the requirements, please check
不符合配置要求。 your configuration.

Maximum number of server IP address already

reached. Maximum number of server IP address already reached, when
the number of server IP address is greater than 8.
中继服务器IP地址个数超过上限。

The option is not configurable.

The option is not configurable, please check your option.
该DHCP选项的配置是被禁止的。

Invalid client ID.

Invalid client ID, please check your client ID.
无效的客户端ID。

The address pool doesn’t exist.

The address pool doesn’t exist, when getting or deleting it
该DHCP地址池不存在。

The subnet has already been configured. The subnet has already been configured, please try another
该网段的IP地址已经在其他网段配置。 subnet.

Invalid client hardware address. Invalid client hardware address. Please check your client
无效的客户端硬件地址。 hardware address.

The statically bound IP address should be a unicast

address. Please make certain that the statically bound IP address is a
unicast address.
该静态绑定IP地址需要是一个单播地址。

Not used.
The lease is not used.
未使用。

Failed to configure the Option 82.

Configuirng Option 82 fails.
配置Option82功能失败。

Ipv4Address and SourceIfIndex cannot be set at

Ipv4Address and SourceIfIndex are set at the same time.
the same time.
用户指定DHCP中继向DHCP服务器转发报文的源地址时，同时下
指定DHCP中继向DHCP服务器转发报文的源地址
发了源地址和源接口信息
和源接口不能在一次操作中同时配置

Failed to enable the DHCP flood protection. The DHCP flood protection is not supported.
开启DHCP Flood攻击防范功能失败 设备不支持DHCP Flood攻击防范功能

The configuration of the DHCP flood protection fails.

Failed to configure the DHCP flood protection.
DHCP Flood攻击防范功能相关配置失败(比如Flood 表项老化时
DHCP Flood攻击防范功能相关配置下发失败
间、阈值设置等)

Failed to enable DHCP logging.

DHCP logging is not enabled.
开启DHCP日志功能失败。

2
Contents
DHCP event stream ··········································································1
DHCP instance status event ········································································································· 1
XML structure for event subscription ························································································ 1
XML structure for event report ································································································ 1
DHCP event stream
DHCP event stream description.

DHCP instance status event

This event is used to report status of the DHCP instance.

XML structure for event subscription

<InstanceStatus>
</InstanceStatus>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>DHCP</stream>
<filter type="subtree">
<InstanceStatus xmlns="http://www.h3c.com/netconf/event:1.0/dhcp:1.0">
</InstanceStatus>
</filter>
</create-subscription>
</rpc>

Table description

Item Description

Event stream name DHCP

Event name InstanceStatus
Event
http://www.h3c.com/netconf/event:1.0/dhcp:1.0
namespace
Support for
No
extended query

XML structure for event report

<InstanceStatus>
<ProtocolType></ProtocolType>
<Status></Status>
</InstanceStatus>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2019-01-21T10:12:15</eventTime>
<InstanceStatus xmlns="http://www.h3c.com/netconf/event:1.0/dhcp:1.0">
 <ProtocolType>1</ProtocolType>
<Status>Master</Status>
</InstanceStatus>
</notification>

Table description

Column
Column description Data type and restrictions Remarks
name

Enumeration:
ProtocolType Protocol type • 1—IPv4. N/A
• 2—IPv6.
String:
• Master
Status Instance status N/A
• Backup
• Down
Contents
DHCP6 ··························································································1
DHCP6/DHCP6ServerUpdateDatabase ·························································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCP6/DHCP6ServerClearIpInUse ······························································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
DHCP6/DHCP6ServerClearIpInUseByPool ····················································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
DHCP6/DHCP6ServerClearPDInUseByPrefix ·················································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
DHCP6/DHCP6ServerClearPDInUseByPool ···················································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4

i
DHCP6
DHCP6/DHCP6ServerUpdateDatabase
This table is used to save current IPv6 DHCP server entries to the file and stop downloading these
entries from the file.

XML structure
<DHCP6>
<DHCP6ServerUpdateDatabase>
<UpdateMode></UpdateMode>
</DHCP6ServerUpdateDatabase>
</DHCP6>

Table description
Item Description
Feature name DHCP6
Table name DHCP6ServerUpdateDatabase
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Data type and
Column description Column type
name restrictions
Update IPv6 DHCP server database
Unsigned integer:
immediately.
UpdateMode N/A • 0—Now.
Stop downloading entries from IPv6
DHCP server database. • 1—Stop.

DHCP6/DHCP6ServerClearIpInUse
This table is used to clear binding information about assigned IPv6 addresses according to VRF
and IP6 address.

XML structure
<DHCP6>
<DHCP6ServerClearIpInUse>
<ClearIpInUse>
<VRF></VRF>

1
 <Ipv6Address></Ipv6Address>
</ClearIpInUse>
</DHCP6ServerClearIpInUse>
</DHCP6>

Table description
Item Description
Feature name DHCP6
Table name DHCP6ServerClearIpInUse
Table type Multi-instance table
Row name ClearIpInUse
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. If the Ipv6 pool is on the
VRF instance
VRF Index public network, the
name Length: 1 to 31 characters. length of characters is 0.
Hexadecimal string,
Ipv6Address IPv6 address Index N/A
colon-separated.

DHCP6/DHCP6ServerClearIpInUseByPool
This table is used to clear binding information about assigned IPv6 addresses according to pool
name.

XML structure
<DHCP6>
<DHCP6ServerClearIpInUseByPool>
<ClearIpInUse>
<PoolName></PoolName>
</ClearIpInUse>
</DHCP6ServerClearIpInUseByPool>
</DHCP6>

Table description
Item Description
Feature name DHCP6
Table name DHCP6ServerClearIpInUseByPool

2
 Table type Multi-instance table
Row name ClearIpInUse
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
IPv6 DHCP address String, case-insensitive.
PoolName Index
pool name Length: 1 to 63 characters.

DHCP6/DHCP6ServerClearPDInUseByPrefix
This table is used to clear prefix binding information about assigned IPv6 addresses according to
VRF, IPv6 address and Ipv6 prefix length.

XML structure
<DHCP6>
<DHCP6ServerClearPDInUseByPrefix>
<ClearPDInUseByPrefix>
<VRF></VRF>
<Ipv6Prefix>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
</Ipv6Prefix>
</ClearPDInUseByPrefix>
</DHCP6ServerClearPDInUseByPrefix>
</DHCP6>

Table description
Item Description
Feature name DHCP6
Table name DHCP6ServerClearPDInUseByPrefix
Table type Multi-instance table
Row name ClearPDInUseByPrefix
Restrictions None

3
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. If the Ipv6 pool is on the
VRF instance
VRF Index public network, the
name Length: 1 to 31 characters. length of characters is 0.
Members include:
Data
Ipv6Prefix Ipv6Prefix
structure • Ipv6Address N/A
• Ipv6PrefixLength
Hexadecimal string,
Ipv6Address IPv6 address Index N/A
colon-separated.

Ipv6PrefixLe Length of the IPv6 Unsigned integer.

Index N/A
ngth prefix Value range: 1 to 128.

DHCP6/DHCP6ServerClearPDInUseByPool
This table is used to clear prefix binding information about assigned IPv6 addresses according to
pool name.

XML structure
<DHCP6>
<DHCP6ServerClearPDInUseByPool>
<ClearPDInUseByPool>
<PoolName></PoolName>
</ClearPDInUseByPool>
</DHCP6ServerClearPDInUseByPool>
</DHCP6>

Table description
Item Description
Feature name DHCP6
Table name DHCP6ServerClearPDInUseByPool
Table type Multi-instance table
Row name ClearPDInUseByPool
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
IPv6 DHCP address String, case-insensitive.
PoolName Index
pool name Length: 1 to 63 characters.

4
Contents
DHCP6 ··························································································1
DHCP6/DHCP6ServerDatabase ··································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCP6/DHCP6ServerIpPool ········································································································ 2
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
DHCP6/ DHCP6OptionGroup ······································································································· 9
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ···························································································································· 9
DHCP6/ DHCP6OptionGroupOption ···························································································· 10
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 11
DHCP6/DHCP6RelayPoolRemoteServer ······················································································ 12
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 12
DHCP6/DHCP6Config ·············································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
DHCP6/DHCP6ServerPoolStaticAddress ······················································································ 15
XML structure ··················································································································· 15
Table description ··············································································································· 15
Columns ·························································································································· 16
DHCP6/DHCP6ServerPoolStaticPrefix ························································································· 16
XML structure ··················································································································· 17
Table description ··············································································································· 17
Columns ·························································································································· 17
DHCP6/DHCP6RelaySrvAddress ································································································ 18
XML structure ··················································································································· 18
Table description ··············································································································· 19
Columns ·························································································································· 19
DHCP6/ DHCP6PrefixPool········································································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 21
DHCP6/DHCP6If ····················································································································· 21
XML structure ··················································································································· 21
Table description ··············································································································· 22
Columns ·························································································································· 22
DHCP6/ DHCP6ServerPoolOption······························································································· 24
XML structure ··················································································································· 24
Table description ··············································································································· 25
Columns ·························································································································· 25
DHCP6/DHCP6Vsi ··················································································································· 25
XML structure ··················································································································· 26
Table description ··············································································································· 26
Columns ·························································································································· 26

i
DHCP6
DHCP6/DHCP6ServerDatabase
This table contains IPv6 DHCP server database configuration information.

XML structure
<DHCP6>
<DHCP6ServerDatabase>
<FileName></FileName>
<URL></URL>
<Username></Username>
<Password></Password>
<UpdateInterval></UpdateInterval>
</DHCP6ServerDatabase>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerDatabase

Table type Single-instance table

Row name None

Restrictions None

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
For the merge, create
String, case-insensitive. and replace operations,
Database file
FileName N/A Length: 1 to 255 FileName and URL
name
characters. cannot be configured
simultaneously.

1
 Column Column Data type and
Column name Remarks
description type restrictions

Specifies the URL of a

remote file. Do not
include a username or
password in the URL.
Case sensitivity and the
String. case-sensitive. supported format type of
URL Object URL string N/A Length: 1 to 255 the path depend on the

characters. server.

If URL is configured for

the delete and remove
operations, Username
and Password will be
removed automatically.

String. case-sensitive. Cannot be configured

Username FTP username N/A Length: 1 to 32 for the delete and
characters. remove operations.

Only plaintext password

is supported.

For the merge, create

and replace operations,
String. case-sensitive.
Password must be
Password FTP password N/A Length: 1 to 32
configured with
characters.
Username.

Can not be configured

for the delete and
remove operations.

Unsigned integer.

Auto update Value range: 60 to

UpdateInterval N/A N/A
interval 864000 seconds.

Default: 300 seconds.

DHCP6/DHCP6ServerIpPool
This table contains IPv6 DHCP server pool information.

2
XML structure
<DHCP6>
<DHCP6ServerIpPool>
<Pool>
<PoolIndex></PoolIndex>
<PoolName></PoolName>
<VRF></VRF>
<Network>
<NetworkIpv6Address></NetworkIpv6Address>
<NetworkIpv6PrefixLength></NetworkIpv6PrefixLength>
<NetworkPreferLifetime></NetworkPreferLifetime>
<NetworkValidLifetime></NetworkValidLifetime>
<NetworkExportRoute></NetworkExportRoute>
</Network>
<Range>
<StartIpv6Address></StartIpv6Address>
<EndIpv6Address></EndIpv6Address>
<RangePreferLifetime></RangePreferLifetime>
<RangeValidLifetime></RangeValidLifetime>
</Range>
<TempRange>
<TempStartIpv6Address></TempStartIpv6Address>
<TempEndIpv6Address></TempEndIpv6Address>
<TempRangePreferLifetime></TempRangePreferLifetime>
<TempRangeValidLifetime></TempRangeValidLifetime>
</TempRange>
<PrefixPool>
<PrefixPoolNumber></PrefixPoolNumber>
<PrefixPoolPreferLifetime></PrefixPoolPreferLifetime>
<PrefixPoolValidLifetime></PrefixPoolValidLifetime>
</PrefixPool>
<DomainName></DomainName>
<GatewayIpv6Address></GatewayIpv6Address>
<DNSIpv6Address></DNSIpv6Address>
<SIPIpv6Address></SIPIpv6Address>
<SIPDomainName></SIPDomainName>
</Pool>
</DHCP6ServerIpPool>
</DHCP6>

Table description

Item Description
Feature name DHCP6

3
 Table name DHCP6ServerIpPool

Table type Multi-instance table

Row name Pool

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
For the merge, create
and replace operations,
0 means to
IPv6 DHCP
Unsigned integer. automatically assign a
PoolIndex address pool Index
Value range: 0 to 1024. minimum unused index.
index
For the delete and
remove operations, 0
can not be set.

IPv6 DHCP String, case-insensitive. Required when create a

PoolName address pool N/A Length: 1 to 63 new row, can not be
name characters. modified.

String, case-sensitive. If the Ipv6 pool is on the

VRF instance
VRF N/A Length: 1 to 31 public network, the
name
characters. length of characters is 0.

Members include:

• NetworkIpv6Addre
ss
• NetworkIpv6Prefix
The configuration Data
Network Length N/A
of the IPv6 subnet structure
• NetworkPreferLifet
ime
• NetworkValidLifeti
me

Modifying or removing
NetworkIpv6Addr IPv6 address Hexadecimal string,
N/A the network
ess prefix colon-separated.
configuration deletes the

4
 Column Column Data type and
Column name Remarks
description type restrictions
assigned addresses
from the current address
pool.

NetworkIpv6Prefi Length of the IPv6 Unsigned integer. Must be specified with

N/A
xLength prefix Value range: 1 to 128. NetworkIpv6Address.

It must be configured
Unsigned integer. together with
The preferred
NetworkPreferLif Value range: 60 to NetworkIpv6Address
lifetime of the IPv6 N/A
etime 4294967295. when the configuration
subnet
Default: 604800. of the IPv6 subnet is not
exist.

It must be configured
together with
NetworkIpv6Address
Unsigned integer.
when the configuration
NetworkValidLifet The valid lifetime Value range: 60 to
N/A of the IPv6 subnet is not
ime of the IPv6 subnet 4294967295.
exist.
Default: 2592000.
The preferred lifetime
can't be longer than the
valid lifetime.

It must be configured
Wether advertise
together with
the subnet Boolean:
NetworkExportRo NetworkIpv6Address
assigned to IPv6 N/A • true
ute when the configuration
DHCP clients or • false (default)
of the IPv6 subnet is not
not.
exist.

Members include:

The configuration • StartIpv6Address

of the • EndIpv6Address
Data
Range non-temporary • RangePreferLifeti N/A
structure
IPv6 address me
range
• RangeValidLifetim
e

The start IPv6 Hexadecimal string,

StartIpv6Address N/A N/A
address colon-separated.

The end IPv6 Hexadecimal string, Must be specified with

EndIpv6Address N/A
address colon-separated. StartIpv6Address.

5
 Column Column Data type and
Column name Remarks
description type restrictions
It must be configured
together with
StartIpv6Address when
The preferred Unsigned integer. the configuration of the
lifetime of the
RangePreferLifeti Value range: 60 to non-temporary IPv6
non-temporary N/A
me 4294967295. address range is not
IPv6 address
exist.
range Default: 604800.
The preferred lifetime
can't be longer than the
valid lifetime.

It must be configured
The valid lifetime Unsigned integer. together with
of the StartIpv6Address when
RangeValidLifeti Value range: 60 to
non-temporary N/A the configuration of the
me 4294967295.
IPv6 address non-temporary IPv6
range Default: 2592000. address range is not
exist.

Members include:

• TempStartIpv6Add
ress
The configuration
• TempEndIpv6Addr
of the temporary Data
TempRange ess N/A
IPv6 address structure
• TempRangePrefer
range
Lifetime
• TempRangeValidLi
fetime

TempStartIpv6Ad The start IPv6 Hexadecimal string,

N/A N/A
dress address colon-separated.

TempEndIpv6Ad The end IPv6 Hexadecimal string, Must be specified with

N/A
dress address colon-separated. TempStartIpv6Address.

It must be configured

Unsigned integer. together with

The preferred
TempStartIpv6Address
TempRangePrefe lifetime of the Value range: 60 to
N/A when the configuration
rLifetime temporary IPv6 4294967295.
of the temporary IPv6
address range Default: 604800. address range is not
exist.

6
 Column Column Data type and
Column name Remarks
description type restrictions
The preferred lifetime
can't be longer than the
valid lifetime.

It must be configured

Unsigned integer. together with

The valid lifetime
TempStartIpv6Address
TempRangeValid of the temporary Value range: 60 to
N/A when the configuration
Lifetime IPv6 address 4294967295.
of the temporary IPv6
range Default: 2592000. address range is not
exist.

Members include:
The configuration
of the prefix pool • PrefixPoolNumber
Data
PrefixPool applied in the IPv6 • PrefixPoolPreferLif N/A
structure
DHCP address etime
pool • PrefixPoolValidLife
time

PrefixPoolNumbe Prefix pool Unsigned integer.

N/A N/A
r number
Value range: 1 to 128

It must be configured
together with
Unsigned integer. PrefixPoolNumber when
The preferred
PrefixPoolPreferL Value range: 60 to the configuration of the
lifetime of the N/A
ifetime 4294967295. prefix pool is not exist.
prefix pool
Default: 604800. The preferred lifetime
can't be longer than the
valid lifetime.

Unsigned integer. It must be configured

together with
PrefixPoolValidLif The valid lifetime Value range: 60 to
N/A PrefixPoolNumber when
etime of the prefix pool 4294967295.
the configuration of the
Default: 2592000. prefix pool is not exist.

String, case-sensitive.
Domain name
DomainName N/A Length: 1 to 50 N/A
suffix
characters

GatewayIpv6Addr Gateway N/A String, case-insensitive. Separated by space if

7
 Column Column Data type and
Column name Remarks
description type restrictions
ess addresses Length: 1 to 367 there are multiple
characters. addresses.

Specifies a
space-separated list of
up to eight addresses

Example:

1::1 2::2.

Separated by space if
there are multiple
addresses.
String, case-insensitive.
DNS server Specifies a
DNSIpv6Address N/A Length: 1 to 367
addresses space-separated list of
characters. up to eight addresses

Example:

1::1 2::2.

Separated by space if
there are multiple
addresses.
String, case-insensitive.
SIP server Specifies a
SIPIpv6Address N/A Length: 1 to 367
addresses space-separated list of
characters. up to eight addresses

Example:

1::1 2::2.

Separated by space if
there are multiple SIP
domain name.

The max length of a SIP

String, case-insensitive. domain name is 50.
DNS server
SIPDomainName N/A Length: 1 to 407 Specifies a
domain name
characters. space-separated list of
up to eight SIP domain
names

Example:

aa.com bb.com.

8
DHCP6/ DHCP6OptionGroup
This table contains IPv6 DHCP option group and self-defined IPv6 DHCP option configuration
information.

XML structure
<DHCP6>
<DHCP6OptionGroup>
<OptionGroup>
<GroupNumber></GroupNumber>
<DNSIpv6Address></DNSIpv6Address>
<DomainName></DomainName>
<SIPIpv6Address></SIPIpv6Address>
<SIPDomainName></SIPDomainName>
</OptionGroup>
</DHCP6OptionGroup>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6OptionGroup

Table type Multi-instance table

Row name OptionGroup

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Unsigned integer.
GroupNumber Group index Index N/A
Value range: 1 to 100

DNSIpv6Address DNS server N/A String, case-insensitive. Separated by space if

9
 Column Column Data type and
Column name Remarks
description type restrictions
addresses Length: 1 to 367 there are multiple
characters. addresses.

Specifies a
space-separated list of up
to eight addresses

Example:

1::1 2::2.

String, case-sensitive.
Domain name
DomainName N/A Length: 1 to 50 N/A
suffix
characters

Separated by space if
there are multiple
addresses.
String, case-insensitive.
SIP server Specifies a
SIPIpv6Address N/A Length: 1 to 367
addresses space-separated list of up
characters. to eight addresses

Example:

1::1 2::2.

Separated by space if
there are multiple SIP
domain name.

The max length of a SIP

String, case-insensitive. domain name is 50.
DNS server
SIPDomainName N/A Length: 1 to 407 Specifies a
domain name
characters. space-separated list of up
to eight SIP domain
names

Example:

aa.com bb.com.

DHCP6/ DHCP6OptionGroupOption
This table contains self-defined IPv6 DHCP option configuration information.

10
XML structure
<DHCP6>
<DHCP6OptionGroupOption>
<GroupOption>
<GroupNumber></GroupNumber>
<OptionCode></OptionCode>
<OptionValueHex></OptionValueHex>
</GroupOption>
</DHCP6OptionGroupOption>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6OptionGroupOption

Table type Multi-instance table

Row name GroupOption

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
The specified
Unsigned integer.
GroupNumber Group index Index GroupNumber must
Value range: 1 to 100
already exist.

Following values of
Unsigned integer. OptionCode are
Number of the
OptionCode Index Value range: 21 to forbidden:
option
65535 25,26,37 to 40 and 43 to
48

String. case-insensitive. Lenth of OptionValueHex

OptionValueHex Option content N/A
Length: 2 to 256 must be an even number.

11
 Column Column Data type and
Column name Remarks
description type restrictions
characters.

DHCP6/DHCP6RelayPoolRemoteServer
This table contains IPv6 DHCP relay pool remote server configuration information.

XML structure
<DHCP6>
<DHCP6RelayPoolRemoteServer>
<RemoteServer>
<PoolIndex></PoolIndex>
<RemoteServerIpv6Address></RemoteServerIpv6Address>
<OutIfIndex></OutIfIndex>
</RemoteServer>
</DHCP6RelayPoolRemoteServer>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6RelayPoolRemoteServer

Table type Multi-instance table

Row name RemoteServer

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
IPv6 DHCP
Unsigned integer. The specified PoolIndex
PoolIndex address pool Index
Value range: 1 to 1024. must already exist.
index

12
 Column Column Data type and
Column name Remarks
description type restrictions
For the merge, create
and replace operations,
RemoteServerIpv IPv6 DHCP server Hexadecimal string,
Index 0::0,0::1.and local
6Address address. colon-separated.
multi-cast address are
invalid addresses.

If a IPv6 DHCP server

address is a link-local
address, you must
specify an outgoing
The outgoing interface
interface for the Some versions support
IPv6 DHCP relay interface name. For
OutIfIndex Index Unsigned integer.
agent to forward relevant information, see
packets to the the XSD document of
IPv6 DHCP server your product. For
information about IfIndex,
see IfMgr in Ifmgr
NETCONF XML API
Configuration Reference.

DHCP6/DHCP6Config
This table contains IPv6 DHCP DSCP configuration information.

XML structure
<DHCP6>
<DHCP6Config>
<DSCP></DSCP>
<FloodProtectionThreshold>
<NumberOfPackets></NumberOfPackets>
<DetectionTime></DetectionTime>
</FloodProtectionThreshold>
<FloodProtectionAgeTime></FloodProtectionAgeTime>
<LogEnable></LogEnable>
</DHCP6Config>
</DHCP6>

13
Table description

Item Description
Feature name DHCP6

Table name DHCP6Config

Table type Single-instance table

Row name None

Restrictions None

Support for row creation and deletion No

Columns

Column Column Column Data type and

Remarks
name description type restrictions

The DSCP value Unsigned integer.

DSCP for IPv6 DHCP N/A Value range: 0 to 63. N/A

packets Default: 56.

FloodProtect The threshold of Members include:

Data
ionThreshol IPv6 DHCP flood • NumberOfPackets N/A
structure
d protection. • DetectionTime.

Number of IPv6
DHCP packets
allowed to be Unsigned integer.
NumberOfP
received within N/A Value range: 2 to 200. N/A
ackets
detection time Default: 6.
and not judged as
an attack.

Unsigned integer.
The detection
DetectionTi Value range: 1000 to
time in N/A N/A
me 10000.
milliseconds.
Default: 5000.

The age time of Unsigned integer.

FloodProtect IPv6 DHCP flood
N/A Value range: 30 to 600. N/A
ionAgeTime protection table
items. Default: 300.

14
 Column Column Column Data type and
Remarks
name description type restrictions
Whether the
Boolean:
function of IPv6
LogEnable N/A • true N/A
DHCP logging is
• false (default)
enabled

DHCP6/DHCP6ServerPoolStaticAddress
This table contains IPv6 DHCP server pool static address information.

XML structure
<DHCP6>
<DHCP6ServerPoolStaticAddress>
<PoolStaticAddress>
<PoolIndex></PoolIndex>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
<DUID></DUID>
<IAID></IAID>
<PreferLifetime></PreferLifetime>
<ValidLifetime></ValidLifetime>
<Description></Description>
</PoolStaticAddress>
</DHCP6ServerPoolStaticAddress>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerPoolStaticAddress

Table type Multi-instance table

Row name PoolStaticAddress

Restrictions None

Support for row creation and deletion Yes

15
Columns

Column Column Data type and

Column name Remarks
description type restrictions
IPv6 DHCP
Unsigned integer. The specified PoolIndex
PoolIndex address pool Index
Value range: 1 to 1024. must already exist.
index

IPv6 address Hexadecimal string,

Ipv6Address Index N/A
prefix colon-separated.

Required when create a

Length of the IPv6 Unsigned integer.
Ipv6PrefixLength N/A new row, can not be
prefix Value range: 1 to 128.
deleted.

The value is an
String, case-insensitive. Required when create a
even hexadecimal
DUID N/A Length: 2 to 256 new row, can not be
number in the
characters. deleted.
range of 2 to 256.

The value is a
If you do not specify an
hexadecimal
String, case-insensitive. IAID, the server does
IAID number in the N/A
Length: 8 characters. not match the client IAID
range of 0 to
for prefix assignment.
FFFFFFFF

Unsigned integer.
The preferred The preferred lifetime
Value range: 60 to
PreferLifetime lifetime of the IPv6 N/A can't be longer than the
4294967295.
subnet valid lifetime.
Default: 604800

Unsigned integer.

The valid lifetime Value range: 60 to

ValidLifetime N/A N/A
of the IPv6 subnet 4294967295.

Default: 2592000.

String, case insensitive.

Description of the
Description N/A Length: 1 to 255 N/A
static binding
characters.

DHCP6/DHCP6ServerPoolStaticPrefix
This table contains IPv6 DHCP server pool static prefix information.

16
XML structure
<DHCP6>
<DHCP6ServerPoolStaticPrefix>
<PoolStaticPrefix>
<PoolIndex></PoolIndex>
<Ipv6Prefix>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
</Ipv6Prefix>
<DUID></DUID>
<IAID></IAID>
<PreferLifetime></PreferLifetime>
<ValidLifetime></ValidLifetime>
<Description></Description>
</PoolStaticPrefix>
</DHCP6ServerPoolStaticPrefix>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerPoolStaticPrefix

Table type Multi-instance table

Row name PoolStaticPrefix

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
IPv6 DHCP
Unsigned integer. The specified PoolIndex
PoolIndex address pool Index
Value range: 1 to 1024. must already exist.
index

Data Members include:

Ipv6Prefix Ipv6Prefix N/A
structure • Ipv6Address

17
 Column Column Data type and
Column name Remarks
description type restrictions
• Ipv6PrefixLength

IPv6 address Hexadecimal string,

Ipv6Address Index N/A
prefix colon-separated.

Length of the IPv6 Unsigned integer.

Ipv6PrefixLength Index N/A
prefix Value range: 1 to 128.

The value is an
String, case-insensitive. Required when create a
even hexadecimal
DUID N/A Length: 2 to 256 new row, can not be
number in the
characters. deleted.
range of 2 to 256.

The value is a
If you do not specify an
hexadecimal
String, case-insensitive. IAID, the server does
IAID number in the N/A
Length: 8 characters. not match the client IAID
range of 0 to
for prefix assignment.
FFFFFFFF

Unsigned integer.
The preferred The preferred lifetime
Value range: 60 to
PreferLifetime lifetime of the IPv6 N/A can't be longer than the
4294967295.
static prefix valid lifetime.
Default: 604800

Unsigned integer.
The valid lifetime
Value range: 60 to
ValidLifetime of the IPv6 static N/A N/A
4294967295.
prefix
Default: 2592000.

String, case insensitive.

Description of the
Description N/A Length: 1 to 255 N/A
static binding
characters.

DHCP6/DHCP6RelaySrvAddress
This table contains IPv6 DHCP relay server configuration information.

XML structure
<DHCP6>
<DHCP6RelaySrvAddress>
<RelaySrvIPv6>

18
 <IfIndex></IfIndex>
<Ipv6Address></Ipv6Address>
<OutIfIndex></OutIfIndex>
</RelaySrvIPv6>
</DHCP6RelaySrvAddress>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6RelaySrvAddress

Table type Multi-instance table

Row name RelaySrvIPv6

Restrictions This table supports only Layer 3 interfaces.

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information, see
the XSD document of
IfIndex Interface index. Index Unsigned integer. your product. For
information about IfIndex,
see IfMgr in Ifmgr
NETCONF XML API
Configuration Reference.

IPv6 DHCP DHCP For the merge, create

servers IPv6 and replace operations,
Hexadecimal string,
Ipv6Address address on the Index 0::0,0::1.and local
colon-separated.
IPv6 DHCP relay multi-cast address are
agent. invalid addresses.

The outgoing If a IPv6 DHCP server

OutIfIndex Index Unsigned integer.
interface for the address is a link-local

19
 Column Column Data type and
Column name Remarks
description type restrictions
IPv6 DHCP relay address, you must
agent to forward specify an outgoing
packets to the interface
IPv6 DHCP server

DHCP6/ DHCP6PrefixPool
This table contains IPv6 DHCP prefix pool configuration information.

XML structure
<DHCP6>
<DHCP6PrefixPool>
<PrefixPool>
<VRF></VRF>
<PrefixPoolNumber></PrefixPoolNumber>
<Ipv6Prefix>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
</Ipv6Prefix>
<AssignIpv6PrefixLength></AssignIpv6PrefixLength>
</PrefixPool>
</DHCP6PrefixPool>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6PrefixPool

Table type Multi-instance table

Row name PrefixPool

Restrictions None

Support for row creation and deletion Yes

20
Columns

Column Column Data type and

Column name Remarks
description type restrictions
String, case-sensitive. If the prefix pool is on the
VRF instance
VRF Index Length: 1 to 31 public network, the length
name
characters. of characters is 0.

PrefixPoolNumbe Prefix pool Unsigned integer.

Index N/A
r number Value range: 1 to 128.

Members include:
Data
Ipv6Prefix Ipv6Prefix • Ipv6Address N/A
structure
• Ipv6PrefixLength

Required when create a

Hexadecimal string,
Ipv6Address IPv6 address N/A new row, can not be
colon-separated.
deleted.

Required when create a

Length of the IPv6 Unsigned integer.
Ipv6PrefixLength N/A new row, can not be
prefix Value range: 1 to 128.
deleted.

Required when create a

new row, can not be
deleted.

The value can't be

Length of the
AssignIpv6Prefix Unsigned integer. shorter than
assigned IPv6 N/A
Length Value range: 1 to 128. Ipv6PrefixLength. The
prefix
difference between
AssignIpv6PrefixLength
and Ipv6PrefixLength
can't be greater than 16.

DHCP6/DHCP6If
This table contains IPv6 DHCP config information on interface.

XML structure
<DHCP6>
<DHCP6If>
<IfConfigure>

21
 <IfIndex></IfIndex>
<Mode></Mode>
<ServerAllowHint></ServerAllowHint>
<ServerRapidCommit></ServerRapidCommit>
<ServerPreference></ServerPreference>
<ApplyPoolName></ApplyPoolName>
<ApplyPoolAllowHint></ApplyPoolAllowHint>
<ApplyPoolRapidCommit></ApplyPoolRapidCommit>
<ApplyPoolPreference></ApplyPoolPreference>
<RelayInterfaceIDMode></RelayInterfaceIDMode>
<RelayGatewayAddress></RelayGatewayAddress>
<ClientDetect></ClientDetect>
<DiscardReqFromTnlEnable></DiscardReqFromTnlEnable>
</IfConfigure>
</DHCP6If>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6If

Table type Multi-instance table

Row name IfConfigure

Restrictions This table supports only Layer 3 interfaces.

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD
IfIndex Interface index. Index Unsigned integer. document of your
product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF

22
 Column Column Data type and
Column name Remarks
description type restrictions
XML API
Configuration
Reference.

Enumeration: None means the

• 0—None(default). interface discards IPv6
Mode DHCPv6 mode N/A
• 1—Server. DHCP packets from

• 2—Relay. IPv6 DHCP clients.

Allow client
Boolean:
suggested IPv6
ServerAllowHint N/A • true N/A
addresses and
• false(default).
prefixes.

Boolean:
ServerRapidCom Enable the rapid
N/A • true N/A
mit commit function.
• false(default).

Unsigned integer.

Specify the server Value range: 0 to 255,

ServerPreference N/A N/A
preference. 4294967295.

Default: 4294967295

IPv6 DHCP String, case-insensitive.

ApplyPoolName address pool N/A Length: 1 to 63 N/A
name characters.

It must be configured
Allow client together with
Boolean:
ApplyPoolAllowHi suggested IPv6 ApplyPoolName when
N/A • true
nt addresses and apply a IPv6 DHCP
• false(default)
prefixes. address pool to an
interface.

It must be configured
together with
Boolean:
ApplyPoolRapidC Enable the rapid ApplyPoolName when
N/A • true
ommit commit function. apply a IPv6 DHCP
• false(default)
address pool to an
interface.

Unsigned integer. It must be configured

ApplyPoolPrefere Specify the server
N/A Value range: 0 to 255, together with
nce preference.
4294967295. ApplyPoolName when

23
 Column Column Data type and
Column name Remarks
description type restrictions
Default: 4294967295 apply a IPv6 DHCP
address pool to an
interface.

None means the IPv6

Enumeration:
DHCP relay agent fills
RelayInterfaceID IPV6 Interface-Id • 0—None(default).
N/A the Interface-ID option
Mode Option • 1—Bas.
with the interface index
• 2—Interface. of the interface.

RelayGatewayAd Gateway for Hexadecimal string,

N/A N/A
dress DHCPv6 clients colon-separated.

Enabling status of Boolean:

ClientDetect client offline N/A • true N/A
detection • false (default)

Support for
discarding request Boolean:
DiscardReqFrom
packet from N/A • true N/A
TnlEnable
tunnels by the • false (default)
DHCP relay agent

DHCP6/ DHCP6ServerPoolOption
This table contains IPv6 DHCP server pool option information.

XML structure
<DHCP6>
<DHCP6ServerPoolOption>
<PoolOption>
<PoolIndex></PoolIndex>
<OptionCode></OptionCode>
<OptionValueHex></OptionValueHex>
</PoolOption>
</DHCP6ServerPoolOption>
</DHCP6>

24
Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerPoolOption

Table type Multi-instance table

Row name PoolOption

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
IPv6 DHCP
Unsigned integer. The specified PoolIndex
PoolIndex address pool Index
Value range: 1 to 1024. must already exist.
index

Following values of
Unsigned integer. OptionCode are
Number of the
OptionCode Index Value range: 21 to forbidden:
option
65535 25,26,37 to 40 and 43 to
48

Required when create a

String. case-insensitive. new row, can not be
OptionValueHex Option content N/A Length: 2 to 256 deleted.Lenth of
characters. OptionValueHex must
be an even number.

DHCP6/DHCP6Vsi
This table contains the VSI configuration of DHCP.

25
XML structure
<DHCP6>
<DHCP6Vsi>
<Vsi>
<VsiName></VsiName>
<FloodProtectionEnable></FloodProtectionEnable>
</Vsi>
</DHCP6Vsi>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6Vsi

Table type Multi-instance table

Row name Vsi

Restrictions None

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
String, case-sensitive.
VsiName VSI name Index Length: 1 to 31 N/A
characters.

Enabling status of Boolean:

FloodProtectionE
DHCP flood N/A • True N/A
nable
protection • False (default).

26
Contents
DHCP6 ··························································································1
DHCP6/DHCP6ServerDatabase ··································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCP6/DHCP6ServerIpPool ········································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
DHCP6/DHCP6OptionGroup ········································································································ 6
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7
DHCP6/DHCP6OptionGroupOption ······························································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ···························································································································· 9
DHCP6/DHCP6RelayPoolRemoteServer ························································································ 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
DHCP6/DHCP6Config ·············································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
DHCP6/DHCP6ServerPoolStaticAddress ······················································································ 12
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 13
DHCP6/DHCP6ServerPoolStaticPrefix ························································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
DHCP6/DHCP6RelaySrvAddress ································································································ 15
XML structure ··················································································································· 15
Table description ··············································································································· 15
Columns ·························································································································· 16
DHCP6/ DHCP6PrefixPool········································································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 16
Columns ·························································································································· 17
DHCP6/DHCP6If ····················································································································· 17
XML structure ··················································································································· 17
Table description ··············································································································· 18
Columns ·························································································································· 18
DHCP6/DHCP6ServerIpInUse ···································································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 21
DHCP6/DHCP6ServerPDInUse ·································································································· 22
XML structure ··················································································································· 22
Table description ··············································································································· 22
Columns ·························································································································· 22
DHCP6/ DHCP6ServerPoolOption······························································································· 23
XML structure ··················································································································· 24
Table description ··············································································································· 24
Columns ·························································································································· 24

i
DHCP6/DHCP6Vsi ··················································································································· 24
XML structure ··················································································································· 25
Table description ··············································································································· 25
Columns ·························································································································· 25

ii
DHCP6
DHCP6/DHCP6ServerDatabase
This table contains IPv6 DHCP server database information.

XML structure
<DHCP6>
<DHCP6ServerDatabase>
<FileName></FileName>
<URL></URL>
<Username></Username>
<Password></Password>
<UpdateInterval></UpdateInterval>
</DHCP6ServerDatabase>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerDatabase

Table type Single-instance table

Row name None

Restrictions None

Columns

Column Column
Column name Data type and restrictions
description type
String, case-insensitive.
FileName Object file name N/A
Length: 1 to 255 characters.

String. case-sensitive.
URL Object URL string N/A
Length: 1 to 255 characters.

Username FTP username N/A String. case-sensitive.

1
 Column Column
Column name Data type and restrictions
description type
Length: 1 to 32 characters.

String. case-sensitive.
Password FTP password N/A
Length: 1 to 32 characters.

Auto update Unsigned integer.

UpdateInterval N/A
interval Value range: 60 to 864000 seconds.

DHCP6/DHCP6ServerIpPool
This table contains IPv6 DHCP server pool information.

XML structure
<DHCP6>
<DHCP6ServerIpPool>
<Pool>
<PoolIndex></PoolIndex>
<PoolName></PoolName>
<VRF></VRF>
<Network>
<NetworkIpv6Address></NetworkIpv6Address>
<NetworkIpv6PrefixLength></NetworkIpv6PrefixLength>
<NetworkPreferLifetime></NetworkPreferLifetime>
<NetworkValidLifetime></NetworkValidLifetime>
<NetworkExportRoute></NetworkExportRoute>
</Network>
<Range>
<StartIpv6Address></StartIpv6Address>
<EndIpv6Address></EndIpv6Address>
<RangePreferLifetime></RangePreferLifetime>
<RangeValidLifetime></RangeValidLifetime>
</Range>
<TempRange>
<TempStartIpv6Address></TempStartIpv6Address>
<TempEndIpv6Address></TempEndIpv6Address>
<TempRangePreferLifetime></TempRangePreferLifetime>
<TempRangeValidLifetime></TempRangeValidLifetime>
</TempRange>
<PrefixPool>
<PrefixPoolNumber></PrefixPoolNumber>
<PrefixPoolPreferLifetime></PrefixPoolPreferLifetime>
<PrefixPoolValidLifetime></PrefixPoolValidLifetime>
</PrefixPool>

2
 <DomainName></DomainName>
<GatewayIpv6Address></GatewayIpv6Address>
<DNSIpv6Address></DNSIpv6Address>
<SIPIpv6Address></SIPIpv6Address>
<SIPDomainName></SIPDomainName>
</Pool>
</DHCP6ServerIpPool>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerIpPool

Table type Multi-instance table

Row name Pool

Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions
IPv6 DHCP
Unsigned integer.
PoolIndex address pool Index N/A
Value range: 1 to 1024.
index

IPv6 DHCP String, case-insensitive.

PoolName address pool N/A Length: 1 to 63 N/A
name characters.

String, case-sensitive. If the Ipv6 pool is on the

VRF instance
VRF N/A Length: 1 to 31 public network, the
name
characters. length of characters is 0.

Members include:

• NetworkIpv6Addre
The configuration Data ss
Network N/A
of the IPv6 subnet structure • NetworkIpv6Prefix
Length
• NetworkPreferLifet

3
 Column Column Data type and
Column name Remarks
description type restrictions
ime
• NetworkValidLifeti
me

NetworkIpv6Addr IPv6 address Hexadecimal string,

N/A N/A
ess prefix colon-separated.

NetworkIpv6Prefi Length of the IPv6 Unsigned integer.

N/A N/A
xLength prefix Value range: 1 to 128.

The preferred Unsigned integer.

NetworkPreferLif
lifetime of the IPv6 N/A Value range: 60 to N/A
etime
subnet 4294967295.

Unsigned integer.
NetworkValidLifet The valid lifetime
N/A Value range: 60 to N/A
ime of the IPv6 subnet
4294967295.

Wether advertise
the subnet Boolean:
NetworkExportRo
assigned to N/A • true N/A
ute
DHCPv6 clients or • false
not.

Members include:

The configuration • StartIpv6Address

of the • EndIpv6Address
Data
Range non-temporary • RangePreferLifeti N/A
structure
IPv6 address me
range
• RangeValidLifetim
e

The start IPv6 Hexadecimal string,

StartIpv6Address N/A N/A
address colon-separated.

The end IPv6 Hexadecimal string,

EndIpv6Address N/A N/A
address colon-separated.

The preferred
lifetime of the Unsigned integer.
RangePreferLifeti
non-temporary N/A Value range: 60 to N/A .
me
IPv6 address 4294967295.
range

RangeValidLifeti The valid lifetime N/A Unsigned integer. N/A

4
 Column Column Data type and
Column name Remarks
description type restrictions
me of the Value range: 60 to
non-temporary 4294967295.
IPv6 address
range

Members include:

• TempStartIpv6Add
ress
The configuration
• TempEndIpv6Addr
of the temporary Data
TempRange ess N/A
IPv6 address structure
• TempRangePrefer
range
Lifetime
• TempRangeValidLi
fetime

TempStartIpv6Ad The start IPv6 Hexadecimal string,

N/A N/A
dress address colon-separated.

TempEndIpv6Ad The end IPv6 Hexadecimal string,

N/A N/A
dress address colon-separated.

The preferred
Unsigned integer.
TempRangePrefe lifetime of the
N/A Value range: 60 to N/A
rLifetime temporary IPv6
4294967295.
address range

The valid lifetime

Unsigned integer.
TempRangeValid of the temporary
N/A Value range: 60 to N/A
Lifetime IPv6 address
4294967295.
range

Members include:
The configuration
of the prefix pool • PrefixPoolNumber
Data
PrefixPool applied in the IPv6 • PrefixPoolPreferLif N/A
structure
DHCP address etime
pool • PrefixPoolValidLife
time

PrefixPoolNumbe Prefix pool Unsigned integer.

N/A N/A
r number
Value range: 1 to 128

PrefixPoolPreferL The preferred

N/A Unsigned integer. N/A
ifetime lifetime of the

5
 Column Column Data type and
Column name Remarks
description type restrictions
prefix pool Value range: 60 to
4294967295.

Unsigned integer.
PrefixPoolValidLif The valid lifetime
N/A Value range: 60 to N/A
etime of the prefix pool
4294967295.

String, case-sensitive.
Domain name
DomainName N/A Length: 1 to 50 N/A
suffix
characters

Seperated by space if
String, case-insensitive. there are multiple
GatewayIpv6Addr Gateway addresses.
N/A Length: 1 to 367
ess addresses
characters. Example:

1::1 2::2.

Seperated by space if
String, case-insensitive. there are multiple
DNS server addresses.
DNSIpv6Address N/A Length: 1 to 367
addresses
characters. Example:

1::1 2::2.

Seperated by space if
String, case-insensitive. there are multiple
SIP server addresses.
SIPIpv6Address N/A Length: 1 to 367
addresses
characters. Example:

1::1 2::2.

Seperated by space if
there are multiple SIP

String, case-sensitive. domain name.

DNS server
SIPDomainName N/A Length: 1 to 407 The max length of a SIP
domain name
characters. domain name is 50.

Example:

aa.com bb.com.

DHCP6/DHCP6OptionGroup
This table contains IPv6 DHCP option group and self-defined IPv6 DHCP option configuration
information.

6
XML structure
<DHCP6>
<DHCP6OptionGroup>
<OptionGroup>
<GroupNumber></GroupNumber>
<DNSIpv6Address></DNSIpv6Address>
<DomainName></DomainName>
<SIPIpv6Address></SIPIpv6Address>
<SIPDomainName></SIPDomainName>
</OptionGroup>
</DHCP6OptionGroup>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6OptionGroup

Table type Multi -instance table

Row name OptionGroup

Restrictions None

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Unsigned integer.
GroupNumber Group index Index N/A
Value range: 1 to 100

Separated by space if
there are multiple
String, case-insensitive.
DNS server addresses.
DNSIpv6Address N/A Length: 1 to 367
addresses Specifies a
characters.
space-separated list of up
to eight addresses

7
 Column Column Data type and
Column name Remarks
description type restrictions
Example:

1::1 2::2.

String, case-sensitive.
Domain name
DomainName N/A Length: 1 to 50 N/A
suffix
characters

Separated by space if
there are multiple
addresses.
String, case-insensitive.
SIP server Specifies a
SIPIpv6Address N/A Length: 1 to 367
addresses space-separated list of up
characters. to eight addresses

Example:

1::1 2::2.

Separated by space if
there are multiple SIP
domain name.

The max length of a SIP

String, case-insensitive. domain name is 50.
DNS server
SIPDomainName N/A Length: 1 to 407 Specifies a
domain name
characters. space-separated list of up
to eight SIP domain
names

Example:

aa.com bb.com.

DHCP6/DHCP6OptionGroupOption
This table contains self-defined IPv6 DHCP option configuration information.

XML structure
<DHCP6>
<DHCP6OptionGroupOption>
<GroupOption>
<GroupNumber></GroupNumber>
<OptionCode></OptionCode>

8
 <OptionValueHex></OptionValueHex>
</GroupOption>
</DHCP6OptionGroupOption>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6OptionGroupOption

Table type Multi -instance table

Row name GroupOption

Restrictions None

Columns

Column
Column name Column type Data type and restrictions
description
Unsigned integer.
GroupNumber Group index Index
Value range: 1 to 100

Number of the Unsigned integer.

OptionCode Index
option Value range: 21 to 65535

String. case-insensitive.
OptionValueHex Option content N/A
Length: 2 to 256 characters.

DHCP6/DHCP6RelayPoolRemoteServer
This table contains IPv6 DHCP relay pool remote server configuration information.

XML structure
<DHCP6>
<DHCP6RelayPoolRemoteServer>
<RemoteServer>
<PoolIndex></PoolIndex>
<RemoteServerIpv6Address></RemoteServerIpv6Address>

9
 <OutIfIndex></OutIfIndex>
</RemoteServer>
</DHCP6RelayPoolRemoteServer>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6RelayPoolRemoteServer

Table type Multi -instance table

Row name RemoteServer

Restrictions None

Columns

Column
Column name Column type Data type and restrictions
description
IPv6 DHCP
Unsigned integer.
PoolIndex address pool Index
Value range: 1 to 1024.
index

RemoteServerIpv IPv6 DHCP server

Index Hexadecimal string, colon-separated.
6Address address.

The outgoing
interface for the
IPv6 DHCP relay
OutIfIndex Index Unsigned integer.
agent to forward
packets to the
DHCPv6 server

DHCP6/DHCP6Config
This table contains IPv6 DHCP DSCP configuration information.

XML structure
<DHCP6>

10
 <DHCP6Config>
<DSCP></DSCP>
<FloodProtectionThreshold>
<NumberOfPackets></NumberOfPackets>
<DetectionTime></DetectionTime>
</FloodProtectionThreshold>
<FloodProtectionAgeTime></FloodProtectionAgeTime>
<LogEnable></LogEnable>
</DHCP6Config>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6Config

Table type Single-instance table

Row name None

Restrictions None

Columns

Column Column Column Data type and

Remarks
name description type restrictions
The DSCP value
Unsigned integer.
DSCP for IPv6 DHCP N/A N/A
Value range: 0 to 63.
packets

FloodProtect Treshold of IPv6 Members include:

Data
ionThreshol DHCP flood • NumberOfPackets N/A
structure
d protection. • DetectionTime.

Number of IPv6
DHCP packets
allowed to be
NumberOfP Unsigned integer.
received within N/A N/A
ackets Value range: 2 to 200.
detection time
and not judged as
an attack.

11
 Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
DetectionTi Detection time in
N/A Value range: 1000 to N/A
me milliseconds.
10000.

Aging time of IPv6

FloodProtect DHCP flood Unsigned integer.
N/A N/A
ionAgeTime protection table Value range: 30 to 600.
items.

Whether the
Boolean:
function of IPv6
LogEnable N/A • true N/A
DHCP logging is
• false
enabled

DHCP6/DHCP6ServerPoolStaticAddress
This table contains IPv6 DHCP server pool static address information.

XML structure
<DHCP6>
<DHCP6ServerPoolStaticAddress>
<PoolStaticAddress>
<PoolIndex></PoolIndex>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
<DUID></DUID>
<IAID></IAID>
<PreferLifetime></PreferLifetime>
<ValidLifetime></ValidLifetime>
<Description></Description>
</PoolStaticAddress>
</DHCP6ServerPoolStaticAddress>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerPoolStaticAddress

12
 Table type Multi-instance table

Row name PoolStaticAddress

Restrictions None

Columns

Column name Column description Column type Data type and restrictions

IPv6 DHCP address pool Unsigned integer.

PoolIndex Index
index Value range: 1 to 1024.

Ipv6Address IPv6 address prefix Index Hexadecimal string, colon-separated.

Unsigned integer.
Ipv6PrefixLength Length of the IPv6 prefix N/A
Value range: 1 to 128.

The value is an even

String, case-insensitive.
DUID hexadecimal number in N/A
Length: 2 to 256 characters.
the range of 2 to 256.

The value is a
hexadecimal number in String, case-insensitive.
IAID N/A
the range of 0 to Length: 8 characters.
FFFFFFFF

The preferred lifetime of Unsigned integer.

PreferLifetime N/A
the IPv6 subnet Value range: 60 to 4294967295.

The valid lifetime of the Unsigned integer.

ValidLifetime N/A
IPv6 subnet Value range: 60 to 4294967295.

Description of the static String, case insensitive.

Description N/A
binding Length: 1 to 255 characters.

DHCP6/DHCP6ServerPoolStaticPrefix
This table contains IPv6 DHCP server pool static prefix information.

XML structure
<DHCP6>
<DHCP6ServerPoolStaticPrefix>
<PoolStaticPrefix>

13
 <PoolIndex></PoolIndex>
<Ipv6Prefix>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
</Ipv6Prefix>
<DUID></DUID>
<IAID></IAID>
<PreferLifetime></PreferLifetime>
<ValidLifetime></ValidLifetime>
<Description></Description>
</PoolStaticPrefix>
</DHCP6ServerPoolStaticPrefix>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerPoolStaticPrefix

Table type Multi-instance table

Row name PoolStaticPrefix

Restrictions None

Columns

Column
Column name Column description Data type and restrictions
type

IPv6 DHCP address pool Unsigned integer.

PoolIndex Index
index Value range: 1 to 1024.

Members include:
Data
Ipv6Prefix Ipv6Prefix • Ipv6Address
structure
• Ipv6PrefixLength

Ipv6Address IPv6 address prefix Index Hexadecimal string, colon-separated.

Unsigned integer.
Ipv6PrefixLength Length of the IPv6 prefix Index
Value range: 1 to 128.

The value is an even String, case-insensitive.

DUID N/A
hexadecimal number in Length: 2 to 256 characters.

14
 Column
Column name Column description Data type and restrictions
type
the range of 2 to 256.

The value is a
hexadecimal number in String, case-insensitive.
IAID N/A
the range of 0 to Length: 8 characters.
FFFFFFFF

The preferred lifetime of Unsigned integer.

PreferLifetime N/A
the IPv6 static prefix Value range: 60 to 4294967295.

The valid lifetime of the Unsigned integer.

ValidLifetime N/A
IPv6 static prefix Value range: 60 to 4294967295.

Description of the static String, case insensitive.

Description N/A
binding Length: 1 to 255 characters.

DHCP6/DHCP6RelaySrvAddress
This table contains IPv6 DHCP relay server configuration information.

XML structure
<DHCP6>
<DHCP6RelaySrvAddress>
<RelaySrvIPv6>
<IfIndex></IfIndex>
<Ipv6Address></Ipv6Address>
<OutIfIndex></OutIfIndex>
</RelaySrvIPv6>
</DHCP6RelaySrvAddress>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6RelaySrvAddress

Table type Multi-instance table

Row name RelaySrvIPv6

15
 Restrictions This table supports only Layer 3 interfaces.

Columns

Column name Column description Column type Data type and restrictions
IfIndex Interface index. Index Unsigned integer.

IPv6 DHCP DHCP servers

Hexadecimal string,
Ipv6Address IPv6 address on the IPv6 Index
colon-separated.
DHCP relay agent.

The outgoing interface for the

IPv6 DHCP relay agent to
OutIfIndex Index Unsigned integer.
forward packets to the IPv6
DHCP server

DHCP6/ DHCP6PrefixPool
This table contains IPv6 DHCP prefix pool configuration information.

XML structure
<DHCP6>
<DHCP6PrefixPool>
<PrefixPool>
<VRF></VRF>
<PrefixPoolNumber></PrefixPoolNumber>
<Ipv6Prefix>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
</Ipv6Prefix>
<AssignIpv6PrefixLength></AssignIpv6PrefixLength>
</PrefixPool>
</DHCP6PrefixPool>
</DHCP6>

Table description

Item Description
Feature name DHCP6

16
 Table name DHCP6PrefixPool

Table type Multi-instance table

Row name PrefixPool

Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions
String, case-sensitive. If the prefix pool is on the
VRF instance
VRF Index Length: 1 to 31 public network, the length
name
characters. of characters is 0.

PrefixPoolNumbe Prefix pool Unsigned integer.

Index N/A
r number Value range: 1 to 128.

Members include:
Data
Ipv6Prefix Ipv6Prefix • Ipv6Address N/A
structure
• Ipv6PrefixLength

Hexadecimal string,
Ipv6Address IPv6 address N/A N/A
colon-separated.

Length of the IPv6 Unsigned integer.

Ipv6PrefixLength N/A N/A
prefix Value range: 1 to 128.

Length of the
AssignIpv6Prefix Unsigned integer.
assigned IPv6 N/A N/A
Length Value range: 1 to 128.
prefix

DHCP6/DHCP6If
This table contains IPv6 DHCP config information on interface.

XML structure
<DHCP6>
<DHCP6If>
<IfConfigure>
<IfIndex></IfIndex>
<Mode></Mode>

17
 <ServerAllowHint></ServerAllowHint>
<ServerRapidCommit></ServerRapidCommit>
<ServerPreference></ServerPreference>
<ApplyPoolName></ApplyPoolName>
<ApplyPoolAllowHint></ApplyPoolAllowHint>
<ApplyPoolRapidCommit></ApplyPoolRapidCommit>
<ApplyPoolPreference></ApplyPoolPreference>
<RelayInterfaceIDMode></RelayInterfaceIDMode>
<RelayGatewayAddress></RelayGatewayAddress>
<ClientDetect></ClientDetect>
<DiscardReqFromTnlEnable></DiscardReqFromTnlEnable>
</IfConfigure>
</DHCP6If>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6If

Table type Multi-instance table

Row name IfConfigure

Restrictions This table supports only Layer 3 interfaces.

Columns

Column Column Data type and

Column name Remarks
description type restrictions
IfIndex Interface index. Index Unsigned integer. N/A

Enumeration: None means the

• 0—None. interface discards IPv6
Mode DHCPv6 mode N/A
• 1—Server. DHCP packets from

• 2—Relay. IPv6 DHCP clients.

Allow client
Boolean:
suggested IPv6
ServerAllowHint N/A • true N/A
addresses and
• false
prefixes.

18
 Column Column Data type and
Column name Remarks
description type restrictions
Boolean:
ServerRapidCom Enable the rapid
N/A • true N/A
mit commit function.
• false

Unsigned integer.
Specify the server
ServerPreference N/A Value range: 0 to 255, N/A
preference.
4294967295.

IPv6 DHCP String, case-insensitive.

ApplyPoolName address pool N/A Length: 1 to 63 N/A
name characters.

It must be configured
Allow client together with
Boolean:
ApplyPoolAllowHi suggested IPv6 ApplyPoolName when
N/A • true
nt addresses and apply a IPv6 DHCP
• false
prefixes. address pool to an
interface.

It must be configured
together with
Boolean:
ApplyPoolRapidC Enable the rapid ApplyPoolName when
N/A • true
ommit commit function. apply a IPv6 DHCP
• false
address pool to an
interface.

It must be configured
together with
Unsigned integer.
ApplyPoolPrefere Specify the server ApplyPoolName when
N/A Value range: 0 to 255,
nce preference. apply a IPv6 DHCP
4294967295.
address pool to an
interface.

None means the IPv6

Enumeration:
DHCP relay agent fills
RelayInterfaceID IPV6 Interface-Id • 0—None.
N/A the Interface-ID option
Mode Option • 1—Bas.
with the interface index
• 2—Interface. of the interface.

RelayGatewayAd Gateway for Hexadecimal string,

N/A N/A
dress DHCPv6 clients colon-separated.

Enabling status of Boolean:

ClientDetect N/A N/A
client offline • true

19
 Column Column Data type and
Column name Remarks
description type restrictions
detection • false

Whether the
DHCP relay agent
Boolean:
DiscardReqFrom supports
N/A • true N/A
TnlEnable discarding request
• false
packet from
tunnels

DHCP6/DHCP6ServerIpInUse
This table contains binding information about assigned IPv6 addresses.

XML structure
<DHCP6>
<DHCP6ServerIpInUse>
<IpInUse>
<PoolIndex></PoolIndex>
<Ipv6Address></Ipv6Address>
<Type></Type>
<EndLease></EndLease>
<ClientIPv6Address></ClientIPv6Address>
<DUID></DUID>
<IAID></IAID>
<PreferLifetime></PreferLifetime>
<ValidLifetime></ValidLifetime>
</IpInUse>
</DHCP6ServerIpInUse>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerIpInUse

Table type Multi-instance table

Row name IpInUse

20
 Restrictions None

Columns

Column name Column description Column type Data type and restrictions

IPv6 DHCP address pool Unsigned integer.

PoolIndex Index
index Value range: 1 to 1024.

Ipv6Address IPv6 address prefix Index Hexadecimal string, colon-separated.

Enumeration:

• 0—Static(F).
• 1—Static(O).
IPv6 address binding
Type N/A • 2—Static(C)..
types
• 3—Auto(E)
• 4—Auto(O)
• 5—Auto(C)

Time when the lease of

String, case-sensitive.
EndLease the IPv6 address will N/A
Length: 1 to 19 characters.
expire.

ClientIPv6Addres
Client IPv6 address N/A Hexadecimal string, colon-separated.
s

The value is an even

String, case-insensitive.
DUID hexadecimal number in N/A
Length: 2 to 256 characters.
the range of 2 to 256.

The value is a
hexadecimal number in String, case-insensitive.
IAID N/A
the range of 0 to Length: 8 characters.
FFFFFFFF

Preferred lifetime in Unsigned integer.

PreferLifetime seconds of the IPv6 N/A
Value range: 60 to 4294967295.
address

Valid lifetime in Unsigned integer.

ValidLifetime seconds of the IPv6 N/A
Value range: 60 to 4294967295.
address

21
DHCP6/DHCP6ServerPDInUse
This table contains prefix binding information about assigned IPv6 addresses.

XML structure
<DHCP6>
<DHCP6ServerPDInUse>
<PDInUse>
<PoolIndex></PoolIndex>
<Ipv6Prefix>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
</Ipv6Prefix>
<Type></Type>
<EndLease></EndLease>
<ClientIPv6Address></ClientIPv6Address>
<DUID></DUID>
<IAID></IAID>
<PreferLifetime></PreferLifetime>
<ValidLifetime></ValidLifetime>
</PDInUse>
</DHCP6ServerPDInUse>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerPDInUse

Table type Multi-instance table

Row name PDInUse

Restrictions None

Columns

Column name Column description Column type Data type and restrictions

IPv6 DHCP address pool Unsigned integer.

PoolIndex Index
index Value range: 1 to 1024.

22
 Column name Column description Column type Data type and restrictions
Members include:
Ipv6Prefix Ipv6Prefix Data structure • Ipv6Address
• Ipv6PrefixLength

Ipv6Address IPv6 address prefix Index Hexadecimal string, colon-separated.

Unsigned integer.
Ipv6PrefixLength Length of the IPv6 prefix Index
Value range: 1 to 128.

Enumeration:

• 0—Static(F).
• 1—Static(O).
IPv6 address binding
Type N/A • 2—Static(C)..
types
• 3—Auto(E)
• 4—Auto(O)
• 5—Auto(C)

Time when the lease of

String, case-sensitive.
EndLease the IPv6 address will N/A
Length: 1 to 19 characters.
expire.

ClientIPv6Addres
Client IPv6 address N/A Hexadecimal string, colon-separated.
s

The value is an even

String, case-insensitive.
DUID hexadecimal number in N/A
Length: 2 to 256 characters.
the range of 2 to 256.

The value is a
hexadecimal number in String, case-insensitive.
IAID N/A
the range of 0 to Length: 8 characters.
FFFFFFFF

Preferred lifetime in Unsigned integer.

PreferLifetime N/A
seconds of the IPv6 prefix Value range: 60 to 4294967295.

Valid lifetime in seconds Unsigned integer.

ValidLifetime N/A
of the IPv6 prefix Value range: 60 to 4294967295.

DHCP6/ DHCP6ServerPoolOption
This table contains IPv6 DHCP server pool option information.

23
XML structure
<DHCP6>
<DHCP6ServerPoolOption>
<PoolOption>
<PoolIndex></PoolIndex>
<OptionCode></OptionCode>
<OptionValueHex></OptionValueHex>
</PoolOption>
</DHCP6ServerPoolOption>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerPoolOption

Table type Multi-instance table

Row name PoolOption

Restrictions None

Support for row creation and deletion Yes

Columns

Column name Column description Column type Data type and restrictions

IPv6 DHCP address Unsigned integer.

PoolIndex Index
pool index Value range: 1 to 1024.

Unsigned integer.
OptionCode Number of the option Index
Value range: 21 to 65535

String. case-insensitive.
OptionValueHex Option content N/A
Length: 2 to 256 characters.

DHCP6/DHCP6Vsi
This table contains the VSI configuration of DHCP.

24
XML structure
<DHCP6>
<DHCP6Vsi>
<Vsi>
<VsiName></VsiName>
<FloodProtectionEnable></FloodProtectionEnable>
</Vsi>
</DHCP6Vsi>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6Vsi

Table type Multi-instance table

Row name Vsi

Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions
String, case-sensitive.
VsiName VSI name Index Length: 1 to 31 N/A
characters.

Enabling status of Boolean:

FloodProtectionE
DHCP flood N/A • True N/A
nable
protection • false

25
Contents
DHCP6/dhcp6 ··························································································································· 1

i
DHCP6/dhcp6
Message Explanation
The configuration doesn’t meet the requirements. The configuration doesn’t meet the requirements, please check
当前配置不符合配置要求。 your configuration.

The URL for a file on the TFTP server can’t include

the username or password. Please make certain that the URL for a file on the TFTP server is
not include the username or password.
不要为一个TFTP文件的URL指定用户名和密码。

Invalid filename or URL.

Invalid filename or URL, please check it.
无效的本地文件名或URL。

The URL can’t include the username or password. Please mask certain that the URL is include the username or
不要在URL中携带用户名和密码信息。 password.

The system is saving DHCPv6 server entries to the

backup file. Please wait….
The system is saving DHCPv6 server entries to the backup file.
系统正在将DHCPv6服务器表项写入备份表项的文
件中。请等待。

The system is downloading DHCPv6 server entries

from the backup file. Please wait…. The system is downloading DHCPv6 server entries from the
系统正在从备份表项的文件中恢复DHCPv6服务器 backup file.
表项。请等待。

The static binding already exists in another

DHCPv6 address pool. The static binding already exists in another DHCPv6 address
pool, please try another one.
静态绑定表项已经在配置在其他DHCPv6地址池中。

For a non-temporary IPv6 address range, the

preferred lifetime can’t be longer than the valid
lifetime. Please make certain that for a non-temporary IPv6 address
range, the preferred lifetime isn’t longer than the valid lifetime.
配置非临时IPv6地址范围时，首选生命期要小于等
于有效生命期。

For a temporary IPv6 address range, the preferred

lifetime can’t be longer than the valid lifetime. Please make certain that for a temporary IPv6 address range, the
配置临时IPv6地址范围时，首选生命期要小于等于 preferred lifetime isn’t longer than the valid lifetime.
有效生命期。

For an IPv6 subnet, the preferred lifetime can’t be

longer than the valid lifetime. Please make certain that for an IPv6 subnet, the preferred lifetime
配置IPv6网段地址池时，首选生命期要小于等于有 isn’t longer than the valid lifetime.
效生命期。

For a prefix pool, the preferred lifetime can’t be

longer than the valid lifetime. Please make certain that for a prefix pool, the preferred lifetime
配置引用前缀池时，首选生命期要小于等于有效生 isn’t longer than the valid lifetime.
命期。

In a non-temporary IPv6 address range, the start

IPv6 address can’t be higher than the end IPv6
address. Please make certain that In a non-temporary IPv6 address range,
the start IPv6 address isn’t higher than the end IPv6 address.
配置非临时IPv6地址范围时，起始IPv6地址不能大
于结束IPv6地址。

In a temporary IPv6 address range, the start IPv6 Please make certain that In a temporary IPv6 address range, the

1
address can’t be higher than the end IPv6 address. start IPv6 address isn’t higher than the end IPv6 address.
配置临时IPv6地址范围时，起始IPv6地址不能大于
结束IPv6地址。

DHCPv6 address pool name can’t be changed.

DHCPv6 address pool name can’t be changed.
指定IPv6地址池名称失败。

Another DHCPv6 address pool is using the name. Another DHCPv6 address pool is using the name, please try
其他IPv6地址池正在使用该名字。 another name.

Invalid IPv6 subnet address. Invalid IPv6 subnet address, please check your IPv6 subnet
非法的IPv6网段地址。 address.

Invalid start IPv6 address.

Invalid start IPv6 address, please check it.
非法的起始IPv6地址。

Invalid end IPv6 address.

Invalid end IPv6 address, please check it.
非法的结束IPv6地址。

Invalid IPv6 address.

Invalid IPv6 address, please check it.
非法的IPv6地址。

Non-temporary IPv6 address range and temporary

IPv6 address range can’t overlap. Please make certain that non-temporary IPv6 address range and
非临时IPv6地址范围和临时IPv6地址范围不能互相 temporary IPv6 address range is not overlap.
重叠。

Number of DHCPv6 address pools exceeded the

limit. Number of DHCPv6 address pools exceeded the limit, when the
number of DHCPv6 address pools is greater than 1024.
DHCPv6地址池个数超过上限。

The IPv6 subnet already exists in another DHCPv6

address pool. The IPv6 subnet already exists in another DHCPv6 address pool,
该IPv6网段的地址已经在配置在其他IPv6地址池 please try another subnet.
中。

The DHCPv6 address pool doesn’t exist. The DHCPv6 address pool doesn’t exist, when getting or deleting
该DHCPv6地址池不存在。 it.

Invalid length for the SIP server domain name.

Invalid length for the SIP server domain name, please check it.
SIP服务器的域名长度不符合配置要求。

The option is not configurable.

The option is not configurable, please check your option.
该DHCPv6选项的配置是被禁止的。

The DHCPv6 option group doesn’t exist. The DHCPv6 option group doesn’t exist, when getting or deleting
该DHCPv6选项组不存在。 it.

Number of servers in the DHCPv6 address pool Number of servers in the DHCPv6 address pool exceeded the
exceeded the limit. limit, when the number of servers in the DHCPv6 address pool is
该地址池可配DHCPv6服务器个数已达上限。 greater than 8.

An output interface is required when the DHCPv6

server address is a multicast address or link-local Please make certain that an output interface is required when the
address. DHCPv6 server address is a multicast address or link-local
当DHCPv6服务器地址为组播地址或者链路本地地 address.
址必须指定出接口。

The valid lifetime can’t be shorter than the Please make certain that the valid lifetime isn’t shorter than the
preferred lifetime. preferred lifetime.

2
有效生命期不应小于首选生命期。

Invalid DUID.
Invalid DUID, please check it.
非法的DUID字符串。

Number of statically bound address exceeded the

limit. Number of statically bound address exceeded the limit, when the
number of statically bound address is greater than 8192.
该地址池静态绑定的IPv6地址个数已达上限。

Number of statically bound prefixes exceeded the

limit. Number of statically bound prefixes exceeded the limit, when the
number of statically bound prefixes is greater than 4096.
该地址池静态绑定IPv6地址前缀个数已达上限。

The assigned prefix length can’t be shorter than the

specified prefix length. Please make certain that the assigned prefix length isn’t shorter
than the specified prefix length.
分配的前缀长度不能小于前缀长度。

Difference between the specified prefix length and

the assigned prefix length can’t be greater than 16. Please make certain that the difference between the specified
分配的前缀长度和前缀长度大小差异应该不小于 prefix length and the assigned prefix length isn’t greater than 16.
16。

Prefix pools can’t overlap.

Please make certain that prefix pools isn’t overlap.
前缀池不应该重叠。

Number of DHCPv6 servers on the interface Number of DHCPv6 servers on the interface exceeded the limit,
exceeded the limit. when the number of DHCPv6 servers on the interface is greater
该接口上指定的DHCPv6服务器个数已达上线。 than 8.

Number of VRF exceeded the limit.

Number of VRF exceeded the limit.
VRF个数已达到上限。

Not available.
The Lease is not used.
未使用。

Failed to enable DHCPv6 logging.

DHCPv6 logging is not enabled.
开启DHCPv6日志功能失败。

3
Contents
DHCPC ··························································································1
DHCPC/DHCPCConfig ··············································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCPC/DHCPAlloc ···················································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
DHCPC/DHCPClientID················································································································ 2
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
DHCPC/BootpAlloc ···················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
DHCPC/DHCPCIfConfig ·············································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6

i
DHCPC
DHCPC/DHCPCConfig
This table contains DHCP client configuration information.

XML structure
<DHCPC>
<DHCPCConfig>
<DadEnable></DadEnable>
<DSCP></DSCP>
</DHCPCConfig>
</DHCPC>

Table description
Item Description
Feature name DHCPC
Table name DHCPCConfig
Table type Single-instance table
Row name N/A
Restrictions None
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Whether the
function of Boolean:
DadEnable duplicated N/A • true (default) N/A
address detection • false
is enabled
Set the DSCP Unsigned integer. A bigger DSCP value
value for DHCP
DSCP N/A Value range: 0 to 63. represents a higher
packets sent by
Default: 56. priority.
the DHCP client

DHCPC/DHCPAlloc
This table contains the information about using DHCP for IP address acquisition.

1
XML structure
<DHCPC>
<DHCPAlloc>
<Alloc>
<IfIndex></IfIndex>
<AllocEnable></AllocEnable>
</Alloc>
</DHCPAlloc>
</DHCPC>

Table description
Item Description
Feature name DHCPC
Table name DHCPAlloc
Table type Multi-instance table
Row name Alloc
Restrictions This table supports only Layer 3 interfaces.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
Some versions support
interface name. For
relevant information,
IfIndex Interface index. Index Unsigned integer. see the XSD document
of your product. For
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.
Whether the
function of the
interface to use Boolean:
AllocEnable DHCP for IP N/A • true N/A
address • false (default)
acquisition is
enabled

DHCPC/DHCPClientID
This table contains DHCP client ID configuration information.

2
XML structure
<DHCPC>
<DHCPClientID>
<ClientID>
<IfIndex></IfIndex>
<ASCII></ASCII>
<Hex></Hex>
<ClientIfIndex></ClientIfIndex>
</ClientID>
</DHCPClientID>
</DHCPC>

Table description
Item Description
Feature name DHCPC
Table name DHCPClientID
Table type Multi-instance table
Row name ClientID
Restrictions This table supports only Layer 3 interfaces.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
Some versions support
interface name. For
relevant information,
IfIndex Interface index. Index Unsigned integer. see the XSD document
of your product. For
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.
String, case-insensitive.
This column cannot be
Length: 1 to 63
DHCP Client ID in configured with Hex
ASCII N/A characters.
ASCII code type column or ClientIfIndex
The string must be column together.
ASCII string.

3
 Column Column Data type and
Column name Remarks
description type restrictions
Hexadecimal string. This column cannot be
DHCP Client ID in configured with ASCII
Hex N/A Length: 4 to 64
hex code type column or ClientIfIndex
characters. column together.
Only Layer 3 interfaces
Uses the MAC are supported.
address of This column cannot be
ClientIfIndex N/A Unsigned integer.
interface as a configured with ASCII
DHCP client ID column or Hex column
together.

DHCPC/BootpAlloc
This table contains the information about using BOOTP for IP address acquisition.

XML structure
<DHCPC>
<BootpAlloc>
<Alloc>
<IfIndex></IfIndex>
<AllocEnable></AllocEnable>
</Alloc>
</BootpAlloc>
</DHCPC>

Table description
Item Description
Feature name DHCPC
Table name BootpAlloc
Table type Multi-instance table
Row name Alloc
Restrictions This table supports only Layer 3 interfaces.
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
IfIndex Interface index. Index Unsigned integer.
Some versions support
interface name. For

4
 Column Column Data type and
Column name Remarks
description type restrictions
relevant information,
see the XSD document
of your product. For
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.
Whether the
function of the
interface to use Boolean:
AllocEnable BOOTP for IP N/A • true N/A
address • false (default)
acquisition is
enabled

DHCPC/DHCPCIfConfig
This table contains DHCP client configuration information on interface.

XML structure
<DHCPC>
<DHCPCIfConfig>
<IfConfigure>
<IfIndex></IfIndex>
<TrackID></TrackID>
<Priority></Priority>
</IfConfigure>
</DHCPCIfConfig>
</DHCPC>

Table description
Item Description
Feature name DHCPC
Table name DHCPCIfConfig
Table type Multi -instance table
Row name IfConfigure
Restrictions None
Support for row creation and deletion No

5
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
Some versions support
interface name. For
related information, see
IfIndex Interface index Index Unsigned integer. the XSD document of
your product. For
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.
Unsigned integer. No track number is set
TrackID Track number N/A
Value range: 1 to 1024. by default.

Unsigned integer.
Priority of the The greater the value,
Priority N/A Value range: 1 to 255.
gateway the higher the priority.
Default: 70.

6
Contents
DHCPC ··························································································1
DHCPC/DHCPCConfig ··············································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCPC/DHCPAlloc ···················································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
DHCPC/DHCPClientID················································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
DHCPC/BootpAlloc ···················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5
DHCPC/DHCPCIfConfig ·············································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6

i
DHCPC
DHCPC/DHCPCConfig
This table contains DHCP client configuration information.

XML structure
<DHCPC>
<DHCPCConfig>
<DadEnable></DadEnable>
<DSCP></DSCP>
</DHCPCConfig>
</DHCPC>

Table description
Item Description
Feature name DHCPC
Table name DHCPCConfig
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Whether the
function of Boolean:
DadEnable duplicated N/A • true N/A
address detection • false
is enabled
Set the DSCP
Unsigned integer. A bigger DSCP value
value for DHCP
DSCP N/A represents a higher
packets sent by Value range: 0 to 63 priority.
the DHCP client

DHCPC/DHCPAlloc
This table contains the information about using DHCP for IP address acquisition.

1
XML structure
<DHCPC>
<DHCPAlloc>
<Alloc>
<IfIndex></IfIndex>
<AllocEnable></AllocEnable>
<CurrentState></CurrentState>
<AllocatedIpv4Address></AllocatedIpv4Address>
<AllocatedIpv4Mask></AllocatedIpv4Mask>
<DHCPServerIpv4Address></DHCPServerIpv4Address>
<Allocatedlease></Allocatedlease>
<T1></T1>
<T2></T2>
</Alloc>
</DHCPAlloc>
</DHCPC>

Table description
Item Description
Feature name DHCPC
Table name DHCPAlloc
Table type Multi-instance table
Row name Alloc
Restrictions This table supports only Layer 3 interfaces.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
Some versions support
interface name. For
related information, see
IfIndex Interface index. Index Unsigned integer. the XSD document of
your product. For
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.
Whether the
function of the Boolean:
interface to use
AllocEnable N/A • true N/A
DHCP for IP
address • false
acquisition is

2
 Column Column Data type and
Column name Remarks
description type restrictions
enabled
Enumeration:
• 1—HALT.
• 2—INIT.
• 3—SELECTING.
CurrentState
Current state of
N/A • 4—REQUESTING N/A
the DHCP client .
• 5—BOUND.
• 6—RENEWING.
• 7—REBOUNDING
.
IPv4 address
AllocatedIpv4Add String, dotted decimal
allocated by the N/A N/A
ress notation.
DHCP server
IPv4 address
AllocatedIpv4Mas String, dotted decimal
mask allocated by N/A N/A
k notation.
the DHCP server
IPv4 address of
DHCPServerIpv4 the DHCP server String, dotted decimal
N/A N/A
Address that assigned IP notation.
addresses
Lease time (in
Allocatedlease seconds) for the N/A Unsigned integer. N/A
allocated address
1/2 lease time (in
T1 seconds) for the N/A Unsigned integer. N/A
allocated address
7/8 lease time (in
T2 seconds) for the N/A Unsigned integer. N/A
allocated address

DHCPC/DHCPClientID
This table contains DHCP client ID configuration information.

XML structure
<DHCPC>
<DHCPClientID>
<ClientID>
<IfIndex></IfIndex>
<ASCII></ASCII>
<Hex></Hex>
<ClientIfIndex></ClientIfIndex>
</ClientID>
</DHCPClientID>
</DHCPC>

3
Table description
Item Description
Feature name DHCPC
Table name DHCPClientID
Table type Multi-instance table
Row name ClientID
Restrictions This table supports only Layer 3 interfaces.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
Some versions support
interface name. For
related information, see
IfIndex Interface index. Index Unsigned integer. the XSD document of
your product. For
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.
String, case-insensitive.
This column cannot be
Length: 1 to 63
DHCP Client ID in configured with Hex
ASCII N/A characters.
ASCII code type column or ClientIfIndex
The string must be column together.
ASCII string.

Hexadecimal string. This column cannot be

DHCP Client ID in configured with ASCII
Hex N/A Length: 4 to 64
hex code type column or ClientIfIndex
characters. column together.
Only Layer 3 interfaces
Uses the MAC are supported.
address of This column cannot be
ClientIfIndex N/A Unsigned integer.
interface as a configured with ASCII
DHCP client ID column or Hex column
together.

DHCPC/BootpAlloc
This table contains the information about using BOOTP for IP address acquisition.

XML structure
<DHCPC>
<BootpAlloc>

4
 <Alloc>
<IfIndex></IfIndex>
<AllocEnable></AllocEnable>
<AllocatedIpv4Address></AllocatedIpv4Address>
<AllocatedIpv4Mask></AllocatedIpv4Mask>
<MacAddress></MacAddress>
</Alloc>
</BootpAlloc>
</DHCPC>

Table description
Item Description
Feature name DHCPC
Table name BootpAlloc
Table type Multi-instance table
Row name Alloc
Restrictions This table supports only Layer 3 interfaces.

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
Some versions support
interface name. For
related information, see
IfIndex Interface index. Index Unsigned integer. the XSD document of
your product. For
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.
Whether the
function of the
interface to use Boolean:
AllocEnable BOOTP for IP N/A • true N/A
address • false
acquisition is
enabled
IPv4 address
AllocatedIpv4Add String, dotted decimal
allocated by the N/A N/A
ress notation.
BOOTP server
IPv4 address
AllocatedIpv4Mas String, dotted decimal
mask allocated by N/A N/A
k notation.
the BOOTP server

MacAddress N/A Six groups of two N/A

MAC address of hexadecimal digits,

5
 Column Column Data type and
Column name Remarks
description type restrictions
a BOOTP client hyphen-separated.

DHCPC/DHCPCIfConfig
This table contains DHCP client configuration information on interfaces.

XML structure
<DHCPC>
<DHCPCIfConfig>
<IfConfigure>
<IfIndex></IfIndex>
<TrackID></TrackID>
<Priority></Priority>
<NextHop></NextHop>
</IfConfigure>
</DHCPCIfConfig>
</DHCPC>

Table description
Item Description
Feature name DHCPC
Table name DHCPCIfConfig
Table type Multi -instance table
Row name IfConfigure
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Only Layer 3 interfaces
are supported.
Some versions support
interface name. For
related information, see
IfIndex Interface index Index Unsigned integer. the XSD document of
your product. For
information about
IfIndex, see “Appendix”
in Ifmgr NETCONF XML
API Configuration
Reference.
No track number is set
TrackID Track number N/A Unsigned integer.
by default.

6
 Column Column Data type and
Column name Remarks
description type restrictions
Value range: 1 to 1024.
Unsigned integer.
Priority of the The greater the value,
Priority N/A Value range: 1 to 255.
gateway the higher the priority.
Default: 70.
IP address of the String, dotted decimal
NextHop N/A N/A
next hop notation.

7
Contents
DHCP/dhcpc ····························································································································· 1

i
DHCP/dhcpc
Message Explanation
The configuration doesn’t meet the requirements. The configuration doesn’t meet the requirements, please check
当前配置不符合配置要求。 your configuration.

Invalid client ID.

Invalid client ID, please check your client ID.
非法的客户端ID。

1
Contents
DHCPC6 ························································································1
DHCPC6/DHCPC6Config ············································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCPC6/DHCP6Alloc ················································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
DHCPC6/DHCP6PrefixDelegation ································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
DHCPC6/DHCP6Stateless··········································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5

i
DHCPC6
DHCPC6/DHCPC6Config
This table contains DHCPv6 client configuration information.

XML structure
<DHCPC6>
<DHCPC6Config>
<DSCP></DSCP>
</DHCPC6Config>
</DHCPC6>

Table description
Item Description
Feature name DHCPC6
Table name DHCPC6Config
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Set DSCP value Unsigned integer. A bigger DSCP value
for DHCPv6
DSCP N/A Value range: 0 to 63. represents a higher
packets sent by
Default: 56. priority.
the DHCPv6 client

DHCPC6/DHCP6Alloc
This table contains the information about using DHCPv6 for IPv6 address acquisition.

XML structure
<DHCPC6>
<DHCP6Alloc>
<Alloc>
<IfIndex></IfIndex>

1
 <AllocEnable></AllocEnable>
<OptionGroup></OptionGroup>
<RapidCommit></RapidCommit>
</Alloc>
</DHCP6Alloc>
</DHCPC6>

Table description
Item Description
Feature name DHCPC6
Table name DHCP6Alloc
Table type Multi-instance table
Row name Alloc
This table supports interface types:
Layer 3 Ethernet interface/subinterface view
Restrictions
Layer 3 aggregate interface/subinterface view
VLAN interface view
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.
Whether the
function of the
interface to use Boolean:
AllocEnable DHCPv6 for IPv6 N/A • true N/A
address • false (default)
acquisition is
enabled
Enables the
DHCPv6 client to DHCPv6 client does not
create a dynamic create any dynamic
DHCPv6 option DHCPv6 option groups
Unsigned integer.
OptionGroup group for saving N/A as default.
the configuration Value range: 1 to 100.
This column is available
parameters, and when the AllocEnable
assigns an ID to column is true.
the option group

2
 Column Column Data type and
Column name Remarks
description type restrictions
Whether rapid Boolean: This column is available
address or prefix
RapidCommit
assignment is
N/A • true when the AllocEnable
• false (default) column is true.
supported

DHCPC6/DHCP6PrefixDelegation
This table contains the information about using DHCPv6 for IPv6 prefix acquisition.

XML structure
<DHCPC6>
<DHCP6PrefixDelegation>
<PrefixDelegation>
<IfIndex></IfIndex>
<PrefixNumber></PrefixNumber>
<OptionGroup></OptionGroup>
<RapidCommit></RapidCommit>
</PrefixDelegation>
</DHCP6PrefixDelegation>
</DHCPC6>

Table description
Item Description
Feature name DHCPC6
Table name DHCP6PrefixDelegation
Table type Multi-instance table
Row name PrefixDelegation
This table supports interface types:
Layer 3 Ethernet interface/subinterface view
Restrictions
Layer 3 aggregate interface/subinterface view
VLAN interface view
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
IfIndex Interface index. Index Unsigned integer. relevant information,
see the XSD document
of your product. For

3
 Column Column Data type and
Column name Remarks
description type restrictions
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.
No prefix ID as default.
Unsigned integer. After obtaining an IPv6
PrefixNumber IPv6 prefix ID N/A
Value range: 1 to 1024. prefix, the client assigns
the ID to the IPv6 prefix.
Enables the
DHCPv6 client to DHCPv6 client does not
create a dynamic create any dynamic
DHCPv6 option DHCPv6 option groups
Unsigned integer.
OptionGroup group for saving N/A as default.
the configuration Value range: 1 to 100.
This column is available
parameters, and when the PrefixNumber
assigns an ID to column is set.
the option group
Whether rapid Boolean: This column is available
address or prefix
RapidCommit
assignment is
N/A • true when the PrefixNumber
• false (default) column is set.
supported

DHCPC6/DHCP6Stateless
This table contains stateless DHCPv6 configuration information.

XML structure
<DHCPC6>
<DHCP6Stateless>
<Stateless>
<IfIndex></IfIndex>
<StatelessEnable></StatelessEnable>
</Stateless>
</DHCP6Stateless>
</DHCPC6>

Table description
Item Description
Feature name DHCPC6
Table name DHCP6Stateless
Table type Multi-instance table
Row name Stateless
This table supports interface types:
Restrictions
Layer 3 Ethernet interface/subinterface view

4
 Layer 3 aggregate interface/subinterface view
VLAN interface view
Support for row creation and deletion No

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.
Whether the Boolean:
function of
StatelessEnable
stateless DHCPv6
N/A • true N/A
is enabled • false (default)

5
Contents
DHCPC6 ························································································1
DHCPC6/DHCPC6Config ············································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCPC6/DHCP6Alloc ················································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
DHCPC6/DHCP6PrefixDelegation ································································································· 2
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
DHCPC6/DHCP6Stateless··········································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
DHCPC6/DHCP6ClientInfo ·········································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6

i
DHCPC6
DHCPC6/DHCPC6Config
This table contains DHCPv6 client configuration information.

XML structure
<DHCPC6>
<DHCPC6Config>
<DSCP></DSCP>
</DHCPC6Config>
</DHCPC6>

Table description
Item Description
Feature name DHCPC6
Table name DHCPC6Config
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Set DSCP value
Unsigned integer. A bigger DSCP value
for DHCPv6
DSCP N/A represents a higher
packets sent by Value range: 0 to 63. priority.
the DHCPv6 client

DHCPC6/DHCP6Alloc
This table contains the information about using DHCPv6 for IPv6 address acquisition.

XML structure
<DHCPC6>
<DHCP6Alloc>
<Alloc>
<IfIndex></IfIndex>
<AllocEnable></AllocEnable>

1
 <OptionGroup></OptionGroup>
<RapidCommit></RapidCommit>
</Alloc>
</DHCP6Alloc>
</DHCPC6>

Table description
Item Description
Feature name DHCPC6
Table name DHCP6Alloc
Table type Multi-instance table
Row name Alloc
This table supports interface types:
Layer 3 Ethernet interface/subinterface view
Restrictions
Layer 3 aggregate interface/subinterface view
VLAN interface view

Columns
Column Column Data type and
Column name Remarks
description type restrictions
IfIndex Interface index. Index Unsigned integer. N/A
Whether the
function of the
interface to use Boolean:
AllocEnable DHCPv6 for IPv6 N/A • true N/A
address • false
acquisition is
enabled
Enables the
DHCPv6 client to
create a dynamic
DHCPv6 option Unsigned integer. This column is available
OptionGroup group for saving N/A when the AllocEnable
the configuration Value range: 1 to 100. column is true.
parameters, and
assigns an ID to
the option group
Whether rapid Boolean: This column is available
address or prefix
RapidCommit
assignment is
N/A • true when the AllocEnable
• false column is true.
supported

DHCPC6/DHCP6PrefixDelegation
This table contains the information about using DHCPv6 for IPv6 prefix acquisition.

2
XML structure
<DHCPC6>
<DHCP6PrefixDelegation>
<PrefixDelegation>
<IfIndex></IfIndex>
<PrefixNumber></PrefixNumber>
<OptionGroup></OptionGroup>
<RapidCommit></RapidCommit>
</PrefixDelegation>
</DHCP6PrefixDelegation>
</DHCPC6>

Table description
Item Description
Feature name DHCPC6
Table name DHCP6PrefixDelegation
Table type Multi-instance table
Row name PrefixDelegation
This table supports interface types:
Layer 3 Ethernet interface/subinterface view
Restrictions
Layer 3 aggregate interface/subinterface view
VLAN interface view

Columns
Column Column Data type and
Column name Remarks
description type restrictions
IfIndex Interface index. Index Unsigned integer. N/A

Unsigned integer. After obtaining an IPv6

PrefixNumber IPv6 prefix ID N/A prefix, the client assigns
Value range: 1 to 1024. the ID to the IPv6 prefix.

3
 Column Column Data type and
Column name Remarks
description type restrictions
Enables the
DHCPv6 client to
create a dynamic
DHCPv6 option Unsigned integer. This column is available
OptionGroup group for saving N/A when the PrefixNumber
the configuration Value range: 1 to 100. column is set.
parameters, and
assigns an ID to
the option group
Whether rapid Boolean: This column is available
address or prefix
RapidCommit
assignment is
N/A • true when the PrefixNumber
• false column is set.
supported

DHCPC6/DHCP6Stateless
This table contains stateless DHCPv6 configuration information.

XML structure
<DHCPC6>
<DHCP6Stateless>
<Stateless>
<IfIndex></IfIndex>
<StatelessEnable></StatelessEnable>
</Stateless>
</DHCP6Stateless>
</DHCPC6>

Table description
Item Description
Feature name DHCPC6
Table name DHCP6Stateless
Table type Multi-instance table
Row name Stateless
This table supports interface types:
Layer 3 Ethernet interface/subinterface view
Restrictions
Layer 3 aggregate interface/subinterface view
VLAN interface view

4
Columns
Column Column Data type and
Column name Remarks
description type restrictions
IfIndex Interface index. Index Unsigned integer. N/A
Whether the Boolean:
function of
StatelessEnable
stateless DHCPv6
N/A • true N/A
is enabled • false

DHCPC6/DHCP6ClientInfo
This table contains DHCPv6 client information.

XML structure
<DHCPC6>
<DHCP6ClientInfo>
<ClientInfo>
<IfIndex></IfIndex>
<Type></Type>
<State></State>
<IAID></IAID>
<ClientDUID></ClientDUID>
<ReachableViaIpv6Address></ReachableViaIpv6Address>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
<DNSServer></DNSServer>
<DomainName></DomainName>
<PreferredLifetime></PreferredLifetime>
<ValidLifetime></ValidLifetime>
<T1></T1>
<T2></T2>
</ClientInfo>
</DHCP6ClientInfo>
</DHCPC6>

Table description
Item Description
Feature name DHCPC6
Table name DHCP6ClientInfo
Table type Multi-instance table
Row name ClientInfo
This table supports interface types:
Restrictions
Layer 3 Ethernet interface/subinterface view

5
 Layer 3 aggregate interface/subinterface view
VLAN interface view

Columns
Column Column Data type and
Column name Remarks
description type restrictions
IfIndex Interface index. Index Unsigned integer. N/A
Enumeration:
• 0—Stateless
client.
Type
Types of DHCPv6
Index • 1—Stateful client N/A
client requesting prefix.
• 2—Stateful client
requesting
address.
Enumeration:
• 0—IDLE.
• 1—SOLICIT.
• 2—REQUEST.
• 3—OPEN.
Current states of
State
the DHCPv6 client
N/A • 4—RENEW. N/A
• 5—REBIND.
• 6—RELEASE.
• 7—DECLINE.
• 8—INFO-REQUE
STING.
Hexadecimal string.
IAID IA identifier N/A Length: 1 to 10 N/A
characters.
Hexadecimal string.
DUID of the
ClientDUID N/A Length: 4 to 64 N/A
DHCPv6 client
characters.
Reachable
address for the
DHCPv6 client. It
ReachableViaIpv is the link local Hexadecimal string,
N/A N/A
6Address address of the colon-separated.
DHCPv6 server or
DHCPv6 relay
agent
This column is not
IPv6 address Hexadecimal string, available when the
Ipv6Address N/A
obtained. colon-separated. DHCPv6 client type is
Stateless client.
This column is not
IPv6 prefix Unsigned integer. available when the
Ipv6PrefixLength N/A
length obtained. Value range: 1 to 128. DHCPv6 client type is
Stateless client.
IPv6 address of Seperated by space if
DNSServer N/A String, case insensitive.
the DNS server there are multiple

6
 Column Column Data type and
Column name Remarks
description type restrictions
addresses.
Example:
1::1 2::2 3::3.
String, case insensitive.
DomainName Domain name N/A N/A
Length: 1 to 50
suffix
characters.
Preferred lifetime
PreferredLifetime N/A Unsigned integer. N/A
in seconds
Valid lifetime in
ValidLifetime N/A Unsigned integer. N/A
seconds
T1 time value in
T1 N/A Unsigned integer. N/A
seconds
T2 time value in
T2 N/A Unsigned integer. N/A
seconds

7
Contents
DHCP/dhcpc6 ··························································································································· 1

i
DHCP/dhcpc6
Message Explanation
The configuration doesn’t meet the requirements.
The configuration doesn’t meet the requirements, please check it.
当前配置不符合配置要求。

Another interface is using the IPv6 prefix ID. Another interface is using the IPv6 prefix ID, please try another
其它接口已经使用这个IPv6前缀号。 one.

1
Contents
DHCPSP ························································································1
DHCPSP/DHCPSPUpdateBindingDatabase ···················································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCPSP/DHCPSPClearBinding ··································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2

i
DHCPSP
DHCPSP/DHCPSPUpdateBindingDatabase
This table is used to save current DHCP snooping entries to the file.

XML structure
<DHCPSP>
<DHCPSPUpdateBindingDatabase>
<Update></Update>
</DHCPSPUpdateBindingDatabase>
</DHCPSP>

Table description
Item Description
Feature name DHCPSP
Table name DHCPSPUpdateBindingDatabase
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Update DHCP
snooping This column must be
Update N/A String.
database empty.
immediately

DHCPSP/DHCPSPClearBinding
This table is used to clear DHCP snooping entries.

XML structure
<DHCPSP>
<DHCPSPClearBinding>
<ClearBinding>
<Ipv4Address></Ipv4Address>
<VLANID></VLANID>

1
 </ClearBinding>
</DHCPSPClearBinding>
</DHCPSP>

Table description
Item Description
Feature name DHCPSP
Table name DHCPSPUpdateBindingDatabase
Table type Multi-instance table
Row name ClearBinding
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
If Ipv4Address is empty,
String, dotted decimal
Ipv4Address IPv4 address Index clears all DHCP
notation.
snooping entries.
If VLANID is empty,
Unsigned integer. clears the DHCP
VLANID VLAN ID Index snooping entry for the
Value range: 1 to 4094. specified IP address in
all Vlan.

2
Contents
DHCPSP ························································································1
DHCPSP/DHCPSPBindingDatabase ······························································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
DHCPSP/DHCPSPInterface··········································································································· 2
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
DHCPSP/DHCPSPOpt82CircuitIDVLAN ·························································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 5
DHCPSP/DHCPSPOpt82RemoteIDVLAN ························································································ 6
XML structure ······················································································································· 6
Table description ··················································································································· 7
Columns ······························································································································ 7
DHCPSP/DHCPSPOpt82 ·············································································································· 8
XML structure ······················································································································· 8
Table description ··················································································································· 9
Columns ······························································································································ 9
DHCPSP/DHCPSPConfig············································································································ 12
XML structure ····················································································································· 12
Table description ················································································································· 13
Columns ···························································································································· 13
DHCPSP/DHCPSPEthernetServiceInstance ··················································································· 13
XML structure ····················································································································· 13
Table description ················································································································· 14
Columns ···························································································································· 14
DHCPSP/DHCPSPVsi ················································································································ 15
XML structure ····················································································································· 15
Table description ················································································································· 15
Columns ···························································································································· 15

i
DHCPSP
DHCPSP/DHCPSPBindingDatabase
This table contains DHCP snooping binding database configuration information.

XML structure
<DHCPSP>
<DHCPSPBindingDatabase>
<FileName></FileName>
<URL></URL>
<Username></Username>
<Password></Password>
<UpdateInterval></UpdateInterval>
</DHCPSPBindingDatabase>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPBindingDatabase

Table type Single-instance table

Row name None

Restrictions None

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
For the merge, create
String, case-insensitive. and replace operations,
Database file
FileName N/A Length: 1 to 255 FileName and URL
name
characters. cannot be configured
simultaneously.

1
 Column Column Data type and
Column name Remarks
description type restrictions
Specifies the URL of a
remote file. Do not
include a username or
password in the URL.
Case sensitivity and the
String. case sensitive. supported format type of
URL Object URL string N/A Length: 1 to 255 the path depend on the

characters. server.

If URL is configured for

the delete and remove
operations, Username
and Password will be
removed automatically.

String. case sensitive. Cannot be configured

Username FTP username N/A Length: 1 to 32 for the delete and
characters. remove operations.

Only plaintext password

is supported.

For the merge, create

and replace operations,
String. case sensitive.
Password must be
Password FTP password N/A Length: 1 to 32
configured with
characters.
Username.

Cannot be configured
for the delete and
remove operations.

Unsigned integer.

Auto update Value range: 60 to

UpdateInterval N/A N/A
interval 864000 seconds.

Default: 300 seconds.

DHCPSP/DHCPSPInterface
This table contains the configuration information on interface about using DHCP snooping.

2
XML structure
<DHCPSP>
<DHCPSPInterface>
<Interface>
<IfIndex></IfIndex>
<BindingRecord></BindingRecord>
<CheckMacAddress></CheckMacAddress>
<CheckRequestMessage></CheckRequestMessage>
<Trust></Trust>
<LearnMaxNum></LearnMaxNum>
<RateLimitNum></RateLimitNum>
</Interface>
</DHCPSPInterface>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPInterface

Table type Multi-instance table

Row name Interface

This table supports interface types:

Layer 2 Ethernet interface/Layer 2 aggregate interface

Restrictions Layer 3 Ethernet interface/subinterface

Layer 3 aggregate interface/aggregate subinterface

S-channel interface/S-channel aggregate interface

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
IfIndex Interface index Index Unsigned integer.
relevant information,
see the XSD document

3
 Column Column Data type and
Column name Remarks
description type restrictions
of your product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Whether enable
the interface to Boolean: Applicable to only Layer
BindingRecord record DHCP N/A • true 2 interfaces of the
snooping entry or • false (default) Restrictions.
not.

Whether enable
the interface to Boolean:
CheckMacAddres
check MAC N/A • true N/A
s
address in DHCP • false(default)
packets or not.

Whether enable
the interface to Boolean: Applicable to only Layer
CheckRequestMe
check request N/A • true 2 interfaces of the
ssage
message in DHCP • false (default) Restrictions.
packets or not.

Whether to
Boolean:
configure an
Trust N/A • true N/A
interface as a
• false (default)
trusted interface.

The maximum
number of DHCP Unsigned integer.
No limit as default.
LearnMaxNum snooping entries N/A Value range: 0 to
0 means No limit.
for an interface to 4294967295.
learn

Values of
RateLimitMinNum and
The maximum
Unsigned integer. RateLimitMaxNum
rate for an
Value range: 0, depend on the device
RateLimitNum interface to N/A
RateLimitMinNum to model.
receive DHCP
RateLimitMaxNum. Applicable to only Layer
packets, in Kbps
2 interfaces of the
Restrictions.

4
 Column Column Data type and
Column name Remarks
description type restrictions
No limit as default.

0 means No limit.

DHCPSP/DHCPSPOpt82CircuitIDVLAN
This table contains DHCP snooping option 82 circuit ID with VLAN configuration information.

XML structure
<DHCPSP>
<DHCPSPOpt82CircuitIDVLAN>
<VLANCircuitID>
<IfIndex></IfIndex>
<VLANID></VLANID>
<CircuitID></CircuitID>
</VLANCircuitID>
</DHCPSPOpt82CircuitIDVLAN>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPOpt82CircuitIDVLAN

Table type Multi-instance table

Row name VLANCircuitID

Restrictions This table supports only Layer 2 interfaces.

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Only Layer 2 interfaces
IfIndex Interface index. Index Unsigned integer.
are supported.

5
 Column Column Data type and
Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Unsigned integer.
VLANID VLAN ID Index N/A
Value range: 1 to 4094.

For the merge, create

and replace operations,
the CircuitID must be
String, case-insensitive.
Option82 circuit ID configured.
CircuitID N/A Length: 3 to 63
string For the remove and
characters.
delete operations, the
CircuitID cannot be
configured.

DHCPSP/DHCPSPOpt82RemoteIDVLAN
This table contains DHCP snooping option 82 remote ID with VLAN configuration information.

XML structure
<DHCPSP>
<DHCPSPOpt82RemoteIDVLAN>
<VLANRemoteID>
<IfIndex></IfIndex>
<VLANID></VLANID>
<RemoteID></RemoteID>
<Sysname></Sysname>
</VLANRemoteID>
</DHCPSPOpt82RemoteIDVLAN>
</DHCPSP>

6
Table description

Item Description
Feature name DHCPSP

Table name DHCPSPOpt82RemoteIDVLAN

Table type Multi-instance table

Row name VLANRemoteID

Restrictions This table supports only Layer 2 interfaces.

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Only Layer 2 interfaces
are supported.

Some versions support

interface name. For
relevant information,
see the XSD document
IfIndex Interface index. Index Unsigned integer.
of your product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Unsigned integer.
VLANID VLAN ID Index N/A
Value range: 1 to 4094.

For the merge, create

String, case-insensitive. and replace operations,

the RemoteID and
Length: 1 to 63
Option82 remote Sysname cannot be
RemoteID N/A characters.
ID string configured
The string must be simultaneously and
ASCII string. RemoteID or Sysname
must be configured.

7
 Column Column Data type and
Column name Remarks
description type restrictions
Cannot be configured
for the delete and
remove operations.

For the merge, create

and replace operations,
the RemoteID and
Whether the Sysname cannot be
function of system Boolean: configured
Sysname name fix in option N/A • true simultaneously and
82 remote ID is RemoteID or Sysname
• false (default)
used. must be configured.

Cannot be configured
for the delete and
remove operations.

DHCPSP/DHCPSPOpt82
This table contains DHCP snooping option 82 configuration information.

XML structure
<DHCPSP>
<DHCPSPOpt82>
<Option82>
<IfIndex></IfIndex>
<Option82Enable></Option82Enable>
<Strategy></Strategy>
<Circuit>
<CircuitID></CircuitID>
<CircuitIDMode></CircuitIDMode>
<CircuitIDNodeIDType></CircuitIDNodeIDType>
<CircuitIDNodeID></CircuitIDNodeID>
<CircuitIDFormat></CircuitIDFormat>
</Circuit>
<Remote>
<RemoteIDMode></RemoteIDMode>
<RemoteID></RemoteID>
<RemoteIDFormat></RemoteIDFormat>
</Remote>
</Option82>
</DHCPSPOpt82>

8
 </DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPOpt82

Table type Multi-instance table

Row name Option82

Restrictions This table supports only Layer 2 interfaces.

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Whether enable
theDHCP Boolean:
Option82Enable snooping to N/A • true. N/A
support Option 82 • false (default)
or not.

Enumeration:

• 0—Drop.
Option 82 strategy
Strategy N/A • 1—Keep. N/A
type
• 2—Replace
(default).

Circuit The configuration Data Members include: N/A

9
 Column Column Data type and
Column name Remarks
description type restrictions
of Circuit ID structure • CircuitID
sub-option • CircuitIDMode
• CircuitIDNodeIDTy
pe

• CircuitIDNodeID
• CircuitIDFormat

For the merge, create

and replace operations,
String. case insensitive. the CircuitID must be
Circuit ID user
CircuitID N/A Length: 3 to 63 configured if
defined string
characters. CircuitIDMode is 2 and
can't be configured if
CircuitIDMode is 0 or 1.

It must be configured
together with the
CircuitIDFormat.
Enumeration:
If CircuitIDMode is
• 0—Normal configured for the
CircuitIDMode Circuit ID mode N/A (default). remove and delete
• 1—Verbose. operations, CircuitID,
• 2—User-defined. CircuitIDNodeIDType
and CircuitIDNodeID will
be removed
automatically.

If CircuitIDNodeIDType
is configured for the
remove and delete
operations,
CircuitIDNodeID will be
Enumeration:
Circuit IP removed automatically.
CircuitIDNodeIDT • 0—Mac (default).
node-identifier N/A For the merge, create
ype • 1—Sysname.
type and replace operations,
• 2—User-defined.
the
CircuitIDNodeIDType
can be configured only
when CircuitIDMode is
1.

CircuitIDNodeID Circuit ID N/A String. case insensitive. For the merge, create

10
 Column Column Data type and
Column name Remarks
description type restrictions
node-identifier Length: 1 to 50 and replace operations,
user defined string characters. the CircuitIDNodeID
must be configured if
CircuitIDNodeIDType is
2 and can't be
configured if
CircuitIDNodeIDType is
0 or 1.

It must be configured
together with the
CircuitIDMode.

CircuitIDFormat must be
1 if CircuitIDMode is 2.

The default
CircuitIDFormat is Hex
Enumeration: when CircuitIDMode is
Circuit ID format • 0—Hex. Normal;
CircuitIDFormat N/A
type • 1—Ascii. The default
• 2—Undefined. CircuitIDFormat is
Undefined when
CircuitIDMode is
Verbose;

The default
CircuitIDFormat is Ascii
when CircuitIDMode is
User-defined.

Members include:
The configuration
Data • RemoteIDMode
Remote of Remote ID N/A
structure • RemoteID
sub-option
• RemoteIDFormat

It must be configured
together with the
Enumeration:
RemoteIDFormat.
• 0—Normal
(default). If RemoteIDMode is
RemoteIDMode Remote ID mode N/A
configured for the
• 1—Sysname.
remove and delete
• 2—User-defined.
operations, RemoteID
will be removed

11
 Column Column Data type and
Column name Remarks
description type restrictions
automatically.

For the merge, create

and replace operations,
the RemoteID must be
String. case insensitive.
Remote ID user configured if
RemoteID N/A Length: 1 to 63
defined string RemoteIDMode is 2 and
characters.
can't be configured if
RemoteIDMode is 0 or
1.

It must be configured
together with the
RemoteIDMode.

RemoteIDFormat must
be 1 if RemoteIDMode
is 1 or 2.

Enumeration: The default

Remote ID format RemoteIDFormat is Hex
RemoteIDFormat N/A • 0—Hex.
type when RemoteIDMode is
• 1—Ascii.
Normal;

The default
RemoteIDFormat is
Ascii when
CircuitIDMode is
Sysname or
User-defined;

DHCPSP/DHCPSPConfig
This table contains DHCP snooping configuration information.

XML structure
<DHCPSP>
<DHCPSPConfig>
<DHCPSPEnable></DHCPSPEnable>
</DHCPSPConfig>
</DHCPSP>

12
Table description

Item Description
Feature name DHCPSP

Table name DHCPSPConfig

Table type Single-instance table

Row name N/A

Restrictions None

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Whether the
Boolean:
function of DHCP
DHCPSPEnable N/A • true. N/A
snooping is
• false (default)
enabled.

DHCPSP/DHCPSPEthernetServiceInstance
This table contains the Ethernet service instance configuration information of DHCP snooping.

XML structure
<DHCPSP>
<DHCPSPEthernetServiceInstance>
<EthernetServiceInstance>
<IfIndex></IfIndex>
<ServiceInstance></ServiceInstance>
<Trust></Trust>
</EthernetServiceInstance>
</DHCPSPEthernetServiceInstance>
</DHCPSP>

13
Table description

Item Description
Feature name DHCPSP

Table name DHCPSPEthernetServiceInstance

Table type Multi-instance table

Row name EthernetServiceInstance

This table supports only Layer 2 Ethernet interfaces or

Restrictions
Layer 2 aggregate interfaces.

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Service instance
ServiceInstance Index Unsigned integer. N/A
ID.

Whether to
configure the
Boolean:
interface for the
Trust N/A • true N/A
Ethernet service
• false (default)
instance as a
trusted interface.

14
DHCPSP/DHCPSPVsi
This table contains the VSI configuration information of DHCP snooping.

XML structure
<DHCPSP>
<DHCPSPVsi>
<Vsi>
<VsiName></VsiName>
<BindingRecord></BindingRecord>
<TrustTunnel></TrustTunnel>
</Vsi>
</DHCPSPVsi>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPVsi

Table type Multi-instance table

Row name Vsi

Restrictions None

Support for row creation and deletion No

Columns

Column Column
Column name Data type and restrictions
description type
String, case-sensitive.
VsiName VSI name Index
Length: 1 to 31 characters.

Whether to enable
Boolean:
recording DHCP
BindingRecord N/A • true
snooping entries
• false (default)
in the VSI.

TrustTunnel Whether to N/A Boolean:

15
 Column Column
Column name Data type and restrictions
description type
configure the • true
tunnel interface of • false (default)
the VSI as a
trusted interface.

16
Contents
DHCPSP ························································································1
DHCPSP/DHCPSPBindingDatabase ······························································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
DHCPSP/DHCPSPInterface··········································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 3
DHCPSP/DHCPSPOpt82CircuitIDVLAN ·························································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 5
DHCPSP/DHCPSPOpt82RemoteIDVLAN ························································································ 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 6
DHCPSP/DHCPSPOpt82 ·············································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 7
Columns ······························································································································ 7
DHCPSP/DHCPSPBinding ············································································································ 8
XML structure ······················································································································· 9
Table description ··················································································································· 9
Columns ······························································································································ 9
DHCPSP/DHCPSPConfig············································································································ 10
XML structure ····················································································································· 10
Table description ················································································································· 10
Columns ···························································································································· 10
DHCPSP/DHCPSPSpecification ··································································································· 10
XML structure ····················································································································· 11
Table description ················································································································· 11
Columns ···························································································································· 11
DHCPSP/DHCPSPEthernetServiceInstance ··················································································· 11
XML structure ····················································································································· 11
Table description ················································································································· 12
Columns ···························································································································· 12
DHCPSP/DHCPSPVsi ················································································································ 13
XML structure ····················································································································· 13
Table description ················································································································· 13
Columns ···························································································································· 13

i
DHCPSP
DHCPSP/DHCPSPBindingDatabase
This table contains DHCP snooping binding database information.

XML structure
<DHCPSP>
<DHCPSPBindingDatabase>
<FileName></FileName>
<URL></URL>
<Username></Username>
<Password></Password>
<UpdateInterval></UpdateInterval>
</DHCPSPBindingDatabase>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPBindingDatabase

Table type Single-instance table

Row name None

Restrictions None

Columns

Column Column
Column name Data type and restrictions
description type
String, case-insensitive.
FileName Object file name N/A
Length: 1 to 255 characters.

String, case-insensitive.
URL Object URL string N/A
Length: 1 to 255 characters.

Username FTP username N/A String, case-insensitive.

1
 Column Column
Column name Data type and restrictions
description type
Length: 1 to 32 characters.

String, case-insensitive.
Password FTP password N/A
Length: 1 to 32 characters.

Auto update Unsigned integer.

UpdateInterval N/A
interval Value range: 60 to 864000 seconds.

DHCPSP/DHCPSPInterface
This table contains the configuration information on interface about using DHCP snooping.

XML structure
<DHCPSP>
<DHCPSPInterface>
<Interface>
<IfIndex></IfIndex>
<BindingRecord></BindingRecord>
<CheckMacAddress></CheckMacAddress>
<CheckRequestMessage></CheckRequestMessage>
<Trust></Trust>
<LearnMaxNum></LearnMaxNum>
<RateLimitNum></RateLimitNum>
</Interface>
</DHCPSPInterface>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPInterface

Table type Multi-instance table

Row name Interface

This table supports interface types:

Restrictions Layer 2 Ethernet interface/Layer 2 aggregate interface

Layer 3 Ethernet interface/subinterface

2
 Layer 3 aggregate interface/aggregate subinterface

S-channel interface/S-channel aggregate interface

Columns

Column Column Colum

Data type and restrictions Remarks
name description n type
Interface
IfIndex Index Unsigned integer. N/A
index

Whether
enable the
interface to Boolean: Applicable to only Layer 2
BindingRec
record N/A • true interfaces of the
ord
DHCP • false Restrictions.
snooping
entry or not.

Whether
enable the
interface to
Boolean:
CheckMac check MAC
N/A • true N/A
Address address in
• false
DHCP
packets or
not.

Whether
enable the
interface to
CheckRequ check Boolean: Applicable to only Layer 2
estMessag request N/A • true interfaces of the
e message in • false Restrictions.
DHCP
packets or
not.

Whether to
configure an Boolean:
Trust interface as N/A • true N/A
a trustd • false
interface.

LearnMaxN The N/A Unsigned integer. N/A

3
 Column Column Colum
Data type and restrictions Remarks
name description n type
um maximum Value range: 0 to 4294967295.
number of
DHCP
snooping
entries for
an interface
to learn

The Values of
maximum RateLimitMinNum and
rate for an RateLimitMaxNum
Unsigned integer.
RateLimitN interface to depend on the device
N/A Value range: 0, RateLimitMinNum to
um receive model.
RateLimitMaxNum.
DHCP Applicable to only Layer 2
packets, in interfaces of the
Kbps Restrictions.

DHCPSP/DHCPSPOpt82CircuitIDVLAN
This table contains DHCP snooping option 82 circuit ID with VLAN configuration information.

XML structure
<DHCPSP>
<DHCPSPOpt82CircuitIDVLAN>
<VLANCircuitID>
<IfIndex></IfIndex>
<VLANID></VLANID>
<CircuitID></CircuitID>
</VLANCircuitID>
</DHCPSPOpt82CircuitIDVLAN>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPOpt82CircuitIDVLAN

Table type Multi-instance table

4
 Row name VLANCircuitID

Restrictions This table supports only Layer 2 interfaces.

Columns

Column Column
Column name Data type and restrictions
description type
IfIndex Interface index. Index Unsigned integer.

Unsigned integer.
VLANID VLAN ID Index
Value range: 1 to 4094.

String, case-insensitive.
Option82 circuit ID
CircuitID N/A Length: 3 to 63 characters.
string
The string must be ASCII string.

DHCPSP/DHCPSPOpt82RemoteIDVLAN
This table contains DHCP snooping option 82 remote ID with VLAN configuration information.

XML structure
<DHCPSP>
<DHCPSPOpt82RemoteIDVLAN>
<VLANRemoteID>
<IfIndex></IfIndex>
<VLANID></VLANID>
<RemoteID></RemoteID>
<Sysname></Sysname>
</VLANRemoteID>
</DHCPSPOpt82RemoteIDVLAN>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPOpt82RemoteIDVLAN

Table type Multi-instance table

5
 Row name VLANRemoteID

Restrictions This table supports only Layer 2 interfaces.

Columns

Column Column
Column name Data type and restrictions
description type
IfIndex Interface index. Index Unsigned integer.

Unsigned integer.
VLANID VLAN ID Index
Value range: 1 to 4094.

String, case-insensitive.
Option82 remote
RemoteID N/A Length: 1 to 63 characters.
ID string
The string must be ASCII string.

Whether the
function of system Boolean:
Sysname name fix in option N/A • true
82 remote ID is • false
used.

DHCPSP/DHCPSPOpt82
This table contains DHCP snooping option 82 configuration information.

XML structure
<DHCPSP>
<DHCPSPOpt82>
<Option82>
<IfIndex></IfIndex>
<Option82Enable></Option82Enable>
<Strategy></Strategy>
<Circuit>
<CircuitID></CircuitID>
<CircuitIDMode></CircuitIDMode>
<CircuitIDNodeIDType></CircuitIDNodeIDType>
<CircuitIDNodeID></CircuitIDNodeID>
<CircuitIDFormat></CircuitIDFormat>
</Circuit>
<Remote>

6
 <RemoteIDMode></RemoteIDMode>
<RemoteID></RemoteID>
<RemoteIDFormat></RemoteIDFormat>
</Remote>
</Option82>
</DHCPSPOpt82>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPOpt82

Table type Multi-instance table

Row name Option82

Restrictions This table supports only Layer 2 interfaces.

Columns

Column Column
Column name Data type and restrictions
description type
IfIndex Interface index. Index Unsigned integer.

Whether enable
the DHCP Boolean:
Option82Enable snooping to N/A • true
support Option 82 • false
or not.

Enumeration:

Option 82 strategy • 0—Drop.

Strategy N/A
type • 1—Keep.
• 2—Replace.

Members include:

• CircuitID
The configuration
Data • CircuitIDMode
Circuit of Circuit ID
structure • CircuitIDNodeIDType
sub-option
• CircuitIDNodeID
• CircuitIDFormat

7
 Column Column
Column name Data type and restrictions
description type
Circuit ID user String, case-insensitive.
CircuitID N/A
defined string Length: 3 to 63 characters.

Enumeration:

• 0—Normal.
CircuitIDMode Circuit ID mode N/A
• 1—Verbose.
• 2—User-defined.

Enumeration:
Circuit IP
CircuitIDNodeIDT • 0—Mac.
node-identifier N/A
ype • 1—Sysname.
type
• 2—User-defined.

Circuit ID
String, case-insensitive.
CircuitIDNodeID node-identifier N/A
Length: 1 to 50 characters.
user defined string

Enumeration:

Circuit ID format • 0—Hex.

CircuitIDFormat N/A
type • 1—Ascii.
• 2—Undefined.

Members include:
The configuration
Data • RemoteIDMode
Remote of Remote ID
structure • RemoteID
sub-option
RemoteIDFormat

Enumeration:

• 0—Normal.
RemoteIDMode Remote ID mode N/A
• 1—Sysname.
• 2—User-defined.

Remote ID user String, case-insensitive.

RemoteID N/A
defined string Length: 1 to 63 characters.

Enumeration:
Remote ID format
RemoteIDFormat N/A • 0—Hex.
type
• 1—Ascii.

DHCPSP/DHCPSPBinding
This table contains DHCP snooping entries information.

8
XML structure
<DHCPSP>
<DHCPSPBinding>
<Binding>
<Ipv4Address></Ipv4Address>
<VLANID></VLANID>
<SVLANID></SVLANID>
<MacAddress></MacAddress>
<Lease></Lease>
<IfIndex></IfIndex>
</Binding>
</DHCPSPBinding>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPBinding

Table type Multi-instance table

Row name Binding

Restrictions None

Columns

Column Column
Column name Data type and restrictions
description type
Ipv4Address IPv4 address Index String, dotted decimal notation.

Unsigned integer.
VLANID VLAN ID Index
Value range: 1 to 4094.

Unsigned integer.

SVLANID Second VLAN ID Index Value range: 1 to 4094 and 65535.

65535 means do not have SVLANID.

Six groups of two hexadecimal digits,

MacAddress MAC address N/A
hyphen-separated.

Lease Left Lease time N/A Unsigned integer.

9
 Column Column
Column name Data type and restrictions
description type
IfIndex Interface index N/A Unsigned integer.

DHCPSP/DHCPSPConfig
This table contains DHCP snooping configuration information.

XML structure
<DHCPSP>
<DHCPSPConfig>
<DHCPSPEnable></DHCPSPEnable>
</DHCPSPConfig>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPConfig

Table type Single-instance table

Row name None

Restrictions None

Columns

Column Column
Column name Data type and restrictions
description type
Whether the
Boolean:
function of DHCP
DHCPSPEnable N/A • true
snooping is
• false
enabled.

DHCPSP/DHCPSPSpecification
This table contains DHCP snooping specification information.

10
XML structure
<DHCPSP>
<DHCPSPSpecification>
<RateLimitMinNum></RateLimitMinNum>
<RateLimitMaxNum></RateLimitMaxNum>
</DHCPSPSpecification>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPSpecification

Table type Single-instance table

Row name None

Restrictions None

Columns

Column Column Data type and

Column type Remarks
name description restrictions
The minimum rate
RateLimitM
number can be N/A Unsigned integer. N/A
inNum
configured

The maximum rate

RateLimitM 0 means that rate limit isn't
number can be N/A Unsigned integer.
axNum supported.
configured

DHCPSP/DHCPSPEthernetServiceInstance
This table contains the Ethernet service instance configuration information of DHCP snooping.

XML structure
<DHCPSP>
<DHCPSPEthernetServiceInstance>

11
 <EthernetServiceInstance>
<IfIndex></IfIndex>
<ServiceInstance></ServiceInstance>
<Trust></Trust>
</EthernetServiceInstance>
</DHCPSPEthernetServiceInstance>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPEthernetServiceInstance

Table type Multi-instance table

Row name EthernetServiceInstance

This table supports only Layer 2 Ethernet interfaces or

Restrictions
Layer 2 aggregate interfaces.

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
IfIndex Interface index Index Unsigned integer.
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Service instance
ServiceInstance Index Unsigned integer. N/A
ID

Whether to
configure the Boolean:
Trust interface for the N/A • true N/A
Ethernet service • false
instance as a

12
 Column Column Data type and
Column name Remarks
description type restrictions
trusted interface

DHCPSP/DHCPSPVsi
This table contains the VSI configuration information of DHCP snooping.

XML structure
<DHCPSP>
<DHCPSPVsi>
<Vsi>
<VsiName></VsiName>
<BindingRecord></BindingRecord>
<TrustTunnel></TrustTunnel>
</Vsi>
</DHCPSPVsi>
</DHCPSP>

Table description

Item Description
Feature name DHCPSP

Table name DHCPSPVsi

Table type Multi-instance table

Row name Vsi

Restrictions None

Columns

Column Column
Column name Data type and restrictions
description type
String, case-sensitive.
VsiName VSI name Index
Length: 1 to 31 characters.

Whether to enable Boolean:

BindingRecord N/A
recording DHCP • true

13
 Column Column
Column name Data type and restrictions
description type
snooping entries • false
in the VSI.

Whether to
configure the Boolean:
TrustTunnel tunnel interface of N/A • true
the VSI as a • false
trusted interface.

14
Contents
DHCP/dhcpsp ····························································································································· 1

i
DHCP/dhcpsp
Message Explanation
The configuration doesn’t meet the requirements. The configuration doesn’t meet the requirements, please check
当前配置不符合配置要求。 your configuration.

Invalid VLAN ID.

Invalid VLAN ID, please check your VLAN ID.
非法的VLAN ID。

The URL of the TFTP file can’t include username or

password. Please do not set a username or password for a URL of the TFTP
file.
不要为一个TFTP文件的URL指定用户名和密码。

Invalid filename or URL.

Invalid filename or URL, please check it.
无效的本地文件名或URL。

The URL can’t include the username or password.

Please do not set username or password in the URL.
不要在URL中携带用户名和密码信息。

The system is saving DHCP snooping entries to

backup file. Please wait.
The system is saving DHCP snooping entries to backup file.
系统正在将DHCP Snooping表项写入备份表项的文
件中。请等待。

The system is downloading DHCP snooping

entries from the backup file. Please wait. The system is downloading DHCP snooping entries from the
系统正在从备份表项的文件中恢复DHCP Snooping backup file.
表项。请等待。

The node identifier can’t include any spaces. Please make certain that the node identifier is not include any
节点标识的字符串中不允许出现空格。 spaces.

The value is out of range.

The value is out of range, please check your value.
参数值超出范围。

The VSI instance is not created.

The VSI instance does not exist.
配置DHCP Snooping信任通道（远端站点）时，对应的VSI实例未
VSI实例不存在。
创建。

The Ethernet service instance is not created.

The Ethernet service instance does not exist.
配置DHCP Snooping信任通道（本地站点）时，对应的以太网服
Service instance不存在。
务实例未创建。

1
Contents
DHCPSP6 ······················································································1
DHCPSP6/DHCPSP6UpdateBindingDatabase ················································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCPSP6/DHCPSP6ClearBinding ································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2

i
DHCPSP6
DHCPSP6/DHCPSP6UpdateBindingDatabase
This table is used to save current DHCP snooping entries to the file.

XML structure
<DHCPSP6>
<DHCPSP6UpdateBindingDatabase>
<Update></Update>
</DHCPSP6UpdateBindingDatabase>
</DHCPSP6>

Table description
Item Description
Feature name DHCPSP6
Table name DHCPSP6UpdateBindingDatabase
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Update DHCP Boolean:
snooping This column must be
Update
database
N/A • true—Enabled. empty.
immediately • false—Disabled.

DHCPSP6/DHCPSP6ClearBinding
This table is used to clear DHCP snooping entries.

XML structure
<DHCPSP6>
<DHCPSP6ClearBinding>
<ClearBinding>
<Ipv6Address></Ipv6Address>
<VLANID></VLANID>

1
 </ClearBinding>
</DHCPSP6ClearBinding>
</DHCPSP6>

Table description
Item Description
Feature name DHCPSP6
Table name DHCPSP6ClearBinding
Table type Single-instance table
Row name ClearBinding
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
If Ipv6Address is empty,
Hexadecimal string,
Ipv6Address IPv6 address Index clears all DHCP
colon-separated.
snooping entries.
If VLANID is empty,
Unsigned integer. clears the DHCP
VLANID VLAN ID Index snooping entry for the
Value range: 1 to 4094. specified IP address in
all Vlan.

2
Contents
DHCPSP6 ······················································································1
DHCPSP6/DHCPSP6BindingDatabase ·························································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCPSP6/DHCPSP6Interface ····································································································· 2
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
DHCPSP6/DHCPSP6OptionInterfaceID ·························································································· 4
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
DHCPSP6/DHCPSP6OptionRemoteID ··························································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7
DHCPSP6/DHCPSP6OptionEnable ······························································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8
DHCPSP6/DHCPSP6Config ········································································································ 8
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ···························································································································· 9
DHCPSP6/DHCPSP6EthernetServiceInstance ················································································ 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
DHCPSP6/DHCPSP6Vsi ··········································································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 11

i
DHCPSP6
DHCPSP6/DHCPSP6BindingDatabase
This table contains IPv6 DHCP snooping binding database configuration information.

XML structure
<DHCPSP6>
<DHCPSP6BindingDatabase>
<FileName></FileName>
<URL></URL>
<Username></Username>
<Password></Password>
<UpdateInterval></UpdateInterval>
</DHCPSP6BindingDatabase>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6BindingDatabase

Table type Single-instance table

Row name N/A

Restrictions None

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
For the merge, create
String, case-insensitive. and replace operations,
Database file
FileName N/A Length: 1 to 255 FileName and URL can
name
characters. not be configured
simultaneously.

1
 Column Column Data type and
Column name Remarks
description type restrictions
Specifies the URL of a
remote file. Do not
include a username or
password in the URL.
Case sensitivity and the
String. case sensitive. supported format type of
URL Object URL string N/A Length: 1 to 255 the path depend on the

characters. server.

If URL is configured for

the delete and remove
operations, Username
and Password will be
removed automatically.

String. case sensitive. Can not be configured

Username FTP username N/A Length: 1 to 32 for the delete and
characters. remove operations.

Only plaintext password

is supported.

For the merge, create

and replace operations,
String. case sensitive.
Password must be
Password FTP password N/A Length: 1 to 32
configured with
characters.
Username.

Can not be configured

for the delete and
remove operations.

Unsigned integer.

Auto update Value range: 60 to

UpdateInterval N/A N/A
interval 864000 seconds.

Default: 300 seconds.

DHCPSP6/DHCPSP6Interface
This table contains the configuration information on interface about using IPv6 DHCP snooping.

2
XML structure
<DHCPSP6>
<DHCPSP6Interface>
<Interface>
<IfIndex></IfIndex>
<LearnMaxNum></LearnMaxNum>
<RateLimitNum></RateLimitNum>
<CheckRequestMessage></CheckRequestMessage>
<BindingRecord></BindingRecord>
<Trust></Trust>
</Interface>
</DHCPSP6Interface>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6Interface

Table type Multi-instance table

Row name Interface

This table supports interface types:

Layer 2 Ethernet interface/Layer 2 aggregate

Restrictions
interfaceS-channel interface/S-channel aggregate
interface

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
IfIndex Interface index Index Unsigned integer. see the XSD document
of your product. For
information about
IfIndex, see IfMgr in

3
 Column Column Data type and
Column name Remarks
description type restrictions
Ifmgr NETCONF XML
API Configuration
Reference.

The maximum
number of IPv6 Unsigned integer.
No limit as default.
LearnMaxNum DHCP snooping N/A Value range: 0 to
0 means No limit.
entries for an 4294967295.
interface to learn

Values of
The maximum RateLimitMinNum and
rate for an Unsigned integer.
RateLimitMaxNum
interface to Value range: 0, depend on the device
RateLimitNum N/A
receive IPv6 RateLimitMinNum to model.
DHCP packets, in RateLimitMaxNum.
No limit as default.
Kbps.
0 means No limit.

Whether enable
the interface to Boolean:
BindingRecord record IPv6 DHCP N/A • true. N/A
snooping entry or • false(default)
not.

Whether enable
the interface to
Boolean:
CheckRequestMe check request
N/A • true. N/A
ssage message in IPv6
• false(default)
DHCP packets or
not.

Whether
Boolean:
configurate an
Trust N/A • true. N/A
interface to be
• false(default)
trusted or not.

DHCPSP6/DHCPSP6OptionInterfaceID
This table contains IPv6 DHCP snooping option 18 DUID configuration information.

4
XML structure
<DHCPSP6>
<DHCPSP6OptionInterfaceID>
<InterfaceID>
<IfIndex></IfIndex>
<VLANID></VLANID>
<InterfaceID></InterfaceID>
</InterfaceID>
</DHCPSP6OptionInterfaceID>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6OptionInterfaceID

Table type Multi-instance table

Row name InterfaceID

Restrictions This table supports only Layer 2 interfaces.

Support for row creation and deletion Yes

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Only Layer 2 interfaces
are supported.

Some versions support

interface name. For
relevant information,
see the XSD document
IfIndex Interface index. Index Unsigned integer.
of your product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

5
 Column Column Data type and
Column name Remarks
description type restrictions
Unsigned integer. 0 means don’t specify
VLANID VLAN ID Index
Value range: 0 to 4094. the VLAN.

For the merge, create

and replace operations,
the InterfaceID must be
String, case-insensitive.
Option18 DUID configured.
InterfaceID N/A Length: 1 to 128
string For the remove and
characters.
delete operations, the
InterfaceID can not be
configured.

DHCPSP6/DHCPSP6OptionRemoteID
This table contains IPv6 DHCP snooping option 37 DUID configuration information.

XML structure
<DHCPSP6>
<DHCPSP6OptionRemoteID>
<RemoteID>
<IfIndex></IfIndex>
<VLANID></VLANID>
<RemoteID></RemoteID>
</RemoteID>
</DHCPSP6OptionRemoteID>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6OptionRemoteID

Table type Multi-instance table

Row name RemoteID

Restrictions This table supports only Layer 2 interfaces.

Support for row creation and deletion Yes

6
Columns

Column Column Data type and

Column name Remarks
description type restrictions
Only Layer 2 interfaces
are supported.

Some versions support

interface name. For
relevant information,
see the XSD document
IfIndex Interface index. Index Unsigned integer.
of your product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Unsigned integer. 0 means don’t specify

VLANID VLAN ID Index
Value range: 0 to 4094. the VLAN.

For the merge, create

and replace operations,
the RemoteID must be
String, case-insensitive.
Option37 DUID configured.
RemoteID N/A Length: 1 to 128
string For the remove and
characters.
delete operations, the
RemoteID can not be
configured.

DHCPSP6/DHCPSP6OptionEnable
This table contains IPv6 DHCP snooping option 82 configuration information.

XML structure
<DHCPSP6>
<DHCPSP6OptionEnable>
<OptionEnable>
<IfIndex></IfIndex>
<InterfaceIDEnable></InterfaceIDEnable>
<RemoteIDEnable></RemoteIDEnable>
</OptionEnable>

7
 </DHCPSP6OptionEnable>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6OptionEnable

Table type Multi-instance table

Row name OptionEnable

Restrictions This table supports only Layer 2 interfaces.

Support for row creation and deletion No

Columns

Column name Column description Column type Data type and restrictions
Unsigned integer.

Some versions support interface

name. For relevant information,
see the XSD document of your
IfIndex Interface index. Index
product. For information about
IfIndex, see IfMgr in Ifmgr
NETCONF XML API
Configuration Reference.

Whether enable the IPv6 Boolean:

InterfaceIDEnabl
DHCP snooping to support N/A • true.
e
InterfaceID or not. • false(default)

Whether enable the IPv6 Boolean:

RemoteIDEnable DHCP snooping to support N/A • true.
RemoteID or not. • false(default)

DHCPSP6/DHCPSP6Config
This table contains IPv6 DHCP snooping configuration information.

8
XML structure
<DHCPSP6>
<DHCPSP6Config>
<DHCPSP6Enable></DHCPSP6Enable>
</DHCPSP6Config>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6Config

Table type Single-instance table

Row name N/A

Restrictions None

Support for row creation and deletion No

Columns

Column name Column description Column type Data type and restrictions
Boolean:
DHCPSPEnable Enable DHCP snooping N/A • true.
• false(default)

DHCPSP6/DHCPSP6EthernetServiceInstance
This table contains the configuration information on Ethernet service instance about using IPv6
DHCP snooping.

XML structure
<DHCPSP6>
<DHCPSP6EthernetServiceInstance>
<EthernetServiceInstance>
<IfIndex></IfIndex>
<ServiceInstance></ServiceInstance>

9
 <Trust></Trust>
</EthernetServiceInstance>
</DHCPSP6EthernetServiceInstance>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6EthernetServiceInstance

Table type Multi-instance table

Row name EthernetServiceInstance

This table supports only Layer 2 Ethernet interfaces or

Restrictions
Layer 2 aggregate interfaces.

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
IfIndex Interface index Index Unsigned integer.
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Service instance
ServiceInstance Index Unsigned integer. N/A
ID

Whether to
Boolean:
configure an
Trust N/A • true N/A
interface to be
• false (default)
trusted or not

10
DHCPSP6/DHCPSP6Vsi
This table contains the configuration in VSI about using IPv6 DHCP snooping.

XML structure
<DHCPSP6>
<DHCPSP6Vsi>
<Vsi>
<VsiName></VsiName>
<BindingRecord></BindingRecord>
<TrustTunnel></TrustTunnel>
</Vsi>
</DHCPSP6Vsi>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6Vsi

Table type Multi-instance table

Row name Vsi

Restrictions None

Support for row creation and deletion No

Columns

Column Column Data type and

Column name Remarks
description type restrictions
String, case-sensitive.
VsiName VSI name Index Length: 1 to 31 N/A
characters.

Whether to enable
Boolean:
the interface to
BindingRecord N/A • True N/A
record DHCP
• false (default)
snooping entries

11
 Column Column Data type and
Column name Remarks
description type restrictions
or not

Whether to
Boolean:
configure tunnel
TrustTunnel N/A • true N/A
interfaces to be
• false (default)
trusted or not

12
Contents
DHCPSP6 ······················································································1
DHCPSP6/DHCPSP6BindingDatabase ·························································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
DHCPSP6/DHCPSP6Interface ····································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
DHCPSP6/DHCPSP6OptionInterfaceID ·························································································· 3
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
DHCPSP6/DHCPSP6OptionRemoteID ··························································································· 4
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
DHCPSP6/DHCPSP6OptionEnable ······························································································· 5
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
DHCPSP6/DHCPSP6Binding ······································································································· 6
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7
DHCPSP6/DHCPSP6Config ········································································································ 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 8
DHCPSP6/DHCPSP6Specification ································································································ 8
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ···························································································································· 9
DHCPSP6/DHCPSP6EthernetServiceInstance ················································································ 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
DHCPSP6/DHCPSP6Vsi ··········································································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 11

i
DHCPSP6
DHCPSP6/DHCPSP6BindingDatabase
This table contains IPv6 DHCP snooping binding database configuration information.

XML structure
<DHCPSP6>
<DHCPSP6BindingDatabase>
<FileName></FileName>
<URL></URL>
<Username></Username>
<Password></Password>
<UpdateInterval></UpdateInterval>
</DHCPSP6BindingDatabase>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6BindingDatabase

Table type Single-instance table

Row name N/A

Restrictions None

Columns

Column
Column name Column type Data type and restrictions
description

Database file String, case-insensitive.

FileName N/A
name Length: 1 to 255 characters.

String. case sensitive.

URL Object URL string. N/A
Length: 1 to 255 characters.

Username FTP username N/A String. case sensitive.

1
 Column
Column name Column type Data type and restrictions
description
Length: 1 to 32 characters.

String. case sensitive.

Password FTP password N/A
Length: 1 to 32 characters.

Unsigned integer.
Auto update
UpdateInterval N/A Value range: 60 to 864000 seconds.
interval
Default: 300 seconds.

DHCPSP6/DHCPSP6Interface
This table contains the configuration information on interface about using IPv6 DHCP snooping.

XML structure
<DHCPSP6>
<DHCPSP6Interface>
<Interface>
<IfIndex></IfIndex>
<LearnMaxNum></LearnMaxNum>
<RateLimitNum></RateLimitNum>
<CheckRequestMessage></CheckRequestMessage>
<BindingRecord></BindingRecord>
<Trust></Trust>
</Interface>
</DHCPSP6Interface>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6Interface

Table type Multi-instance table

Row name Interface

This table supports interface types:

Restrictions Layer 2 Ethernet interface/Layer 2 aggregate
interfaceS-channel interface/S-channel aggregate

2
 interface

Columns

Column Column Data type and

Column name Remarks
description type restrictions
IfIndex Interface index Index Unsigned integer. N/A

The maximum
number of DHCP Unsigned integer.
No limit as default.
LearnMaxNum snooping entries N/A Value range: 0 to
0 means No limit.
for an interface to 4294967295.
learn

The maximum
rate for an The value range
RateLimitNum interface to N/A Unsigned integer. depends on the device
receive DHCP model.
packets, in Kbps

Whether enable
the interface to Boolean:
BindingRecord record DHCP N/A • true. N/A
snooping entry or • false(default)
not

Whether enable
the interface to Boolean:
CheckRequestMe
check request N/A • true. N/A
ssage
message in DHCP • false(default)
packets or not

Whether
Boolean:
configurate an
Trust N/A • true. N/A
interface to be
• false(default)
trusted or not

DHCPSP6/DHCPSP6OptionInterfaceID
This table contains IPv6 DHCP snooping option 18 DUID configuration information.

3
XML structure
<DHCPSP6>
<DHCPSP6OptionInterfaceID>
<InterfaceID>
<IfIndex></IfIndex>
<VLANID></VLANID>
<InterfaceID></InterfaceID>
</InterfaceID>
</DHCPSP6OptionInterfaceID>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6OptionInterfaceID

Table type Multi-instance table

Row name InterfaceID

Restrictions This table supports only Layer 2 interfaces.

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Only Layer 2 interfaces
IfIndex Interface index. Index Unsigned integer.
are supported.

Unsigned integer. 0 means don’t specify

VLANID VLAN ID Index
Value range: 0 to 4094. the VLAN.

String, case-insensitive.
Option18 DUID
InterfaceID N/A Length: 1 to 128 N/A
string
characters.

DHCPSP6/DHCPSP6OptionRemoteID
This table contains IPv6 DHCP snooping option 37 DUID configuration information.

4
XML structure
<DHCPSP6>
<DHCPSP6OptionRemoteID>
<RemoteID>
<IfIndex></IfIndex>
<VLANID></VLANID>
<RemoteID></RemoteID>
</RemoteID>
</DHCPSP6OptionRemoteID>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6OptionRemoteID

Table type Multi-instance table

Row name RemoteID

Restrictions This table supports only Layer 2 interfaces.

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Only Layer 2 interfaces
IfIndex Interface index. Index Unsigned integer.
are supported.

Unsigned integer. 0 means don’t specify

VLANID VLAN ID Index
Value range: 0 to 4094. the VLAN.

String, case-insensitive.
Option37 DUID
RemoteID N/A Length: 1 to 128 N/A
string
characters.

DHCPSP6/DHCPSP6OptionEnable
This table contains IPv6 DHCP snooping option 82 configuration information.

5
XML structure
<DHCPSP6>
<DHCPSP6OptionEnable>
<OptionEnable>
<IfIndex></IfIndex>
<InterfaceIDEnable></InterfaceIDEnable>
<RemoteIDEnable></RemoteIDEnable>
</OptionEnable>
</DHCPSP6OptionEnable>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6OptionEnable

Table type Multi-instance table

Row name OptionEnable

Restrictions This table supports only Layer 2 interfaces.

Columns

Column Column
Column name Data type and restrictions
description type
IfIndex Interface index. Index Unsigned integer.

Enable the DHCP

Boolean:
InterfaceIDEnabl snooping to
N/A • true—Enabled.
e support
• false—Disabled (default).
InterfaceID

Enable the DHCP Boolean:

RemoteIDEnable snooping to N/A • true—Enabled.
support RemoteID • false—Disabled (default).

DHCPSP6/DHCPSP6Binding
This table contains IPv6 DHCP snooping entries information.

6
XML structure
<DHCPSP6>
<DHCPSP6Binding>
<Binding>
<Ipv6Address></Ipv6Address>
<VLANID></VLANID>
<SVLANID></SVLANID>
<MacAddress></MacAddress>
<Lease></Lease>
<IfIndex></IfIndex>
</Binding>
</DHCPSP6Binding>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6Binding

Table type Multi-instance table

Row name Binding

Restrictions None

Columns

Column Column
Column name Data type and restrictions
description type
Ipv6Address IPv6 address Index String, dotted decimal notation.

Unsigned integer.
VLANID VLAN ID Index
Value range: 1 to 4094.

Unsigned integer.

SVLANID Second VLAN ID Index

Value range: 1 to 4094 and 65535.

65535 means no SVLANID.

Six groups of two hexadecimal digits,

MacAddress MAC address N/A
hyphen-separated.

7
 Column Column
Column name Data type and restrictions
description type
Lease Left Lease time N/A Unsigned integer.

IfIndex Interface index N/A Unsigned integer.

DHCPSP6/DHCPSP6Config
This table contains IPv6 DHCP snooping configuration information.

XML structure
<DHCPSP6>
<DHCPSP6Config>
<DHCPSP6Enable></DHCPSP6Enable>
</DHCPSP6Config>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6Config

Table type Single-instance table

Row name N/A

Restrictions None

Columns

Column name Column description Column type Data type and restrictions
Boolean:
DHCPSPEnable Enable DHCP snooping N/A • true.
• false(default)

DHCPSP6/DHCPSP6Specification
This table contains DHCP snooping specification information.

8
XML structure
<DHCPSP6>
<DHCPSP6Specification>
<RateLimitMinNum></RateLimitMinNum>
<RateLimitMaxNum></RateLimitMaxNum>
</DHCPSP6Specification>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6Specification

Table type Single-instance table

Row name N/A

Restrictions None

Columns

Column Column Data type and

Column description Remarks
name type restrictions
The minimum rate
RateLimitM
mumber can be N/A Unsigned integer. N/A
inNum
configured

The maximum rate

RateLimitM 0 means that rate limit isn't
mumber can be N/A Unsigned integer.
axNum supported.
configured

DHCPSP6/DHCPSP6EthernetServiceInstance
This table contains the configuration information on Ethernet service instance about using IPv6
DHCP snooping.

XML structure
<DHCPSP6>

9
 <DHCPSP6EthernetServiceInstance>
<EthernetServiceInstance>
<IfIndex></IfIndex>
<ServiceInstance></ServiceInstance>
<Trust></Trust>
</EthernetServiceInstance>
</DHCPSP6EthernetServiceInstance>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6EthernetServiceInstance

Table type Multi-instance table

Row name EthernetServiceInstance

This table supports only Layer 2 Ethernet interfaces or

Restrictions
Layer 2 aggregate interfaces.

Columns

Column Column Data type and

Column name Remarks
description type restrictions
Some versions support
interface name. For
relevant information,
see the XSD document
of your product. For
IfIndex Interface index. Index Unsigned integer.
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Service instance
ServiceInstance Index Unsigned integer. N/A
ID.

Whether to
Boolean:
configure an
Trust N/A • true N/A
interface to be
• false
trusted or not.

10
DHCPSP6/DHCPSP6Vsi
This table contains the configuration information in VSI about using IPv6 DHCP snooping.

XML structure
<DHCPSP6>
<DHCPSP6Vsi>
<Vsi>
<VsiName></VsiName>
<BindingRecord></BindingRecord>
<TrustTunnel></TrustTunnel>
</Vsi>
</DHCPSP6Vsi>
</DHCPSP6>

Table description

Item Description
Feature name DHCPSP6

Table name DHCPSP6Vsi

Table type Multi-instance table

Row name Vsi

Restrictions None

Columns

Column Column Data type and

Column name Remarks
description type restrictions
String, case-sensitive.
VsiName VSI name Index Length: 1 to 31 N/A
characters.

Whether enable
Boolean:
the interface to
BindingRecord N/A • True N/A
record DHCP
• false
snooping entry or

11
 Column Column Data type and
Column name Remarks
description type restrictions
not.

Whether to
Boolean:
configure tunnel
TrustTunnel N/A • true N/A
interfaces to be
• false
trusted or not.

12
Contents
DHCP/dhcpsp6 ························································································································· 1

i
DHCP/dhcpsp6
Message Explanation
The configuration doesn’t meet the requirements.
The configuration doesn’t meet the requirements, please check it.
当前配置不符合配置要求。

Invalid VLAN ID.

Invalid VLAN ID, please check it.
非法的VLAN ID。

The URL of the TFTP file can’t include username or

password. Please make certain that the URL of the TFTP file isn’t include
username or password.
不要为一个TFTP文件的URL指定用户名和密码。

Invalid filename or URL.

Invalid file name or URL, please check it.
无效的本地文件名或URL。

The URL can’t include the username or password. Please make certain that the URL isn’t include the username or
不要在URL中携带用户名和密码信息。 password.

The system is saving DHCPv6 snooping entries to

backup file. Please wait.
The system is saving DHCPv6 snooping entries to backup file
系统正在将DHCPv6 Snooping表项写入备份表项的
文件中。请等待。

The system is downloading DHCPv6 snooping

entries from the backup file. Please wait. The system is downloading DHCPv6 snooping entries from the
系统正在从备份表项的文件中恢复DHCPv6 backup file.
Snooping表项。请等待。

The value is out of range.

The value is out of range, please check it.
参数值超出范围。

1
Contents
Diagnostic ······················································································1
Diagnostic/CPUHistory ·················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
Diagnostic/CPUAlert ····················································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 3
Diagnostic/MemoryAlert ················································································································ 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4
Diagnostic/CoreAlert ····················································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 6
Diagnostic/Configuration ··············································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 7
Diagnostic/DiskAlert ····················································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 8

i
Diagnostic
Diagnostic/CPUHistory
This table contains usage information about the logical CPUs.

XML structure
<Diagnostic>
<CPUHistory>
<CPU>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<MoniterEnable></MoniterEnable>
<HistroyCycleInSecond></HistroyCycleInSecond>
<CPUUsageLimit></CPUUsageLimit>
</CPU>
</CPUHistory>
</Diagnostic>

Table description
Item Description
Feature name Diagnostic
Table name CPUHistory
Table type Multi-instance table
Row name CPU
Restrictions Available only for logical CPUs

Support for row creation and deletion No

Columns
Column Column
Column name Data type and restrictions
description type
Member ID of the
member device Unsigned integer.
Chassis Index
where the entity Value range: 0 to 65535.
resides

Slot number of the Unsigned integer.

Slot Index
device node Value range: 0 to 65535.

1
 Column Column
Column name Data type and restrictions
description type
Unsigned integer.
CPUID ID of the CPU Index
Value range: 0 to 65535.
Enumeration:
CPU usage
MoniterEnable N/A • 1—Disabled.
monitoring
• 2—Enabled.
Enumeration:
CPU usage • 5—5 seconds.
HistoryCycleInSecond sampling interval in N/A
seconds • 60—60 seconds.
• 300—300 seconds.

CPU usage Unsigned integer.

CPUUsageLimit N/A
threshold (%) Value range: 0 to 100.

Diagnostic/CPUAlert
This table contains usage alarm settings for logical CPUs.

XML structure
<Diagnostic>
<CPUAlert>
<Alert>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<MinorThreshold></MinorThreshold >
<WarningThreshold></WarningThreshold>
<RecoveryThreshold></RecoveryThreshold>
</Alert>
</CPUAlert>
</Diagnostic>

Table description
Item Description
Feature name Diagnostic
Table name CPUAlert
Table type Multi-instance table
Row name Alert
Restrictions Available only for logical CPUs

Support for row creation and deletion No

2
Columns
Column Data type and
Column name Column description type restrictions

Member ID of the member device Unsigned integer.

Chassis Index
where the entity resides Value range: 0 to 65535.
Unsigned integer.
Slot Slot number of the device node Index
Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU. Index
Value range: 0 to 65535.
Unsigned integer.
MinorThreshold CPU usage minor threshold (%) N/A
Value range: 1 to 100.

CPU usage severe alarm threshold Unsigned integer

WarningThreshold N/A
(%) Value range: 1 to 100
Unsigned integer
RecoveryThreshold CPU usage recovery threshold (%) N/A
Value range: 0 to 99

Diagnostic/MemoryAlert
This table contains free-memory alarm settings.

XML structure
<Diagnostic>
<MemoryAlert>
<Alert>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<Unit></Unit>
<MinorThreshold></MinorThreshold>
<SevereThreshold></SevereThreshold>
<CriticalThreshold></CriticalThreshold>
<NormalThreshold></NormalThreshold>
<EarlyWarningThreshold></EarlyWarningThreshold>
<SecureThreshold></SecureThreshold>
</Alert>
</MemoryAlert>
</Diagnostic>

3
Table description
Item Description
Feature name Diagnostic
Table name MemoryAlert
Table type Multi-instance table
Row name Alert
For a create or replace operation, all non-index columns are
required. For a delete, remove, or replace operation, you must
Restrictions
specify all non-index columns or leave all non-index columns
unspecified.

Support for row creation and deletion No

Columns
Column name Column Data type and
Column description Remarks
type restrictions
Member ID of the Unsigned integer.
Chassis member device where Index Value range: 0 to N/A
the entity resides 65535.

Unsigned integer.
Slot number of the
Slot Index Value range: 0 to N/A
device node
65535.
Unsigned integer.
CPUID ID of the CPU. Index Value range: 0 to N/A
65535.
Enumeration:
Unit Unit of the threshold N/A • MB N/A
• Percentage

Unsigned integer. Setting this

Minor
threshold to 0
MinorThreshold insufficient-free-memory N/A Value range: 0 to 100 if disables the minor
threshold the unit is percentage. alarm feature

Setting this
Severe Unsigned integer. threshold to 0
SevereThreshold insufficient-free-memory N/A Value range: 0 to 100 if disables the
threshold the unit is percentage. severe alarm
feature.

Setting this
Critical Unsigned integer. threshold to 0
CriticalThreshold insufficient-free-memory N/A Value range: 0 to 100 if disables the
threshold the unit is percentage. critical alarm
feature.

4
 Column name Column Data type and
Column description Remarks
type restrictions
Unsigned integer.
Normal free-memory
NormalThreshold N/A Value range: 0 to 100 if N/A
state threshold
the unit is percentage.

Early-warning threshold Setting this

for Unsigned integer.
EarlyWarningThres N/A threshold to 0
insufficient-free-memory Value range: 0 to 100 if disables the early
hold condition the unit is percentage. warning feature.

Early-warning-removed Unsigned integer.

threshold for N/A N/A
Value range: 0 to 100 if
SecureThreshold insufficient-free-memory
the unit is percentage.
condition

Diagnostic/CoreAlert
This table contains usage alarm settings for logical Cores.

XML structure
<Diagnostic>
<CoreAlert>
<Alert>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<CoreID></CoreID>
<CoreThreshold></CoreThreshold>
<CoreMinorThreshold></CoreMinorThreshold>
<CoreRecoveryThreshold></CoreRecoveryThreshold>
</Alert>
</CoreAlert>
</Diagnostic>

Table description
Item Description
Feature name Diagnostic
Table name CoreAlert
Table type Multi-instance table
Row name Alert
Restrictions Available only for logical Cores

Support for row creation and deletion No

5
Columns
Data type and
Column name Column description Column type
restrictions

Member ID of the member device Unsigned integer.

Chassis Index
where the entity resides Value range: 0 to 65535.

Unsigned integer.
Slot Slot number of the card Index
Value range: 0 to 65535.

Unsigned integer.
CPUID ID of the CPU. Index
Value range: 0 to 65535.

Unsigned integer.
CoreID ID of the Core Index
Value range: 0 to 65535.

Unsigned integer
CoreThreshold CPU usage threshold (%) N/A
Value range: 2 to 100

CPU core usage minor threshold Unsigned integer

CoreMinorThreshold N/A
(%) Value range: 1 to 99

CoreRecoveryThres CPU core usage recovery threshold Unsigned integer

N/A
hold (%) Value range: 0 to 98

Diagnostic/Configuration
This table contains the global settings of the diagnostic module.

XML structure
<Diagnostic>
<Configuration>
<MonitorDiskUsageInterval></MonitorDiskUsageInterval>
</Configuration>
</Diagnostic>

Table description
Item Description
Feature name Diagnostic
Table name Configuration

6
 Item Description
Table type Single-instance table
Row name N/A
Restrictions None

Support for row creation and deletion No

Columns
Column name Column Data type and
Column description
type restrictions
Unsigned integer.
MonitorDiskUsageInterv Disk usage monitoring interval
N/A Value range: 5 to 1800.
al in seconds.
Default: 300.

Diagnostic/DiskAlert
This table contains disk usage alarm settings.

XML structure
<Diagnostic>
<DiskAlert>
<Alert>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<DiskName></DiskName>
<Threshold></Threshold>
</Alert>
</DiskAlert>
</Diagnostic>

Table description
Item Description
Feature name Diagnostic
Table name DiskAlert
Table type Multi-instance table
Row name Alert
Restrictions None

7
 Item Description

Support for row creation and deletion No

Columns
Column name Column
Column description Data type and restrictions
type
Member ID of the member Unsigned integer.
Chassis device where the entity Index
resides. Value range: 0 to 65535.

Slot number of the device Unsigned integer.

Slot Index
node. Value range: 0 to 65535.

Unsigned integer.
CPUID ID of the CPU. Index
Value range: 0 to 65535.

String.
DiskName Disk name. Index
Length: 1 to 64 characters.

Disk usage threshold in Unsigned integer.

Threshold N/A
percentage. Value range: 1 to 100.

8
Contents
Diagnostic ······················································································1
Diagnostic/CPUHistory ··············································