HPE Comware 7

NETCONF XML API Reference

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

© Copyright 2018 Hewlett Packard Enterprise Development LP
Contents
802.1X ···························································································1
802.1X/IF ··································································································································· 1
802.1X /FreeIp ···························································································································· 1
802.1X /Protocol ·························································································································· 2
802.1X /EadAssist ························································································································ 2

i
802.1X
802.1X/IF
Message Explanation
Can't set a nonexistent VLAN as a guest VLAN. VLAN do not exist.
Can't set a nonexistent VLAN as an Auth-Fail
VLAN do not exist.
VLAN.
Can't set a nonexistent VLAN as a critical VLAN. VLAN do not exist.
Failed to enable 802.1X on the interface, Failed to enable 802.1X on the interface, because it is a link
because it is a link aggregation member port aggregation member port

Can't enable 802.1X for port security mode is Can't enable 802.1X for port security mode is configured on the
configured on the port. port.

Can't enable 802.1x for port security is enabled. Can't enable 802.1x for port security is enabled.
Can't configure port-control for port security is
Can't configure port-control for port security is enabled.
enabled.
Can't configure port-control for port security mode Can't configure port-control for port security mode is configured
is configured on the port. on the port.

Can't configure port-method for port security is Can't configure port-method for port security is enabled.
enabled.

Can't configure port-method for port security Can't configure port-method for port security mode is configured
mode is configured on the port. on the port.

Can't configure port-method for MAC Can't configure port-method for MAC authentication is enabled
authentication is enabled on the port. on the port.

The specified number must be higher than the The specified number must be higher than the current number of
current number of online users. online users.

Can't set a dynamic VLAN as an guest VLAN. Can't set a dynamic VLAN as an guest VLAN.
Can't set a dynamic VLAN as a Auth-Fail VLAN. Can't set a dynamic VLAN as a Auth-Fail VLAN.
Can't set a dynamic VLAN as a critical VLAN. Can't set a dynamic VLAN as a critical VLAN.
Port security, MAC authentication, and 802.1X
Port security, MAC authentication, and 802.1X authentication are
authentication are not supported on Layer 2
not supported on Layer 2 aggregate interfaces.
aggregate interfaces.

802.1X /FreeIp
Message Explanation
The maximum number of free-IP segments has The maximum number of free-IP segments has reached.
reached.

Invalid IP address or subnet mask. Invalid IP address or subnet mask.

1
802.1X /Protocol
Message Explanation
Can't enable 802.1x for port security is enabled. Can't enable 802.1x for port security is enabled.
Can't disable 802.1X for port security is enabled. Can't disable 802.1X for port security is enabled.

802.1X /EadAssist
Message Explanation
Can't enable the EAD assistant function when Can't enable the EAD assistant function when MAC
MAC authentication is enabled globally. authentication is enabled globally.

Can't enable the EAD assistant function when Can't enable the EAD assistant function when port security is
port security is enabled globally. enabled globally.

2
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 ················································································································· 4
Columns ···························································································································· 5
ACL/IPv4BasicRules··················································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6
ACL/IPv4NamedBasicRules ········································································································· 7
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 8
ACL/IPv6BasicRules················································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
ACL/IPv6NamedBasicRules ······································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 13
Columns ·························································································································· 14
ACL/IPv4AdvanceRules ············································································································ 15
XML structure ··················································································································· 15
Table description ··············································································································· 17
Columns ·························································································································· 18
ACL/IPv4NamedAdvanceRules··································································································· 25
XML structure ··················································································································· 25
Table description ··············································································································· 27
Columns ·························································································································· 27
ACL/IPv6AdvanceRules ············································································································ 35
XML structure ··················································································································· 35
Table description ··············································································································· 37
Columns ·························································································································· 37
ACL/IPv6NamedAdvanceRules··································································································· 42
XML structure ··················································································································· 42
Table description ··············································································································· 43
Columns ·························································································································· 43
ACL/MACRules ······················································································································· 48
XML structure ··················································································································· 48
Table description ··············································································································· 49
Columns ·························································································································· 50
ACL/MACNamedRules·············································································································· 53
XML structure ··················································································································· 53
Table description ··············································································································· 54
Columns ·························································································································· 54
ACL/PfilterIgnoreAction ············································································································· 57
XML structure ··················································································································· 57
Table description ··············································································································· 57
Columns ·························································································································· 57

i
ACL/PfilterDefAction ················································································································· 58
XML structure ··················································································································· 58
Table description ··············································································································· 58
Columns ·························································································································· 58
ACL/PfilterApply ······················································································································ 58
XML structure ··················································································································· 59
Table description ··············································································································· 59
Columns ·························································································································· 59
ACL/UserRules ······················································································································· 60
XML structure ··················································································································· 60
Table description ··············································································································· 62
Columns ·························································································································· 62
ACL/UserNamedRules ·············································································································· 66
XML structure ··················································································································· 66
Table description ··············································································································· 68
Columns ·························································································································· 68
ACL/ZonePairPfilterApply ·········································································································· 73
XML structure ··················································································································· 73
Table description ··············································································································· 73
Columns ·························································································································· 74

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. Name is supported for number ACL.
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>
<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
English letter and cannot be all.
String. The value range depends on the
Length: 1 to 63 GroupType column.
characters.
• 2000 to 3999 if GroupType is 1.
• ACL name:
 IPv4 basic ACL: 2000 to
ACL name or Case-insensitive
GroupIndex Index 2999.
number string of 1 to 63
characters.  IPv4 advanced ACL: 3000 to
3999.
• ACL number:
String of digits in • 2000 to 3999 if GroupType is 2.
the range of 2000  IPv6 basic ACL: 2000 to
to 5999. 2999.
 IPv6 advanced ACL: 3000 to
3999.

3
 Column Column Colum Data type and
Remarks
name description n type restrictions
• 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-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>

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

4
 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>
<VRF></VRF>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
</Rule>
</IPv4BasicRules>
</ACL>

5
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.
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.
Source IPv4 String, dotted decimal This column is available
SrcIPv4Addr N/A
address. notation. when the SrcAny column
is false.

6
 Column Column Column
Data type and restrictions Remarks
name description type
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/IPv4NamedBasicRules
This table contains information about namd IPv4 basic ACL rules.

7
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>

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.

8
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.
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.
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.
TimeRange Time range. N/A It cannot be the word all.
Length: 1 to 32 characters.

9
 Column Column Column
Data type and restrictions Remarks
name description type
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
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>

10
 <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.
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.

Members include: This column must be

Source IPv6 Data configured together with
SrcIPv6
information. structure • SrcIPv6Addr. the SrcAny column.
• SrcIPv6Prefix.
The two members must

11
Column Column Column
Data type and restrictions Remarks
name description type
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 • 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).

String, case-sensitive. A comment can only be

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

12
 Column Column Column
Data type and restrictions Remarks
name description type
When the MatchOrder
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>
<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

13
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.
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.

14
 Column Column Column
Data type and restrictions Remarks
name description type
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 • 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/IPv4AdvanceRules
This table contains information about IPv4 advanced ACL rules.

XML structure
<ACL>
<IPv4AdvanceRules>

15
<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>
<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>

16
 <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>
</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

17
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
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.
Wildcard mask for
SrcIPv4Wi String, dotted decimal This column is available
the source IPv4 N/A
ldcard notation. when the SrcAny column
address.
is false.

18
Column Column Column
Data type and restrictions Remarks
name description type
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.
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.
TOS ToS preference. N/A Unsigned integer. The DSCP priority and the

19
Column Column Column
Data type and restrictions Remarks
name description type
Value range: 0 to 15. ToS precedence cannot
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.
Boolean:
• 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.

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.
Boolean:
• 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.
Data
TcpFlag TCP flags. structure. • FIN. N/A
• PSH.
• RST.

20
Column Column Column
Data type and restrictions Remarks
name description type
• 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.
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.
ICMPCod Code of ICMP Value range: 0 to 256. Only the ICMP protocol
N/A
e messages. supports this column.
The value 256 indicates that
no ICMP message code is

21
Column Column Column
Data type and restrictions Remarks
name description type
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
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.

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

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.

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.

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

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.

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.

Boolean:
• 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.

Boolean:
• 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.

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

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).
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/IPv4NamedAdvanceRules
This table contains information about named IPv4 advanced ACL rules.

XML structure
<ACL>
<IPv4NamedAdvanceRules>
<Rule>
<GroupIndex></GroupIndex>
<RuleID></RuleID>
<Action></Action>
<ProtocolType></ProtocolType>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>

25
</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>
<ICMP>
<ICMPType></ICMPType>
<ICMPCode></ICMPCode>
</ICMP>
<Fragment></Fragment>
<TimeRange></TimeRange>
<VRF></VRF>
<QoSLocalID></QoSLocalID>
<EncapType></EncapType>
<InProtocolType></InProtocolType>
<VxlanID></VxlanID>
<InSrcAny></InSrcAny>
<InSrcIPv4>

26
 <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>
</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. You must create an ACL
GroupInde ACL name or
Index • ACL name: first before you create,
x number. Case-insensitive string merge, or replace rules for
of 1 to 63 characters. it.
• ACL number:

27
Column Column Column
Data type and restrictions Remarks
name description type
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
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.

Source object String, case-insensitive. This column and the

N/A
SrcObject group name. Length: 1 to 31 characters. SrcAny column cannot

28
Column Column Column
Data type and restrictions Remarks
name description type
Group 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.
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.

Source port Data Members include: Only the TCP and UDP
SrcPort
information. structure • SrcPortOp. protocols and the VXLAN

29
Column Column Column
Data type and restrictions Remarks
name description type
• SrcPortValue1. encapsulation support this
column.
• SrcPortValue2.
The members must be all
specified.
Boolean:
• 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.

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.
Boolean:
• 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.

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

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

30
Column Column Column
Data type and restrictions Remarks
name description type
• 0—ACK flag is not set.
• 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.
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.

Whether a rule Boolean:

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

31
Column Column Column
Data type and restrictions Remarks
name description type
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.

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.

Members include: Only the VXLAN

Inner source IPv4 Data
InSrcIPv4
information. structure • InSrcIPv4Addr. encapsulation supports
• InSrcIPv4Wildcard. this column.

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

This column must be

configured together with
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.

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.

Wildcard mask for Example: 255.255.255.0.

InDstIPv4 String, dotted decimal
the inner N/A
Wildcard notation.
destination IPv4 This column is available

33
Column Column Column
Data type and restrictions Remarks
name description type
address. when the InDstAny
column is false.

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.

Boolean:
• 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.

Boolean:
• 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.

Unsigned integer. When InDstPortOp is 5,

InDstPortV End inner
N/A the value range is 0 to
alue2 destination port.
Value range: 0 to 65536. 65535. Otherwise, it can

34
 Column Column Column
Data type and restrictions Remarks
name description type
only be 65536. The value
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).
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/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>

35
 <DstIPv6>
<DstIPv6Addr></DstIPv6Addr>
<DstIPv6Prefix></DstIPv6Prefix>
</DstIPv6>
<DstObjectGroup></DstObjectGroup>
<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>
</Rule>
</IPv6AdvanceRules>
</ACL>

36
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.
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.
Source IPv6 Data This column must be
SrcIPv6 Members include:
information. structure configured together with

37
Column Column Column
Data type and restrictions Remarks
name description type
• SrcIPv6Addr. the SrcAny column.
• 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.
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.

RoutingType Whether a rule Boolean: This column and the

N/A
Any matches any • true—Matches any RoutingTypeValue

38
Column Column Column
Data type and restrictions Remarks
name description type
types of routing types of routing header. column cannot both be
header. • false—Matches the configured.
specified type of routing
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.
Boolean:
• 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.
Boolean:
• 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.
TcpFlag TCP flags. Data Members include: N/A

39
Column Column Column
Data type and restrictions Remarks
name description type
structure. • ACK.
• FIN.
• PSH.
• 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
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.

40
Column Column Column
Data type and restrictions Remarks
name description type
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).
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.

41
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>
<DstIPv6Prefix></DstIPv6Prefix>
</DstIPv6>
<DstObjectGroup></DstObjectGroup>
<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>

42
 <ICMP6>
<ICMP6Type></ICMP6Type>
<ICMP6Code></ICMP6Code>
</ICMP6>
<Fragment></Fragment>
<HopTypeAny></HopTypeAny>
<HopTypeValue></HopTypeValue>
<TimeRange></TimeRange>
<VRF></VRF>
<QoSLocalID></QoSLocalID>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
</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.
Action Action on N/A Enumeration: You cannot specify an

43
Column Column Column
Data type and restrictions Remarks
name description type
packets • 1—Deny. action when you remove
matching the • 2—Permit. or delete a rule.
rule. You must specify an
action when you replace a
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.
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.

44
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.
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.
Boolean:
• 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.

SrcPortValue End source port. N/A Unsigned integer. When SrcPortOp is 5, the

45
Column Column Column
Data type and restrictions Remarks
name description type
2 Value range: 0 to 65536. value range is 0 to 65535.
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.
DstPort column.
information. structure • DstPortValue1.
The members must be all
• DstPortValue2. specified.
Boolean:
• 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.
Unsigned integer.
RST flag in a Only the TCP protocol
RST N/A Value range: 0 or 1.
TCP packet. supports this column.
• 0—RST flag is not set.

46
Column Column Column
Data type and restrictions Remarks
name description type
• 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).
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.

47
 Column Column Column
Data type and restrictions Remarks
name description type
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.

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

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

48
 <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>

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

49
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 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.

Members include:
Link layer Data The VXLAN
Protocol
protocol. structure • ProtocolType. encapsulation supports
• ProtocolTypeMask. this column.

50
Column Column Column
Data type and restrictions Remarks
name description type
The members must both
be specified.
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 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.

Information Members include: Only the VXLAN

InDstMACAd about the inner Data
dr destination structure • InDstMACAddress. encapsulation supports
• InDstMACMask. this column.
MAC address.

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

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 • 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.

52
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>
<InDstMACMask></InDstMACMask>
</InDstMACAddr>
<InProtocol>
<InProtocolType></InProtocolType>
<InProtocolTypeMask></InProtocolTypeMask>
</InProtocol>
<TimeRange></TimeRange>
<Counting></Counting>
<Comment></Comment>
</Rule>
</MACNamedRules>

53
 </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 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 N/A Example: ff-ff-ff-ff-ff-ff.
source MAC hexadecimal digits,

54
Column Column Column
Data type and restrictions Remarks
name description type
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 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.

VxlanID VXLAN ID. N/A Unsigned integer Only the VXLAN

encapsulation supports

55
Column Column Column
Data type and restrictions Remarks
name description type
this column.
Value range: 0 to 16777215

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.

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.
TimeRange Time range. N/A String, case-insensitive. It cannot be the word all.

56
 Column Column Column
Data type and restrictions Remarks
name description type
Length: 1 to 32 characters.
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
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
IgnoreAction Whether to N/A Boolean: N/A

57
 Column Column Column
Data type and restrictions Remarks
name description type
ignore the • true—Ignore
packet filter the packet filter permit
permit action. 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.

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

58
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
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.

Application Enumeration:
AppDirection Index N/A
direction. • 1—Inbound.

59
 Column Column Column
Data type and restrictions Remarks
name description type
• 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.

XML structure
<ACL>
<UserRules>
<Rule>

60
<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>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>
<DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>

61
 <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.
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.

62
Column Column Column
Data type and restrictions Remarks
name description type
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.

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.

String for the Hexadecimal string. The length must be an

L4RuleString N/A
match pattern. Length: 2 to the even number.

63
Column Column Column
Data type and restrictions Remarks
name description type
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.
Boolean:
This column is available
Whether a rule • true—Matches any when the ProtocolType is
matches any source IP addresses specified.
SrcAny N/A (default).
source IP This column must be
addresses. • false—Matches the configured together with
specified source IP the SrcIPv4 column.
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.
Example: 1.1.1.1.
Source IPv4 String, dotted decimal This column is available
SrcIPv4Addr N/A
address. notation. when the SrcAny column
is false.

64
Column Column Column
Data type and restrictions Remarks
name description type
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.
Boolean:
This column is available
Whether a rule • true—Matches any when the ProtocolType is
matches any destination IP specified.
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.
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.

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.
Boolean:
• 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

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

65
 Column Column Column
Data type and restrictions Remarks
name description type
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.
Boolean:
• 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.

XML structure
<ACL>
<UserNamedRules>

66
<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>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>
<DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>

67
 <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.
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.

68
Column Column Column
Data type and restrictions Remarks
name description type
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.

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 Data Members include: The members must all be
L4Rule offset is relative structure • L4RuleString. specified.
to the beginning

69
Column Column Column
Data type and restrictions Remarks
name description type
of the Layer 4 • L4RuleMask.
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.

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
remove or delete a rule.
The value 256 represents all
IPv4 protocols.

Whether a rule Boolean:

This column is available
SrcAny
matches any
N/A • true—Matches any when the ProtocolType is
source IP source IP addresses specified.
addresses. (default).

70
Column Column Column
Data type and restrictions Remarks
name description type
• false—Matches the
specified source IP This column must be
address. configured together with
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

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.

Boolean: This column is available

Whether a rule • true—Matches any when the ProtocolType is
destination IP specified.
matches any
DstAny N/A addresses (default).
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

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.

Wildcard mask Example: 255.255.255.0.

DstIPv4Wildc String, dotted decimal
for the N/A
ard notation.
destination IPv4 This column is available

71
Column Column Column
Data type and restrictions Remarks
name description type
address. when the DstAny column
is false.

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.

Boolean:
• 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.

Boolean:
• 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
N/A N/A
1 port.
Value range: 0 to 65535.

Unsigned integer. When DstPortOp is 5, the

DstPortValue End destination
N/A value range is 0 to 65535.
2 port.
Value range: 0 to 65536. Otherwise, it can only be

72
 Column Column Column
Data type and restrictions Remarks
name description type
65536. The value 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>

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

73
 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.

74
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··················································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8
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 ·························································································································· 20
ACL/IPv4NamedAdvanceRules··································································································· 28
XML structure ··················································································································· 28
Table description ··············································································································· 30
Columns ·························································································································· 30
ACL/IPv6AdvanceRules ············································································································ 37
XML structure ··················································································································· 37
Table description ··············································································································· 39
Columns ·························································································································· 39
ACL/IPv6NamedAdvanceRules··································································································· 44
XML structure ··················································································································· 44
Table description ··············································································································· 45
Columns ·························································································································· 46
ACL/MACRules ······················································································································· 51
XML structure ··················································································································· 51
Table description ··············································································································· 52
Columns ·························································································································· 52

i
ACL/MACNamedRules·············································································································· 55
XML structure ··················································································································· 55
Table description ··············································································································· 56
Columns ·························································································································· 56
ACL/PfilterDefAction ················································································································· 59
XML structure ··················································································································· 59
Table description ··············································································································· 59
Columns ·························································································································· 60
ACL/PfilterIgnoreAction ············································································································· 60
XML structure ··················································································································· 60
Table description ··············································································································· 60
Columns ·························································································································· 60
ACL/PfilterApply ······················································································································ 60
XML structure ··················································································································· 61
Table description ··············································································································· 61
Columns ·························································································································· 61
ACL/PfilterGroupRunInfo ··········································································································· 62
XML structure ··················································································································· 62
Table description ··············································································································· 63
Columns ·························································································································· 63
ACL/PfilterRuleRunInfo ············································································································· 65
XML structure ··················································································································· 65
Table description ··············································································································· 65
Columns ·························································································································· 66
ACL/PfilterStatisticSum ············································································································· 67
XML structure ··················································································································· 67
Table description ··············································································································· 67
Columns ·························································································································· 68
ACL/UserRules ······················································································································· 68
XML structure ··················································································································· 68
Table description ··············································································································· 70
Columns ·························································································································· 70
ACL/UserNamedRules ·············································································································· 75
XML structure ··················································································································· 75
Table description ··············································································································· 77
Columns ·························································································································· 77
ACL/ZonePairPfilterApply ·········································································································· 82
XML structure ··················································································································· 82
Table description ··············································································································· 83
Columns ·························································································································· 83
ACL/ZonePairPfilterRules ·········································································································· 83
XML structure ··················································································································· 83
Table description ··············································································································· 84
Columns ·························································································································· 84

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 is supported for number

Name ACL name N/A
Length: 1 to 63 characters. ACL.

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>
<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 value range depends
on the GroupType column.
• 2000 to 3999 if
GroupType is 1.
 IPv4 basic ACL:
2000 to 2999.
 IPv4 advanced
String. ACL: 3000 to
Length: 1 to 63 3999.
characters. • 2000 to 3999 if
• ACL name: GroupType is 2.
ACL name or Case-insensitive  IPv6 basic ACL:
GroupIndex Index string of 1 to 63 2000 to 2999.
number
characters.  IPv6 advanced
• ACL number: ACL: 3000 to
String of digits in the 3999.
range of 2000 to • 4000 to 4999 if
5999. 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-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.

6
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.

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

XML structure
<ACL>
<IPv4BasicRules>

7
 <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

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.

8
Column Column Column Data type and
Remarks
name description type restrictions
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.
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.

9
 Column Column Column Data type and
Remarks
name description type restrictions
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>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
<RuleNum></RuleNum>
</Rule>
</IPv4NamedBasicRules>
</ACL>

10
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.
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.

11
Column Column Column Data type and
Remarks
name description type restrictions
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.

Number of rules in Unsigned integer.

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

12
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
Restrictions None

13
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.

RoutingTypeV Routing header Unsigned integer.

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

14
 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: 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>
<SrcIPv6>
<SrcIPv6Addr></SrcIPv6Addr>

15
 <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.
Action on Enumeration:
packets
Action
matching the
N/A • 1—Deny. N/A
rule. • 2—Permit.

16
Column Column Column
Data type and restrictions Remarks
name description type
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>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
</Rule>
</IPv4AdvanceRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name IPv4AdvanceRules
Table type Multi-instance table
Row name Rule
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.

20
Column Column Column
Data type and restrictions Remarks
name description type
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.

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.

21
Column Column Column
Data type and restrictions Remarks
name description type
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.

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.
Boolean:
• 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.

22
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
• 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.

23
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.

24
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.

25
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.

Boolean:
• 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.

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

Boolean:
• 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.
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.

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

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>

28
 <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>
<InDstPortValue2></InDstPortValue2>
</InDstPort>
<InEstablished></InEstablished>
<Counting></Counting>
<Logging></Logging>
<Comment></Comment>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
<RuleNum></RuleNum>
</Rule>
</IPv4NamedAdvanceRules>
</ACL>

29
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.
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.

30
Column Column Column
Data type and restrictions Remarks
name description type
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.

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.

31
Column Column Column
Data type and restrictions Remarks
name description type
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.
Boolean:
• 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.
Boolean:
• 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.

32
Column Column Column
Data type and restrictions Remarks
name description type
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.
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.

33
Column Column Column
Data type and restrictions Remarks
name description type
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.

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.

34
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.

35
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.

Boolean:
• 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.

Boolean:
• 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.

36
 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.
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/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>

37
 <SrcIPv6Prefix></SrcIPv6Prefix>
</SrcIPv6>
<SrcObjectGroup></SrcObjectGroup>
<DstAny></DstAny>
<DstIPv6>
<DstIPv6Addr></DstIPv6Addr>
<DstIPv6Prefix></DstIPv6Prefix>
</DstIPv6>
<DstObjectGroup></DstObjectGroup>
<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>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>

38
 </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.
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.

39
 Column Column Data type and
Column name Remarks
description type restrictions
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.
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.

40
 Column Column Data type and
Column name Remarks
description type restrictions
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.
Boolean:
• 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.
Boolean:
• 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.

41
 Column Column Data type and
Column name Remarks
description type restrictions
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.
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.

42
 Column Column Data type and
Column name Remarks
description type restrictions
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.
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.

43
 Column Column Data type and
Column name Remarks
description type restrictions
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/IPv6NamedAdvanceRules
This table contains named IPv6 advanced ACL rule information.

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>
<DSCP></DSCP>
<FlowLabel></FlowLabel>
<RoutingTypeAny></RoutingTypeAny>
<RoutingTypeValue></RoutingTypeValue>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>

44
 </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>
<Status></Status>
<Count></Count>
<MatchIndex></MatchIndex>
<RuleNum></RuleNum>
</Rule>
</IPv6NamedAdvanceRules>
</ACL>

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

45
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.

46
 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.

String, case-insensitive.
Destination
DstObjectGroup object group N/A N/A
name. Length: 1 to 31
characters.
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.

47
 Column Column Data type and
Column name Remarks
description type restrictions
Boolean:
• 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.
Boolean:
• 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.

48
 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.

49
 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.

50
 Column Column Data type and
Column name Remarks
description type restrictions
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/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>
<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>

51
 </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

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.

52
 Column Column
Column name Data type and restrictions Remarks
description type
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.
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

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

53
 Column Column
Column name Data type and restrictions Remarks
description type
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.

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.

54
 Column Column
Column name Data type and restrictions Remarks
description type
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>
</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>

55
 <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

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.

56
 Column Column
Column name Data type and restrictions Remarks
description type
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.
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.

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

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.

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.

58
 Column Column
Column name Data type and restrictions Remarks
description type
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>

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

59
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

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.

60
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

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.

61
 Column Column Data type and
Column name Remarks
description type restrictions
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.
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>

62
 <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

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.

63
 Column Column Data type and
Column name Remarks
description type restrictions
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.
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.

64
 Column Column Data type and
Column name Remarks
description type restrictions
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>

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

65
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.

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.

66
 Column Column Data type and
Column name Remarks
description type restrictions
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>

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

67
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.

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

XML structure
<ACL>
<UserRules>
<Rule>
<GroupID></GroupID>
<RuleID></RuleID>
<Action></Action>

68
<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>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>
<DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<SrcPort>
<SrcPortOp></SrcPortOp>
<SrcPortValue1></SrcPortValue1>
<SrcPortValue2></SrcPortValue2>
</SrcPort>
<DstPort>
<DstPortOp></DstPortOp>
<DstPortValue1></DstPortValue1>
<DstPortValue2></DstPortValue2>
</DstPort>
<DSCP></DSCP>

69
 <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.
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.

70
Column Column
Column description Data type and restrictions Remarks
name type
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.

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.

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

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.

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.

72
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.

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.

73
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.

Boolean:
• 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.

Boolean:
• 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.

74
 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/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>

75
<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>
<SrcAny></SrcAny>
<SrcIPv4>
<SrcIPv4Addr></SrcIPv4Addr>
<SrcIPv4Wildcard></SrcIPv4Wildcard>
</SrcIPv4>
<DstAny></DstAny>
<DstIPv4>
<DstIPv4Addr></DstIPv4Addr>
<DstIPv4Wildcard></DstIPv4Wildcard>
</DstIPv4>
<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>

76
 </Rule>
</UserNamedRules>
</ACL>

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.

77
Column Column
Column description Data type and restrictions Remarks
name type
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.

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.

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

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.

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.

79
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.

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.

80
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.

Boolean:
• 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.

Boolean:
• 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.

81
 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>

82
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>

83
 <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.

84
 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.

85
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 ··················································································································· 2
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
<ResetTunnelAdvpnSession>
<Reset>
<IPVersion></IPVersion>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
</Reset>
</ResetTunnelAdvpnSession>

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
PrivateAddres IPv4 address or IPv6
Private address N/A String
s address.

ResetAllSessions
This table is used to clear all ADVPN sessions.

1
XML structure
<ResetAllSessions>
<Reset>
<IPVersion></IPVersion>
</Reset>
</ResetAllSessions>

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
<ResetTunnelAdvpnSessionStat>
<Reset>
<IPVersion></IPVersion>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
</Reset>
</ResetTunnelAdvpnSessionStat>

Table description
Item Description
Feature name ADVPN

2
 Item Description
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
PrivateAddres IPv4 address or IPv6
Private address N/A String
s address.

ResetAllSessionStats
This table is used to clear all ADVPN session statistics.

XML structure
<ResetAllSessionStats>
<Reset>
<IPVersion></IPVersion>
</Reset>
</ResetAllSessionStats>

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 ··················································································································· 3
Columns ······························································································································ 4

i
ADVPN
TunnelAdvpnCfg
This table is used to configure ADVPN feature in the specified tunnel.

XML structure
<TunnelAdvpnCfg>
<Tunnel>
<TunnelID></TunnelID>
<IPv4Client></IPv4Client>
<Compatible></Compatible>
<IPv6Client></IPv6Client>
<DumbTime></DumbTime>
<IdleTime></IdleTime>
<SourcePort></SourcePort>
</Tunnel>
</TunnelAdvpnCfg>

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 deletion No

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
Unsigned integer
Source UDP port UDP and the
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.

IPv4Networks
This table is used to configure the IPv4 subnets under the specified tunnel which is ADVPN node.

XML structure
<IPv4Networks>
<IPv4Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>
</IPv4Network>
</IPv4Networks>

2
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 deletion Yes

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
<IPv6Networks>
<IPv6Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>
</IPv6Network>
</IPv6Networks>

Table description
Item Description
Feature name ADVPN

3
 Item Description
Table name IPv6Networks
Table type Multi-instance table
Row name IPv6Network
Restrictions None
Support for row creation and deletion Yes

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 ······························································································································ 2
XML structure ······················································································································· 2
Table description ··················································································································· 3
Columns ······························································································································ 3
IPv6Networks ······························································································································ 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 4
IPv4TunnelAdvpnSession ·············································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 5
Columns ······························································································································ 5
IPv6TunnelAdvpnSession ·············································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 8
Columns ······························································································································ 8
IPv4TunnelRunInfo····················································································································· 10
XML structure ····················································································································· 10
Table description ················································································································· 10
Columns ···························································································································· 11
IPv6AdvpnTunnelRunInfo ············································································································ 11
XML structure ····················································································································· 11
Table description ················································································································· 12
Columns ···························································································································· 12

i
ADVPN
TunnelAdvpnCfg
This table displays the configuration about ADVPN tunnels.

XML structure
<TunnelAdvpnCfg>
<Tunnel>
<TunnelID></TunnelID>
<IPv4Client></IPv4Client>
<Compatible></Compatible>
<IPv6Client></IPv6Client>
<DumbTime></DumbTime>
<IdleTime></IdleTime>
<SourcePort></SourcePort>
</Tunnel>
</TunnelAdvpnCfg>

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
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

Enumeration:
The value of "2"
Compatibility • 0—Incompatible means not specifying
Compatible N/A
configuration • 1—Compatible the IPv4 VAM client
• 2—Invalid config.

1
 Column Column Column
Data type and restrictions Remarks
name description type
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
Unsigned integer
Source UDP port UDP and the
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.

IPv4Networks
This table displays the IPv4 subnets configuration under an ADVPN node.

XML structure
<IPv4Networks>
<IPv4Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>
</IPv4Network>
</IPv4Networks>

2
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
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 displays the IPv6 subnets configuration under an ADVPN node.

XML structure
<IPv6Networks>
<IPv6Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>
</IPv6Network>
</IPv6Networks>

Table description
Item Description
Feature name ADVPN
Table name IPv6Networks

3
 Item Description
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.
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

IPv4TunnelAdvpnSession
This table is used to display IPv4 ADVPN tunnel session information.

XML structure
<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>

4
 <Multicasts></Multicasts>
<Errors></Errors>
</Input>
<Output>
<TotalPackets></TotalPackets>
<DataPackets></DataPackets>
<ControlPackets></ControlPackets>
<Multicasts></Multicasts>
<Errors></Errors>
</Output>
</IPv4AdvpnSession>
</IPv4TunnelAdvpnSession>

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
tunnel peer IPv6 address.

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
structure • AhOutbound protocol is
outbound SAs • EspInbound IPsec-UDP or IPsec-G
RE.
• EspOutbound

Inbound AH SP Unsigned integer

AhInbound N/A N/A
index Value range: 0 to 65535

Outbound AH SP Unsigned integer

AhOutbound N/A N/A
index Value range: 0 to 65535

5
Column Column Column
Data type and restrictions Remarks
name description type
Inbound ESP SP Unsigned integer
EspInbound N/A N/A
index Value range: 0 to 65535

Outbound ESP Unsigned integer

EspOutbound N/A N/A
SP index Value range: 0 to 65535

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
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

6
 Column Column Column
Data type and restrictions Remarks
name description type
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

IPv6TunnelAdvpnSession
This table is used to display IPv6 ADVPN tunnel session information.

XML structure
<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>

7
 <Multicasts></Multicasts>
<Errors></Errors>
</Input>
<Output>
<TotalPackets></TotalPackets>
<DataPackets></DataPackets>
<ControlPackets></ControlPackets>
<Multicasts></Multicasts>
<Errors></Errors>
</Output>
</IPv6AdvpnSession>
</IPv6TunnelAdvpnSession>

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
tunnel peer IPv6 address.

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 the link layer
Data
SPI inbound and
structure • AhOutbound protocol is
outbound SAs • EspInbound IPsec-UDP or IPsec-G
RE.
• EspOutbound

Inbound AH SP Unsigned integer

AhInbound N/A N/A
index Value range: 0 to 65535

Outbound AH SP Unsigned integer

AhOutbound N/A N/A
index Value range: 0 to 65535

8
Column Column Column
Data type and restrictions Remarks
name description type
Inbound ESP SP Unsigned integer
EspInbound N/A N/A
index Value range: 0 to 65535

Outbound ESP Unsigned integer

EspOutbound N/A N/A
SP index Value range: 0 to 65535

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
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

9
 Column Column Column
Data type and restrictions Remarks
name description type
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

IPv4TunnelRunInfo
This table displays the IPv4 interface information.

XML structure
<IPv4TunnelRunInfo>
<TunnelRunInfo>
<TunnelID></TunnelID>
<ClientName></ClientName>
<DomainName></DomainName>
<LinkProtocol></LinkProtocol>
<SessionNum></SessionNum>
</TunnelRunInfo>
</IPv4TunnelRunInfo>

Table description
Item Description
Feature name ADVPN
Table name IPv4TunnelRunInfo
Table type Multi-instance table
Row name TunnelRunInfo

10
 Item Description
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
VAM client String Case-insensitive and
ClientName N/A contains only letters,
bound to the Length: 1 to 63 characters
tunnel interface digits, and dots (.).

String Case-insensitive and

Domain name of
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
ADVPN tunnel • 2—UDP
• 3—IPsec-GRE
• 4—IPsec-UDP
Number of
ADVPN tunnels
SessionNum established on N/A Unsigned integer N/A
the tunnel
interface

IPv6AdvpnTunnelRunInfo
This table displays the IPv6 interface information.

XML structure
<IPv6TunnelRunInfo>
<TunnelRunInfo>
<TunnelID></TunnelID>
<ClientName></ClientName>
<DomainName></DomainName>
<LinkProtocol></LinkProtocol>
<SessionNum></SessionNum>
</TunnelRunInfo>
</IPv6TunnelRunInfo>

11
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
VAM client String Case-insensitive and
ClientName N/A contains only letters,
bound to the Length: 1 to 63 characters
tunnel interface digits, and dots (.).

String Case-insensitive and

Domain name of
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
ADVPN tunnel • 2—UDP
• 3—IPsec-GRE
• 4—IPsec-UDP
Number of
ADVPN tunnels
SessionNum established on N/A Unsigned integer N/A
the tunnel
interface

12
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, 64, N/A
gth length
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>
<GroupNumber></GroupNumber>

5
 <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
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 ······························································································································ 4
AP/RegroupAPByMac ··················································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 4
AP/RegroupAPBySerialID·············································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 5
AP/RegroupAPByGroup ················································································································ 5
XML structure ······················································································································· 5
Table description ··················································································································· 6
Columns ······························································································································ 6
AP/AuthenticateAP ······················································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 7
Columns ······························································································································ 7
AP/AuthenticateAllAP ··················································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 8
AP/ImportAuthenticateFile ············································································································· 8
XML structure ······················································································································· 8
Table description ··················································································································· 8
Columns ······························································································································ 8
AP/ProvisionAP ··························································································································· 8
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
If this column contains
String, lowercase. uppercase character, it
ApName AP name Index will be converted to
Length: 1 to 64 characters. lowercase
automatically.

AP/ResetAllAP
This table contains information of resetting all APs.

XML structure
<AP>
<ResetAllAP>
<Global>

1
 <ResetType></ResetType>
</Global>
</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
Enumeration:
Which type of APs will be
ResetType
reset.
Index • 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

2
 Item Description
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If this column contains
String, lowercase. uppercase character, it
ApName AP name Index will be converted to
Length: 1 to 64 characters. lowercase
automatically.

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

3
Columns
Column Column Column
Data type and restrictions Remarks
name description type
If this column contains
String, lowercase. uppercase character, it
ApName AP name Index will be converted to
Length: 1 to 64 characters. lowercase
automatically.
The name of AP String, lowercase.
GroupName group which the N/A N/A
AP will belong to. Length: 1 to 31 characters.

AP/RegroupAPByMac
This table contains information of AP regrouping by MAC address.

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
Six groups of two hexadecimal Example:
MacAddress AP MAC address Index
digits, hyphen-separated. 00-0c-af-e3-5d-c0.
The name of AP String, lowercase.
GroupName group which the N/A N/A
AP will belong to. Length: 1 to 31 characters.

4
AP/RegroupAPBySerialID
This table contains information of AP regrouping by serial ID.

XML structure
<AP>
<RegroupAPBySerialID>
<SerialID>
<SerialID></SerialID>
<GroupName></GroupName>
</SerialID>
</RegroupAPBySerialID>
</AP>

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
If this column contains
String, uppercase. lowercase character, it
SerialID AP serial ID Index will be converted to
Length: 1 to 127 characters. uppercase
automatically.
The name of AP String, lowercase.
GroupName group which the N/A N/A
AP will belong to. Length: 1 to 31 characters.

AP/RegroupAPByGroup
This table contains information of AP regrouping by group.

XML structure
<AP>
<RegroupAPByGroup>
<Group>

5
 <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
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If this column contains
String, lowercase. uppercase character, it
OldGroupNa The name of old
Index will be converted to
me AP group. Length: 1 to 31 characters. lowercase
automatically.
If this column contains
The name of AP
String, lowercase. uppercase character, it
NewGroupNa group which the
N/A will be converted to
me AP in old group Length: 1 to 31 characters. lowercase
will belong to.
automatically.

AP/AuthenticateAP
This table contains information of authenticating APs.

XML structure
<AP>
<AuthenticateAP>
<AP>
<ApName></ApName>
<Action></Action>
</AP>
</AuthenticateAP>
</AP>

6
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
If this column contains
String, lowercase. uppercase character, it
ApName AP name Index will be converted to
Length: 1 to 64 characters. lowercase
automatically.

The Enumeration:
Action authenticating N/A • 1—Accept. N/A
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

7
Columns
Column Column Column
Data type and restrictions
name description type
The Enumeration:
Action authenticating N/A • 1—Accept.
action type. • 2—Reject.

AP/ImportAuthenticateFile
This table contains information of importing authenticating file.

XML structure
<AP>
<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
The TXT file name String, Should end with “.txt”
with full path which case-insensitive. and specify the
FileName will be imported as N/A
Length: 1 to 255 authentication ACL
the AP ACL rules for
characters. first.
AP authentication.

AP/ProvisionAP
This table contains information of provisioning APs.

8
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
Row name AP
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
If this column contains
String, lowercase. uppercase character, it
ApName AP name Index will be converted to
Length: 1 to 64 characters. lowercase
automatically.

The Enumeration:
Action authenticating N/A • 1—Provision. N/A
action type. • 2—Reset provisioning.

9
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 ··················································································································· 6
Columns ······························································································································ 7
AP/PrvsOfManualAP ·················································································································· 11
XML structure ····················································································································· 11
Table description ················································································································· 11
Columns ···························································································································· 12
AP/PrvsOfManualAPACIPv4 ········································································································ 13
XML structure ····················································································································· 13
Table description ················································································································· 13
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 ···························································································································· 21
AP/APGroup ····························································································································· 21
XML structure ····················································································································· 21
Table description ················································································································· 22
Columns ···························································································································· 22
AP/APGroupMACRule ················································································································ 24
XML structure ····················································································································· 24
Table description ················································································································· 24
Columns ···························································································································· 24
AP/APGroupSerialIDRule ············································································································ 25
XML structure ····················································································································· 25
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 ················································································································· 27
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>
</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, lowercase. If this column contains
uppercase character, it will
Name AP name. Index Length: 1 to 64 be converted to lowercase
characters. automatically.
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.

4
 Whether the AP will be Boolean:
forced to switch the • true: Switch
Preempt N/A N/A
backup tunnel to active
by priority. • false: Not switch

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.

ControlAddressIPv6 Specify an AC IPv4 N/A Hexadecimal string, Example: 1:1::1:1.

5
 address for AC colon-separated.
rediscovery.

Whether to enable Boolean:

ProvisionAutoUpgrade provision N/A • true—Enable. N/A
auto-upgrade. • false—Disable.
Boolean:
Whether to enable
ProvisionAutoRecover
provision auto-recover.
N/A • true—Enable. N/A
• false—Disable.

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>
</Radio>
</RadioOfManualAP>
</AP>

Table description
Item Description
Feature name AP

6
 Item Description
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
If this column contains
String, lowercase. uppercase character, it
ApName AP name. Index
Length: 1 to 64 characters. will be converted to
lowercase automatically.
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
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
Restrictions None
Support for row creation
No
and deletion

11
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase. If this column contains
Length: 1 to 64 characters. uppercase character, it
ApName AP name Index
will be converted to
lowercase automatically.
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.
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.

12
 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 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>

Table description
Item Description
Feature name AP
Table name PrvsOfManualAPACIPv4
Table type Multi-instance table
Row name Prvs
Restrictions None

13
 Item Description
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
ApName AP 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/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

14
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
ApName ApName Index N/A
Length: 1 to 31 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 Data type and
Column description Remarks
name type restrictions
If this column
contains
String, lowercase. uppercase
ApName AP name. Index character, it will be
Length:1to 64 characters. converted to
lowercase
automatically.
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
AccessCategory Index • 1—BE. N/A
used by a WMM STA to
conten d for the • 2—VI.
channel in order to 3—VO
transmit MSDUs with
certain priorities.
Boolean:
Whehter • true—Not required. N/A
Noack acknowledgement is N/A
required. • false—Required.
The default value is false.
ArbitrationInter Frame The value range conforms
CfgAifsn Spacing Number. N/A to "AP/RadiolDB/Aifsn" N/A
column.
The value range conforms
Exponent form of
CfgEcwmin N/A to "AP/RadiolDB/Ecwmin" N/A
CWmin.
column.
The value range conforms
Exponent form of
CfgEcwmax N/A to "AP/RadiolDB/Ecwmax" N/A
CWmax.
column.
The value range conforms
Transmission
CfgTxOpLimit N/A to "AP/RadiolDB/TxOpLimit" N/A
oppurtunity limit.
column.

AP/RadioWmm
This table contains radio WMM information.

XML structure
<AP>
<RadioWmm>
<Wmm>
<ApName></ApName>
<RadioID></RadioID>

16
 <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

Columns
Column Column Column Data type and
Remarks
name description type restrictions
If this column contains
uppercase character, it
ApName AP name. Index ApName
will be converted to
lowercase automatically.
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>

17
 <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>
</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, lowercase. If this column contains
Length: 1 to 64 characters. uppercase character, it
ApName AP name. Index
will be converted to
lowercase automatically.
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.

18
Column Column Column Data type and
Remarks
name description type restrictions
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.

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.

19
 Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
Client11nOn Client dot11n only
N/A • true—Enable. N/A
ly function.
• false—Disable.
Boolean:
• true—Enable. N/A
Bandwidth • false—Disable.
BandwidthA
autoswitch N/A
utoswitch The column is only for
function.
2.4GHz radio mode, and
AP/RadioOfManualAP/Ban
dwidth must be 2..

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

20
Columns
Column Column Column Data type and
Remarks
name description type restrictions
If this column contains
String, lowercase. uppercase character, it
ApName AP name. Index
Length: 1 to 64 characters. will be converted to
lowercase automatically.
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.

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>

21
 <RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
<ProvisionAutoUpgrade></ProvisionAutoUpgrade>
<ProvisionAutoRecover></ProvisionAutoRecover>
</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.

22
Column Column Column Data type and
Remarks
name description type restrictions
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.
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

23
 Column Column Column Data type and
Remarks
name description type restrictions
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

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.

24
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>

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>

25
 <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
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, lowercase.
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>

26
Table description
Item Description
Feature name AP
Table name APGroupIPv4Rule
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.
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

27
 Item Description
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.
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

28
 Item Description
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-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>

29
 </APGroupRadio>
</AP>

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)

30
Column Column Column Data type and
Remarks
name description type restrictions
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.
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-insensitive.
AclName local AP N/A uses an ACL number.
authentication. Length: 1 to 63 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
If this column contains
String, lowercase. uppercase character, it
Name Local-ac name. Index Length: 1 to 64 will be converted to
characters. lowercase
automatically.
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.
Value range: 0, 5 to
The transmit interval of 255
EchoInterval N/A N/A
tunnel echo messages.
.
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, lowercase.
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, lowercase.
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 ································································································4
AP/APSummary ························································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 6
AP/GlobalCfg ·························································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
AP/ManualAP ························································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
AP/APRunningCfg···················································································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 17
Columns ·························································································································· 17
AP/RunAP ······························································································································ 19
XML structure ··················································································································· 19
Table description ··············································································································· 20
Columns ·························································································································· 20
AP/APHistory ·························································································································· 22
XML structure ··················································································································· 22
Table description ··············································································································· 23
Columns ·························································································································· 23
AP/RadioOfManualAP··············································································································· 23
XML structure ··················································································································· 23
Table description ··············································································································· 24
Columns ·························································································································· 24
AP/RadioRunningCfg ················································································································ 29
XML structure ··················································································································· 29
Table description ··············································································································· 29
Columns ·························································································································· 30
AP/Radio11n ·························································································································· 34
XML structure ··················································································································· 34
Table description ··············································································································· 34
Columns ·························································································································· 35
AP/Radio11ac ························································································································· 36
XML structure ··················································································································· 36
Table description ··············································································································· 37
Columns ·························································································································· 37
AP/RadioRunningCfg11n ··········································································································· 38
XML structure ··················································································································· 38
Table description ··············································································································· 38
Columns ·························································································································· 39
AP/RadioRunningCfg11ac ········································································································· 40
XML structure ··················································································································· 40
Table description ··············································································································· 40
Columns ·························································································································· 41
AP/RadioOfRunAP ··················································································································· 41
XML structure ··················································································································· 42
Table description ··············································································································· 42
Columns ·························································································································· 42
AP/PrvsOfManualAP ················································································································ 44
XML structure ··················································································································· 44
Table description ··············································································································· 44
Columns ·························································································································· 45

1
AP/PrvsOfManualAPACIPv4 ······································································································ 46
XML structure ··················································································································· 46
Table description ··············································································································· 46
Columns ·························································································································· 47
AP/PrvsOfManualAPACIPv6 ······································································································ 47
XML structure ··················································································································· 47
Table description ··············································································································· 47
Columns ·························································································································· 48
AP/APDB ······························································································································· 48
XML structure ··················································································································· 48
Table description ··············································································································· 48
Columns ·························································································································· 49
AP/APDBVersion ····················································································································· 49
XML structure ··················································································································· 49
Table description ··············································································································· 49
Columns ·························································································································· 50
AP/RadioDB ··························································································································· 50
XML structure ··················································································································· 50
Table description ··············································································································· 51
Columns ·························································································································· 51
AP/RegionDB ·························································································································· 54
XML structure ··················································································································· 54
Table description ··············································································································· 54
Columns ·························································································································· 54
AP/AntennaDB ························································································································ 55
XML structure ··················································································································· 55
Table description ··············································································································· 55
Columns ·························································································································· 55
AP/ChannelTypeMap ················································································································ 56
XML structure ··················································································································· 56
Table description ··············································································································· 56
Columns ·························································································································· 56
AP/PowerIndex ······················································································································· 58
XML structure ··················································································································· 58
Table description ··············································································································· 58
Columns ·························································································································· 59
AP/ChannelDB ························································································································ 60
XML structure ··················································································································· 60
Table description ··············································································································· 61
Columns ·························································································································· 61
AP/PowerDB ··························································································································· 63
XML structure ··················································································································· 63
Table description ··············································································································· 63
Columns ·························································································································· 64
AP/ChannelReport ··················································································································· 66
XML structure ··················································································································· 66
Table description ··············································································································· 67
Columns ·························································································································· 67
AP/NeighborAPReport ·············································································································· 68
XML structure ··················································································································· 68
Table description ··············································································································· 68
Columns ·························································································································· 69
AP/EdcaRadio ························································································································· 69
XML structure ··················································································································· 69
Table description ··············································································································· 70
Columns ·························································································································· 70
AP/RadioWmm ························································································································ 71
XML structure ··················································································································· 71
Table description ··············································································································· 71
Columns ·························································································································· 72
AP/APGroup ··························································································································· 72
XML structure ··················································································································· 72

2
 Table description ··············································································································· 73
Columns ·························································································································· 73
AP/APGroupMACRule ·············································································································· 74
XML structure ··················································································································· 74
Table description ··············································································································· 75
Columns ·························································································································· 75
AP/APGroupSerialIDRule ·········································································································· 75
XML structure ··················································································································· 75
Table description ··············································································································· 75
Columns ·························································································································· 76
AP/APGroupNameRule ············································································································· 76
XML structure ··················································································································· 76
Table description ··············································································································· 76
Columns ·························································································································· 77
AP/APGroupIPv4Rule ··············································································································· 77
XML structure ··················································································································· 77
Table description ··············································································································· 77
Columns ·························································································································· 77
AP/APGroupIPv6Rule ··············································································································· 78
XML structure ··················································································································· 78
Table description ··············································································································· 78
Columns ·························································································································· 78
AP/APGroupModel ··················································································································· 79
XML structure ··················································································································· 79
Table description ··············································································································· 79
Columns ·························································································································· 79
AP/APGroupRadio ··················································································································· 79
XML structure ··················································································································· 79
Table description ··············································································································· 80
Columns ·························································································································· 81
AP/APGroupRadio11n ·············································································································· 85
XML structure ··················································································································· 85
Table description ··············································································································· 86
Columns ·························································································································· 86
AP/APGroupRadio11ac ············································································································· 87
XML structure ··················································································································· 87
Table description ··············································································································· 88
Columns ·························································································································· 88
AP/APGroupPrvs ····················································································································· 89
XML structure ··················································································································· 89
Table description ··············································································································· 89
Columns ·························································································································· 90
AP/APGroupPrvsACIPv4 ··········································································································· 90
XML structure ··················································································································· 90
Table description ··············································································································· 90
Columns ·························································································································· 91
AP/APGroupPrvsACIPv6 ··········································································································· 91
XML structure ··················································································································· 91
Table description ··············································································································· 91
Columns ·························································································································· 92
AP/APListOfGroup ··················································································································· 92
XML structure ··················································································································· 92
Table description ··············································································································· 92
Columns ·························································································································· 92
AP/Location ···························································································································· 93
XML structure ··················································································································· 93
Table description ··············································································································· 93
Columns ·························································································································· 93
AP/APAuthentication ················································································································ 93
XML structure ··················································································································· 93
Table description ··············································································································· 94
Columns ·························································································································· 94

3
 AP/HistorySummary ················································································································· 94
XML structure ··················································································································· 94
Table description ··············································································································· 95
Columns ·························································································································· 95
AP/AllAP ································································································································ 96
XML structure ··················································································································· 96
Table description ··············································································································· 96
Columns ·························································································································· 97
AP/LocalACDB ························································································································ 97
XML structure ··················································································································· 97
Table description ··············································································································· 97
Columns ·························································································································· 98
AP/LocalAC ···························································································································· 98
XML structure ··················································································································· 98
Table description ··············································································································· 98
Columns ·························································································································· 99
AP/ContainerTopology ············································································································ 100
XML structure ················································································································· 100
Table description ············································································································· 100
Columns ························································································································ 100
AP/Container ························································································································ 100
XML structure ················································································································· 101
Table description ············································································································· 101
Columns ························································································································ 101

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>

4
 <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>
<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

5
 Item Description
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.
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.

6
 Column Data type and
Column name Column type
description restrictions
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.

which channel busy is
ChannelBusy30PctNum N/A Value range: 0 to
between 30% and
40% 4294967295.

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.
NoiseFloor100Num which noise floor is N/A Value range: 0 to
between 100dbm and 4294967295.

7
 Column Data type and
Column name Column type
description restrictions
105dbm
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.

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%

8
 Column Data type and
Column name Column type
description restrictions
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.
which802.11
Dot11Interf90PctNum N/A Value range: 0 to
interference is upper
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%
NonDot11Interf60PctNum Number of radios N/A Unsigned integer.

9
 Column Data type and
Column name Column type
description restrictions
which non-802.11 Value range: 0 to
interference is 4294967295.
between 60% and
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 runing 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.
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>

10
 <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
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.

11
Column Column Column Data type and
Remarks
name description type restrictions
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
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, lowercase.

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.

12
 Column Column Column Data type and
Remarks
name description type restrictions
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

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>

13
 <LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
<OfflineTime></OfflineTime>
<OfflineMoment></OfflineMoment>
<ControlAddress></ControlAddress>
<ControlAddressIPv4></ControlAddressIPv4>
<ControlAddressIPv6></ControlAddressIPv6>
<ProvisionAutoUpgrade></ProvisionAutoUpgrade>
<ProvisionAutoRecover></ProvisionAutoRecover>
<ModelType></ModelType>
</AP>
</ManualAP>
</AP>

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, lowercase.
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

14
Column Column Column Data type and
Remarks
name description type restrictions
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.

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.

15
 Column Column Column Data type and
Remarks
name description type restrictions
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
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 Whether to enabel N/A Enumeration: When the value is 3,
wtu configuration
• 1—normal some command can not
be configurated.
• 2—wt
• 3—wtu

AP/APRunningCfg
This table contains information of AP running configurations.

XML structure
<AP>

16
 <APRunningCfg>
<AP>
<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>
</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, lowercase.
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.

17
Column Column Column Data type and
Remarks
name description type restrictions
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
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

18
AP/RunAP
This table contains the information of the running AP.

XML structure
<AP>
<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>

19
Table description
Item Description
Feature name AP
Table name RunAP
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
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.

20
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
The time since the Value range: 0 to
OnlineTime N/A N/A
AP online. 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
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
LastFailRea synchronizing String.
N/A N/A
son configurations to Length: 1 to 31 characters.
the AP failed in

21
 Column Column Column Data type and
Remarks
name description type restrictions
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
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, lowercase.

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>

22
Table description
Item Description
Feature name AP
Table name APHistory
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
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>

23
 <SupportDot11AC></SupportDot11AC>
<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>
<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, lowercase.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.

24
Column Column Column Data type and
Remarks
name description type restrictions
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.

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

25
Column Column Column Data type and
Remarks
name description type restrictions
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
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

26
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).

27
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

28
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

29
 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, lowercase.
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.

30
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

31
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

32
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
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.
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.

33
 Column Column Column Data type and
Remarks
name description type restrictions
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>
<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.

34
 Item Description
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase. If this column contains
Length: 1 to 64 characters. uppercase character, it
ApName AP name. Index
will be converted to
lowercase automatically.
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.
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.

35
 Column Column Column Data type and
Remarks
name description type restrictions
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..

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>

36
 </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
If this column contains
String, lowercase. uppercase character, it
ApName AP name. Index
Length: 1 to 64 characters. will be converted to
lowercase automatically.
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.

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.

37
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>
</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

38
Columns
Column Column Column Data type and
Remarks
name description type restrictions
If this column contains
String, lowercase. uppercase character, it
ApName AP name. Index
Length: 1 to 64 characters. will be converted to
lowercase automatically.
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.
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.

39
 Column Column Column Data type and
Remarks
name description type restrictions
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>
<ApName></ApName>
<RadioID></RadioID>
<VHTNSSMulticast></VHTNSSMulticast>
<VHTMCSMulticast></VHTMCSMulticast>
<VHTNSSMandatory></VHTNSSMandatory>
<VHTNSSSupported></VHTNSSSupported>
<Client11acOnly></Client11acOnly>
</Dot11ac>
</RadioRunningCfg11ac>
</AP>

Table description
Item Description
Feature name AP

40
 Item Description
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, lowercase. If this column contains
Length: 1 to 64 characters. uppercase character, it
ApName AP name. Index
will be converted to
lowercase automatically.
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.
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.

41
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

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.

42
Column Column Column Data type and
Remarks
name description type restrictions
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 BasicBSSID. N/A hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.
TxPower TxPower. N/A Unsigned short. N/A
String, Length: 1 to 7
NoiseFloor NoiseFloor. N/A N/A
characters.
ChannelBus ChannelBusy
N/A Unsigned short. N/A
y

43
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
Restrictions None
Support for row creation
No
and deletion

44
Columns
Column Column Column Data type and
Remarks
name description type restrictions
If this column contains
String, lowercase. uppercase character, it
ApName AP name. Index
Length: 1 to 64 characters. will be converted to
lowercase automatically.
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.

45
 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

46
 Item Description
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
ApName AP 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/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

47
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
ApName AP name. Index N/A
Length: 1 to 31 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

48
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,
Whether to enabel • 1—normal
ModelType N/A some command can not
wtu configuration. • 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

49
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>

50
 <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.

51
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.

52
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.

53
 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.

54
 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.

55
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)
Enumeration:
• 1—20M
• 2—40M
Bandwidth Radio bandwidth Index • 3—80M N/A
• 4—160M
• 5—80M + 80M
• 17—5M

56
 • 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.
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
Type of spectrum, mode
ChannelTyp
bandwidth and N/A N/A
e • 13—802.11n(5GHz)
channel range.
(36 to 64) in 40M
mode
• 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

57
 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

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

58
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

59
 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 (100to
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>

60
 <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

61
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

62
 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

63
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

64
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

65
 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>

66
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-insensitive.
ApName AP name Index N/A
Length: 1 to 63 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: %.

67
 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

68
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-insensitive.
ApName AP name Index N/A
Length: 1 to 63 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>

69
 <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 Data type and
Column description Remarks
name type restrictions
If this column
contains
String, lowercase. uppercase
ApName AP name. Index character, it will be
Length:1to 64 characters. converted to
lowercase
automatically.
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
AccessCategory
used by a WMM STA to
Index • 1—BE. N/A
conten d for the • 2—VI.
channel in order to • 3—VO.
transmit MSDUs with
certain priorities..
Noack Whehter N/A Boolean:

70
 Column Column Data type and
Column description Remarks
name type restrictions
acknowledgement is • true—Not required. N/A
required. • false—Required.
The value range conforms
ArbitrationInter Frame
CfgAifsn N/A to “AP/RadiolDB/Aifsn” N/A
Spacing Number.
column.
The value range conforms
Exponent form of
CfgEcwmin N/A to “AP/RadiolDB/Ecwmin” N/A
CWmin.
column.
The value range conforms
Exponent form of
CfgEcwmax N/A to “AP/RadiolDB/Ecwmax” N/A
CWmax.
column.
The value range conforms
Transmission
CfgTxOpLimit N/A to “AP/RadiolDB/TxOpLimit” N/A
oppurtunity 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

71
Columns
Column Column Column Data type and
Remarks
name description type restrictions
If this column contains
String, lowercase. uppercase character, it
ApName AP name. Index
Length: 1 to 64 characters. will be converted to
lowercase automatically.
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>
</Group>
</APGroup>
</AP>

72
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.

73
 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.

AP/APGroupMACRule
This table contains information of AP groups’ rules of MAC address.

XML structure
<AP>
<APGroupMACRule>

74
 <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>

Table description
Item Description
Feature name AP

75
 Item Description
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

76
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, lowercase.
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.

77
 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.

78
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>

79
 <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

80
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

81
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.

82
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)

83
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.

84
 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 >

85
 </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.

86
 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>

87
 <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.

88
 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

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.
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

90
 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

91
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, lowercase.
ApName AP name Index N/A
Length: 1 to 64 characters.

92
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>

93
 </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-insensitive.
AclName local AP N/A uses an ACL number.
authentication. Length: 1 to 63 characters.
The ACL name should
not be “all”.

AP/HistorySummary
This table contains information of history summary.

XML structure
<AP>
<HistorySummary>
<Record>
<Date></Date>

94
 <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.

95
 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>
</AP>
</AllAP>
</AP>

Table description
Item Description
Feature name AP
Table name AllAP
Table type Multi-instance table
Row name AP
Restrictions None

96
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, lowercase.
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.

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

97
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.

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

98
 Item Description
Row name AC
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
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

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.

99
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>

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, lowercase.
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, lowercase.
UnitName Unit name N/A N/A
Length: 1 to 64 characters.

AP/Container
This table contains information about containers.

100
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>
</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, lowercase.
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

101
Column Column Column Data type and
Remarks
name description type restrictions
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.
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

102
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
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 64 N/A
by the interface Value range: 0 to 2 - 1.

Number of bytes Unsigned integer.

InBytes received by the N/A 64 N/A
interface Value range: 0 to 2 - 1.

Packets received Unsigned integer.

InPPS per second by N/A 32 N/A
the interface Value range: 0 to 2 - 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
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 dynamic ARP entries.

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 ······························································································································ 2
ARP/ArpGratuitous ······················································································································· 2
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
ARP/ArpLearnLimit······················································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 4
ARP/ArpGratuitousInterval ············································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 6
Columns ······························································································································ 6
ARP/ArpProxy ····························································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 8
ARP/ArpAttackProtect ··················································································································· 9
XML structure ······················································································································· 9
Table description ··················································································································· 9
Columns ······························································································································ 9
ARP/ArpRateLimit ······················································································································ 11
XML structure ····················································································································· 11
Table description ················································································································· 11
Columns ···························································································································· 12
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 ···························································································································· 18
ARP/ArpFilterSource ·················································································································· 18
XML structure ····················································································································· 18
Table description ················································································································· 19
Columns ···························································································································· 19
ARP/ArpFilterBinding ·················································································································· 20
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

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

1
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.

It must be configured
together with the
PortIndex column when
Unsigned integer.
VLANID VLAN ID N/A ArpType is static.
Value range: 1 to 4094.
It must be specified
when ArpType is
multiport.

It must be configured
together with the
VLANID column when
PortIndex Port index N/A Unsigned integer. ArpType is 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.

2
XML structure
<ARP>
<ArpGratuitous>
<LearnEnable></LearnEnable>
<SendEnable></SendEnable>
</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
enable.

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 enable.

3
ARP/ArpLearnLimit
This table contains the information of maximum number of dynamic ARP entries that an interface
can learn.

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

4
 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
IfIndex Interface Index Index Unsigned integer.
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>

5
 </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

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.

The interval at Unsigned integer. 0 means disable the

which gratuitous Value range: 0, 200 to interface from
Interval N/A
ARP packets are 200000ms. periodically sending
sent Default: 0. gratuitous ARP packets.

6
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

Support for row creation and deletion No

7
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.

Whether the
function of proxy Boolean:
ProxyEnabl
arp on the N/A • true N/A
e
interface is • false (default)
enable.

Whether the
function of local Boolean:
LocalProxyE N/A
proxy arp on the N/A • true
nable
interface is • false (default)
enable.

LocalStartIpv4Address

and
LocalEndIpv4Address
Start Ipv4 address must be configed
of the together.
LocalStartIp String, dotted decimal
specified address N/A LocalStartIpv4Address
v4Address notation.
range for local and
proxy arp 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

8
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>
<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

Whether the Boolean: The default value of

ResolvingR
resolving route N/A • true ResolvingRouteEnable
outeEnable
function is enable. • false depends on the device

9
 model.

Whether the arp

SourceSupp Boolean:
suppression
ressionEnab N/A • true N/A
original address
le • false (default)
function is enable.

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.
detection function
SourceMAC • 0—Disabled (default).
of fixed source N/A N/A
DetectType • 1—Filter.
mac address and
selecthe 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.
detecton entries

The value of
uiSourceMinThreshold
Set the fixed and
Unsigned integer.
source mac uiSourceMaxThreshold
SourceMAC Unsigned integer.
address depend on the device
ThresholdV N/A Value range:
threshold of arp model.
alue uiSourceMinThreshold to
attack detecton The default value of
uiSourceMaxThreshold.
entries 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 enable.

Unsigned integer.

ActiveACKT Enable the active • 0—Disabled (default).

N/A N/A
ype ack function • 1—Loose.
• 2—Strict.

DetectionVa Whether the N/A Boolean: N/A

10
 lidateSrcMA effective checks • true
C on the source mac • false (default)
address function
is enable

Whether the
DetectionVa effective checks Boolean:
lidateDstMA on the destination N/A • true N/A
C mac address • false (default)
function is enable

Whether the
Boolean:
DetectionVa effective checks
N/A • true N/A
lidateIP on the ip address
• false (default)
is enable.

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

11
 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.

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.

ARP/ArpRateLimitLog
This table contains ARP rate limit log information.

XML structure
<ARP>

12
 <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

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
enable. • 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>

13
 </SourceMACExclude>
</ArpSourceMACExclude>
</ARP>

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 MAX number of
protective source mac
Six groups of two
address that can
MacAddress MAC address Index hexadecimal digits,
configed depends on the
hyphen-separated.
device model.

ARP/ArpAuthorized
This table contains the arp authorized information.

XML structure
<ARP>
<ArpAuthorized>
<Authorized>
<IfIndex></IfIndex>
<Enable></Enable>
</Authorized>
</ArpAuthorized>

14
 </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

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 the arp

Enable N/A Boolean: N/A
authorized

15
 function is enable. • true
• false (default)

ARP/ArpDetection
This table contains the information about arp detections.

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

DetectionEn Whether the arp detection Boolean:

N/A
able function is enable. • true

16
 • false (default)

RestrictedF Whether the function of Boolean:

orwardingEn restricted forwarding arp N/A • true
able packet is enable. • false (default)

ARP/ArpDetectionTrust
This table contains the information of interface that arp trusted.

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

17
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

IfIndex Interface index. Index Unsigned integer. relevant information, see

the XSD document of
your product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

Whether the
Boolean:
function of trusting
TrustEnable N/A • true N/A
interface is
• false
enable.

ARP/ArpFilterSource
This table contains the information about arp gateway protection and protected ip address.

XML structure
<ARP>
<ArpFilterSource>
<FilterSource>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
</FilterSource>
</ArpFilterSource>
</ARP>

18
Table description

Item Description
Feature name ARP

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

19
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>

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
IfIndex Interface index. Index Unsigned integer.
Layer 2 aggregate
interface

20
 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.

The permited ip String, dotted decimal

Ipv4Address Index N/A
address notation.

You cannot specify an

Six groups of two
MacAddress when you
MacAddress MAC address N/A hexadecimal digits,
remove or delete a rule.
hyphen-separated.

ARP/ArpSnooping
This table contains the information about the arp snooping entries.

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

21
 Restrictions None

Support for row creation and deletion No

Columns

Column name Column description Column type Data type and restrictions
Unsigned integer.
VLANID VLAN ID Index
Value range: 1 to 4094

Whether the arp Boolean:

SnoopingEnable snooping function is N/A • true
enable. • 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

22
 Support for row creation and deletion No

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 is
side port.
ModeUNI a customer-side N/A supported depends on
• false—Network-
port 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>

23
 <VsiName></VsiName>
</VsiConfig>
</ArpVsiConfig>
</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.

24
 Column Column Column Data type and
Remarks
name description type restrictions
This field must be
configured when the port
Service instance Unsigned integer. is a Layer 2 Ethernet
SrvID N/A
ID Value range: 1 to 4096. 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
the XSD document of
IfIndex Interface index. Index Unsigned integer.
your product. For
information about
IfIndex, see Appendix in
Ifmgr NETCONF XML
API Configuration
Reference.

Whether the arp

Boolean:
direct route
Enable N/A • true N/A
advertise function
• false (default)
is enable.

26
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 ····················································································································· 11
Table description ················································································································· 11
Columns ···························································································································· 11
ARP/ArpRateLimitLog ················································································································· 12
XML structure ····················································································································· 12
Table description ················································································································· 12
Columns ···························································································································· 12
ARP/ArpSourceMACExclude········································································································ 12
XML structure ····················································································································· 13
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 ················································································································· 26
Columns ···························································································································· 27
ARP/ArpRouteAdvertise ·············································································································· 27
XML structure ····················································································································· 28
Table description ················································································································· 28
Columns ···························································································································· 28

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
 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 interface is

The maximum disabled from learning
number of Unsigned integer. dynamic ARP entries.
LearnMaxN
dynamic ARP N/A Value range: 0 to The value of
um
entries that an LearnMaxNumLimit. LearnMaxNumLimit
interface can learn depends on the device
model.

5
 To disable the threashold
LearnAlarm Alarm threshold in Unsigned integer.
N/A alarming, set the value to
Threshold percentage Value range: 0 to 100.
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

6
 Column Column Column Data type and
Remarks
name description type restrictions
The interval at 0 means disable the
Unsigned integer.
which gratuitous interface from
Interval N/A Value range: 0, 200 to
ARP packets are periodically sending
200000ms.
sent 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 the
function of proxy Boolean:
ProxyEnabl
arp on the N/A • true N/A
e
interface is • false
enable.

Whether the
function of local Boolean:
LocalProxyE N/A
proxy arp on the N/A • true
nable
interface is • false
enable.

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>

8
 <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

Columns

Column Column Column Data type and

Remarks
name description type restrictions

Whether the Boolean:

ResolvingR
resolving route N/A • true N/A
outeEnable
function is enable • false

Whether the arp

SourceSupp Boolean:
suppression
ressionEnab N/A • true N/A
original address
le • false
function is enable.

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
selecthe mode • 2—Monitor.

SourceMAC Set the fixed Unsigned integer.

N/A N/A
AgeTime source mac Value range: 60 to 6000.

9
 address aging
time of arp attack
detecton entries

Set the fixed

source mac
SourceMAC
address
ThresholdV N/A Unsigned integer. N/A
threshold of arp
alue
attack detecton
entries

Whether the
source mac Boolean:
ValidCheck
address N/A • true N/A
Enable
consistency check • false
function is enable,

Unsigned integer.

ActiveACKT Enable the active • 0—Disabled.

N/A N/A
ype ack function • 1—Loose.
• 2—Strict.

Whether the
DetectionVa effective checks Boolean:
lidateSrcMA on the source mac N/A • true N/A
C address function • false
is enable.

Whether the
DetectionVa effective checks Boolean:
lidateDstMA on the destination N/A • true N/A
C mac address • false
function is enable.

Whether the
Boolean:
DetectionVa effective checks
N/A • true N/A
lidateIP on the ip address
• false
function is enable,

ARP/ArpRateLimit
This table contains ARP rate limit information.

10
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

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
enable. • 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.

11
ARP/ArpRateLimitLog
This table contains ARP rate limit log information.

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
enable. • 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.

12
XML structure
<ARP>
<ArpSourceMACExclude>
<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
MacAddress MAC address Index hexadecimal digits,
configed depends on the
hyphen-separated.
device model.

ARP/ArpSourceMACAttackEntry
This table contains the information about the arp attack detection entries of fixed source mac
address.

XML structure
<ARP>

13
 <ArpSourceMACAttackEntry>
<Entry>
<DeviceNode>
<Chassis></Chassis>
<Slot></Slot>
<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.

14
 Unsigned integer. 65535 means the
VLANID VLAN ID Index Value range: 1 to interface is layer 3
4094,65535. Ethernet interface

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 arp authorized 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:

Restrictions Layer 3 Ethernet interface/subinterface

Layer 3 aggregate interface/aggregate subinterface

15
 VLAN interface

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 the arp Boolean:

Enable authorized N/A • true N/A
function is enable, • false

ARP/ArpDetection
This table contains the information about arp detections.

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

16
 Row name Detect

Restrictions None

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 the arp detection function
N/A • true
able is enable.
• false

RestrictedF Boolean:
Whether the function of restricted
orwardingEn N/A • true
forwarding arp packet is enable.
able • false

ARP/ArpDetectionTrust
This table contains the information of interface that arp trusted.

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

17
 Row name Interface

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

Whether the
Boolean:
function of trusting
TrustEnable N/A • true N/A
interface is
• false
enable.

ARP/ArpFilterSource
This table contains the information about arp gateway protection and protected ip address.

XML structure
<ARP>
<ArpFilterSource>
<FilterSource>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
</FilterSource>
</ArpFilterSource>
</ARP>

Table description

Item Description
Feature name ARP

Table name ArpFilterSource

18
 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 permited 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>
</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.

SMACMinT The minimum of

N/A Unsigned integer. N/A
hreshold threshold.

SMACMaxT The maximum of

N/A Unsigned integer. N/A
hreshold threshold.

21
 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.

ARP/ ArpSnoopingEntry
This table contains the information about the arp snooping entries.

XML structure
<ARP>
<ArpSnoopingEntry>
<SnoopingEntry>
<DeviceNode>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</DeviceNode>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
<VLANID></VLANID>
<MacAddress></MacAddress>
<Status></Status>
<AgeTime></AgeTime>

22
 </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

String, dotted decimal

Ipv4Address IPv4 address Index N/A
notation.

Unsigned integer.
VLANID VLAN ID N/A N/A
Value range: 1 to 4094.

23
 Six groups of two
MacAddress MAC address N/A hexadecimal digits, N/A
hyphen-separated.

Enumeration:

• 1—Valid.
Status State of a 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 the information about the arp snooping entries.

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

24
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 the arp Boolean:

SnoopingEn
snooping function N/A • true N/A
able
is supported. • 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

Restrictions VLAN interfaces

25
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>

Table description

Item Description
Feature name ARP

Table name ArpVsiConfig

Table type Multi-instance table

26
 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.

String,
VsiName VSI name N/A N/A
Length: 1 to 31 characters.

ARP/ArpRouteAdvertise
This table contains the information about ARP direct route advertisement.

27
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

Whether the arp

Boolean:
direct route
Enable N/A • true N/A
advertise function
• false
is enable.

28
Contents
ARP ······························································································1
ARP/ArpTable ····························································································································· 1
ARP/ArpConfig ···························································································································· 1
ARP/ArpLearnLimit······················································································································· 2
ARP/ArpGratuitousInterval ············································································································· 2
ARP/ArpProxy ····························································································································· 2
ARP/ArpAttackProtect ··················································································································· 2
ARP/ArpRateLimit ························································································································ 3
ARP/ArpSourceMACExclude·········································································································· 3
ARP/ArpDetection ························································································································ 3
ARP/ArpFilterSource ···················································································································· 3
ARP/ArpFilterBinding ···················································································································· 4
ARP/ArpSnooping ························································································································ 4
ARP/ArpVsiConfig ························································································································ 4
ARP/ArpScan ······························································································································ 5
ARP/ArpFixup ····························································································································· 5
ARP/ArpClearTable ······················································································································ 5

i
ARP
ARP/ArpTable
Message Explanation
Invalid IP address. Invalid IP address configuration.

ARP/ArpConfig
Message Explanation
VPN-Instance does not exist. The VPN-Instance does not exist when set the
configuration.

Invalid MAC address. Invalid MAC address configuration.

The VLAN doesn't exist. The VLAN does not exist when set the configuration.

The VLAN interface does not exist when set the

Please create the VLAN interface first.
configuration.

Invalid IP address. Invalid IP address configuration

Can't set S-channel subinterface as the Do not support set S-channel subinterface as the
output interface. output interface.

The port doesn't belong to the VLAN, or The port doesn't belong to the VLAN, or the VLAN is
the VLAN is not permitted on the port. not permitted on the port.

The VPN instance of the configured entry The VPN instance of the configured entry is different
is different from that of the interface. from that of the interface.

The multiport ARP entry contains invalid The ARP entry does not have vlans or have port
parameters. interfaces.

Configuration items don't meet the Invalid configuration, please modify configuration
requirements. under guidance.

Maximum number of ARP entries already Maximum number of ARP entries already reached,p
reached. Please check configuration or specifications

The Ethernet service instance doesn't The Ethernet service instance doesn't exist,when set
exist. the configuration.

The Ethernet interface and Ethernet The Ethernet interface and Ethernet service instance

1
 Message Explanation
service instance are not mapped to the are not mapped to the VSI,please check
VSI. configuration.

Failed to configure the static ARP entry

Failed to configure the static ARP entry because it
because it has the same IP address and
has the same IP address and output interface as an
output interface as an existing remote
existing remote static ARP entry.
static ARP entry.

ARP/ArpLearnLimit
Message Explanation
Configuration items don't meet the Invalid configuration, please modify configuration
requirements. under guidance.

ARP/ArpGratuitousInterval
Message Explanation
Maximum number of interfaces enabled with the
Maximum number of interfaces enabled
feature already reached, please modify configuration
with the feature already reached.
under guidance.

ARP/ArpProxy
Message Explanation
Configuration items don't meet the Invalid configuration, please modify configuration
requirements. under guidance.

Invalid start IPv4 address. Invalid start IPv4 address.

Invalid end IPv4 address. Invalid end IPv4 address.

Start IPv4 address must be lower than or equal to

Start IPv4 address must be lower than or
end IPv4 address, please modify configuration under
equal to end IPv4 address.
guidance.

ARP/ArpAttackProtect
Message Explanation
Configuration items don't meet the Invalid configuration, please modify configuration

2
 Message Explanation
requirements. under guidance.

ARP/ArpRateLimit
Message Explanation
Failed to set the maximum number of The device returned failed when set the maximun
dynamic ARP entries. number of dynamic ARP entries.

Configuration items don't meet the Invalid configuration, please modify configuration
requirements. under guidance.

Invalid configuration, please modify configuration

The value is out of range.
under guidance.

ARP/ArpSourceMACExclude
Message Explanation
Maximum number of protected MAC addresses
Maximum number of protected MAC
already reached,please check configuration or
addresses already reached.
specifications.

ARP/ArpDetection
Message Explanation
The VLAN doesn't exist. The VLAN does not exist when set the configuration.

ARP/ArpFilterSource
Message Explanation
Maximum number of protected gateway IP
Maximum number of protected gateway
addresses already reached, Please check
IP addresses already reached.
configuration or specifications.

Configuration failed. Please disable ARP

Please disable ARP filtering first.
filtering first.

3
ARP/ArpFilterBinding
Message Explanation
Configuration items don't meet the Invalid configuration, please modify configuration
requirements. under guidance.

Maximum number of permitted IP-to-MAC bindings

Maximum number of permitted
already reached, please modify configuration under
IP-to-MAC bindings already reached.
guidance.

Configuration failed. Please disable ARP Please disable ARP gateway protection first, please
gateway protection first. modify configuration under guidance.

ARP/ArpSnooping
Message Explanation
The VLAN doesn't exist. The VLAN does not exist when set the configuration.

ARP/ArpVsiConfig
Message Explanation
The VPN-Instance does not exist when set the
VPN-Instance does not exist.
configuration.

Invalid MAC address. Invalid MAC address configuration.

Invalid IP address. Invalid IP address configuration.

The VPN instance of the configured entry is different

The VPN instance of the configured entry
from that of the interface., please modify
is different from that of the interface.
configuration under guidance.

Configuration items don't meet the Invalid configuration, please modify configuration
requirements. under guidance.

Maximum number of ARP entries already Maximum number of ARP entries already
reached. reached,please check configuration or specifications.

The VSI doesn't exist. The VSI does not exist when set the configuration.

The VSI interface is not associated with The VSI interface is not associated with the VSI,
the VSI. please check configuration .

The Ethernet service instance doesn't The Ethernet service instance doesn't exist, please
exist. check configuration.

4
 Message Explanation
The Ethernet interface and Ethernet The Ethernet interface and Ethernet service instance
service instance are not mapped to the are not mapped to the VSI, please check
VSI. configuration.

ARP/ArpScan
Message Explanation
Invalid IP address. Invalid IP address configuration.

Start IP address must be lower than or equal to end

Start IP address must be lower than or
IP address, please modify configuration under
equal to end IP address.
guidance.

The interface is down or has no IP address

The interface is down or has no IP
configured, please modify configuration under
address configured.
guidance.

The start and end IP addresses must be The start and end IP addresses must be on the same
on the same subnet as the interface IP subnet as the interface IP address, please modify
address. configuration under guidance.

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.

ARP/ArpClearTable
Message Explanation
Invalid IP address. Invalid IP address configuration

5
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 ······························································································································ 4
ASPF/AspfOnInterfaces ················································································································ 4
XML structure ······················································································································· 5
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.

2
 Column Column Column
Data type and restrictions Remarks
name description type
• 1—TCP.
• 2—UDP.
• 3—UDP-Lite.
The detected Unsigned integer. • 4—ICMP.
ProtocolID transport layer Index
protocol ID. Value range: 1 to 8. • 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

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.
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
N/A • 1—Drop illegal packets. • 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
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. to that interface.
index
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.

5
 Column Column Column
Data type and restrictions Remarks
name description type
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
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>

Table description
Item Description
Feature name ASPF
Table name AspfOnInterZones
Table type Multi-instance table
Row name InterZone
Restrictions None
Support for row creation and deletion No

6
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Members include:
Inter-Zone Data
ZonePair
structure. • SourceZone. N/A
information.
• DestinationZone.

String, case-insensitive. Characters ">" , ">>"

Source zone
SourceZone
name.
Index and "|" can't be
Length: 1 to 31 characters.
included.

String, case-insensitive. Characters ">" , ">>"

DestinationZo Destination zone
ne name.
Index and "|" can't be
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 ··················································································································· 6
Columns ······························································································································ 6
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.

2
 Column Column Column
Data type and restrictions Remarks
name description type
• 1—TCP.
• 2—UDP.
• 3—UDP-Lite.
The detected Unsigned integer. • 4—ICMP.
ProtocolID transport layer Index
protocol ID. Value range: 1 to 8. • 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
N/A • 1—Drop illegal packets. • 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. to that interface.
index
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.

5
 Column Column Column
Data type and restrictions Remarks
name description type
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
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>

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
structure. • SourceZone. N/A
information.
• DestinationZone.

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

String, case-insensitive. Characters ">" , ">>"

Source zone
SourceZone
name.
Index and "|" can't be
Length: 1 to 31 characters.
included.

String, case-insensitive. Characters ">" , ">>"

DestinationZo Destination zone
ne name.
Index and "|" can't be
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>
<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>

7
 </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

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

8
 Column Data type and
Column name Column description Remarks
type restrictions
Whether support ICMP Boolean:
DetectICMP transport layer protocol N/A • true N/A
detection. • false

Whether support Boolean:

DetectICMPv6 ICMPv6 transport layer N/A • true N/A
protocol 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

Whether support SCCP Boolean:

DetectSCCP application layer N/A • true N/A
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 Boolean:

DetectSQLNET SQLNET application N/A • true N/A
layer protocol detection. • false

9
 Column Data type and
Column name Column description Remarks
type restrictions
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 Boolean:

DetectXDMCP XDMCP application N/A • true N/A
layer 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/ClearStatistics ·········································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 6
ATK/ClientVerify/ClearProtectHostStatistics ······················································································ 6
XML structure ······················································································································· 6
Table description ··················································································································· 7
Columns ······························································································································ 7
ATK/ClientVerify/ClearTrustClients ·································································································· 7
XML structure ······················································································································· 8
Table description ··················································································································· 8
Columns ······························································································································ 8

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/ClearStatistics
This table is used to clear blacklist statistics.

XML structure
<ATK>
<Blacklist>
<ClearStatistics>
<Clear></Clear>
</ClearStatistics>
</Blacklist>
</ATK>

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>

6
 <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.

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.

7
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
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.

8
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 ····················································································································· 19
Table description ················································································································· 20
Columns ···························································································································· 20
ATK/Signature/LevelActions ········································································································· 20
XML structure ····················································································································· 20
Table description ················································································································· 21
Columns ···························································································································· 21

i
ATK/Signature/LogAggregate ······································································································· 21
XML structure ····················································································································· 21
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/InterfaceSwitches ···································································································· 24
XML structure ····················································································································· 24
Table description ················································································································· 25
Columns ···························································································································· 25
ATK/Blacklist/ZoneSwitches ········································································································· 25
XML structure ····················································································································· 25
Table description ················································································································· 25
Columns ···························································································································· 26
ATK/Blacklist/GlobalConfigs ········································································································· 26
XML structure ····················································································································· 26
Table description ················································································································· 26
Columns ···························································································································· 27
ATK/Whitelist/IPv4ObjItems ········································································································· 27
XML structure ····················································································································· 27
Table description ················································································································· 27
Columns ···························································································································· 27
ATK/Whitelist/IPv6ObjItems ········································································································· 28
XML structure ····················································································································· 28
Table description ················································································································· 28
Columns ···························································································································· 28
ATK/Whitelist/InterfaceSwitches ··································································································· 29
XML structure ····················································································································· 29
Table description ················································································································· 29
Columns ···························································································································· 29
ATK/Whitelist/ZoneSwitches ········································································································ 30
XML structure ····················································································································· 30
Table description ················································································································· 30
Columns ···························································································································· 30
ATK/Whitelist/GlobalSwitches······································································································· 31
XML structure ····················································································································· 31
Table description ················································································································· 31
Columns ···························································································································· 31
ATK/ClientVerify/Switches ··········································································································· 31
XML structure ····················································································································· 31
Table description ················································································································· 32
Columns ···························································································································· 32
ATK/ClientVerify/ZoneSwitches ···································································································· 33
XML structure ····················································································································· 33
Table description ················································································································· 33
Columns ···························································································································· 34
ATK/ClientVerify/IPv4ProtectHosts ································································································ 34
XML structure ····················································································································· 34
Table description ················································································································· 35
Columns ···························································································································· 35
ATK/ClientVerify/IPv6ProtectHosts ································································································ 35
XML structure ····················································································································· 36
Table description ················································································································· 36
Columns ···························································································································· 36
ATK/TopStatisticsSwitch ············································································································· 37
XML structure ····················································································································· 37

ii
Table description ················································································································· 37
Columns ···························································································································· 37

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.
Main signature
Maintype
type
Index • 2—ICMP single N/A
packet attack.
• 3—ICMPv6 single
packet attack.
• 4—IPv6 extend
header 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
Sub signature • 6—Trace route
SubType Index N/A
type • 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

17
 Column Column Data type and
Column name Remarks
description type restrictions
• 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

attack, SubType is the
ICMPv6 type value, range:
0 to 255.
• 128—ICMPv6 echo

18
 Column Column Data type and
Column name Remarks
description type restrictions
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.

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.

XML structure
<ATK>
<Signature>
<LargeICMPLength>
<Policy>
<PolicyName></PolicyName>
<IPv4Threshold></IPv4Threshold>
<IPv6Threshold></IPv6Threshold>
</Policy>
</LargeICMPLength>
</Signature>
</ATK>

19
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>
<LevelActions>
<LevelAction>
<PolicyName></PolicyName>
<Level></Level>
<Log></Log>
<Drop></Drop>
</LevelAction>
</LevelActions>
</Signature>
</ATK>

20
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.

ATK/Signature/LogAggregate
This table contains signature log aggregation information.

XML structure
<ATK>
<Signature>
<LogAggregate>
<Enable></Enable>

21
 </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>
<Ipv4Address></Ipv4Address>
<DSLitePeer></DSLitePeer>
<TTL></TTL>
</Item>
</IPv4Blacklists>
</Blacklist>
</ATK>

22
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 60000 N/A
second.

ATK/Blacklist/IPv6Blacklists
This table contains IPv6 blacklist information.

XML structure
<ATK>
<Blacklist>
<IPv6Blacklists>
<Item>
<VrfIndex></VrfIndex>
<Ipv6Address></Ipv6Address>
<TTL></TTL>
</Item>
</IPv6Blacklists>

23
 </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
60000 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>

24
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

25
 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

26
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

27
 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.

28
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.

29
 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

30
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>

31
 <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:

32
 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

33
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>

34
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.

35
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

36
 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

37
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 ················································································································· 11
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 ··········································································································· 17
XML structure ····················································································································· 17
Table description ················································································································· 18
Columns ···························································································································· 18
ATK/Flood/IPv4ProtectHosts ········································································································ 19
XML structure ····················································································································· 20
Table description ················································································································· 20
Columns ···························································································································· 20

i
ATK/Flood/IPv6ProtectHosts ········································································································ 21
XML structure ····················································································································· 22
Table description ················································································································· 22
Columns ···························································································································· 22
ATK/Flood/LearnItems ················································································································ 23
XML structure ····················································································································· 24
Table description ················································································································· 24
Columns ···························································································································· 24
ATK/Flood/FlowResults ··············································································································· 25
XML structure ····················································································································· 25
Table description ················································································································· 26
Columns ···························································································································· 26
ATK/Signature/Detects ················································································································ 27
XML structure ····················································································································· 27
Table description ················································································································· 27
Columns ···························································································································· 28
ATK/Signature/LargeICMPLength ································································································· 30
XML structure ····················································································································· 30
Table description ················································································································· 31
Columns ···························································································································· 31
ATK/Signature/LevelActions ········································································································· 31
XML structure ····················································································································· 31
Table description ················································································································· 32
Columns ···························································································································· 32
ATK/Signature/LogAggregate ······································································································· 32
XML structure ····················································································································· 32
Table description ················································································································· 33
Columns ···························································································································· 33
ATK/Blacklist/IPv4Blacklists ········································································································· 33
XML structure ····················································································································· 33
Table description ················································································································· 34
Columns ···························································································································· 34
ATK/Blacklist/IPv6Blacklists ········································································································· 34
XML structure ····················································································································· 35
Table description ················································································································· 35
Columns ···························································································································· 35
ATK/Blacklist/InterfaceSwitches ···································································································· 36
XML structure ····················································································································· 36
Table description ················································································································· 36
Columns ···························································································································· 36
ATK/Blacklist/ZoneSwitches ········································································································· 37
XML structure ····················································································································· 37
Table description ················································································································· 37
Columns ···························································································································· 37
ATK/Blacklist/GlobalConfigs ········································································································· 37
XML structure ····················································································································· 37
Table description ················································································································· 38
Columns ···························································································································· 38
ATK/Whitelist/IPv4ObjItems ········································································································· 38
XML structure ····················································································································· 38
Table description ················································································································· 39
Columns ···························································································································· 39
ATK/Whitelist/IPv6ObjItems ········································································································· 39
XML structure ····················································································································· 39
Table description ················································································································· 39
Columns ···························································································································· 40
ATK/Whitelist/InterfaceSwitches ··································································································· 40
XML structure ····················································································································· 40
Table description ················································································································· 40
Columns ···························································································································· 40
ATK/Whitelist/ZoneSwitches ········································································································ 41
XML structure ····················································································································· 41

ii
 Table description ················································································································· 41
Columns ···························································································································· 42
ATK/Whitelist/GlobalSwitches······································································································· 42
XML structure ····················································································································· 42
Table description ················································································································· 42
Columns ···························································································································· 42
ATK/ClientVerify/Switches ··········································································································· 43
XML structure ····················································································································· 43
Table description ················································································································· 43
Columns ···························································································································· 43
ATK/ClientVerify/ZoneSwitches ···································································································· 44
XML structure ····················································································································· 44
Table description ················································································································· 44
Columns ···························································································································· 45
ATK/ClientVerify/IPv4ProtectHosts ································································································ 45
XML structure ····················································································································· 45
Table description ················································································································· 46
Columns ···························································································································· 46
ATK/ClientVerify/IPv6ProtectHosts ································································································ 47
XML structure ····················································································································· 47
Table description ················································································································· 48
Columns ···························································································································· 48
ATK/ClientVerify/IPv4TrustClients ································································································· 49
XML structure ····················································································································· 49
Table description ················································································································· 49
Columns ···························································································································· 49
ATK/ClientVerify/IPv6TrustClients ································································································· 50
XML structure ····················································································································· 50
Table description ················································································································· 51
Columns ···························································································································· 51
ATK/Specification······················································································································· 51
XML structure ····················································································································· 51
Table description ················································································································· 52
Columns ···························································································································· 52
ATK/TopStatisticsSwitch ············································································································· 52
XML structure ····················································································································· 52
Table description ················································································································· 53
Columns ···························································································································· 53
ATK/TopStatisticsSampleTime ····································································································· 53
XML structure ····················································································································· 53
Table description ················································································································· 53
Columns ···························································································································· 54
ATK/TopAttackStatisticsByIP········································································································ 54
XML structure ····················································································································· 54
Table description ················································································································· 54
Columns ···························································································································· 55
ATK/TopAttackStatisticsByType ···································································································· 55
XML structure ····················································································································· 56
Table description ················································································································· 56
Columns ···························································································································· 56
ATK/ScanAttackTypes ················································································································ 57
XML structure ····················································································································· 57
Table description ················································································································· 58
Columns ···························································································································· 58
ATK/FloodAttackTypes ··············································································································· 58
XML structure ····················································································································· 58
Table description ················································································································· 58
Columns ···························································································································· 59
ATK/SignatureAttackTypes ·········································································································· 59
XML structure ····················································································································· 59
Table description ················································································································· 59
Columns ···························································································································· 59

iii
ATK/BlacklistTypes ···················································································································· 60
XML structure ····················································································································· 60
Table description ················································································································· 60
Columns ···························································································································· 60

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 Data type and
Column name
description type restrictions
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
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
header attack.
SubType Sub attack type Index Enumeration, value range

8
 Column Column Data type and
Column name
description type restrictions
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:

• 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

9
 Column Column Data type and
Column name
description type restrictions
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.

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>

10
Table description
Item Description
Feature name ATK
Table name ZoneAttackStatistics
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.
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.
Maintype Main attack type Index • 3—Named single-packet attack.
• 4—IP option single-packet attack.
• 5—ICMP single-packet attack.
• 6—ICMPv6 single-packet attack.
• 7—IPv6 extension header single-packet
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.
SubType Attack subtype Index
 2—SYN-ACK flood.
 3—RST flood.
 4—FIN flood.
 5—UDP flood.
 6—ICMP flood.
 7—ICMPv6 flood.
• For application layer floods:
 0—DNS flood.

11
 Column Column
Column name Data type and restrictions
description type
 1—HTTP flood.
 2—DNS reply flood.
 3—SIP flood.
• For named single-packet attacks:
 0—IP fragment attack.
 1—IP impossible attack.
 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.
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>

12
 <LocalAttackStatistics>
<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.
Maintype Main attack type Index • 3—Named single
packet attack.
• 4—IP option single
packet attack.
• 5—ICMP single
packet attack.
• 6—ICMPv6 single
packet attack.

13
 Column Column Data type and
Column name
description type restrictions
• 7—IPv6 extend
header 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:

• 0—DNS flood.
• 1—HTTP flood.
SubType Sub attack type Index • 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

14
 Column Column Data type and
Column name
description type restrictions
• 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.

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>
<Policy>
<PolicyName></PolicyName>
<Level></Level>
</UserDefinedCfg>
<PortScanEnable></PortScanEnable>
<PortScanThreshold></PortScanThreshold>
<IPSweepEnable></IPSweepEnable>
<IPSweepThreshold></IPSweepThreshold>
<Period></Period>
</UserDefinedCfg>
<Log></Log>
<Drop></Drop>

15
 <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.

Members include:
• PortScanEnable
Custom scan
Data • PortScanThreshold
UserDefinedCfg detection N/A
configuration.
struct • 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.

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

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.

ATK/Flood/DefaultConfigs
This table contains flood default configurations.

XML structure
<ATK>
<Flood>
<DefaultConfigs>
<Config>

17
 <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
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.
SubType Sub flood type Index N/A
• 1—ACK flood.
• 2—SYN-ACK flood.
• 3—RESET flood.
• 4—FIN flood.
• 5—UDP flood.
• 6—ICMP flood.

18
 Column Column Data type and
Column name Remarks
description type restrictions
• 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
Flood detect Signed integer, value
Threshold N/A N/A
threshold range: 1 to 1000000 pps.
Support
Application layer
only for now.
For http flood,
default
monitored port is
80.
For DNS flood,
default
monitored port is
Monitor service Port range string, port 53.
MonitorPort N/A
port range value range: 1 to 65535. 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.
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.

19
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.

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
SubType Sub flood type Index MainType. N/A

For transport layer flood:

20
 Column Column Data type and
Column name Remarks
description type restrictions
• 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.

ATK/Flood/IPv6ProtectHosts
This table contains IPv6 flood protect hosts information.

21
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.

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
SubType Sub flood type Index MainType. N/A

For transport layer flood:

22
 Column Column Data type and
Column name Remarks
description type restrictions
• 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.

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.

ATK/Flood/LearnItems
This table contains flow threshold learning information.

23
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

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.
Unsigned integer. Only when the
Interval value for
IntervalValue N/A Value range: 1 to 1200000 mode is cycle,
cycle mode
minutes. this column is

24
 Column Column Data type and
Column name Remarks
description type restrictions
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.

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>

25
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:
• 0—Initialize.
Status Learning status N/A N/A
• 1—Stop.
• 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.
ICMPv6 Learning result of N/A Unsigned integer. N/A

26
 Column Column Data type and
Column name Remarks
description type restrictions
ICMPv6 packets Value range: 0 to
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.

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

27
 Item Description
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.
Main signature
Maintype
type
Index • 2—ICMP single N/A
packet attack.
• 3—ICMPv6 single
packet attack.
• 4—IPv6 extend
header 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
Sub signature
SubType
type
Index • 9—Large ICMPv6 N/A
• 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

28
 Column Column Data type and
Column name Remarks
description type restrictions
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

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

29
 Column Column Data type and
Column name Remarks
description type restrictions
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.

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>

30
Table description
Item Description
Feature name ATK
Table name LargeICMPLength
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.
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>

31
Table description
Item Description
Feature name ATK
Table name LevelActions
Table type Multi-instance table
Row name LevelAction
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—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>

32
 </Signature>
</ATK>

Table description
Item Description
Feature name ATK
Table name LogAggregate
Table type Single-instance table
Row name N/A
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>

33
Table description
Item Description
Feature name ATK
Table name IPv4Blacklists
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
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.

34
XML structure
<ATK>
<Blacklist>
<IPv6Blacklists>
<Item>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<VrfIndex></VrfIndex>
<Ipv6Address></Ipv6Address>
<AddType></AddType>
<TTL></TTL>
<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.

35
 Column Column Data type and
Column name
description type restrictions
• 1—Automatic add.
Unsigned integer, unit
TTL 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>

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

36
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

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>

37
 <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 • 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>

38
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.

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

39
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>
</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
IfIndex Interface index Index Unsigned integer. name. For
relevant
information, see
the XSD

40
 Column Column Data type and
Column name Remarks
description type restrictions
document of your
product. For
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>
<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

41
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
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

42
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.

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
VerifyMode Verification mode N/A MainType.

43
 Column Column Data type and
Column name
description type restrictions
For TCP proxy:
• 0—Shutdown.
• 1—SYN cookie.
• 2—Safe reset.

For DNS client verification:

• 0—Shutdown.
• 1—Truncate.

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>
<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

44
 Item Description
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.
• 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—Option.

ATK/ClientVerify/IPv4ProtectHosts
This table contains IPv4 client verification protect hosts information.

XML structure
<ATK>
<ClientVerify>
<IPv4ProtectHosts>
<Host>

45
 <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.

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.
VrfIndex Vrf index Index Unsigned integer, 0 N/A

46
 Column Column Data type and
Column name Remarks
description type restrictions
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.

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>

47
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:
• 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
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.

48
 Column Column Data type and
Column name Remarks
description type restrictions
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>
</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
Chassis ID of the member Index Unsigned integer.

49
 Column Column Data type and
Column name
description type restrictions
where the client Value range: 0 to 65535.
resides

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.

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>

50
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:
• 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.
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>

51
 <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:
attack-defense
InterfaceApply
policy to
N/A • True
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>

52
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.

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

53
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.

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

54
 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.
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.

55
XML structure
<ATK>
<TopAttackStatisticsByType>
<Statistics>
<Period></Period>
<AttackType></AttackType>
<AttackTimes></AttackTimes>
</Statistics>
</TopAttackStatisticsByType>
</ATK>

Table description
Item Description
Feature name Session
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.

56
 Column Column Column
Data type and restrictions Remarks
name description type
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.

XML structure
<ATK>
<ScanAttackTypes>
<AttackType>
<Digest></Digest>
<AttackTypeName></AttackTypeName>
</AttackType>
</ScanAttackTypes>
</ATK>

57
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>

Table description
Item Description
Feature name ATK
Table name FloodAttackTypes
Table type Multi-instance table
Row name AttackType
Restrictions None.

58
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.

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.

59
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.

60
Contents
ATK·······························································································1
ATK/IPv4Exempts ························································································································ 1
ATK/IPv6Exempts ························································································································ 1
ATK/Scan/Policies························································································································ 1
ATK/Flood/DefaultConfigs ············································································································· 2
ATK/Flood/IPv4ProtectHosts ·········································································································· 2
ATK/Flood/IPv6ProtectHosts ·········································································································· 2
ATK/Signature/Detects ·················································································································· 3
ATK/Blacklist/ZoneSwitches ··········································································································· 3
ATK/Blacklist/IPv4Blacklists ··········································································································· 3
ATK/Blacklist/IPv6Blacklists ··········································································································· 3
ATK/Whitelist/ZoneSwitches ·········································································································· 4
ATK/Whitelist/IPv4ObjItems ··········································································································· 4
ATK/Whitelist/IPv6ObjItems ··········································································································· 4
ATK/ClientVerify/IPv4ProtectHosts ·································································································· 4
ATK/ClientVerify/IPv6ProtectHosts ·································································································· 4
ATK/ClientVerify/Switches ············································································································· 5
ATK/ClientVerify/ZoneSwitches ······································································································ 5
ATK/TopStatisticsSwitch ··············································································································· 5

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
name. and ACL name are mutual exclusive and only one of them can be
set in a single message.

ATK/IPv6Exempts
Message Explanation
During executing create、merge or replace operation, ACL numer
Please specify an ACL by either its number or its
name. and ACL name are mutual exclusive and only one of them can be
set in a single message.

ATK/Scan/Policies
Message Explanation
During executing configuration operation(create、merge、replace、
Please specify the detection sensitivity before
specifying defense actions. delete or remove), Please specify the detection sensitivity before
specifying defense actions.

During executing configuration operation(create、merge、replace、

Please specify at least one defense action.
delete or remove),please specify at least one defense action.

During executing configuration operation(create、merge、replace、

The drop and block-source actions cannot be both
specified. delete or remove),drop and BlockSource are mutual exclusive
and only one of them can be set in a single message.
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.

During executing configuration operation(create、merge、replace、

At least one of scan attack detect ways should be
specified. delete or remove), at least one of scan attack detect ways should
be specified.

The port scan attack detect switch and the port During executing configuration operation(create、merge、replace、
scan attack detect threshold should all be set or delete or remove), the port scan attack detect switch and the port
neither be set. scan attack detect threshold should all be set or neither be set.

During executing configuration operation(create、merge、replace、

The IP scan attack detect switch and the IP attack
detect threshold should all be set or neither be set. delete or remove), the IP scan attack detect switch and the IP
attack detect threshold should all be set or neither be set.

During executing configuration operation(create、merge、replace、

Ipsweep switch and portscan switch cannot be
open when the detect level is UNDO. delete or remove), IP sweep switch and port scan switch cannot
be open when the detect level is UNDO.

1
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.

During executing configuration operation(create、merge、replace、

The flood attack type doesn't exist. delete or remove) or get operation, the flood attack type must
exist.
Client verification is not an available defense action During executing configuration operation(create、merge、replace、
for this flood attack. delete or remove) or get operation, client verification is not an
available defense action for this flood attack.

Only HTTP DNS DNS-REPLY and SIP flood attack During executing configuration operation(create、merge、replace、
defense supports port configuration. delete or remove) or get operation,only HTTP DNS DNS-REPLY
and SIP flood attack defense supports port configuration.

During executing configuration operation(create、merge、replace、

The number of detection ports exceeds the upper
limit. delete or remove) or get operation,the number of detection ports
must not exceeds the upper limit.

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.

During executing configuration operation(create、merge、replace、

The flood attack type doesn't exist. delete or remove) or get operation, the flood attack type must
exist.

During executing configuration operation(create、merge、replace、

Client verification is not an available defense action
for this flood attack. delete or remove) or get operation, client verification is not an
available defense action for this flood attack.

During executing configuration operation(create、merge、replace、

Only HTTP DNS DNS-REPLY and SIP flood attack
defense supports port configuration. delete or remove) or get operation,only HTTP DNS DNS-REPLY
and SIP flood attack defense supports port configuration.

During executing configuration operation(create、merge、replace、

The number of detection ports exceeds the upper
limit. delete or remove) or get operation,the number of detection ports
must not exceeds the upper limit.

During executing configuration operation(create、merge、replace、

Invalid IP address.
delete or remove) or get operation, the IP address is must valid.

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.

The flood attack type doesn't exist. During executing configuration operation(create、merge、replace、
delete or remove) or get operation, the flood attack type must

2
 exist.

During executing configuration operation(create、merge、replace、

Client verification is not an available defense action
for this flood attack. delete or remove) or get operation, client verification is not an
available defense action for this flood attack.

During executing configuration operation(create、merge、replace、

Only HTTP DNS DNS-REPLY and SIP flood attack
defense supports port configuration. delete or remove) or get operation,only HTTP DNS DNS-REPLY
and SIP flood attack defense supports port configuration.

During executing configuration operation(create、merge、replace、

The number of detection ports exceeds the upper
limit. delete or remove) or get operation,the number of detection ports
must not exceeds the upper limit.

During executing configuration operation(create、merge、replace、

Invalid IP address.
delete or remove) or get operation, the IP address is must valid.

ATK/Signature/Detects
Message Explanation
During executing configuration operation(create、merge、replace、
The single-packet attack type doesn't exist. delete or remove) or get operation, the single-packet attack type
must exist.

ATK/Blacklist/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
on Local zone.

ATK/Blacklist/IPv4Blacklists
Message Explanation
During executing create、merge or replace operation, the
The VRF instance doesn't exist.
specified VPN instance must exist.

ATK/Blacklist/IPv6Blacklists
Message Explanation
During executing create、merge or replace operation, the
The VRF instance doesn't exist.
specified VPN instance must exist.

3
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
on Local zone.

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.

During executing configuration operation(create、merge、replace、

The object group is not an IP address object group. delete or remove),the object group is must an IP address object
group.

ATK/Whitelist/IPv6ObjItems
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.

During executing configuration operation(create、merge、replace、

The object group is not an IP address object group. delete or remove),the object group is must an IP address object
group.

ATK/ClientVerify/IPv4ProtectHosts
Message Explanation
During executing configuration operation(create、merge、replace、
The VRF instance doesn't exist. delete or remove) or get operation, the specified VPN instance
must exist.

During executing configuration operation(create、merge、replace、

Invalid IP address.
delete or remove) or get operation, the IP address is must valid.

ATK/ClientVerify/IPv6ProtectHosts
Message Explanation
During executing configuration operation(create、merge、replace、
The VRF instance doesn't exist. delete or remove) or get operation, the specified VPN instance
must exist.

During executing configuration operation(create、merge、replace、

Invalid IP address.
delete or remove) or get operation, the IP address is must valid.

4
ATK/ClientVerify/Switches
Message Explanation
During executing create、merge or replace operation,the
The verification mode is not supported.
verification mode is must supported.

ATK/ClientVerify/ZoneSwitches
Message Explanation
During executing create、merge or replace operation,the
The verification mode is not supported.
verification mode is must supported.

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
on Local zone.

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.

5
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
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

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>
<Action>
<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
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 Optional
umber rule number Value range: 1 to 4294967295.

1
 Column Column Column
Data type and restrictions Remarks
name description type
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.

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.

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
Table name RuleOptions
Table type Multi-instance table
Row name Option
Restrictions None
Support for row creation and deletion Yes

2
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>
<TotalMaxKbps></TotalMaxKbps>
<TotalGuaranteedKbps></TotalGuaranteedKbps>
<TotalGuaranteedKbpsPerIP></TotalGuaranteedKbpsPerIP>
<TotalGuaranteedKbpsPerUser></TotalGuaranteedKbpsPerUser>
<TotalMaxKbpsPerIP></TotalMaxKbpsPerIP>
<TotalMaxKbpsPerUser></TotalMaxKbpsPerUser>
<DnGuaranteedKbpsPerIP></DnGuaranteedKbpsPerIP>

3
 <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 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
Unsigned integer:
ReferenceMo Rule shared
de mode
N/A • 0—per-rule. N/A
• 1—rule-shared.

4
Column Column Column
Data type and restrictions Remarks
name description type
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.

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

5
 Column Column Column
Data type and restrictions Remarks
name description type
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>
<OptionJsonType></OptionJsonType>
<OptionJsonVal></OptionJsonVal>
</OptionJson>
</RuleJsonOptions>
</AVC>

6
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

7
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 ······························································································································ 4
AVC/TrafficPolicyQuery ················································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 6
Columns ······························································································································ 6
AVC/TrafficQueParentRule ············································································································ 7
XML structure ······················································································································· 8
Table description ··················································································································· 8
Columns ······························································································································ 8
AVC/TrafficPolicyRules ················································································································· 9
XML structure ······················································································································· 9
Table description ··················································································································· 9
Columns ···························································································································· 10
AVC/RuleOptions ······················································································································· 10
XML structure ····················································································································· 10
Table description ················································································································· 10
Columns ···························································································································· 11
AVC/TrafficPolicyProfiles ············································································································· 11
XML structure ····················································································································· 11
Table description ················································································································· 12
Columns ···························································································································· 12
AVC/AVCSpecification ················································································································ 14
XML structure ····················································································································· 14
Table description ················································································································· 15
Columns ···························································································································· 15

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>
<ProfileName></ProfileName>
</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.
Unsigned integer:
RuleNumber Rule number N/A N/A
Value range: 1 to 4294967295.
String, case-insensitive.
RuleName Rule name N/A N/A
Length: 1 to 63 characters.

1
 Column Column
Column name Data type and restrictions Remarks
description type
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.

Traffic profile String, case-insensitive.

ProfileName N/A N/A
name Length: 1 to 63 characters.

AVC/TrafficPolicyChildRules
This table contains information about child traffic rules.

XML structure
<AVC>
<TrafficPolicyChildRules>
<Rule>
<RuleNumber></RuleNumber>
<ParentRuleNumber></ParentRuleNumber>
<RuleName></RuleName>
<FirstSonRuleNum></FirstSonRuleNum>
<Enable></Enable>
<TimeRange></TimeRange>
<ProfileName></ProfileName>
<OptionContent></OptionContent>
</Rule>
</TrafficPolicyChildRules>

2
 </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.

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.

3
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
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.
AvcOptionTy Match criterion • 4—DestAddressSets.
N/A N/A
pe type • 5—Users.
• 6—UserGroups.
• 7—Applications.
• 8—AppGroups.
• 9—Services.

4
 Column Column Column
Data type and restrictions Remarks
name description type
• 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>
<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>
<DomainFilter></DomainFilter>
</RuleQuery>
</TrafficPolicyQuery>
</AVC>

5
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 String, case-insensitive.

Rule name N/A N/A
er 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 N/A String, case-insensitive. N/A

6
 Column Column Column
Data type and restrictions Remarks
name description type
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
parent traffic rule in the
JSON array format. A
JSON array is made up
of JSON objects. A
String, case-insensitive. JSON object describes
OptionConten Match criterion information about one
N/A Length: 1 to65535.
t 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.

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
String, case-insensitive.
DomainFilter Domain value N/A N/A
Length: 1 to 255 characters.

AVC/TrafficQueParentRule
This table contains information about the parent rule for a child rule.

7
XML structure
<AVC>
<TrafficQueParentRule>
<QueRule>
<RuleNumber></RuleNumber>
<PRuleNumber></PRuleNumber>
<RuleName></RuleName>
<OptionContent></OptionContent>
<Enable></Enable>
<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
String, case-insensitive. of JSON objects. A
Match criterion
OptionContent N/A Length: 1 to 10240. JSON object describes
content
Content: JSON array. information about one
match criterion type by
using optionType and
optionVal. The optionVal
is a set of values for the
match criterion. A JSON

8
 Column Column
Column name Data type and restrictions Remarks
description type
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.

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>
<Action>
<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

9
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.
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. N/A
the rule • false.

Time Range String, case-insensitive.

TimeRange N/A N/A
Name Length: 1 to 63 characters.

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

10
 Row name Option
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>

11
 <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

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 N/A Unsigned integer: N/A

12
Column Column Column
Data type and restrictions Remarks
name description type
de mode • 0—per-rule.
• 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.

DnMaxKbpsP Downstream Unsigned integer:

N/A N/A
erUser Max kbps per Value range: 8 to 100,000,000.

13
 Column Column Column
Data type and restrictions Remarks
name description type
User

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>

14
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.

15
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 Data
N/A N/A
e device 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 Data
N/A N/A
e device 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 ······························································································································ 1
BFD/Interfaces ···························································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 2

i
BFD
BFD/Base
This table contains global BFD information.

XML structure
<BFD>
<Base>
<MultihopMinTransmitInterval></MultihopMinTransmitInterval>
<MultihopMinReceiveInterval></MultihopMinReceiveInterval>
<MultihopDetectMultiplier></MultihopDetectMultiplier>
</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

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.

1
BFD/Interfaces
This table contains BFD interface information.

XML structure
<BFD>
<Interfaces>
<Interface>
<IfIndex></IfIndex>
<MinTransmitInterval></MinTransmitInterval>
<MinReceiveInterval></MinReceiveInterval>
<DetectMultiplier></DetectMultiplier>
</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.

2
 Column Column
Column name Data type and restrictions Remarks
description type
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.

3
Contents
BFD ······························································································1
BFD/Base ··································································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
BFD/Interfaces ···························································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 2

i
BFD
BFD/Base
This table contains global BFD information.

XML structure
<BFD>
<Base>
<MultihopMinTransmitInterval></MultihopMinTransmitInterval>
<MultihopMinReceiveInterval></MultihopMinReceiveInterval>
<MultihopDetectMultiplier></MultihopDetectMultiplier>
</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.
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.

1
BFD/Interfaces
This table contains BFD interface information.

XML structure
<BFD>
<Interfaces>
<Interface>
<IfIndex></IfIndex>
<MinTransmitInterval></MinTransmitInterval>
<MinReceiveInterval></MinReceiveInterval>
<DetectMultiplier></DetectMultiplier>
<MinEchoReceiveInterval></MinEchoReceiveInterval>
</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.

2
 Column Column
Column name Data type and restrictions Remarks
description type
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.
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.

3
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尚未配置。

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。

BFD is not configured.

BFD service has not been started.
BFD尚未配置。

2
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

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
Contents
BGP ······························································································1
BGP/Instances ·························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
BGP/VRFs ······························································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
BGP/CfgSessionGroups ·············································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 5
BGP/CfgSessions ······················································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7
BGP/Familys ····························································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ·························································································································· 10
BGP/Networks ························································································································ 11
XML structure ··················································································································· 11
Table description ··············································································································· 12
Columns ·························································································································· 12
BGP/Aggregates ······················································································································ 13
XML structure ··················································································································· 13
Table description ··············································································································· 13
Columns ·························································································································· 14
BGP/NeighborGroups ··············································································································· 14
XML structure ··················································································································· 14
Table description ··············································································································· 15
Columns ·························································································································· 16
BGP/Neighbors ······················································································································· 18
XML structure ··················································································································· 18
Table description ··············································································································· 19
Columns ·························································································································· 20
BGP/Redistributes···················································································································· 22
XML structure ··················································································································· 22
Table description ··············································································································· 23
Columns ·························································································································· 23

i
BGP
BGP/Instances
This table contains BGP instance information.

XML structure
<BGP>
<Instances>
<Instance>
<Name></Name>
<ASNumber></ASNumber>
<NSR></NSR>
<SendDelayTime></SendDelayTime>
<SendDelayPrefix></SendDelayPrefix>
<SendStartupTime></SendStartupTime>
<StartupPolicyMed></StartupPolicyMed>
</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
String. process.
Name Instance name Index When execute get
Length: 0 to 31 characters.
bulk operation, you
can only get the
data of the
specified BGP

1
 Column Column Column
Data type and restrictions Remarks
name description type
instance.
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 prefix String.

N/A
fix 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

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>
</VRF>
</VRFs>
</BGP>

2
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.

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.

BGP/CfgSessionGroups
This table contains configure information of BGP session group.

XML structure
<BGP>
<CfgSessionGroups>

3
 <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>
</CfgSessionGroup>
</CfgSessionGroups>
</BGP>

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

4
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.

Enumeration. The default type

indicate that actual
• 0—default type bfd type
BfdType Bfd type • 1—single-hop (single-hop or
• 2—multi-hop multi-hop) depend
on different
situations
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.

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

String.
Description Peer Description Case Sensitive
Length: 1 to 79 characters.

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>
<Ignore></Ignore>
<Description></Description>
</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

6
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
Mask of 255.For IPv4
Unsigned integer.
Mask session address Index dynamic peers,this
Value range: 0 to 128,or 255 is 0 to 32.For IPv6
dynamic peers, this
is 0 to 128.
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

indicate that actual
• 0—default type bfd type
BfdType Bfd type • 1—single-hop (single-hop or
• 2—multi-hop multi-hop) depend
on different
situations

7
 Column Column Column
Data type and restrictions Remarks
name description type
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.

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>
<Balance>
<MaxBalance></MaxBalance>
</Balance>
<PolicyVpnTarget></PolicyVpnTarget>
<ReflectBtwClients></ReflectBtwClients>
<ReflectorClusterID></ReflectorClusterID>
<RrFilter></RrFilter>
<DefaultRtImport></DefaultRtImport>
<DomainDistinguisher></DomainDistinguisher>
<PIC></PIC>
<VpnCrossMultipath></VpnCrossMultipath>
</Family>
</Familys>
</BGP>

8
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

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.
Enumeration:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
• 4—VPNv4
Address Family
Type Index • 5—IPv6 Unicast N/A
Identifier
• 6—IPv6 Multicast.
• 7—VPNv6
• 8—L2VPN
• 9—L2VPN EVPN
• 10—Link-State
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
number of BGP Include:
Data
Balance ECMP routes for N/A
load balancing
Structure • MaxBalance

maximum Unsigned integer.

number of BGP
MaxBalance Value range: N/A
ECMP routes for
load balancing 1 to 255

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.

10
 Column Column Column
Data type and restrictions Remarks
name description type
String,IPv4 address string or
Unsigned integer.
ReflectorClus cluster ID of the
Value range: N/A
terID route reflector
1 to 4294967295

Only IBGP routes

whose extended
Specify reflector Unsigned integer. community
route Extended Value range: attribute matches
RrFilter
community filter the specified
1 to 199
policy extended
community list are
reflected.
Enumeration:
DefaultRtImp Import default • 0—Disable N/A
ort 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

BGP/Networks
This table contains BGP network information.

XML structure
<BGP>
<Networks>
<Network>
<Name></Name>
<VRF></VRF>
<Family></Family>
<IpAddress></IpAddress>

11
 <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

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.

12
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>
</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

13
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.

BGP/NeighborGroups
This table contains BGP neighbor group information.

XML structure
<BGP>
<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>

14
 <ReOriginated></ReOriginated>
<AdvEvpnRouteSuppressMac></AdvEvpnRouteSuppressMac>
<AdvEvpnRouteSuppressPrefix></AdvEvpnRouteSuppressPrefix>
<DefaultgatewayNoAdv></DefaultgatewayNoAdv>
<RouteLimit>
<Number></Number>
<Percentage></Percentage>
<AlertOnly></AlertOnly>
<Discard></Discard>
<Reconnect></Reconnect>
</RouteLimit>
<PreferredValue></PreferredValue>
</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

15
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
Address Family • 4—VPNv4
N/A
Family Identifier of Index • 5—IPv6 Unicast
NeighborGroup • 6—IPv6 Multicast.
• 7—VPNv6
• 8—L2VPN
• 9—L2VPN EVPN
• 10—Link-State
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
Send original
next hop for Enumeration. Next-hop-local
NexthopInvari conflict with
routes • 0—Disable.
able next-hop-invariable
advertised to • 1—Enable. .
the peer
Specify local Enumeration. Next-hop-local
NexthopLocal address as the • 0—Disable. conflict with
next hop of next-hop-invariable
routes advertised • 1—Enable.

16
Column Column Column
Data type and restrictions Remarks
name description type
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.
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
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.

AlertOnly message when • 0—Disable. (default) N/A
the route limit is • 1—Enable.

17
 Column Column Column
Data type and restrictions Remarks
name description type
exceeded
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

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>
<ReOriginated></ReOriginated>
<AdvEvpnRouteSuppressMac></AdvEvpnRouteSuppressMac>
<AdvEvpnRouteSuppressPrefix></AdvEvpnRouteSuppressPrefix>
<DefaultgatewayNoAdv></DefaultgatewayNoAdv>
<RouteLimit>
<Number></Number>
<Percentage></Percentage>
<AlertOnly></AlertOnly>

18
 <Discard></Discard>
<Reconnect></Reconnect>
</RouteLimit>
<PreferredValue></PreferredValue>
</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

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:
• 1—IPv4 Unicast.
• 2—IPv4 Multicast.
• 3—MDT
Address Family • 4—VPNv4
N/A
Family Identifier of Index • 5—IPv6 Unicast
Neighbor • 6—IPv6 Multicast.
• 7—VPNv6
• 8—L2VPN
• 9—L2VPN EVPN
• 10—Link-State
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
Unsigned integer. 255.For IPv4
Mask of
Mask Index Value range: dynamic peers,this
session address is 0 to 32.For IPv6
0 to 128,or 255
dynamic peers, this
is 0 to 128.
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
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

20
Column Column Column
Data type and restrictions Remarks
name description type
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.

Re-originate
EVPN routes Enumeration.
received from the
ReOriginated peer by • 0—Disable. N/A
modifying the L3 • 1—Enable.
VXLAN ID and
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

Advertise EVPN
routes by • Enumeration.
Defaultgatew deleting the
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

21
 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

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>

22
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

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.
Protocol Protocol name Index N/A
• 3—RIP
• 4—OSPF
• 5—ISIS

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

23
Contents
BGP ······························································································1
BGP/Instances ·························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
BGP/VRFs ······························································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
BGP/CfgSessionGroups ·············································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 5
BGP/CfgSessions ······················································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7
BGP/Sessions ··························································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 9
BGP/Familys ····························································································································· 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 11
BGP/Networks ························································································································ 12
XML structure ··················································································································· 12
Table description ··············································································································· 13
Columns ·························································································································· 13
BGP/Aggregates ······················································································································ 13
XML structure ··················································································································· 14
Table description ··············································································································· 14
Columns ·························································································································· 15
BGP/NeighborGroups ··············································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 16
Columns ·························································································································· 17
BGP/Neighbors ······················································································································· 19
XML structure ··················································································································· 19
Table description ··············································································································· 20
Columns ·························································································································· 21
BGP/Redistributes···················································································································· 23
XML structure ··················································································································· 23
Table description ··············································································································· 24
Columns ·························································································································· 24
BGP/SessionCounts ················································································································· 25
XML structure ··················································································································· 25
Table description ··············································································································· 25
Columns ·························································································································· 26

i
BGP
BGP/Instances
This table contains BGP instance information.

XML structure
<BGP>
<Instances>
<Instance>
<Name></Name>
<ASNumber></ASNumber>
<NSR></NSR>
<SendDelayTime></SendDelayTime>
<SendDelayPrefix></SendDelayPrefix>
<SendStartupTime></SendStartupTime>
<StartupPolicyMed></StartupPolicyMed>
</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.

1
 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 prefix String.

N/A
fix 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

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>
</VRF>
</VRFs>
</BGP>

2
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.
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.

BGP/CfgSessionGroups
This table contains configure information of BGP session group.

XML structure
<BGP>
<CfgSessionGroups>
<CfgSessionGroup>
<Name></Name>

3
 <VRF></VRF>
<GroupName></GroupName>
<Type></Type>
<ASNumber></ASNumber>
<ConnectInterface></ConnectInterface>
<UpdateInterval></UpdateInterval>
<PasswordType></PasswordType>
<Password></Password>
<BfdType></BfdType>
<EbgpMaxHop></EbgpMaxHop>
<Ignore></Ignore>
<Description></Description>
</CfgSessionGroup>
</CfgSessionGroups>
</BGP>

Table description
Item Description
Feature name BGP
Table name CfgSessionGroups

Table type Multi-instance table

Row name CfgSessionGroup

Restrictions No

4
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.

Enumeration. The default type

indicate that actual
• 0—default type bfd type
BfdType Bfd type • 1—single-hop (single-hop or
• 2—multi-hop multi-hop) depend
on different
situations
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.

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

String.
Description Peer Description Case Sensitive
Length: 1 to 79 characters.

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>
<Ignore></Ignore>
<Description></Description>
</CfgSession>
</CfgSessions>
</BGP>

Table description
Item Description
Feature name BGP
Table name CfgSessions

Table type Multi-instance table

Row name CfgSession

Restrictions No

6
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
Mask of 255.For IPv4
Unsigned integer.
Mask session address Index dynamic peers,this
Value range: 0 to 128,or 255 is 0 to 32.For IPv6
dynamic peers, this
is 0 to 128.
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

indicate that actual
• 0—default type bfd type
BfdType Bfd type • 1—single-hop (single-hop or
• 2—multi-hop multi-hop) depend
on different
situations

7
 Column Column Column
Data type and restrictions Remarks
name description type
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.

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>
<State></State>
</Session>
</Sessions>
</BGP>

Table description
Item Description
Feature name BGP
Table name Sessions
Table type Multi-instance table
Row name Session
Restrictions No

8
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.

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>
<Balance>

9
 <MaxBalance></MaxBalance>
</Balance>
<PolicyVpnTarget></PolicyVpnTarget>
<ReflectBtwClients></ReflectBtwClients>
<ReflectorClusterID></ReflectorClusterID>
<RrFilter></RrFilter>
<DefaultRtImport></DefaultRtImport>
<DomainDistinguisher></DomainDistinguisher>
<PIC></PIC>
<VpnCrossMultipath></VpnCrossMultipath>
</Family>
</Familys>
</BGP>

Table description
Item Description
Feature name BGP
Table name Family
Table type Multi-instance table
Row name Family
Restrictions No

10
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
Type Index • 5—IPv6 Unicast N/A
Identifier
• 6—IPv6 Multicast.
• 7—VPNv6
• 8—L2VPN
• 9—L2VPN EVPN
• 10—Link-State
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
number of BGP Include:
Data
Balance ECMP routes for N/A
load balancing
Structure • MaxBalance

maximum Unsigned integer.

number of BGP
MaxBalance Value range: N/A
ECMP routes for
load balancing 1 to 255

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.

11
 Column Column Column
Data type and restrictions Remarks
name description type
String,IPv4 address string or
Unsigned integer.
ReflectorClus cluster ID of the
Value range: N/A
terID route reflector
1 to 4294967295

Only IBGP routes

whose extended
Specify reflector Unsigned integer. community
route Extended Value range: attribute matches
RrFilter
community filter the specified
1 to 199
policy extended
community list are
reflected.
Enumeration:
DefaultRtImp Import default • 0—Disable N/A
ort 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

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>

12
 </Network>
</Networks>
</BGP>

Table description
Item Description
Feature name BGP
Table name Networks
Table type Multi-instance table
Row name Network
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:
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.

13
XML structure
<BGP>
<Aggregates>
<Aggregate>
<Name></Name>
<VRF></VRF>
<Family></Family>
<IpAddress></IpAddress>
<Mask></Mask>
<DetailSuppressed></DetailSuppressed>
</Aggregate>
</Aggregates>
</BGP>

Table description
Item Description
Feature name BGP
Table name Aggregates
Table type Multi-instance table
Row name Aggregate
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 • 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.

BGP/NeighborGroups
This table contains BGP neighbor group information.

XML structure
<BGP>
<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>

15
 <ReOriginated></ReOriginated>
<AdvEvpnRouteSuppressMac></AdvEvpnRouteSuppressMac>
<AdvEvpnRouteSuppressPrefix></AdvEvpnRouteSuppressPrefix>
<DefaultgatewayNoAdv></DefaultgatewayNoAdv>
<RouteLimit>
<Number></Number>
<Percentage></Percentage>
<AlertOnly></AlertOnly>
<Discard></Discard>
<Reconnect></Reconnect>
</RouteLimit>
<PreferredValue></PreferredValue>
</NeighborGroup>
</NeighborGroups>
</BGP>

Table description
Item Description
Feature name BGP
Table name NeighborGroups
Table type Multi-instance table
Row name NeighborGroup
Restrictions No

16
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
Address Family • 4—VPNv4
N/A
Family Identifier of Index • 5—IPv6 Unicast
NeighborGroup • 6—IPv6 Multicast.
• 7—VPNv6
• 8—L2VPN
• 9—L2VPN EVPN
• 10—Link-State
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

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

RouterMacLo Specify local Enumeration.

N/A
cal MAC as the • 0—Disable.

17
Column Column Column
Data type and restrictions Remarks
name description type
router MAC of • 1—Enable.
routes advertised
to and received
from the peers

Send community Enumeration.

AdvertiseCo
attribute to the • 0—Disable. N/A
mmunity
peers • 1—Enable.
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
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.

Discard N/A
received after the • 0—Disable.

18
 Column Column Column
Data type and restrictions Remarks
name description type
route limit is • 1—Enable.
exceeded
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

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>
<ReOriginated></ReOriginated>
<AdvEvpnRouteSuppressMac></AdvEvpnRouteSuppressMac>
<AdvEvpnRouteSuppressPrefix></AdvEvpnRouteSuppressPrefix>
<DefaultgatewayNoAdv></DefaultgatewayNoAdv>
<RouteLimit>
<Number></Number>
<Percentage></Percentage>
<AlertOnly></AlertOnly>
<Discard></Discard>
<Reconnect></Reconnect>
</RouteLimit>
<PreferredValue></PreferredValue>

19
 </Neighbor>
</Neighbors>
</BGP>

Table description
Item Description
Feature name BGP
Table name Neighbors
Table type Multi-instance table
Row name Neighbor
Restrictions No

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
Address Family • 4—VPNv4
N/A
Family Identifier of Index • 5—IPv6 Unicast
Neighbor • 6—IPv6 Multicast.
• 7—VPNv6
• 8—L2VPN
• 9—L2VPN EVPN
• 10—Link-State
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
Unsigned integer. 255.For IPv4
Mask of
Mask Index Value range: dynamic peers,this
session address is 0 to 32.For IPv6
0 to 128,or 255
dynamic peers, this
is 0 to 128.
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
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 • 0—Disable.
ReflectClient N/A
specify a peer or
peer group as a • 1—Enable.
client

21
Column Column Column
Data type and restrictions Remarks
name description type
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.

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.
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
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 Number of Unsigned integer. N/A

22
 Column Column Column
Data type and restrictions Remarks
name description type
prefixes Value range:
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

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>

23
Table description
Item Description
Feature name BGP
Table name Redistributes
Table type Multi-instance table
Row name Redist
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:
• 1—IPv4 Unicast.
Address Family
Family Index • 2—IPv4 Multicast.
Identifier N/A
• 5—IPv6 Unicast
• 6—IPv6 Multicast.
Enumeration:
• 1—Direct.
• 2—Static.
Protocol Protocol name Index N/A
• 3—RIP
• 4—OSPF
• 5—ISIS

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.

24
BGP/SessionCounts
This table contains session statistics.

XML structure
<BGP>
<SessionCounts>
<SessionCount>
<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

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: 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

26
Contents
BGP ······························································································2
BGP/Instances ·························································································································· 2
BGP/VRFs ······························································································································· 2
BGP/CfgSessionGroups ·············································································································· 3
BGP/CfgSessions ······················································································································ 4
BGP/Familys ····························································································································· 5
BGP/Networks ·························································································································· 6
BGP/Aggregates ························································································································ 7
BGP/NeighborGroups ················································································································· 7
BGP/Neighbors ························································································································· 9
BGP/Redistributes···················································································································· 10

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.

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.

2
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 must be null. 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.

3
Invalid ciphertext password length. Invalid configuration, please modify configuration under the
密文密码长度不合法。 guidance.

BFD not supported.

BFD service has not been started.
不支持BFD

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检查。

When the operation is create, merge, or replace,

the AS number must not be null. Invalid configuration, please modify configuration under the
guidance.
Create、merge、replace操作时，AS号不能为空。

When the operation is delete or remove, the AS

number must be null. 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必须同时配置。

4
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

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.
配置的等价条数超过产品所能配置的最大值。

5
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命令。

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命令。

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命令。

6
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号不匹配。

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命令。

7
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

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命令。

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.

8
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.

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命令。

Invalid configuration, please modify configuration under the

The specified address family doesn't support the guidance.

9
next-hop-local command。
指定地址族不支持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

无效的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不能同时配置。

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命令。

When the protocol is Direct or Static, the protocol

name must be null. Invalid configuration, please modify configuration under the
guidance.
引入协议为直连或者静态时，协议名称必须为空。

When the Protocol is RIP, OSPF, or ISIS, the Invalid configuration, please modify configuration under the
protocol name must be ""all-processes"" or a guidance.

10
number in the range of 1 to 65535.
引入协议为RIP、ISIS或者OSPF时，协议名称必须
为all-processes或者1到65535的数字。

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。

11
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 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.
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 N/A • true—Enabled. N/A
processing
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 ··············································································································· 4
XML structure for event subscription ························································································· 4
XML structure for event report ································································································· 5

i
BufferMonitor event stream
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>
</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>
</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

XML structure for event report

<QueueOverrunEvent>
<IfIndex/>
<QueIndex/>
<AlarmType/>
<CurrentValue/>
<CurrentRatio/>
<Threshold/>
</QueueOverrunEvent>

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.

PortQueDropEvent event
This event is used to report counters of interface’s queue drop threshold.

XML structure for event subscription

<PortQueDropEvent>

4
 <PortQueDrop>
<IfIndex></IfIndex>
<QueIndex></QueIndex>
<AlarmType></AlarmType>
</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>
</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
1— for ingress
drops
AlarmType Alarm type. Unsigned integer. No
2— for egress
drops

XML structure for event report

<QueueDropEvent>
<IfIndex/>
<QueIndex/>
<AlarmType/>

5
 <DropCounters/>
</QueueDropEvent>

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.

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.
Wrong MAC address. Invalid MAC address, please check your MAC address.

1
Contents
CAR ······························································································1
CAR/CarLists ···························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
CAR/Policies ····························································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5

i
CAR
CAR/CarLists
This table contains information about commited-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 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 objgroup. Length: 1 to 31 characters. object group name can’t
be trated 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
objgroup.
be trated 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/Policies
This table contains information about commited-access-rate policy.

XML structure
<CAR>
<CarPolicies>
<Policy>
<IfIndex></IfIndex>
<Direction></Direction>
<Type></Type>
<Value></Value>
<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
Restrictions None
Support for row creation and deletion Yes

4
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
configurated 0.
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

Members include: GreenActionValue is

Specify behavior Data required when
GreenAction
for green packets structure • GreenActionType GreenActionType is not 1,
• GreenActionValue 10 or 19.

Enumeration: The default

GreenActionType is pass.
• 1—pass.
• 2—remark-dscp-pass When GreenActionType
is 1, send the packet.
• 3—remark-precedence-
pass When GreenActionType
is 2, remark DSCP value
GreenActionT
Action type N/A • 4—remark-mpls-exp-pa
ype of the packet and send it.
ss
• 5—remark-dot1p-pass When GreenActionType
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 GreenActionType
ass is 4, remark EXP of the

5
Column Column Column
Data type and restrictions Remarks
name description type
• 10—discard MPLS packet and send it.
• 11—remark-dscp-contin When GreenActionType
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 GreenActionType
ontinue is 6, remark CLP bit of the
• 14—remark-dot1p-conti ATM packet and send it.
nue When GreenActionType
• 15—remark-atm-clp-co is 7, remark DE bit of the
ntinue. FR packet and send it.
• 16—remark-fr-de-contin When GreenActionType
ue. is 8, drop the packet.
• 17—remark-local-prec-c When GreenActionType
ontinue. is 10, remark local
• 19—continue. precedence of the packet
and send it.
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.

Members include: YellowActionValue is

Specify behavior
Data required when
YellowAction for Yellow
structure • YellowActionType GreenActionType is not 1,
packets • YellowActionValue 10 or 19.
The default
YellowActionType is pass.
When YellowActionType
Enumeration: is 1, send the packet.
• 1—pass. When YellowActionType
• 2—remark-dscp-pass 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
and send it.
• 5—remark-dot1p-pass
• 6—remark-atm-clp-pass When YellowActionType
is 4, remark EXP of the
• 7—remark-fr-de-pass MPLS packet and send it.
• 8—remark-local-prec-p
When YellowActionType
ass
is 5, remark 802.1p
• 10—discard priority value of the packet
YellowAction
Action type N/A • 11—remark-dscp-contin and send it.
Type
ue When YellowActionType
• 12—remark-precedenc is 6, remark CLP bit of the
e-continue ATM packet and send it.
• 13—remark-mpls-exp-c When YellowActionType
ontinue is 7, remark DE bit of the
• 14—remark-dot1p-conti FR packet and send it.
nue When YellowActionType
• 15—remark-atm-clp-co is 8, drop the packet.
ntinue.
When YellowActionType
• 16—remark-fr-de-contin is 10, remark local
ue. precedence of the packet
• 17—remark-local-prec-c and send it.
ontinue.
When YellowActionType
• 19—continue. is 11, remark DSCP value
of the packet and continue
to process it using the
next CAR policy.

7
Column Column Column
Data type and restrictions Remarks
name description type
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.

Members include: RedActionValue is

Specify behavior Data required when
RedAction
for Red packets structure • RedActionType GreenActionType is not 1,
• RedActionValue 10 or 19.

RedActionTyp Enumeration: The default

Action type N/A
e • 1—pass. RedActionType is discard.

8
Column Column Column
Data type and restrictions Remarks
name description type
• 2—remark-dscp-pass When RedActionType is
• 3—remark-precedence- 1, send the packet.
pass When RedActionType is
• 4—remark-mpls-exp-pa 2, remark DSCP value of
ss the packet and send it.
• 5—remark-dot1p-pass When RedActionType is
• 6—remark-atm-clp-pass 3, remark IP precedence
of the packet and send it.
• 7—remark-fr-de-pass
• 8—remark-local-prec-p When RedActionType is
ass 4, remark EXP of the
MPLS packet and send it.
• 10—discard
• 11—remark-dscp-contin When RedActionType is
ue 5, remark 802.1p priority
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
nue When RedActionType is
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.
ue
• 17—remark-local-prec-c When RedActionType is
ontinue. 10, remark local
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.

9
Column Column Column
Data type and restrictions Remarks
name description type
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.

10
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

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 objgroup. 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
objgroup.
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>
<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
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
Value Match type value Index Unsigned integer. N/A
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: The default

GreenActionType is pass.
• 1—pass.
• 2—remark--dscp--pass When GreenActionType
is 1, send the packet.
• 3—remark--precedence
--pass When GreenActionType
is 2, remark DSCP value
• 4—remark--mpls--exp--
of the packet and send it.
pass
• 5—remark-dot1p-pass When GreenActionType
is 3, remark IP
GreenActionT
Action type N/A • 6—remark-atm-clp-pass precedence of the packet
ype • 7—remark-fr-de-pass and send it.
• 8—remark-local-prec-p When GreenActionType
ass is 4, remark EXP of the
• 10—discard MPLS packet and send it.
• 11—remark-dscp-contin When GreenActionType
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 GreenActionType
5
Column Column Column
Data type and restrictions Remarks
name description type
ontinue is 6, remark CLP bit of the
• 14—remark-dot1p-conti ATM packet and send it.
nue When GreenActionType
• 15—remark-atm-clp-co is 7, remark DE bit of the
ntinue. FR packet and send it.
• 16—remark-fr-de-contin When GreenActionType
ue. is 8, drop the packet.
• 17—remark-local-prec-c When GreenActionType
ontinue. is 10, remark local
• 19—continue precedence of the packet
and send it.
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.
When GreenActionType
is 1, 10 or 19,
GreenActionValue is
GreenActionV Unsigned integer. invalid.
Action value N/A
alue Value range: 0 to 63. When GreenActionType
is 6, 7, 15, 16,
GreenActionValue is
0~1.
6
Column Column Column
Data type and restrictions Remarks
name description type
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
The default
YellowActionType is pass.
When YellowActionType
is 1, send the packet.
When YellowActionType
is 2, remark DSCP value
of the packet and send it.
When YellowActionType
Enumeration:
is 3, remark IP
• 1—pass. precedence of the packet
• 2—remark-dscp-pass and send it.
• 3—remark-precedence- When YellowActionType
pass is 4, remark EXP of the
• 4—remark-mpls-exp-pa MPLS packet and send it.
ss When YellowActionType
• 5—remark-dot1p-pass is 5, remark 802.1p
• 6—remark-atm-clp-pass priority value of the packet
and send it.
• 7—remark-fr-de-pass
When YellowActionType
• 8—remark-local-prec-p
is 6, remark CLP bit of the
ass
ATM packet and send it.
• 10—discard
YellowAction When YellowActionType
Action type N/A • 11—remark-dscp-contin is 7, remark DE bit of the
Type
ue FR packet and send it.
• 12—remark-precedenc
When YellowActionType
e-continue
is 8, drop the packet.
• 13—remark-mpls-exp-c
ontinue When YellowActionType
is 10, remark local
• 14—remark-dot1p-conti
precedence of the packet
nue and send it.
• 15—remark-atm-clp-co
When YellowActionType
ntinue.
is 11, remark DSCP value
• 16—remark-fr-de-contin of the packet and continue
ue. to process it using the
• 17—remark-local-prec-c next CAR policy.
ontinue.
When YellowActionType
• 19—continue 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.

7
Column Column Column
Data type and restrictions Remarks
name description type
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: 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
RedActionTyp
Action type N/A • 4—remark-mpls-exp-pa the packet and send it.
e 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
ass MPLS packet and send it.

8
Column Column Column
Data type and restrictions Remarks
name description type
• 10—discard When RedActionType is
• 11—remark-dscp-contin 5, remark 802.1p priority
ue value of the packet and
send it.
• 12—remark-precedenc
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
packet and send it.
• 15—remark-atm-clp-co
ntinue. When RedActionType is
• 16—remark-fr-de-contin 8, drop the packet.
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.

RedActionVal Unsigned integer. When RedActionType is

Action value N/A 1, 10 or 19,
ue Value range: 0 to 63. RedActionValue is
9
 Column Column Column
Data type and restrictions Remarks
name description type
invalid.
When RedActionType is
6, 7, 15, 16,
RedActionValue is 0~1.
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>
<PIRGranularity></PIRGranularity>
</Capability>
</CAR>

10
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.

The value of this

Minimum EBS value column depends
EBSMin N/A Unsigned integer.
in bytes on the device
model.

11
Column Column
Column description Data type and restrictions Remarks
name type
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.

12
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

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

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.

4
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 ····························································································································································· 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>
<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>
</VerificationDis>
</CellularVerificationDis>
</Cellular>

2
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

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>

3
 </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 32 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.

XML structure
<Cellular>
<CellularApplyProfile>
<ApplyProfile>
<IfIndex></IfIndex>

4
 <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
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
CMTNLMGR ···················································································1
Cmtnlmgr/CloudDomain ················································································································ 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1

i
CMTNLMGR
Cmtnlmgr/CloudDomain
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.

1
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/CloudDomain ················································································································ 2
XML structure ······················································································································· 2
Table description ··················································································································· 3
Columns ······························································································································ 3

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
Re
Column
Column name Column type Data type and restrictions mar
description
ks
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/CloudDomain
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.

3
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

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

1
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

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

3
Contents
Configuration···················································································1
Configuration/Files ······················································································································· 1

i
Configuration
Configuration/Files
Message Explanation
The file name is invalid or the file is not in the root Startup configuration file must be in the root directory.
directory!
The file does not exist or is not as the same as the
Startup configuration file must be the same on all boards.
file on the active MPU.
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.

1
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
among the

1
 Column Column Column
Data type and restrictions Remarks
name description type
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 ······························································································································ 7
Context/Resource/ObjectPolicyRules ······························································································· 8
XML structure ······················································································································· 8
Table description ··················································································································· 8
Columns ······························································································································ 8
Context/Resource/Sessions ··········································································································· 9
XML structure ······················································································································· 9
Table description ··················································································································· 9
Columns ······························································································································ 9
Context/InterfaceAllocations ········································································································· 10
XML structure ····················································································································· 10
Table description ················································································································· 10
Columns ···························································································································· 10
Context/Allocations····················································································································· 11
XML structure ····················································································································· 11
Table description ················································································································· 11
Columns ···························································································································· 11
Context/VLANAllocations············································································································· 12
XML structure ····················································································································· 12
Table description ················································································································· 12
Columns ···························································································································· 12
Context/Capabilities···················································································································· 13
XML structure ····················································································································· 13
Table description ················································································································· 13
Columns ···························································································································· 13
Context/LocationBladeControllerTeams(discard) ·············································································· 14
XML structure ····················································································································· 14
Table description ················································································································· 14
Columns ···························································································································· 14
Context/Resource/SSLVPNs ········································································································ 15
XML structure ····················································································································· 15
Table description ················································································································· 15
Columns ···························································································································· 15

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
firewall card:There
Full name of an String. is no default
Name N/A context.
Context Length: 1 to 15 characters.
centralized firewall

1
Column Column Column
Data type and restrictions Remarks
name description type
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 Unsigned integer. Location: Authorize

N/A
erTeam eam ID Value range: 0 to 256. the context

2
 Column Column Column
Data type and restrictions Remarks
name description type
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.
centralized firewall and packaging firewall:query all contexts’ disk

3
 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.

Instance name of String.

Partition Index N/A
disk resource Length: 1 to 31 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>
<Quota></Quota>
<Reserved></Reserved>
<Used></Used>

4
 <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
Restrictions default 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)

Current available The minimum

Available resources of N/A Unsigned integer. between(Quota-Used)and
memory(KB) idle resource of disk.

5
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 number of Unsigned integer.

Chassis Index N/A
CPU resource Value range: 0 to 65535.

Slot number of CPU Unsigned integer.

Slot Index N/A
resource Value range: 0 to 65535.

CPU ID of CPU Unsigned integer.

CPUID Index N/A
resource Value range: 0 to 65535.

6
 Column Column Column Data type and
Remarks
name description type restrictions
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.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A

7
 Column Column Column Data type and
Remarks
name description type restrictions
Members include:
ThroughputVa Throughputs Data
lue 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.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID context index Index Unsigned integer. N/A

Max Maxnum of N/A Positive integer. The value range depends

ObjectPolicyRule

8
 Column Column Column Data type and
Remarks
name description type restrictions
s on the device model.
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

Maxnum of
MaxRate N/A Positive integer. 0 means no restrictions
transfer rate:1/s

9
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
Full name of an String.
IfName Index N/A
interface Length: 2 to 47 characters.
ContextID Context ID Index Unsigned integer. N/A
Enumeration:
• 0: Invalid
• 1: The interface has
not been allocated.
Interface
AllocType
assignment type
N/A • 2: The allocation N/A
type is shared.
• 3: The allocation
type is exclusive.

10
Context/Allocations
This table contains interfaces and vlans.

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.

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContextID Context ID N/A Unsigned integer. N/A
String.
Unshared interface list
UnsharedIn List of unshared Such as:
N/A N/A
terfaceList interfaces GigabitEthernet2/2/0/2,Gi
gabitEthernet2/2/0/5 to
GigabitEthernet2/2/0/6
String.
Shared interface list
SharedInte List of shared Such as:
N/A N/A
rfaceList interfaces GigabitEthernet2/2/0/3,Gi
gabitEthernet2/2/0/7 to
GigabitEthernet2/2/0/8

11
 Column Column Column Data type and
Remarks
name description type restrictions
VLAN Vlan list N/A Numeric string N/A
Such as: 1,2,3,5-8,10-20

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
VLANID Vlan Index Index Positive integer. firewall card :There is not
default context.
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
String. Example: 2,3,5-8,10-20.
ContextIDList Context ID List N/A Length: 1to 65535 Available Context IDs are
characters. in the ContextID column in

12
 Column Column Column Data type and
Remarks
name description type restrictions
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:
BelongtoSup
belongto can be N/A • true N/A
port
configured. • false

Check whether Boolean:

ModeSupport vlan mode can N/A • true N/A
be configured. • false

13
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

14
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.

15
Contents
Context ··························································································1
Context/ContextInformations ·········································································································· 1
Context/Resources/Disks ·············································································································· 1
Context/Resources/Memories········································································································· 2
Context/Resources/CPUs ·············································································································· 2
Context/LocationBladeControllerTeams(discard) ················································································ 2
Context/Allocation ························································································································ 2

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.
Another context is using the ID when creating a context. Please
Another context is using the ID.
switch a new one.

The name is already exists. The name is already exists when creating a new context.
Operation failed. The context is already started. Operation failed. The context is already started.
The MDC is not authorized to use the blade
The MDC is not authorized to use the blade controller team.
controller team."
The context doesn't belong to the MDC. The context doesn't belong to the MDC.
This context has been assigned to another blade
This context has been assigned to another blade controller team.
controller team.
Restoring context configuration. Please try again
Restoring context configuration. Please try again later.
later.
The context is starting or stopping. Please try again later if need
Context is busy. Please try again later.
do some set operations.
The context name and ID must identify the same
The context name and ID must identify the same context.
context.
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.

Invalid context ID or context name. Invalid context ID or context name.

The default context can't be deleted. The default context can't be deleted.
The default context can't be deleted. The default context can't be deleted.

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.

Restoring context configuration. Please try again

Restoring context configuration. Please try again later.
later.
The context is starting or stopping. Please try again later if need
Context is busy. Please try again later.
do some set operations.

1
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.
Restoring context configuration. Please try again
Restoring context configuration. Please try again later.
later.
The context is starting or stopping. Please try again later if need
Context is busy. Please try again later.
do some set operations.

Context/Resources/CPUs
Message Explanation
Restoring context configuration. Please try again
Restoring context configuration. Please try again later.
later.
The context is starting or stopping. Please try again later if need
Context is busy. Please try again later.
do some set operations.

Context/LocationBladeControllerTeams(discard)
Message Explanation
Authorization failed. Invalid blade-controller-team
Authorization failed. Invalid blade-controller-team ID.
ID.

This context has been assigned to another blade

This context has been assigned to another blade controller team.
controller team.

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.

Restoring context configuration. Please try again

Restoring context configuration. Please try again later.
later.

The context is starting or stopping. Please try again later if need

Context is busy. Please try again later.
do some set operations.

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.
Some interfaces name are invalid. Some interfaces name are invalid.
Some interfaces have been allocated as other
Some interfaces have been allocated as other mode.
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.

2
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.
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.
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

Some interfaces' member interface has been allocated.
allocated.

Failed to allocate nonexistent VLANs. Failed to allocate nonexistent VLANs.

Default VLAN can not be allocated. Default VLAN can not be allocated.
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.
Failed to allocate VLANs because some of them Failed to allocate VLANs because some of them have VLAN
have VLAN interfaces. interfaces.
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.
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.

3
Contents
CustomLog ·····················································································1
CustomLog/LogHost ····················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 2
CustomLog/LogAttribute ················································································································ 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
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>
</OutputLog>
</Host>
</LogHosts>
</CustomLog>

Table description
Item Description
Feature name CustomLog
Table name LogHosts
Table type Multi-instance table
Row name Host
Restrictions The device supports up to four log hosts.
Support for row creation and deletion Yes

1
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
Type of logs to • UnicomUserlog
Data
OutputLog be sent to the log
structure • Sessionlog N/A
host • PacketFilterlog
• ATKlog
• AFTlog
• DPIAuditlog
• DPIUfltlog
• DPINetSharelog
• SCDlog
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
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

2
Column Column Column
Data type and restrictions Remarks
name description type
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 N/A • true—Enabled. N/A
audit logs to the
log host • false—Disabled.

Enabling status Boolean:

of outputting DPI
DPIUfltlog
URL filter logs to
N/A • true—Enabled. N/A
the log host • false—Disabled.

DPINetSharel Enabling status Boolean:

of outputting DPI N/A N/A
og
netshare control • true—Enabled.

3
 Column Column Column
Data type and restrictions Remarks
name description type
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 N/A • true—Enabled. N/A
IPS logs to 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>
<DPINetShareLogFormat></DPINetShareLogFormat>
<SCDLogFormat></SCDLogFormat>
<DPIIPSLogFormat></DPIIPSLogFormat>
<DPIIPSUpdateLogFormat></DPIIPSUpdateLogFormat>
</LogAttribute>
</CustomLog>

Table description
Item Description
Feature name CustomLog
Table name LogAttribute
Table type Single-instance table
Row name None
Restrictions None

4
 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).
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).
DPIUfltLogFor Format for Enumeration:
N/A N/A
mat outputting DPI • 0—Output standard H3C

5
Column Column Column
Data type and restrictions Remarks
name description type
URL filter custom format DPI URL filter logs.
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 • 0—Output SGCC format

DPIIPSUpdate outputting DPI DPI IPS signature update
N/A logs. N/A
LogFormat IPS signature
update logs • 1—Do not output DPI IPS
signature update logs
(default).

6
Contents
CustomLog ·····················································································1
CustomLog/LogHost ····················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 2
CustomLog/LogAttribute ················································································································ 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
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>
</OutputLog>
</Host>
</LogHosts>
</CustomLog>

Table description
Item Description
Feature name CustomLog
Table name LogHosts
Table type Multi-instance table
Row name Host
Restrictions The device supports up to four log hosts.

1
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
Type of logs to • UnicomUserlog
Data
OutputLog be sent to the log
structure • Sessionlog N/A
host • PacketFilterlog
• ATKlog
• AFTlog
• DPIAuditlog
• DPIUfltlog
• DPINetSharelog
• SCDlog
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
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

2
Column Column Column
Data type and restrictions Remarks
name description type
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:

of outputting DPI
DPIAuditlog
audit logs to the
N/A • true—Enabled. N/A
log host • false—Disabled.

Enabling status Boolean:

of outputting DPI
DPIUfltlog
URL filter logs to
N/A • true—Enabled. N/A
the log host • false—Disabled.

Enabling status N/A Boolean: N/A

DPINetSharel
of outputting DPI

3
 Column Column Column
Data type and restrictions Remarks
name description type
og netshare control • true—Enabled.
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.

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>
<DPINetShareLogFormat></DPINetShareLogFormat>
<SCDLogFormat></SCDLogFormat>
<DPIIPSLogFormat></DPIIPSLogFormat>
<DPIIPSUpdateLogFormat></DPIIPSUpdateLogFormat>
</LogAttribute>
</CustomLog>

Table description
Item Description
Feature name CustomLog
Table name LogAttribute
Table type Single-instance table
Row name None

4
 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.
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.
DPIUfltLogFor Format for Enumeration:
N/A N/A
mat outputting DPI • 0—Output standard H3C

5
Column Column Column
Data type and restrictions Remarks
name description type
URL filter custom format DPI URL filter logs.
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
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 ···························································································1
CWMP/Configuration ···················································································································· 1

i
CWMP
CWMP/Configuration
Message Explanation
Failed to enable CWMP. Failed to start CWMP.

First enable CWMP to do the replace, remove and delete

Please enable CWMP first.
operation.
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.
The specified interface is not supported. The specified interface type is not supported.

1
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 deletion No

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 deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
IpType
Type of the DAE
Index • 0—IPv4. Only support IPv4 at
client IP address. 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.

2
Column Column Column
Data type and restrictions Remarks
name description type
In non-FIPS mode, a plaintext
Shared key of shared key is a string of 1 to 64
the RADIUS characters.
packets In FIPS mode, a plaintext
Key exchanged N/A The shared key is in
shared key is a string of 15 to
between the 64 characters that must plain text.
DAE server and contain digits, uppercase
client. 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 ······························································································································ 4

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 deletion No

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 deletion Yes

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.

2
 Column Column Column
Data type and restrictions Remarks
name description type
In non-FIPS mode, a plaintext
Shared key of shared key is a string of 1 to 64
the RADIUS characters.
packets In FIPS mode, a plaintext The shared key is in
Key exchanged N/A shared key is a string of 15 to plain text.
between the 64 characters that must
DAE server and contain digits, uppercase
client. 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 deletion No

3
Columns
Column
Column name Column description Data type and restrictions
type
Number of DM request
DmReq N/A Unsigned integer.
packets.

Number of DM ACK
DmAck N/A Unsigned integer.
packets.

Number of DM NAK
DmNak N/A Unsigned integer.
packets.

Number of CoA request

CoaReq N/A Unsigned integer.
packets.

Number of CoA ACK

CoaAck N/A Unsigned integer.
packets.

Number of CoA NAK

CoaNak N/A Unsigned integer.
packets.

Number of packets that

the DAE client
ReTrans N/A Unsigned integer.
retransmits to the DAE
server.
Number of packets for
FindNasFail which the device can't N/A Unsigned integer.
locate the DAE server.
Number of packets
SendToNasFail failed to send to the N/A Unsigned integer.
DAE server.

4
Contents
DaeProxy ·······················································································1
DaeProxy/DaeProxyService ··········································································································· 1
DaeProxy/DaeProxyClients ············································································································ 1

i
DaeProxy
DaeProxy/DaeProxyService
Message Explanation
Can't set the DAE listening port when disabling RADIUS DAE
Can't set the DAE listening port when disabling proxy.
RADIUS DAE proxy.

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.

DaeProxy/DaeProxyClients
Message Explanation
Invalid IP address. Invalid IP address.

1
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
DDNS ····························································································1
DDNS/DDNSPolicy ······················································································································ 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
DDNS/DDNSIfApply ····················································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 4

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 Colum Data type and
descriptio Remarks
name n type restrictions
n
String, case
DDNS insensitive.
PolicyNa
policy Index N/A
me Length: 1 to 32
name
characters.

1
 Column
Column Colum Data type and
descriptio Remarks
name n type restrictions
n
The URL addresses configured for update requests
depend on the DDNS servers. Common DDNS
server URL address format are shown in following
table.
DDNS URL addresses for DDNS update requests
server
www. http://members.3322.org/dyndns/update?s
3322. m=dyndns&hostname=<h>&myip=<a>
org
DYND http://members.dyndns.org/nic/update?sys
NS dyndns&hostname=<h>&myip=<a>
DYNS http://www.dyns.cx/postscript.php?host=<h
=<a>
ZONE http://dynamic.zoneedit.com/auth/dynamic.
EDIT ?host=<h>&dnsto=<a>
TZO http://cgi.tzo.com/webclient/signedon.html?
Name=<h>IPAddress=<a>
EASY http://members.easydns.com/dyn/ez-ipupd
DNS hp?action=edit&myip=<a>&host_id=<h>
HEIP http://dyn.dns.he.net/nic/update?hostname
V6TB >&myip=<a>
CHAN http://nic.changeip.com/nic/update?hostnam
GE-IP <h>&offline=1
NO-IP http://dynupdate.no-ip.com/nic/update?hos
me=<h>&myip=<a>
DHS http://members.dhs.org/nic/hosts?domain=
dhs.org&hostname=<h>&hostscmd=edit&h
cmdstage=2&type=1&ip=<a>
HP https://server-name/nic/update?group=grou
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
URL String, case command.
address for sensitive.
HP and GNUDIP are common DDNS update
URL DDNS N/A Length: 1 to protocols. The server-name parameter is the
update 240 domain name or IP address of the service provider's
requests characters. 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.
2
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,
 Column
Column Colum Data type and
descriptio Remarks
name n type restrictions
n
It must be configured together with the IntervalHour
Interval for column and IntervalMinute column.
sending
Unsigned If you set the interval to 0, the device does not
DDNS
integer. periodically initiate DDNS update request.
update
IntervalD However, it initiates a DDNS update request in
requests N/A Value range: 0 either of the following situations:
ay
after DDNS to 365 days.
update is Default: 0. • When the primary IP address of the interface
enabled changes.
(Day) • When the link state of the interface changes
from down to up.
Interval for
sending
DDNS Unsigned
update integer.
IntervalH It must be configured together with the IntervalDay
requests N/A Value range: 0
our column and IntervalMinute column.
after DDNS to 23 hours.
update is Default: 1.
enabled
(Hour)
Interval for
sending Unsigned
DDNS integer.
update
IntervalM Value range: 0 It must be configured together with the IntervalDay
requests N/A
inute to 59 column and IntervalHour column.
after DDNS
minutes.
update is
enabled Default: 0.
(minute)
Username
to be
included in String, case
Usernam the URL sensitive.
N/A N/A
e address for Length: 1 to 32
DDNS characters.
update
requests
Password
to be
included in String, case
Passwor the URL sensitive.
N/A Support for configuring in plain text only.
d address for Length: 1 to 32
DDNS characters.
update
requests
Transmissi
on method
for sending Enumeration:
DDNS • 0—Http-g
update et
Method N/A N/A
requests to (default).
HTTP/HTT • 1—Http-p
PS-based ost.
DDNS
servers

3
 Column
Column Colum Data type and
descriptio Remarks
name n type restrictions
n
Associate a
specific String, case
SSLClie SSL client insensitive. The SSL client policy is effective only for
N/A
ntPolicy policy with Length: 1 to 31 HTTPS-based DDNS update requests.
a DDNS characters.
policy

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
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

4
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 ······························································································································ 4

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 Colum Data type and
descriptio Remarks
name n type restrictions
n
String, case
DDNS insensitive.
PolicyNa
policy Index N/A
me Length: 1 to 32
name
characters.

1
 Column
Column Colum Data type and
descriptio Remarks
name n type restrictions
n
The URL addresses configured for update requests
depend on the DDNS servers. Common DDNS
server URL address format are shown in following
table.
DDNS URL addresses for DDNS update requests
server
www. http://members.3322.org/dyndns/update?s
3322. m=dyndns&hostname=<h>&myip=<a>
org
DYND http://members.dyndns.org/nic/update?sys
NS dyndns&hostname=<h>&myip=<a>
DYNS http://www.dyns.cx/postscript.php?host=<h
=<a>
ZONE http://dynamic.zoneedit.com/auth/dynamic.
EDIT ?host=<h>&dnsto=<a>
TZO http://cgi.tzo.com/webclient/signedon.html?
Name=<h>IPAddress=<a>
EASY http://members.easydns.com/dyn/ez-ipupd
DNS hp?action=edit&myip=<a>&host_id=<h>
HEIP http://dyn.dns.he.net/nic/update?hostname
V6TB >&myip=<a>
CHAN http://nic.changeip.com/nic/update?hostnam
GE-IP <h>&offline=1
NO-IP http://dynupdate.no-ip.com/nic/update?hos
me=<h>&myip=<a>
DHS http://members.dhs.org/nic/hosts?domain=
dhs.org&hostname=<h>&hostscmd=edit&h
cmdstage=2&type=1&ip=<a>
HP https://server-name/nic/update?group=grou
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
URL String, case command.
address for sensitive.
HP and GNUDIP are common DDNS update
URL DDNS N/A Length: 1 to protocols. The server-name parameter is the
update 240 domain name or IP address of the service provider's
requests characters. 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.
2
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,
 Column
Column Colum Data type and
descriptio Remarks
name n type restrictions
n
It must be configured together with the IntervalHour
Interval for column and IntervalMinute column.
sending
If you set the interval to 0, the device does not
DDNS Unsigned periodically initiate DDNS update request.
update integer.
IntervalD However, it initiates a DDNS update request in
requests N/A either of the following situations:
ay Value range: 0
after DDNS
update is to 365 days. • When the primary IP address of the interface
enabled changes.
(Day) • When the link state of the interface changes
from down to up.
Interval for
sending
DDNS Unsigned
update integer.
IntervalH It must be configured together with the IntervalDay
requests N/A Value range: 0
our column and IntervalMinute column.
after DDNS to 23 hours.
update is
enabled
(Hour)
Interval for
sending Unsigned
DDNS integer.
update
IntervalM Value range: 0 It must be configured together with the IntervalDay
requests N/A
inute to 59 column and IntervalHour column.
after DDNS
minutes.
update is
enabled
(minute)
Username
to be
included in String, case
Usernam the URL sensitive.
N/A N/A
e address for Length: 1 to 32
DDNS characters.
update
requests
Password
to be
included in String, case
Passwor the URL sensitive.
N/A N/A
d address for Length: 1 to 32
DDNS characters.
update
requests
Transmissi
on method
for sending Enumeration:
DDNS
update • 0—Http-g
Method N/A et N/A
requests to
HTTP/HTT • 1—Http-p
PS-based ost.
DDNS
servers

3
 Column
Column Colum Data type and
descriptio Remarks
name n type restrictions
n
Associate a
specific String, case
SSLClie SSL client insensitive. The SSL client policy is effective only for
N/A
ntPolicy policy with Length: 1 to 31 HTTPS-based DDNS update requests.
a DDNS characters.
policy

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
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.

4
Column Column Column Data type and
Remarks
name description type restrictions
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 the username and password in the corresponding fields
password 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.
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.
Failed to apply the DDNS policy, please modify
Failed to apply the DDNS policy.
configuration under guidance.

1
Contents

DDR ··············································································································································································· 1
DDR/DiaGroupRule ·························································································································································· 1
XML structure ····························································································································································· 1
Table description ······················································································································································ 1
Columns ····································································································································································· 1
DDR/DiaBundle ································································································································································· 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/DiaBundle
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/DiaBundle ································································································································································· 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/DiaBundle
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/DiaGroupRule
Message Explanation
The configuration doesn't meet the requirements. The configuration parameter is incomplete.
Invalid Acl Name. Invalid Acl Name.

DDR/DDRAutodial
Message Explanation
Enable DDR first. This message means DDR not be configured.

DDR/DDRIdle
Message Explanation
Enable DDR first. This message means DDR not be configured.

DDR/IfDiaGroup
Message Explanation
Enable DDR first. This message means DDR not be configured.

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
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 ··········································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 7
Device/Transceivers ··················································································································· 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
Device/TransceiversChannels ···································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 16
Columns ·························································································································· 16
Device/TransceiversITUChannels································································································ 17
XML structure ··················································································································· 17
Table description ··············································································································· 17
Columns ·························································································································· 17
Device/CPUs ·························································································································· 18
XML structure ··················································································································· 18
Table description ··············································································································· 18
Columns ·························································································································· 19
Device/SummerTime ················································································································ 19
XML structure ··················································································································· 19
Table description ··············································································································· 20
Columns ·························································································································· 20
Device/Boards ························································································································· 22
XML structure ··················································································································· 22
Table description ··············································································································· 23
Columns ·························································································································· 23
Device/Blades ························································································································· 24
XML structure ··················································································································· 24
Table description ··············································································································· 24
Columns ·························································································································· 24
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
Columns ·························································································································· 28

i
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

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>
</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.

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>
<MfgName></MfgName>
<Model></Model>
<Alias></Alias>
<AssetID></AssetID>
<FRU></FRU>
<MfgDate></MfgDate>
<Uris></Uris>

3
 </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.
• 2-Unknown.
• 3-Frame.
• 4-Backplane.
• 5-Slot or subslot.
Class Entity type N/A N/A
• 6-Power supply.
• 7-Fan.
• 8-Sensor.
• 9-Module. It might
indicates a card, a
subcard, or, for example,
a flash memory.

4
 Column Column Column
Data type and restrictions Remarks
name description type
• 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.

Device/ExtPhysicalEntities
This table contains extended information about an entity.

XML structure
<Device>
<ExtPhysicalEntities>
<Entity>

5
 <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
Table type Multi-instance table
Row name Entity
Restrictions None

6
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 of the
Voltage N/A Unsigned integer.
entity (V)
Low-voltage
VoltageLowThreshold N/A Unsigned integer.
threshold (V)
High-voltage
VoltageHighThreshold N/A Unsigned integer.
threshold (V)

7
 Column Column
Column name Data type and restrictions
description type
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
Average Unsigned integer.
MemAvgUsage memory usage N/A
(%) Value range: 0 to 100

String.
MemType Memory type N/A
Length: 0 to 32 characters.

8
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>
<BiasLoWarn></BiasLoWarn>
<PwrOutHiAlarm></PwrOutHiAlarm>
<PwrOutLoAlarm></PwrOutLoAlarm>
<PwrOutHiWarn></PwrOutHiWarn>
<PwrOutLoWarn></PwrOutLoWarn>
<RcvPwrHiAlarm></RcvPwrHiAlarm>
<RcvPwrLoAlarm></RcvPwrLoAlarm>
<RcvPwrHiWarn></RcvPwrHiWarn>
<RcvPwrLoWarn></RcvPwrLoWarn>

9
 <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.

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)

10
 Column Column
Column name Data type and restrictions Remarks
description type
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)
Maximum
2147483647
transmitted
means the device
MaxTxPower optical power N/A Integer.
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)

11
 Column Column
Column name Data type and restrictions Remarks
description type
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
alarm
VccLoAlarm N/A Integer. N/A
threshold
(hundreds of
microvolts)
Transceiver
VCC high
warning
VccHiWarn N/A Integer. N/A
threshold
(hundreds of
microvolts)
Transceiver
VccLoWarn VCC low N/A Integer. N/A
warning

12
 Column Column
Column name Data type and restrictions Remarks
description type
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)
Transceiver
transmit
power low
PwrOutLoWarn warning N/A Integer. N/A
thresholdt
(tenths of
microwatts)
Transceiver
receive power
high alarm
RcvPwrHiAlarm N/A Integer. N/A
threshold
(tenths of
microwatts)

13
 Column Column
Column name Data type and restrictions Remarks
description type
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)
8: pcsReceiveLocalFault(7)
9: phyXSReceiveLocalFault(8)
Bitmask 10: laserBiasCurrentFault(9)
indicating 11: laserTemperatureFault(10)
TransceiverErrors N/A N/A
transceiver
errors 12: laserOutputPowerFault(11)
13: txFault(12)
14:
pmapmdTransmitterLocalFault
(13)
15: pcsTransmitLocalFault(14)
16:
phyXSTransmitLocalFault(15)
17: rxLossOfSignal(16)
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 N/A N/A
number of the Length: 0 to 255 characters.

14
 Column Column
Column name Data type and restrictions Remarks
description type
interface
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)

Device/TransceiversChannels
This table provides statistics for transceiver modules with multiple channels.

XML structure
<Device>
<TransceiversChannels>
<Interface>
<IfIndex></IfIndex>
<ChannelIndex></ChannelIndex>

15
 <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.
Current
transmitted 2147483647
ChannelCurT optical power of means the device
N/A Integer.
XPower the channel doesn't support this
(hundredths of feature.
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
ChannelTem Temperature of support current
N/A Integer. temperature. For
perature the channel (°C)
relevant
information, see

16
 Column Column Column
Data type and restrictions Remarks
name description type
the XSD document
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
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
IfIndex Interface Index Unsigned integer. N/A

17
 Column Column
Column name Data type and restrictions Remarks
description type
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>

Table description
Item Description
Feature name Device
Table name CPUs
Table type Multi-instance table
Row name CPU
Restrictions Available only for logical CPUs

18
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>
<EndMinute></EndMinute>
<EndSecond></EndSecond>
</DateBased>
<WeekBased>
<BeginMonth></BeginMonth>
<BeginWeek></BeginWeek>
<BeginWeekDay></BeginWeekDay>
<BeginHour></BeginHour>
<BeginMinute></BeginMinute>
<BeginSecond></BeginSecond>
<EndMonth></EndMonth>
<EndWeek></EndWeek>

19
 <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 Members include:
• BeginMonth
• BeginDay
• BeginHour
Daylight saving • BeginMinute
time Data
configuration Structure • BeginSecond N/A
based on date. • 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.

20
Column Column Column
Data type and restrictions Remarks
name description type
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 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
Begin day of • 1-Monday
N/A N/A
week. • 2-Tuesday
• 3-Wednesday
• 4-Thursday

21
 Column Column Column
Data type and restrictions Remarks
name description type
• 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.

Device/Boards
This table contains board information.

XML structure
<Device>
<Boards>
<Board>
<DeviceNode>
<Chassis></Chassis>
<Slot></Slot>

22
 <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.
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:
Role of the • 1-Unknown Role is Unknown when status
N/A
device node. • 2-ActiveMPU is Absent or Fault.
• 3-StandbyMPU

23
 Column Column Column
Data type and restrictions Remarks
name description type
• 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
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

24
 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.
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
Table type Multi-instance table
Row name PEX
Restrictions N/A

25
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
N/A Short
erature Temperature(℃)
LowerLimit Lower Limit
N/A Short
Temperature(℃)
WarningLimit Warnning Limit
N/A Short
Temperature(℃)
AlarmLimit Alarm Limit
N/A Short
Temperature(℃)
ShutdownLim Shutdown Limit
N/A Short
it Temperature(℃)

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>
<StableStatus>
<Chassis></Chassis>
<Slot></Slot>

33
 <CPU></CPU>
<Role></Role>
<Status></Status>
</StableStatus>
</BoardStableStatus>
</Device>

Table description
Item Description
Feature name Device
Table name BoardStableStatus
Table type Multi-instance table
Row name StableStatus
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
Contents
Device ···························································································1
Device/summer time ····················································································································· 1
Device/ failovergroup ···················································································································· 1
Device/ transceiver ······················································································································· 2

i
Device
Device/summer time
Message Explanation
When modify the time protocol by netconf, check the parameters
Unsupported parameter. are not supported.
When modify the time protocol by netconf, check the parameters
Incomplete parameter. are incomplete.
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.
Please choose either datebased or weekbased to When setting summer time, date and week can only choose one,
configure the summertime. if both of them are not 0 , this prompt will be printed.
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.
Setting summer time with begin time and end time, if check out
Invalid date. that the begin time or the end time are not allowed, this prompt will
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.

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.
Invalid failovergroup ID or Name. When the name and ID is invalid, this prompt will be printed.

1
Device/ transceiver
When failed to set ITU channel num to the driver, the reason is the
The transceiver is absent.
transceiver is absent.
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.
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.
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.

2
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>
</Temperature>

5
 </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">
<Temperature>

6
 <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(℃)

Warnning Limit
WarnningLimitTemperature Short
Temperature(℃)

7
 Column name Column description Data type and restrictions
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">
<eventTime>2016-07-21T09:10:51</eventTime>

8
 <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
the address pool
Sublist The details of the sublist refer to address-pool table.

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
<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>
</v:address-pool>

5
 </v:address-pools>
</config>
</edit-config>
</rpc>

<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
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 ······································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6
DHCP/DHCPConfig ···················································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8
DHCP/DHCPIfMode ················································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 10
Columns ·························································································································· 11
DHCP/DHCPRelaySrvIPv4Address ····························································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 12
Columns ·························································································································· 12
DHCP/DHCPServerPoolOption ··································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 13
Columns ·························································································································· 13
DHCP/DHCPRelaySourceAddress ······························································································ 14
XML structure ··················································································································· 14
Table description ··············································································································· 14
Columns ·························································································································· 15
DHCP/DHCPRelayInfoEnable ···································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 15
Columns ·························································································································· 16
DHCP/DHCPServerForbiddenIp·································································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 17
Columns ·························································································································· 17
DHCP/DHCPRelayDiscReqFromTnlEnable ··················································································· 17
XML structure ··················································································································· 18
Table description ··············································································································· 18
Columns ·························································································································· 18
DHCP/DHCPRelayMacFowardEnable ·························································································· 19
XML structure ··················································································································· 19
Table description ··············································································································· 19
Columns ·························································································································· 19

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>
</IpPool>
</DHCPServerIpPool>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerIpPool

Table type Multi-instance table

Row name IpPool

Restrictions None

1
 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
can not be set.

String, case insensitive. Required when create a

DHCP address
PoolName N/A Length: 1 to 63 new row, can not be
pool name
characters. 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
the subnet. The
Start IP address of
addresses out of the
IP address range
String, dotted decimal address range cannot
StartIpv4Address in a DHCP N/A
notation. be assigned.
address pool for
It must be configured
dynamic allocation
together with the
EndIpv4Address
column.

End IP address of String, dotted decimal It must be configured

EndIpv4Address N/A
IP address range notation. together with the

2
 Column Column Data type and
Column name Remarks
description type restrictions
in a DHCP 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. 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

DNS server String, case insensitive.
DNSIpv4Address N/A space-separated list of
addresses Length: 1 to 127
up to eight addresses.

3
 Column Column Data type and
Column name Remarks
description type restrictions
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
broadcasts the
Enumeration: destination name to get
• 1—b-node. the mapping from a
NetBIOS node
NetbiosType N/A • 2—p-node. server.
type
• 3—m-node. m-node: Specifies the

• 4—h-node. 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.

WINS server String, case insensitive. You can specify a

NbnsIpv4Address N/A
addresses Length: 1 to 127 space-separated list of

4
 Column Column Data type and
Column name Remarks
description type restrictions
characters. up to eight addresses.

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 id dynamic.

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>
</IpPoolStatic>
</DHCPServerPoolStatic>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerPoolStatic

Table type Multi-instance table

5
 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.

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.
String, case insensitive. For example,
Client ID of the
CID N/A aabb-cccc-dd is correct,
Length: 4 to 254
static binding
and aabb-c-dddd and
characters.
aabb-cc-dddd are not
correct.

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

6
 Column Column Data type and
Column name Remarks
description type restrictions
client, you must delete
the existing binding first
and create a new
binding.

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.

Enumeration:
It must be configured
Client hardware • 1—Ethernet
HType N/A together with the
address type (default).
HAddress column.
• 2—TokenRing.

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>

7
 </ServerConfig>
<RelayConfig>
<UserInfoRecord></UserInfoRecord>
<UserInfoRefresh></UserInfoRefresh>
<UserInfoFlushTime></UserInfoFlushTime>
</RelayConfig>
</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:

AlwaysBroadcast N/A N/A
the DHCP server • true

8
 Column Column Data type and
Column name Remarks
description type restrictions
to broadcast all • false(default)
responses or not.

Whether ignore Boolean:

IgnoreBOOTP BOOTP requests N/A • true N/A
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
The configuration Data
RelayConfig • UserInfoRefresh N/A
of DHCP relay structure
• UserInfoFlushTim
e

Whether the Boolean:

UserInfoRecord function of N/A • true N/A
recording client • false(default)

9
 Column Column Data type and
Column name Remarks
description type restrictions
information in
relay entries is
enabled.

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

DHCP/DHCPIfMode
This table contains DHCP interface mode information.

XML structure
<DHCP>
<DHCPIfMode>
<IfMode>
<IfIndex></IfIndex>
<Mode></Mode>
</IfMode>
</DHCPIfMode>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPIfMode

Table type Multi-instance table

Row name IfMode

10
 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.

Enumeration:

• 0—None.
Mode DHCP mode N/A • 1—Server N/A
(default).
• 2—Relay.

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>

11
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.

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>

12
 <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

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.

OptionValueAscii ASCII string as N/A String, case sensitive. N/A

13
 Column Column Data type and
Column name Remarks
description type restrictions
the option content Length: 1 to 255
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.

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>
</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

14
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
addresses of the
String, dotted decimal
Ipv4Address packets sent by N/A N/A
notation.
the DHCP relay
agent

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

15
 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>
<ForbiddenIp>
<VRF></VRF>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
</ForbiddenIp>
</DHCPServerForbiddenIp>
</DHCP>

16
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

DHCP/DHCPRelayDiscReqFromTnlEnable
This table contains information about whether the DHCP relay discard request from tunnel.

17
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
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 (default)

18
 Column Column Data type and
Column name Remarks
description type restrictions
request packet
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
If mac forward is enable,
Whether enable Boolean:
MacEnable N/A DHCP server OFFER or
mac forward • true
ACK packet will forward

19
 Column Column Data type and
Column name Remarks
description type restrictions
• false (default) via unicast.

Boolean: It must configured with

Whether enable
MacBroadCast • true MacEnable and Mac
mac broadcast
• false (default) Enable must be true.

20
Contents
DHCP ····························································································1
DHCP/DHCPServerIpPool ··········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 2
DHCP/DHCPServerPoolStatic ······································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5
DHCP/DHCPServerIpInUse ········································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 7
Columns ···························································································································· 7
DHCP/DHCPConfig ···················································································································· 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
DHCP/DHCPIfMode ················································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 13
DHCP/DHCPRelaySrvIPv4Address ····························································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 13
Columns ·························································································································· 14
DHCP/DHCPRelayUserInfo ······································································································· 14
XML structure ··················································································································· 14
Table description ··············································································································· 14
Columns ·························································································································· 15
DHCP/DHCPServerPoolOption ··································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 15
Columns ·························································································································· 16
DHCP/ DHCPServerPoolStatistics ······························································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 17
Columns ·························································································································· 17
DHCP/DHCPRelaySourceAddress ······························································································ 17
XML structure ··················································································································· 18
Table description ··············································································································· 18
Columns ·························································································································· 18
DHCP/DHCPRelayInfoEnable ···································································································· 19
XML structure ··················································································································· 19
Table description ··············································································································· 19
Columns ·························································································································· 19
DHCP/DHCPServerLeaseInfo ···································································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 21
DHCP/DHCPServerForbiddenIp·································································································· 21
XML structure ··················································································································· 21
Table description ··············································································································· 22
Columns ·························································································································· 22
DHCP/ DHCPServerSubnetInUse ······························································································· 22
XML structure ··················································································································· 23
Table description ··············································································································· 23
Columns ·························································································································· 23

i
DHCP/DHCPRelayDiscReqFromTnlEnable ··················································································· 24
XML structure ··················································································································· 24
Table description ··············································································································· 25
Columns ·························································································································· 25
DHCP/DHCPRelayMacFowardEnable ·························································································· 26
XML structure ··················································································································· 26
Table description ··············································································································· 26
Columns ·························································································································· 26

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>
</IpPool>
</DHCPServerIpPool>
</DHCP>

Table description

Item Description
Feature name DHCP

Table name DHCPServerIpPool

Table type Multi-instance table

Row name IpPool

Restrictions None

1
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.

Whether the
Boolean:
function of
LeaseUnlimit N/A • true N/A
unlimited lease
• false
duration is

2
 Column Column Data type and
Column name Remarks
description type restrictions
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.

h-node: Specifies the

hybrid node. An h-node
Enumeration:
client unicasts the
• 1—b-node. destination name to a
NetBIOS node
NetbiosType N/A • 2—p-node. WINS server. If it does
type
• 3—m-node. not receive a response,

• 4—h-node. the h-node client

broadcasts the
destination name to get
the mapping from a
server.

m-node: Specifies the

mixed node. An m-node
client broadcasts the
destination name. If it
does not receive a

3
 Column Column Data type and
Column name Remarks
description type restrictions
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.

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>
</IpPoolStatic>
</DHCPServerPoolStatic>
</DHCP>

4
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

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.

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.

HAddress Client hardware N/A String, case insensitive. The string can contain

5
 Column Column Data type and
Column name Remarks
description type restrictions
address of the Length: 4 to 79 only hexadecimal
static binding characters. 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,
and aabb-c-dddd and
aabb-cc-dddd are not
correct.

Enumeration:
Client hardware
HType N/A • 1—Ethernet. N/A
address type
• 2—TokenRing.

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>

6
Table description

Item Description
Feature name DHCP

Table name DHCPServerIpInUse

Table type Multi-instance table

Row name IpInUse

Restrictions None

Columns

Column Column
Column name Data type and restrictions Remarks
description type

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.

Client hardware String, case-insensitive. The string can contain

HAddress N/A
address of the Length: 4 to 79 characters. only hexadecimal

7
 Column Column
Column name Data type and restrictions Remarks
description type
static binding 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, and
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
Enumeration:
whose IP address has
1—staticUnallocated.
not been assigned.
2—staticOffered.
staticOffered: An
Type N/A
3—staticCommitted. offered static binding

4—autoOffered. whose IP address has

been selected and
5—autoCommitted.
sent by the DHCP
server in a

8
 Column Column
Column name Data type and restrictions Remarks
description type
DHCP-OFFER packet
to the client.

staticCommitted: A
committed static
binding whose IP
address has been
assigned to the DHCP
client.

autoOffered: An
offered temporary
dynamic binding
whose IP address has
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>

9
 <PingTimeout></PingTimeout>
</ServerConfig>
<RelayConfig>
<UserInfoRecord></UserInfoRecord>
<UserInfoRefresh></UserInfoRefresh>
<UserInfoFlushTime></UserInfoFlushTime>
</RelayConfig>
</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:

DHCPEnable function of DHCP N/A • true N/A
is enabled. • false

Members include:

• AlwaysBroadcast
Alert
• IgnoreBOOTP
The configuration Data
ServerConfig • BOOTPReplyRFC N/A
of DHCP server structure
1048

• Opt82Enabled
• PingNumber

PingTimeout

Whether Enable
Boolean:
AlwaysBroadcast the DHCP server N/A N/A
• true
to broadcast all

10
 Column Column Data type and
Column name Remarks
description type restrictions
responses or not. • false

Whether Ignore Boolean:

IgnoreBOOTP BOOTP requests N/A • true N/A
or not. • false

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
BOOTP requests
for statically
bound addresses
or not.

Whether enable
Boolean:
the DHCP server
Opt82Enabled N/A • true N/A
to handle Option
• false
82 or not.

To disable the address

Maximum number Unsigned integer.
PingNumber N/A conflict detection, set
of ping packets Value range: 0 to 10.
the value to 0.

To disable the ping

Ping response Unsigned integer. operation for address
PingTimeout timeout time on N/A Value range: 0 to 10000 conflict detection, set
the DHCP server milliseconds. the value to 0
milliseconds.

Members include:

The configuration Data • UserInfoRecord

RelayConfig N/A
of DHCP relay structure • UserInfoRefresh

UserInfoFlushTime

Whether the
function of
Boolean:
recording client
UserInfoRecord N/A • true N/A
information in
• false
relay entries is
enabled.

11
 Column Column Data type and
Column name Remarks
description type restrictions
Whether enable
the relay agent to
Boolean:
periodically
UserInfoRefresh N/A • true N/A
refresh dynamic
• false
relay entries or
not.

Interval at which
To automatically
the DHCP relay Unsigned integer.
UserInfoFlushTim calculate the refresh
agent periodically N/A Value range: 0 to 120
e interval, set the value to
refreshes relay seconds.
0 seconds.
entries

DHCP/DHCPIfMode
This table contains DHCP interface mode information.

XML structure
<DHCP>
<DHCPIfMode>
<IfMode>
<IfIndex></IfIndex>
<Mode></Mode>
</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.

12
Columns

Column Column Data type and

Column name Remarks
description type restrictions
IfIndex Interface index. Index Unsigned integer. N/A

Enumeration:

• 0—None.
Mode DHCP mode N/A N/A
• 1—Server.
• 2—Relay.

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
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

14
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

15
 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>

16
 </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.

17
XML structure
<DHCP>
<DHCPRelaySourceAddress>
<RelaySrcAddr>
<IfIndex></IfIndex>
<Ipv4Address></Ipv4Address>
</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
addresses of the String, dotted decimal
Ipv4Address N/A N/A
packets sent by notation.
the DHCP relay

18
 Column Column Data type and
Column name Remarks
description type restrictions
agent

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

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
IfIndex Interface index. Index Unsigned integer.
the XSD document of
your product. For
information about

19
 Column Column Data type and
Column name Remarks
description type restrictions
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>

Table description

Item Description
Feature name DHCP

Table name DHCPServerLeaseInfo

Table type Multi-instance table

Row name LeaseInfo

Restrictions None

20
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>
<DHCPServerForbiddenIp>
<ForbiddenIp>
<VRF></VRF>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
</ForbiddenIp>
</DHCPServerForbiddenIp>
</DHCP>

21
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

DHCP/ DHCPServerSubnetInUse
This table contains information about subnet allocation IP addresses.

22
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
Column name Data type and restrictions Remarks
description type
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.

String, dotted decimal

Network Address Subnet Address Index N/A
notation.

NetworkMask Subnet Mask Index Unsigned integer. N/A

23
 Column Column
Column name Data type and restrictions Remarks
description type
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.

XML structure
<DHCP>
<DHCPRelayDiscReqFromTnlEnable>
<RelayDiscardReqFromTnlEnable>

24
 <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
DHCP relay agent Boolean:
DiscardReqFrom
support discard N/A • true N/A
TnlEnable
request packet • false
from tunnel .

25
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
If mac forward is enable,
Boolean:
Whether enable DHCP server OFFER or
MacEnable N/A • true
mac forward ACK packet will forward
• false
via unicast.

Boolean: It must configured with

Whether enable
MacBroadCast • true MacEnable and Mac
mac broadcast
• false Enable must be true.

26
27
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 check 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.

The configure the Option 82 is failed.
配置Option82功能失败。

2
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 ················································································································· 13
Columns ···························································································································· 14
DHCP6/DHCP6ServerPoolStaticAddress ······················································································· 14
XML structure ····················································································································· 14
Table description ················································································································· 14
Columns ···························································································································· 15
DHCP6/DHCP6ServerPoolStaticPrefix ··························································································· 16
XML structure ····················································································································· 16
Table description ················································································································· 16
Columns ···························································································································· 16
DHCP6/DHCP6RelaySrvAddress ·································································································· 17
XML structure ····················································································································· 17
Table description ················································································································· 18
Columns ···························································································································· 18
DHCP6/ DHCP6PrefixPool ·········································································································· 19
XML structure ····················································································································· 19
Table description ················································································································· 19
Columns ···························································································································· 20
DHCP6/DHCP6If ······················································································································· 20
XML structure ····················································································································· 20
Table description ················································································································· 21
Columns ···························································································································· 21
DHCP6/ DHCP6ServerPoolOption ································································································ 23
XML structure ····················································································································· 23
Table description ················································································································· 23
Columns ···························································································································· 24

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 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.

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>
</DHCP6Config>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6Config

13
 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
Unsigned integer.
The DSCP value for IPv6
DSCP N/A Value range: 0 to 63.
DHCP packets
Default: 56.

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>
</PoolStaticAddress>
</DHCP6ServerPoolStaticAddress>
</DHCP6>

Table description

Item Description
Feature name DHCP6

Table name DHCP6ServerPoolStaticAddress

14
 Table type Multi-instance table

Row name PoolStaticAddress

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

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.

15
DHCP6/DHCP6ServerPoolStaticPrefix
This table contains IPv6 DHCP server pool static prefix information.

XML structure
<DHCP6>
<DHCP6ServerPoolStaticPrefix>
<PoolStaticPrefix>
<PoolIndex></PoolIndex>
<Ipv6Prefix>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
</Ipv6Prefix>
<DUID></DUID>
<IAID></IAID>
<PreferLifetime></PreferLifetime>
<ValidLifetime></ValidLifetime>
</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

16
 Column Column Data type and
Column name Remarks
description type restrictions
Members include:
Data
Ipv6Prefix Ipv6Prefix • Ipv6Address N/A
structure
• 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.

DHCP6/DHCP6RelaySrvAddress
This table contains IPv6 DHCP relay server configuration information.

XML structure
<DHCP6>
<DHCP6RelaySrvAddress>
<RelaySrvIPv6>
<IfIndex></IfIndex>

17
 <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 interface for the Index Unsigned integer. address is a link-local
IPv6 DHCP relay address, you must

18
 Column Column Data type and
Column name Remarks
description type restrictions
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

19
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>

20
 <IfIndex></IfIndex>
<Mode></Mode>
<ServerAllowHint></ServerAllowHint>
<ServerRapidCommit></ServerRapidCommit>
<ServerPreference></ServerPreference>
<ApplyPoolName></ApplyPoolName>
<ApplyPoolAllowHint></ApplyPoolAllowHint>
<ApplyPoolRapidCommit></ApplyPoolRapidCommit>
<ApplyPoolPreference></ApplyPoolPreference>
<RelayInterfaceIDMode></RelayInterfaceIDMode>
<RelayGatewayAddress></RelayGatewayAddress>
</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
document of your
IfIndex Interface index. Index Unsigned integer. product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF
XML API
Configuration

21
 Column Column Data type and
Column name Remarks
description type restrictions
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

together with
ApplyPoolPrefere Specify the server Value range: 0 to 255,
N/A ApplyPoolName when
nce preference. 4294967295.
apply a IPv6 DHCP
Default: 4294967295
address pool to an

22
 Column Column Data type and
Column name Remarks
description type restrictions
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.

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>

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

23
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.

24
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 ·········································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 6
Columns ······························································································································ 6
DHCP6/DHCP6OptionGroupOption ································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 7
DHCP6/DHCP6RelayPoolRemoteServer ·························································································· 8
XML structure ······················································································································· 8
Table description ··················································································································· 8
Columns ······························································································································ 8
DHCP6/DHCP6Config ·················································································································· 9
XML structure ······················································································································· 9
Table description ··················································································································· 9
Columns ······························································································································ 9
DHCP6/DHCP6ServerPoolStaticAddress ························································································· 9
XML structure ······················································································································· 9
Table description ················································································································· 10
Columns ···························································································································· 10
DHCP6/DHCP6ServerPoolStaticPrefix ··························································································· 10
XML structure ····················································································································· 10
Table description ················································································································· 11
Columns ···························································································································· 11
DHCP6/DHCP6RelaySrvAddress ·································································································· 12
XML structure ····················································································································· 12
Table description ················································································································· 12
Columns ···························································································································· 12
DHCP6/ DHCP6PrefixPool ·········································································································· 12
XML structure ····················································································································· 12
Table description ················································································································· 13
Columns ···························································································································· 13
DHCP6/DHCP6If ······················································································································· 13
XML structure ····················································································································· 13
Table description ················································································································· 14
Columns ···························································································································· 14
DHCP6/DHCP6ServerIpInUse ······································································································ 15
XML structure ····················································································································· 15
Table description ················································································································· 16
Columns ···························································································································· 16
DHCP6/DHCP6ServerPDInUse ···································································································· 16
XML structure ····················································································································· 17
Table description ················································································································· 17
Columns ···························································································································· 17
DHCP6/ DHCP6ServerPoolOption ································································································ 18
XML structure ····················································································································· 18
Table description ················································································································· 18
Columns ···························································································································· 19

i
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.
String. case-sensitive.
Username FTP username N/A
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.

1
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>
<DomainName></DomainName>
<GatewayIpv6Address></GatewayIpv6Address>
<DNSIpv6Address></DNSIpv6Address>
<SIPIpv6Address></SIPIpv6Address>
<SIPDomainName></SIPDomainName>
</Pool>
</DHCP6ServerIpPool>
</DHCP6>

2
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
index Value range: 1 to 1024.

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
ss
The configuration Data • NetworkIpv6Prefix
Network Length N/A
of the IPv6 subnet structure
• NetworkPreferLifet
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
ute
assigned to N/A • true N/A
DHCPv6 clients or • false
not.

3
 Column Column Data type and
Column name Remarks
description type restrictions
Members include:
The configuration • StartIpv6Address
of the
Data • EndIpv6Address
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
The valid lifetime
of the Unsigned integer.
RangeValidLifeti
non-temporary N/A Value range: 60 to N/A
me
IPv6 address 4294967295.
range

Members include:
• TempStartIpv6Add
ress
The configuration
of the temporary Data • TempEndIpv6Addr
TempRange ess N/A
IPv6 address structure
range • TempRangePrefer
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
address range 4294967295.

The valid lifetime Unsigned integer.

TempRangeValid of the temporary
N/A Value range: 60 to N/A
Lifetime IPv6 address
range 4294967295.

The configuration Members include:

of the prefix pool • PrefixPoolNumber
Data
PrefixPool applied in the IPv6 • PrefixPoolPreferLif N/A
structure
DHCP address etime
pool
• PrefixPoolValidLife
time

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

PrefixPoolNumbe Prefix pool Unsigned integer.

N/A N/A
r number
Value range: 1 to 128

The preferred Unsigned integer.

PrefixPoolPreferL
lifetime of the N/A Value range: 60 to N/A
ifetime
prefix pool 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 The max length of a SIP
SIPDomainName N/A Length: 1 to 407
domain name domain name is 50.
characters.
Example:
aa.com bb.com.

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>

5
 <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, addresses.
DNS server case-insensitive. Specifies a
DNSIpv6Address N/A space-separated list of
addresses Length: 1 to 367
characters. 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
String, addresses.
SIP server case-insensitive. Specifies a
SIPIpv6Address N/A space-separated list of
addresses Length: 1 to 367
characters. up to eight addresses
Example:
1::1 2::2.

6
 Column Column Data type and
Column name Remarks
description type restrictions
Separated by space if
there are multiple SIP
domain name.
The max length of a SIP
String, domain name is 50.
DNS server case-insensitive.
SIPDomainName N/A Specifies a
domain name Length: 1 to 407 space-separated list of
characters. 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>
<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

7
 Column
Column name Column type Data type and restrictions
description
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>
<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
index Value range: 1 to 1024.

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

8
DHCP6/DHCP6Config
This table contains IPv6 DHCP DSCP configuration information.

XML structure
<DHCP6>
<DHCP6Config>
<DSCP></DSCP>
</DHCP6Config>
</DHCP6>

Table description
Item Description
Feature name DHCP6
Table name DHCP6Config
Table type Single-instance table
Row name None
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
The DSCP value for IPv6 Unsigned integer.
DSCP N/A
DHCP packets Value range: 0 to 63.

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>
</PoolStaticAddress>
</DHCP6ServerPoolStaticAddress>

9
 </DHCP6>

Table description
Item Description
Feature name DHCP6
Table name DHCP6ServerPoolStaticAddress
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
the range of 2 to 256. Length: 2 to 256 characters.

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.

DHCP6/DHCP6ServerPoolStaticPrefix
This table contains IPv6 DHCP server pool static prefix information.

XML structure
<DHCP6>
<DHCP6ServerPoolStaticPrefix>
<PoolStaticPrefix>
<PoolIndex></PoolIndex>
<Ipv6Prefix>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>

10
 </Ipv6Prefix>
<DUID></DUID>
<IAID></IAID>
<PreferLifetime></PreferLifetime>
<ValidLifetime></ValidLifetime>
</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
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.
The value is an even String, case-insensitive.
DUID hexadecimal number in N/A
the range of 2 to 256. Length: 2 to 256 characters.

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.

11
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
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>

12
 <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

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
name
characters. length of characters is 0.

PrefixPoolNumbe Prefix pool Unsigned integer.

Index N/A
r number Value range: 1 to 128.
Members include:
Data
Ipv6Prefix Ipv6Prefix
structure • Ipv6Address N/A
• 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 Unsigned integer.
AssignIpv6Prefix
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>

13
 <Mode></Mode>
<ServerAllowHint></ServerAllowHint>
<ServerRapidCommit></ServerRapidCommit>
<ServerPreference></ServerPreference>
<ApplyPoolName></ApplyPoolName>
<ApplyPoolAllowHint></ApplyPoolAllowHint>
<ApplyPoolRapidCommit></ApplyPoolRapidCommit>
<ApplyPoolPreference></ApplyPoolPreference>
<RelayInterfaceIDMode></RelayInterfaceIDMode>
<RelayGatewayAddress></RelayGatewayAddress>
</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
IPv6 DHCP clients.
• 2—Relay.
Allow client Boolean:
suggested IPv6
ServerAllowHint N/A • true N/A
addresses and
prefixes. • false

Boolean:
ServerRapidCom Enable the rapid
mit commit function.
N/A • true N/A
• 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.

14
 Column Column Data type and
Column name Remarks
description type restrictions
It must be configured
Allow client Boolean: together with
ApplyPoolAllowHi suggested IPv6 ApplyPoolName when
nt addresses and
N/A • true apply a IPv6 DHCP
prefixes. • false address pool to an
interface.
It must be configured
Boolean: together with
ApplyPoolRapidC Enable the rapid ApplyPoolName when
ommit commit function.
N/A • true apply a IPv6 DHCP
• false address pool to an
interface.
It must be configured
Unsigned integer. together with
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.

Enumeration: None means the IPv6

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.

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>

15
Table description
Item Description
Feature name DHCP6
Table name DHCP6ServerIpInUse
Table type Multi-instance table
Row name IpInUse
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
types
N/A • 2—Static(C)..
• 3—Auto(E)
• 4—Auto(O)
• 5—Auto(C)
Time when the lease of String, case-sensitive.
EndLease the IPv6 address will N/A
expire. Length: 1 to 19 characters.

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
the range of 2 to 256. Length: 2 to 256 characters.

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

DHCP6/DHCP6ServerPDInUse
This table contains prefix binding information about assigned IPv6 addresses.

16
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.
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.

17
 Column name Column description Column type Data type and restrictions
Enumeration:
• 0—Static(F).
• 1—Static(O).
IPv6 address binding
Type
types
N/A • 2—Static(C)..
• 3—Auto(E)
• 4—Auto(O)
• 5—Auto(C)
Time when the lease of String, case-sensitive.
EndLease the IPv6 address will N/A
expire. Length: 1 to 19 characters.

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
the range of 2 to 256. Length: 2 to 256 characters.

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.

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

18
 Item Description
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.

19
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.
未使用。

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 ······························································································································ 5
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

4
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 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 ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 5
DHCPC/DHCPCIfConfig················································································································ 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 7

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.

2
 Column Column Data type and
Column name Remarks
description type restrictions
Whether the
function of the
interface to use Boolean:
AllocEnable DHCP for IP N/A • true N/A
address • false
acquisition is
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>

3
 <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.

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.

4
XML structure
<DHCPC>
<BootpAlloc>
<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

5
 Column Column Data type and
Column name Remarks
description type restrictions
IPv4 address
AllocatedIpv4Mas String, dotted decimal
mask allocated by N/A N/A
k notation.
the BOOTP server
Six groups of two
MacAddress MAC address of N/A hexadecimal digits, N/A
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

6
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.
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 ······························································································································ 4
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

3
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.
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

4
 Item Description
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
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 N/A • true when the PrefixNumber
assignment is
• 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

5
 Item Description
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
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.

6
 Column Column Data type and
Column name Remarks
description type restrictions
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.

Seperated by space if
there are multiple
IPv6 address of addresses.
DNSServer N/A String, case insensitive.
the DNS server
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 ······················································································································· 2
Table description ··················································································································· 3
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 ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 8
DHCPSP/DHCPSPConfig············································································································ 10
XML structure ····················································································································· 10
Table description ················································································································· 10
Columns ···························································································································· 11

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 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
String. case sensitive. and replace operations,
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.

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>

2
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
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
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
s
check MAC N/A • true N/A
address in DHCP • false(default)
packets or not.
Whether enable
the interface to Boolean: Applicable to only Layer
CheckRequestMe
ssage
check request N/A • true 2 interfaces of the
message in DHCP • false(default) Restrictions.
packets or not.
Whether Boolean:
configurate an
Trust
interface to be
N/A • true N/A
trusted or not. • false(default)

3
 Column Column Data type and
Column name Remarks
description type restrictions
The maximum
number of DHCP Unsigned integer.
No limit as default.
LearnMaxNum snooping entries N/A Value range: 0 to
for an interface to 0 means No limit.
4294967295.
learn

Values of
RateLimitMinNum and
RateLimitMaxNum
The maximum Unsigned integer. depend on the device
rate for an model.
RateLimitNum interface to N/A Value range: 0,
RateLimitMinNum to Applicable to only Layer
receive DHCP 2 interfaces of the
packets, in Kbps RateLimitMaxNum.
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

4
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,
IfIndex Interface index. Index Unsigned integer. 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 can not 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>

Table description
Item Description
Feature name DHCPSP
Table name DHCPSPOpt82RemoteIDVLAN

5
 Item Description
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,
IfIndex Interface index. Index Unsigned integer. 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 RemoteID and
String, case-insensitive. Sysname can not be
Length: 1 to 63 configured
Option82 remote simultaneously and
RemoteID N/A characters.
ID string RemoteID or Sysname
The string must be must be configured.
ASCII string.
Can not be configured
for the delete and
remove operations.
For the merge, create
and replace operations,
the RemoteID and
Whether the Sysname can not 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.
Can not be configured
for the delete and
remove operations.

DHCPSP/DHCPSPOpt82
This table contains DHCP snooping option 82 configuration information.

6
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>
</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

7
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
type
N/A • 1—Keep. N/A
• 2—Replace
(default).
Members include:
• CircuitID
The configuration • CircuitIDMode
Data
Circuit of Circuit ID
structure • CircuitIDNodeIDTy N/A
sub-option 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.

8
 Column Column Data type and
Column name Remarks
description type restrictions
If CircuitIDNodeIDType
is configured for the
remove and delete
operations,
Enumeration: CircuitIDNodeID will be
Circuit IP removed automatically.
CircuitIDNodeIDT • 0—Mac (default).
node-identifier N/A For the merge, create
ype
type • 1—Sysname.
and replace operations,
• 2—User-defined. the
CircuitIDNodeIDType
can be configured only
when CircuitIDMode is
1.
For the merge, create
and replace operations,
the CircuitIDNodeID
Circuit ID String. case insensitive. must be configured if
CircuitIDNodeID node-identifier N/A Length: 1 to 50 CircuitIDNodeIDType is
user defined string characters. 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
sub-option
structure • RemoteID
• RemoteIDFormat
It must be configured
together with the
Enumeration: RemoteIDFormat.
• 0—Normal If RemoteIDMode is
RemoteIDMode Remote ID mode N/A (default). configured for the
• 1—Sysname. remove and delete
• 2—User-defined. operations, RemoteID
will be removed
automatically.

9
 Column Column Data type and
Column name Remarks
description type restrictions
For the merge, create
and replace operations,
String. case insensitive. the RemoteID must be
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
type
N/A • 0—Hex.
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>

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

10
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Whether the Boolean:
function of DHCP
DHCPSPEnable
snooping is
N/A • true. N/A
enabled. • false(default)

11
Contents
DHCPSP ························································································1
DHCPSP/DHCPSPBindingDatabase ······························································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
DHCPSP/DHCPSPInterface··········································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 2
DHCPSP/DHCPSPOpt82CircuitIDVLAN ·························································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4
DHCPSP/DHCPSPOpt82RemoteIDVLAN ························································································ 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 5
DHCPSP/DHCPSPOpt82 ·············································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 6
Columns ······························································································································ 6
DHCPSP/DHCPSPBinding ············································································································ 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 8
DHCPSP/DHCPSPConfig·············································································································· 8
XML structure ······················································································································· 8
Table description ··················································································································· 8
Columns ······························································································································ 9
DHCPSP/DHCPSPSpecification ····································································································· 9
XML structure ······················································································································· 9
Table description ··················································································································· 9
Columns ······························································································································ 9

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 sensitive.
URL Object URL string N/A
Length: 1 to 255 characters.
String. case sensitive.
Username FTP username N/A
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.

1
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:
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

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
ord
record N/A • true interfaces of the
DHCP • false Restrictions.
snooping
entry or not.

2
 Column Column Colum
Data type and restrictions Remarks
name description n type
Whether
enable the
interface to Boolean:
CheckMac check MAC
Address address in
N/A • true N/A
DHCP • false
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
configurate Boolean:
Trust an interface N/A • true N/A
to be trustd • false
or not.
The
maximum
number of
LearnMaxN DHCP Unsigned integer.
N/A N/A
um snooping Value range: 0 to 4294967295.
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 model.
um receive
DHCP RateLimitMaxNum.
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>

3
 </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.

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

4
 Item Description
Table name DHCPSPOpt82RemoteIDVLAN
Table type Multi-instance table
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>
<RemoteIDMode></RemoteIDMode>
<RemoteID></RemoteID>
<RemoteIDFormat></RemoteIDFormat>

5
 </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 • CircuitIDMode
Data
Circuit of Circuit ID
sub-option
structure • CircuitIDNodeIDType
• CircuitIDNodeID
CircuitIDFormat

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
type • 1—Sysname.
• 2—User-defined.

6
 Column Column
Column name Data type and restrictions
description type
Circuit ID String. case insensitive.
CircuitIDNodeID node-identifier N/A
user defined string Length: 1 to 50 characters.

Enumeration:
Circuit ID format • 0—Hex.
CircuitIDFormat N/A
type • 1—Ascii.
• 2—Undefined.
Members include:
The configuration • RemoteIDMode
Data
Remote of Remote ID
sub-option
structure • RemoteID
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
type
N/A • 0—Hex.
• 1—Ascii.

DHCPSP/DHCPSPBinding
This table contains DHCP snooping entries information.

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

7
 Item Description
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.
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

8
Columns
Column Column
Column name Data type and restrictions
description type
Whether the Boolean:
function of DHCP
DHCPSPEnable
snooping is
N/A • true
enbled. • false

DHCPSP/DHCPSPSpecification
This table contains DHCP snooping specification information.

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

9
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.
参数值超出范围。

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 ······················································································································· 2
Table description ··················································································································· 3
Columns ······························································································································ 3
DHCPSP6/DHCPSP6OptionInterfaceID ··························································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 5
DHCPSP6/DHCPSP6OptionRemoteID ···························································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 6
DHCPSP6/DHCPSP6OptionEnable································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 7
Columns ······························································································································ 7
DHCPSP6/DHCPSP6Config ·········································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 8

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
String. case sensitive. and replace operations,
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.

XML structure
<DHCPSP6>
<DHCPSP6Interface>
<Interface>
<IfIndex></IfIndex>
<LearnMaxNum></LearnMaxNum>
<RateLimitNum></RateLimitNum>
<CheckRequestMessage></CheckRequestMessage>
<BindingRecord></BindingRecord>
<Trust></Trust>
</Interface>
</DHCPSP6Interface>
</DHCPSP6>

2
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
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 IfMgr in
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
entries for an 0 means No limit.
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
ssage
N/A • true. N/A
message in IPv6
DHCP packets or • false(default)
not.

3
 Column Column Data type and
Column name Remarks
description type restrictions
Whether Boolean:
configurate an
Trust
interface to be
N/A • true. N/A
trusted or not. • false(default)

DHCPSP6/DHCPSP6OptionInterfaceID
This table contains IPv6 DHCP snooping option 18 DUID configuration information.

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

4
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,
IfIndex Interface index. Index Unsigned integer. see the XSD document
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 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

5
 Item Description
Row name RemoteID
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,
IfIndex Interface index. Index Unsigned integer. see the XSD document
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>
</DHCPSP6OptionEnable>
</DHCPSP6>

6
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,
IfIndex Interface index. Index see the XSD document of your
product. For information about
IfIndex, see IfMgr in Ifmgr
NETCONF XML API
Configuration Reference.

Whether enable the IPv6 Boolean:

InterfaceIDEnable DHCP snooping to support N/A • true.
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.

XML structure
<DHCPSP6>
<DHCPSP6Config>
<DHCPSP6Enable></DHCPSP6Enable>
</DHCPSP6Config>
</DHCPSP6>

Table description
Item Description
Feature name DHCPSP6

7
 Item Description
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)

8
Contents
DHCPSP6 ······················································································1
DHCPSP6/DHCPSP6BindingDatabase ···························································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
DHCPSP6/DHCPSP6Interface ······································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 2
DHCPSP6/DHCPSP6OptionInterfaceID ··························································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 4
DHCPSP6/DHCPSP6OptionRemoteID ···························································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 4
DHCPSP6/DHCPSP6OptionEnable································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 5
DHCPSP6/DHCPSP6Binding ········································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 6
DHCPSP6/DHCPSP6Config ·········································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 7
DHCPSP6/DHCPSP6Specification ·································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 8
Columns ······························································································································ 8

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.
String. case sensitive.
Username FTP username N/A
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.

1
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
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
for an interface to 0 means No limit.
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

2
 Column Column Data type and
Column name Remarks
description type restrictions
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
ssage
check request N/A • true. N/A
message in DHCP • false(default)
packets or not
Whether Boolean:
configurate an
Trust
interface to be
N/A • true. N/A
trusted or not • false(default)

DHCPSP6/DHCPSP6OptionInterfaceID
This table contains IPv6 DHCP snooping option 18 DUID configuration information.

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.

3
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.

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.

4
 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.

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.

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
e support
N/A • true—Enabled.
InterfaceID • false—Disabled (default).

Enable the DHCP Boolean:

RemoteIDEnable snooping to N/A • true—Enabled.
support RemoteID • false—Disabled (default).

5
DHCPSP6/DHCPSP6Binding
This table contains IPv6 DHCP snooping entries information.

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.

Lease Left Lease time N/A Unsigned integer.

IfIndex Interface index N/A Unsigned integer.

6
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.

XML structure
<DHCPSP6>
<DHCPSP6Specification>
<RateLimitMinNum></RateLimitMinNum>
<RateLimitMaxNum></RateLimitMaxNum>
</DHCPSP6Specification>
</DHCPSP6>

7
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

8
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>
</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

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
Table type Single-instance table
Row name N/A
Restrictions None

Support for row creation and deletion No

6
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

Support for row creation and deletion No

7
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 ················································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Diagnostic/ProcessesCPUHistory ·································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
Diagnostic/CPUUsage(currently not available) ················································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
Diagnostic/ProcessesCPU(currently not available) ············································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6
Diagnostic/CPUAlert ··················································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7
Diagnostic/Memories ·················································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ···························································································································· 9
Diagnostic/ProcessesMemory (currently not available) ····································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
Diagnostic/SlubInfo (currently not available) ·················································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 12
Diagnostic/MemoryAlert ············································································································ 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
Diagnostic/CoreAlert ················································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 16
Columns ·························································································································· 16
Diagnostic/CPUGroups ············································································································· 17
XML structure ··················································································································· 17
Table description ··············································································································· 17
Columns ·························································································································· 17
Diagnostic/Configuration············································································································ 18
XML structure ··················································································································· 18
Table description ··············································································································· 18
Columns ·························································································································· 19
Diagnostic/DiskAlert ················································································································· 19
XML structure ··················································································································· 19
Table description ··············································································································· 19
Columns ·························································································································· 20

i
Diagnostic
Diagnostic/CPUHistory
This table contains usage information about the logical CPUs.

XML structure
<Diagnostic>
<CPUHistory>
<CPU>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<CPUUsage></CPUUsage>
<Last1mUsage></Last1mUsage>
<Last5mUsage></Last5mUsage>
<MoniterEnable></MoniterEnable>
<HistroyCycleInSecond></HistroyCycleInSecond>
<CPUUsageLimit></CPUUsageLimit>
<CPUHistory></CPUHistory>
</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

Columns
Column Column
Column description Data type and restrictions
name type

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.

1
 Column Column
Column description Data type and restrictions
name type
Unsigned integer.
CPUID ID of the CPU. Index
Value range: 0 to 65535.

CPUUsa Unsigned integer.

CPU usage (%) N/A
ge Value range: 0 to 100.

Last1mU Usage in the most recent Unsigned integer.

N/A
sage 1-minute interval (%) Value range: 0 to 100.

Last5mU Usage in the most recent Unsigned integer.

N/A
sage 5-minute interval (%) Value range: 0 to 100.
Enumeration:
MoniterE
CPU usage monitoring N/A • 1—Disabled.
nable
• 2—Enabled.
Enumeration:
HistroyCy • 5—5 seconds.
CPU usage sampling interval in
cleInSec N/A
ond
seconds • 60—60 seconds.
• 300—300 seconds.

CPUUsa Unsigned integer.

CPU usage threshold (%) N/A
geLimit Value range: 0 to 100.
String of up to 60 integers. Each integer
represents the CPU usage in a CPU usage
CPUHist sampling interval.
Historical CPU usage statistics N/A
ory
Length: 0 to 304 characters.
Format: HH,HH,HH,HH,HH,HH

Diagnostic/ProcessesCPUHistory
This table contains historical CPU usage statistics by process ID.

XML structure
<Diagnostic>
<ProcessesCPUHistory>
<Process>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<ProcessJobID></ProcessJobID>
<ProcessName></ProcessName>
<CPUHistoryProcess></CPUHistoryProcess>
</Process>
</ProcessesCPUHistory>
</Diagnostic>

2
Table description
Item Description
Feature name Diagnostic
Table name ProcessesCPUHistory
Table type Multi-instance table
Row name Process
Restrictions N/A

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.
Unsigned integer.
CPUID ID of the CPU. Index
Value range: 0 to 65535.
Unsigned integer.
ProcessJobID Process ID Index
Value range: 1 to 2147483647
String.
ProcessName Process name N/A
Length: 0 to 128 characters.
String of up to 60 integers. Each integer
Historical CPU usage represents the CPU usage in a CPU usage
CPUHistoryProce sampling interval.
statistics by process N/A
ss
ID Length: 0 to 304 characters.
Format: HH,HH,HH,HH,HH,HH

Diagnostic/CPUUsage(currently not available)

This table contains usage information about the logical CPUs.

XML structure
<Diagnostic>
<CPUUsage>
<CPU>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>

3
 <CPUUsage></CPUUsage>
<Core>
<CoreID></CoreID>
<CPUUsage></CPUUsage>
<Idle></Idle>
<User></User>
<Kernel></Kernel>
<Interrupt></Interrupt>
</Core>
</CPU>
</CPUUsage>
</Diagnostic>

Table description
Item Description
Feature name Diagnostic
Table name CPUUsage
Table type Multi-instance table
Row name CPU
Restrictions Available only for logical CPUs

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Member ID of
the member Unsigned integer.
Chassis device where Index N/A
the entity Value range: 0 to 65535.
resides.

Slot number of Unsigned integer.

Slot Index N/A
the device node Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU. Index N/A
Value range: 0 to 65535.

CPUUsa Unsigned integer.

CPU usage (%) N/A N/A
ge Value range: 0 to 100.
Members include:
• CoreID
• CPUUsage
Data
Core CPUInfo of core
structure • Idle Contain all core of the cpu.
• User
• Kernel
• Interrupt
CoreID ID of the core N/A Unsigned integer. N/A

4
 Column Column Column Data type and
Remarks
name description type restrictions
Value range: 0 to 65535.
Double. Accurate to the second
CPUUsa decimal place.
Core usage (%) N/A Value range: 0 to 100.
ge
Formats: %.2f Example: 12.34

Double. Accurate to the second

CPU idle time decimal place.
Idle N/A Value range: 0 to 100.
ratio (%)
Formats: %.2f Example: 12.34

Ratio of time for

processes in Double. Accurate to the second
User user mode to N/A Value range: 0 to 100. decimal place.
total CPU time Formats: %.2f Example: 12.34
(%)
Ratio of time for
processes in Double. Accurate to the second
Kernel kernel mode to N/A Value range: 0 to 100. decimal place.
total CPU time Formats:%.2f Example: 12.34
(%)
Ratio of time for Double. Accurate to the second
interrupts to decimal place.
Interrupt N/A Value range: 0 to 100.
total CPU time
(%) Formats: %.2f Example: 12.34

Diagnostic/ProcessesCPU(currently not
available)
This table contains CPU usage information for processes.

XML structure
<Diagnostic>
<ProcessesCPU>
<Process>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<JobID></JobID>
<Name></Name>
<CPUUsage></CPUUsage>
<Priority></Priority>
<State></State>
<FDs></FDs>
<Memory></Memory>
<RunTime></RunTime>
</Process>
</ProcessesCPU>

5
 </Diagnostic>

Table description
Item Description
Feature name Diagnostic
Table name ProcessesCPU
Table type Multi-instance table
Row name Process
Restrictions N/A

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Member ID of
the member Unsigned integer.
Chassis device where Index N/A
the entity Value range: 0 to 65535.
resides

Slot number of Unsigned integer.

Slot Index N/A
the device node Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU. Index N/A
Value range: 0 to 65535.
Unsigned integer.
JobID Job ID Index Value range: 1 to N/A
2147483647
String.
Name Process name N/A N/A
Length: 0 to 255 characters.
Double.
CPUUsa CPU usage of
N/A Value range: 0 to 100. N/A
ge the process
Formats: %.2f
Unsigned integer.
Priority Thread priority N/A N/A
Value range: 0 to 65535.
Enumeration:
• R—Running.
Status of the • S—Sleeping.
State N/A N/A
process • T—Traced or stopped.
• D—Uninterruptible sleep.
• Z—Zombie.
Unsigned integer.
File descriptions
FDs N/A Value range: 0 to N/A
for the process
4294967295.

Memory Process N/A Unsigned integer. N/A

memory space

6
 Column Column Column Data type and
Remarks
name description type restrictions
(KB) Value range: 0 to
4294967295.
String.
Formats:
Running time of
RunTime N/A • HH:MM:SS Runtime < N/A
the process
100h
• HHh Runtime >= 100h

Diagnostic/CPUAlert
This table contains cpu usage alarm information about the logical CPUs.

XML structure
<Diagnostic>
<CPUAlert>
<Alert>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<MinorThreshold></MinorThreshold>
<WarningThreshold></WarningThreshold>
<RecoveryThreshold></RecoveryThreshold>
<CurrentState></CurrentState>
</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 CPU

Columns
Column Column
Column name Data type and restrictions
description type
Chassis Member ID of the Index Unsigned integer.

7
 Column Column
Column name Data type and restrictions
description type
member device Value range: 0 to 65535.
where the entity
resides

Slot number of the Unsigned integer.

Slot Index
device node Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU. Index
Value range: 0 to 65535.

CPU usage minor Unsigned integer.

MinorThreshold N/A
threshold (%) Value range: 1 to 100.

CPU usage severe Unsigned integer.

WarningThreshold N/A
threshold (%) Value range: 1 to 100
CPU usage Unsigned integer
RecoveryThreshold RecoveryThreshold N/A
(%) Value range: 0 to 99

Enumeration:
Current alarm • Normal
CurrentState N/A
status • Minor
• Severe

Diagnostic/Memories
This table contains memory information.

XML structure
<Diagnostic>
<Memories>
<Memory>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<Total></Total>
<Used></Used>
<Free></Free>
<FreeRatio></FreeRatio>
<Buffers></Buffers>
<Cached></Cached>
<CommitLimit></CommitLimit>
<CommittedAS></CommittedAS>
<VmallocTotal></VmallocTotal>
<VmallocUsed></VmallocUsed>
<VmallocChunk></VmallocChunk>
<SwapTotal></SwapTotal>
<SwapFree></SwapFree>
<LowTotal></LowTotal>

8
 <LowFree></LowFree>
<HighTotal></HighTotal>
<HighFree></HighFree>
</Memory>
</Memories>
</Diagnostic>

Table description
Item Description
Feature name Diagnostic
Table name Memories
Table type Multi-instance table
Row name Memory
Restrictions N/A

Columns

Column
Column name Column type Data type and restrictions
description
Member ID of the
member device Unsigned integer.
Chassis Index
where the entity Value range: 0 to 65535.
resides

Slot number of Unsigned integer.

Slot Index
the device node Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU Index
Value range: 0 to 65535.

Total memory Unsigned integer.

Total N/A
size (KB) Value range: 0 to 4294967295.

Used memory Unsigned integer.

Used N/A
space (KB) Value range: 0 to 4294967295.

Free memory Unsigned integer.

Free N/A
space (KB) Value range: 0 to 4294967295.
Double.
Free memory Value range: 0 to 100.
FreeRatio N/A
ratio (%) Formats:
%.1f
Memory space Unsigned integer.
Buffers used for buffers N/A
(KB) Value range: 0 to 4294967295.

Memory space Unsigned integer.

Cached N/A
used for cache Value range: 0 to 4294967295.

9
 Column
Column name Column type Data type and restrictions
description
(KB)
Memory space Unsigned integer.
CommitLimit currently available N/A 64
for allocation (KB) Value range: 0 to 2 - 1.

Memory space Unsigned integer.

CommittedAS allocated by N/A 64
processes (KB) Value range: 0 to 2 - 1.

Total allocated Unsigned integer.

VmallocTotal virtual memory N/A 64
space (KB) Value range: 0 to 2 - 1.

Used virtual Unsigned integer.

VmallocUsed memory space N/A 64
(KB) Value range: 0 to 2 - 1.

Free virtual Unsigned integer.

VmallocChunk memory space N/A 64
(KB) Value range: 0 to 2 - 1.

Total memory Unsigned integer.

SwapTotal space used for N/A
swapping (KB) Value range: 0 to 4294967295.

Free memory Unsigned integer.

SwapFree space dedicated N/A
for swapping (KB) Value range: 0 to 4294967295.

Total low-memory Unsigned integer.

LowTotal N/A
size (KB) Value range: 0 to 4294967295.

Free low-memory Unsigned integer.

LowFree N/A
space (KB) Value range: 0 to 4294967295.
Total Unsigned integer.
HighTotal high-memory size N/A
(KB) Value range: 0 to 4294967295.

Free Unsigned integer.

HighFree high-memory N/A
space (KB) Value range: 0 to 4294967295.

Diagnostic/ProcessesMemory (currently not

available)
This table contains memory information about the Processes.

XML structure
<Diagnostic>
<ProcessesMemory>
<Process>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>

10
 <JID></JID>
<Name></Name>
<Text></Text>
<Data></Data>
<Stack></Stack>
<Dynamic></Dynamic>
</Process>
</ProcessesMemory>
</Diagnostic>

Table description
Item Description
Feature name Diagnostic
Table name ProcessesMemory
Table type Multi-instance table
Row name Process
Restrictions N/A

Columns
Column Column
Column name Data type and restrictions
description type
Member ID of the Unsigned integer.
Chassis member device where Index
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.
CPUID ID of the CPU. Index
Value range: 0 to 65535.
Unsigned integer.
JID Job ID of the process Index
Value range: 1 to 2147483647
String.
Name Process name N/A
Length: 0 to 255 characters.

Memory space for the Unsigned integer.

Text N/A
text segment (KB) Value range: 0 to 4294967295.

Memory space for the Unsigned integer.

Data N/A
data segment (KB) Value range: 0 to 4294967295.

Memory space for the Unsigned integer.

Stack N/A
stack segment (KB) Value range: 0 to 4294967295.
Memory space for Unsigned integer.
Dynamic dynamic allocation N/A
(KB) Value range: 0 to 4294967295.

11
Diagnostic/SlubInfo (currently not available)
This table contains memory information about the Slub.

XML structure
<Diagnostic>
<SlubInfo>
<Slub>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<Name></Name>
<Active></Active>
<Number></Number>
<Size></Size>
<Align></Align>
<Slab></Slab>
<PgSlab></PgSlab>
<ASlabs></ASlabs>
<NSlabs></NSlabs>
<Slub>
</SlubInfo>
</Diagnostic>

Table description
Item Description
Feature name Diagnostic
Table name SlubInfo
Table type Multi-instance table
Row name Slub
Restrictions N/A

Columns
Column Column
Column name Data type and restrictions
description type
Member ID of the Unsigned integer.
Chassis member device where Index
the entity resides Value range: 0 to 65535.

Slot number of the Unsigned integer.

Slot Index
device node Value range: 0 to 65535.
CPUID ID of the CPU. Index Unsigned integer.

12
 Column Column
Column name Data type and restrictions
description type
Value range: 0 to 65535.
String.
Name Target name Index
Length: 1 to 255 characters.

Number of active Unsigned integer.

Active N/A
targets Value range: 0 to 4294967295.

Total number of Unsigned integer.

Number N/A
targets Value range: 0 to 4294967295.

Target memory space Unsigned integer.

Size N/A
(KB) Value range: 0 to 2147483647.
Unsigned integer.
Align Aligned memory N/A
Value range: 0 to 2147483647.

Number of targets in Unsigned integer.

Slab N/A
one slab Value range: 0 to 2147483647.

Number of memory Unsigned integer.

PgSlab N/A
pages for one slab Value range: 0 to 2147483647.

Number of active Unsigned integer.

ASlabs N/A
slabs Value range: 0 to 4294967295.
Unsigned integer.
NSlabs Total number of slabs N/A
Value range: 0 to 4294967295.

Diagnostic/MemoryAlert
This table contains free-memory alarm settings and status information.

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>
<CurrentState></CurrentState>
</Alert>
</MemoryAlert>
</Diagnostic>

13
Table description
Item Description
Feature name Diagnostic
Table name MemoryAlert
Table type Multi-instance table
Row name Alert
Restrictions N/A

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

Member ID of
the member Unsigned integer.
Chassis device where Index N/A
the entity Value range: 0 to 65535.
resides

Slot number of Unsigned integer.

Slot Index N/A
the device node Value range: 0 to 65535.

Unsigned integer.
CPUID ID of the CPU. Index N/A
Value range: 0 to 65535.

Enumeration:
Unit for memory
Unit N/A • MB N/A
thresholds
• Percentage

Minor Unsigned integer. Setting this threshold to 0

MinorThr insufficient-free-
N/A When unit is percentage, disables the minor alarm
eshold memory
value range: 0 to 100. feature.
threshold

Severe Unsigned integer. Setting this threshold to 0

SevereT insufficient-free-
N/A When unit is percentage, disables the severe alarm
hreshold memory
value range: 0 to 100. feature.
threshold

Critical Unsigned integer. Setting this threshold to 0

CriticalTh insufficient-free-
N/A When unit is percentage, disables the critical alarm
resholdl memory
value range: 0 to 100. feature.
threshold

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

Normal Unsigned integer.

NormalT
free-memory N/A When unit is percentage, N/A
hreshold
state threshold value range: 0 to 100.

Early-warning
EarlyWar threshold for Unsigned integer.
Setting this threshold to 0
ningThre insufficient-free- N/A When unit is percentage, disables the early warning
shold memory value range: 0 to 100. feature.
condition

Early-warning-r
emoved Unsigned integer.
SecureT threshold for
N/A When unit is percentage, N/A
hreshold insufficient-free-
memory value range: 0 to 100.
condition

Enumeration:
• Minor
• Severe
CurrentSt Current memory
N/A • Critical N/A
ate alarm status
• Normal
• EarlyWarning
• Secure

Diagnostic/CoreAlert
This table contains core alarm settings and status information.

XML structure
<Diagnostic>
<CoreAlert>
<Alert>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<CoreID></CoreID>
<CoreThreshold></CoreThreshold>
<Current5SUsage></Current5SUsage>
<Current1MUsage></Current1MUsage>
<Current5MUsage></Current5MUsage>
<LastState></LastState>
</Alert>
</CoreAlert>
</Diagnostic>

15
Table description
Item Description
Feature name Diagnostic
Table name CoreAlert
Table type Multi-instance table
Row name Alert
Restrictions N/A

Columns
Column
Column description Column type Data type and restrictions
name

Member ID of the Unsigned integer.

Chassis member device where Index
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.
CoreThreshol Core usage Threshold
N/A Value range: 2 to 100
d (%)
Default: 4294967295

Core usage in the most Unsigned integer.

Current5SUsa
recent 5-second interval N/A
ge Value range: 0 to 100
(%)
Core usage in the most Unsigned integer.
Current1MUsa
recent 12 five-second N/A
ge Value range: 0 to 100
interval (%)
Core usage in the most Unsigned integer.
Current5MUsa
recent 60 five-second N/A
ge Value range: 0 to 100
interval (%)
Enumeration:
Previous core alarm
LastState N/A • Normal
status
• Warning

16
Diagnostic/CPUGroups
This table contains usage information about the logical CPU groups.

XML structure
<Diagnostic>
<CPUGroups>
<CPUGroup>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<GroupID></GroupID>
<GroupName></GroupName>
<CPUUsage></CPUUsage>
<Last1mUsage></Last1mUsage>
<Last5mUsage></Last5mUsage>
</CPUGroup>
</CPUGroups>
</Diagnostic>

Table description
Item Description
Feature name Diagnostic
Table name CPUGroups
Table type Multi-instance table
Row name CPUGroup
Restrictions Available only for logical CPU groups

Columns
Column Column
Column description Data type and restrictions
name type

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.

GroupID ID of CPU group Index Unsigned integer.

Value range: 0 to 65535.

17
 Column Column
Column description Data type and restrictions
name type
For example: 0 means control plane, 1
means data plane

GroupNa String.
Name of CPU group N/A
me
Length: 1 to 64 characters.
Usage in the most recent
CPUUsa Unsigned integer.
5-second interval (%) for the N/A
ge
specified plane Value range: 0 to 100.
Usage in the most recent Unsigned integer.
Last1mU
1-minute interval (%) for the N/A
sage Value range: 0 to 100.
specified plane
Usage in the most recent Unsigned integer.
Last5mU
5-minute interval (%) for the N/A
sage Value range: 0 to 100.
specified plane

Diagnostic/Configuration
This table contains the global settings of the diagnostic module.

XML structure
<Diagnostic>
<Configuration>
<MonitorDiskEnable></MonitorDiskEnable>
<DefaultMonitorDiskUsageInterval></DefaultMonitorDiskUsageInterval>
<MonitorDiskUsageInterval></MonitorDiskUsageInterval>
</Configuration>
</Diagnostic>

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

18
Columns
Column Column
Column name Data type
description type

Boolean:
Enable disk usage
MonitorDiskEnable
monitoring.
N/A • true
• false

Default disk usage Unsigned integer.

DefaultMonitorDiskUsageInterval monitoring interval N/A
in seconds. Value range: 5 to 1800.

Disk usage Unsigned integer.

MonitorDiskUsageInterval monitoring interval N/A
in seconds. Value range: 5 to 1800.

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

19
Columns
Column Column
Column type Data type and restrictions
name description

Member ID of the Unsigned integer.

Chassis member device where Index
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.
CPUID ID of the CPU. Index
Value range: 0 to 65535.

String.
DiskName Disk name. Index
Length: 1 to 64 characters.

Disk usage threshold Unsigned integer.

Threshold N/A
in percentage. Value range: 1 to 100.

20
Contents
Diagnostic ······················································································1
Diagnostic/CPUUsage(currently not available) ··················································································· 1
Diagnostic/MemoryAlert ················································································································ 1
Diagnostic/CoreAlert ····················································································································· 2

i
Diagnostic
Diagnostic/CPUUsage(currently not available)
Message Explanation
The value of MinorThreshold should be greater The value of MinorThreshold should be greater than the value of
than the value of RecoveryThreshold. RecoveryThreshold.
PEX configuration not supported. PEX configuration not supported.

Diagnostic/MemoryAlert
Message Explanation
The value of SevereThreshold should be greater The value of SevereThreshold should be greater than or equal to
than or equal to the value of CriticalThreshold. the value of CriticalThreshold.
The value of MinorThreshold should be greater The value of MinorThreshold should be greater than or equal to
than or equal to the value of SevereThreshold. the value of SevereThreshold.
The value of NormalThreshold should be greater The value of NormalThreshold should be greater than or equal to
than or equal to the value of MinorThreshold. the value of MinorThreshold.
The value of NormalThreshold should be less than The value of NormalThreshold should be less than or equal to the
or equal to the total memory size of Device. total memory size of Device.
The value of WarningThreshold should be greater The value of WarningThreshold should be greater than the value
than the value of MinorThreshold. of MinorThreshold.
To disable the free-memory alarm feature, set all To disable the free-memory alarm feature, set all free-memory
free-memory thresholds to 0. thresholds to 0.
The value of EarlyWarningThreshold should be
The value of EarlyWarningThreshold should be greater than or
greater than or equal to the value of
equal to the value of NormalThreshold.
NormalThreshold.

The value of EarlyWarningThreshold should be The value of EarlyWarningThreshold should be less than or equal
less than or equal to the total memory size. to the total memory size.

The value of SecureThreshold should be greater

The value of SecureThreshold should be greater than or equal to
than or equal to the value of
the value of EarlyWarningThreshold.
EarlyWarningThreshold.
The value of SecureThreshold should be less than The value of SecureThreshold should be less than or equal to the
or equal to the total memory size. total memory size.

To disable the EarlyWarningThreshold alarm

To disable the EarlyWarningThreshold alarm feature, set
feature, set EarlyWarningThreshold and
EarlyWarningThreshold and SecureThreshold to 0.
SecureThreshold to 0.
The device doesn't support setting The device doesn't support setting EarlyWarningThreshold or
EarlyWarningThreshold or SecureThreshold. SecureThreshold.
Please set all free-memory thresholds to 0 to Please set all free-memory thresholds to 0 to disable the
disable the free-memory alarm functions first. free-memory alarm functions first.
For a create or merge operation, all non-index For a create or merge operation, all non-index columns are
columns are required. required.

For a delete, remove, or replace operation, you For a delete, remove, or replace operation, you must specify all
must specify all non-index columns or leave all non-index columns or leave all non-index columns unspecified.

1
non-index columns unspecified.

Diagnostic/CoreAlert
Message Explanation
The core doesn't support setting the thresholds. The core doesn't support setting the thresholds.
The specified core doesn't exist. The specified core doesn't exist.
The value of CoreThreshold must be in the range of
The value of CoreThreshold must be in the range of 2 to 100.
2 to 100.

2
Contents
Diagnostics event stream ···································································1
CPUEvent event ·························································································································· 1
XML structure for event subscription ························································································· 1
XML structure for event report ································································································· 2
MemoryEvent event······················································································································ 5
XML structure for event subscription ························································································· 6
XML structure for event report ································································································· 7
CoreEvent event ·························································································································· 9
XML structure for event subscription ························································································· 9
XML structure for event report ······························································································· 11
DiskEvent event ························································································································· 14
XML structure for event subscription ······················································································· 14
XML structure for event report ······························································································· 15

i
Diagnostics event stream
CPUEvent event
This event is used to report CPU alarm information.

XML structure for event subscription

<CPUEvent>
<CPU>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</CPU>
</CPUEvent>

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>Diagnostic</stream>
<filter type="subtree">
<CPUEvent xmlns="http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0">
<CPU>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
</CPU>
</CPUEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name Diagnostic
Event name CPUEvent
Event namespace http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0
Support for extended query No

Columns

Support for
Column Column Data type and
extended Remarks
name description restrictions
queries
Chassis Member ID of the Unsigned integer. No N/A

1
 Support for
Column Column Data type and
extended Remarks
name description restrictions
queries
member device Value range: 0 to
where the entity 65535.
resides
Unsigned integer.
Slot number of the
Slot Value range: 0 to No N/A
device node
65535.

Unsigned integer.
CPUID ID of the CPU. Value range: 0 to No N/A
65535.

XML structure for event report

<CPUEvent>
<CPU>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<Description></Description>
<CPUUsage></CPUUsage>
<Core>
<CoreID></CoreID>
<CPUUsage></CPUUsage>
<Idle></Idle>
<User></User>
<Kernel></Kernel>
<Interrupt></Interrupt>
</Core>
<Process>
<JobID></JobID>
<PID></PID>
<Name></Name>
<CPUUsage></CPUUsage>
<Priority></Priority>
<State></State>
<FDs></FDs>
<Memory></Memory>
<RunTime></RunTime>
</Process>
</CPU>
</CPUEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<CPUEvent xmlns="http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0">

2
 <CPU>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
<Description>CPU_THRESHOLD</Description>
<CPUUsage>50</CPUUsage>
<Core>
<CoreID>0</CoreID>
<CPUUsage>11.00</CPUUsage>
<Idle>89.00</Idle>
<User>4.00</User>
<Kernel>5.00</Kernel>
<Interrupt>2.00</Interrupt>
</Core>
……
<Core>
<CoreID>7</CoreID>
<CPUUsage>13.00</CPUUsage>
<Idle>87.00</Idle>
<User>5.00</User>
<Kernel>5.00</Kernel>
<Interrupt>3.00</Interrupt>
</Core>
<Process>
<JobID>84</JobID>
<PID>84</PID>
<Name>diagd</Name>
<CPUUsage>0.03</CPUUsage>
<Priority>120</Priority>
<State>R</State>
<FDs>18</FDs>
<Memory>10384</Memory>
<RunTime>00:00:56</RunTime>
</Process>
……
<Process>
<JobID>86</JobID>
<PID>86</PID>
<Name>syslogd</Name>
<CPUUsage>0.03</CPUUsage>
<Priority>120</Priority>
<State>S</State>
<FDs>30</FDs>
<Memory>12984</Memory>
<RunTime>00:00:36</RunTime>
</Process>
</CPU>
</CPUEvent>

3
 </notification>

Columns

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.
Enumeration:
• CPU_THRESHOLD
• CPU_THRESHOLD_RECOVE
Description CPU event description. N/A
RY
• CPU_MINOR_THRESHOLD
• CPU_MINOR_RECOVER
Unsigned integer.
CPUUsage CPU usage (%) N/A
Value range: 0 to 100.
Members include:
• CoreID
• CPUUsage
Core CPUInfo of core • Idle N/A
• User
• Kernel
• Interrupt
Unsigned integer.
CoreID Core ID N/A
Value range: 0 to 65535.
Double.
Accurate to the second
Value range: 0 to 100. decimal place.
CPUUsage Core CPU usage (%)
Formats: Example: 12.34
%.2f
Double.
Accurate to the second
Value range: 0 to 100.
Idle CPU idle time ratio(%) decimal place.
Formats:
Example: 12.34
%.2f
Double.
Ratio of the time of Accurate to the second
processes executing in Value range: 0 to 100. decimal place.
User
user mode to CPU total Formats:
time(%) Example: 12.34
%.2f
Double.
Ratio of the time of Accurate to the second
processes executing in Value range: 0 to 100.
Kernel decimal place.
kernel mode to CPU Formats:
total time (%) Example: 12.34
%.2f

Ratio of the time of Double. Accurate to the second

Interrupt
interrupt to total cpu Value range: 0 to 100. decimal place.

4
 Column
Column description Data type and restrictions Remarks
name
time. Formats: Example: 12.34
%.2f
Members include:
• JobID
• PID
• Name
• CPUUsage
Process CPUInfo of process N/A
• Priority
• State
• FDs
• Memory
• RunTime
Unsigned integer.
JobID Job ID N/A
Value range: 1 to 2147483647.
Unsigned integer.
PID Process ID N/A
Value range: 1 to 2147483647.
String. Only report the top 10
Name Process name
Length: 1 to 255 characters. cpuusage processes.

Double.
Value range: 0 to 100.
CPUUsage CPUUsage of Process N/A
Formats:
%.2f
Unsigned integer.
Priority Process priority N/A
Value range: 0 to 65535.
Enumeration:
• R—Running.
Running state of • S—Sleeping.
State N/A
process • T—Traced or stopped.
• D—Uninterruptible sleep.
• Z—Zombie.

File descriptions of Unsigned integer.

FDs N/A
process Value range: 0 to 4294967295.
Size of the process Unsigned integer.
Memory N/A
memory space(KB) Value range: 0 to 4294967295.
String.
Formats:
RunTime Runtime of process N/A
• HH:MM:SS Runtime < 100h
• HHh Runtime >= 100h

MemoryEvent event
This event is used to report memory alarm information.

5
XML structure for event subscription
<MemoryEvent>
<Memory>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</Memory>
</MemoryEvent>

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>Diagnostic</stream>
<filter type="subtree">
<MemoryEvent xmlns="http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0">
<Memory>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
</Memory>
</MemoryEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name Diagnostic
Event name MemoryEvent
Event namespace http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0
Support for extended query No

Columns

Column Support for

Column name Data type and restrictions
description extended queries
Member ID of the
member device Unsigned integer.
Chassis No
where the entity Value range: 0 to 65535.
resides.

Slot number of the Unsigned integer.

Slot No
device node. Value range: 0 to 65535.
Unsigned integer.
CPUID CPU Identification. No
Value range: 0 to 65535.

6
XML structure for event report
<MemoryEvent>
<Memory>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<Description></Description>
<Total></Total>
<Used></Used>
<Free></Free>
<FreeRatio></FreeRatio>
<LowTotal></LowTotal>
<LowFree></LowFree>
<HighTotal></HighTotal>
<HighFree></HighFree>
<TopUsageProcess>
<JID></JID>
<Name></Name>
<Used></Used>
</TopUsageProcess>
<TopUsageSlub>
<Name></Name>
<Used></Used>
</TopUsageSlub>
</Memory>
</MemoryEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<MemoryEvent xmlns="http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0">
<Memory>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
<Description>Normal</Description>
<Total>1199160</Total>
<Used>773500</Used>
<Free>425660</Free>
<FreeRatio>35</FreeRatio>
<LowTotal>895096</LowTotal>
<LowFree>425060</LowFree>
<HighTotal>304064</HighTotal>
<HighFree>600</HighFree>
<TopUsageProcess>
<JID>1</JID>
<Name>scmd</Name>

7
 <Used>8868</Used>
</TopUsageProcess>
……
<TopUsageProcess>
<JID>78</JID>
<Name>fsd</Name>
<Used>5668</Used>
</TopUsageProcess>
<TopUsageSlub>
<Name>kmalloc-524280</Name>
<Used>524280</Used>
</TopUsageSlub>
……
<TopUsageSlub>
<Name>tcpcb</Name>
<Used>856</Used>
</TopUsageSlub>
</Memory>
</MemoryEvent>
</notification>

Columns

Column
Column name Data type and restrictions Remarks
description
Member ID of the
member device Unsigned integer.
Chassis N/A
where the entity Value range: 0 to 65535.
resides.

Slot number of the Unsigned integer.

Slot N/A
device node. Value range: 0 to 65535.
Unsigned integer.
CPUID CPU Identification. N/A
Value range: 0 to 65535.
Enumeration:
• MEM_EARLYWARNING_THR
ESHOLD
• MEM_EARLYWARNING_REC
OVER
Memory event • MEM_MINOR_THRESHOLD
Description N/A
description. • MEM_MINOR_RECOVER
• MEM_SEVERE_THRESHOLD
• MEM_SEVERE_RECOVER
• MEM_CRITICAL_THRESHOL
D
• MEM_CRITICAL_RECOVER

Total memory size Unsigned integer.

Total N/A
(KB) Value range: 0 to 4294967295.

Size of the used Unsigned integer.

Used N/A
memory space(KB) Value range: 0 to 4294967295.
Free Size of the free Unsigned integer. N/A

8
 Column
Column name Data type and restrictions Remarks
description
memory space Value range: 0 to 4294967295.
(KB)

Free memory Unsigned integer.

FreeRatio N/A
Ratio(%) Value range: 0 to 100.

Total LowMem size Unsigned integer.

LowTotal N/A
(KB) Value range: 0 to 4294967295.
Size of the free Unsigned integer.
LowFree LowMem space N/A
(KB) Value range: 0 to 4294967295.

Total HighMem Unsigned integer.

HighTotal N/A
size (KB) Value range: 0 to 4294967295.
Size of the free Unsigned integer.
HighFree HighMem space N/A
(KB) Value range: 0 to 4294967295.

Members include:
TopUsageProce Memory Info of top • JID Only report the top 10
ss usage process • Name memory usage processes.
• Used
Unsigned integer.
JID Process Job ID N/A
Value range: 1 to 2147483647.
String.
Name Process name N/A
Length: 1 to 255 characters.
Size of the process Unsigned integer.
Used used memory N/A
space(KB) Value range: 0 to 4294967295.

Members include:
Memory Info of top Only report the top 10
TopUsageSlub
usage slub • Name memory usage target.
• Used
String.
Name Target name N/A
Length: 1 to 255 characters.
Size of the target Unsigned integer.
Used used memory N/A
space(KB) Value range: 0 to 4294967295.

CoreEvent event
This event is used to report core alarm information.

XML structure for event subscription

<CoreEvent>
<Cores>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>

9
 <CoreID></CoreID>
</Cores>
</CoreEvent>

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>Diagnostic</stream>
<filter type="subtree">
<CoreEvent xmlns="http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0">
<Cores>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
<CoreID>0</CoreID>
</Cores>
</CoreEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name Diagnostic
Event name CoreEvent
Event namespace http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0
Support for extended query No

Columns

Support for
Data type and
Column name Column description extended Remarks
restrictions
queries
Member ID of the Unsigned integer.
member device
Chassis Value range: 0 to No N/A
where the entity
resides 65535.

Unsigned integer.
Slot number of the
Slot Value range: 0 to No N/A
card
65535.
Unsigned integer.
CPUID ID of the CPU. Value range: 0 to No N/A
65535.

Unsigned integer.
CoreID ID of the Core. Value range: 0 to No N/A
65535.

10
XML structure for event report
<CoreEvent>
<Cores>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<CoreID></CoreID>
<CoreUsage></CoreUsage>
<CoreThreshold></CoreThreshold>
<CpuLast5sUsage></CpuLast5sUsage>
<CpuLast1mUsage></CpuLast1mUsage>
<CpuLast5mUsage></CpuLast5mUsage>
<Process>
<Name></Name>
<CPU></CPU>
<JobID></JobID>
<PID></PID>
<PPID></PPID>
<InLast5sUsage></InLast5sUsage>
<InLast1mUsage></InLast1mUsage>
<InLast5mUsage></InLast5mUsage>
<State></State>
<Memory></Memory>
</Process>
</Cores>
</CoreEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<CoreEvent xmlns="http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0">
<Cores>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
<CoreID>0</CoreID>
<CoreUsage>6</CoreUsage>
<CoreThreshold>5</CoreThreshold>
<CpuLast5sUsage>3.12%</CpuLast5sUsage>
<CpuLast1mUsage>2.56%</CpuLast1mUsage>
<CpuLast5mUsage>5.23%</CpuLast5mUsage>
<Process>
<Name>diagd</Name>
<CPU>0</CPU>
<JobID>84</JobID>
<PID>84</PID>
<InLast5sUsage>10.0%</InLast5sUsage>

11
 <InLast1mUsage>6.0%</InLast1mUsage>
<InLast5mUsage>5.3%</InLast5mUsage>
<State>R</State>
<Memory>10384</Memory>
</Process>
……
<Process>
<Name>syslogd</Name>
<CPU>0</CPU>
<JobID>86</JobID>
<PID>86</PID>
<Name>syslogd</Name>
<InLast5sUsage>10.0%</InLast5sUsage>
<InLast1mUsage>6.0%</InLast1mUsage>
<InLast5mUsage>5.3%</InLast5mUsage>
<State>S</State>
<Memory>12984</Memory>
</Process>
</Cores>
</CoreEvent>
</notification>

Columns

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.

Unsigned integer.
Slot Slot number of the card N/A
Value range: 0 to 65535.
Unsigned integer.
CPUID ID of the CPU. N/A
Value range: 0 to 65535.
Unsigned integer.
CoreID ID of the Core. N/A
Value range: 0 to 65535.
Unsigned integer. In last 30 minutes the core
CoreUsage Core usage (%)
Value range: 0 to 100. usage

Double.
CpuLast5sU The core on CPU usage Value range:0 to 100. In last 5 seconds the CPU
sage (%) Formats: usage.
%.2f
Double.
CpuLast1m The core on CPU usage Value range:0 to 100. In last 1 minute the CPU
Usage (%) Formats: usage.
%.2f

CpuLast5m The core on CPU usage Double. In last 5 minutes the CPU
Usage (%) Value range:0 to 100. usage.

12
Column
Column description Data type and restrictions Remarks
name
Formats:
%.2f

CoreThresh Unsigned integer.

Core usage threshold N/A
old Value range: 2 to 100.
Members include:
• Name
• CPU
• JobID
Only the top high-core
High-core usage • PID
Process usage processes are
processes • InLast5sUsage reported
• InLast1mUsage
• InLast5mUsage
• State
• Memory
String.
Name Process name N/A
Length: 1 to 255 characters.
Core that held one of
the top high-core usage Unsigned integer.
CPU processes when the N/A
high-core usage alarm Value range: 0 to 65535.
was issued
Unsigned integer.
JobID Job ID N/A
Value range: 1 to 2147483647.
Unsigned integer.
PID Process ID N/A
Value range: 1 to 2147483647.
Double.
Usage in the most Value range: 0 to 100.
InLast5sUs
recent 5-second interval N/A
age Formats:
(%)
%.1f
Double.
Usage in the most Value range: 0 to 100.
InLast1mUs
recent 1-minute interval N/A
age Formats:
(%)
%.1f
Double.
Usage in the most Value range: 0 to 100.
InLast5mUs
recent 5-minute interval N/A
age Formats:
(%)
%.1f
Enumeration:
• R—Running.
Running state of • S—Sleeping.
State N/A
process • T—Traced or stopped.
• D—Uninterruptible sleep.
• Z—Zombie.

Size of the process Unsigned integer.

Memory N/A
memory space(KB) Value range: 0 to 4294967295.

13
DiskEvent event
This event is used to report disk alarm information.

XML structure for event subscription

<DiskEvent>
<Disk>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<DiskName></DiskName>
</Disk>
</DiskEvent>

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>Diagnostic</stream>
<filter type="subtree">
<DiskEvent xmlns="http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0">
<Disk>
<Chassis>0</Chassis>
<Slot>0</Slot>
<CPUID>0</CPUID>
<DiskName>flash</DiskName>
</Disk>
</DiskEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name Diagnostic
Event name DiskEvent
Event namespace http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0
Support for extended query No

Columns

Column Support for

Column name Data type and restrictions
description extended queries
Member ID of the
member device Unsigned integer.
Chassis No
where the entity Value range: 0 to 65535.
resides.

14
 Column Support for
Column name Data type and restrictions
description extended queries
Slot number of the Unsigned integer.
Slot No
device node. Value range: 0 to 65535.
Unsigned integer.
CPUID CPU Identification. No
Value range: 0 to 65535.
String.
DiskName Disk name.
Length: 1 to 64 characters.

XML structure for event report

<DiskEvent>
<Disk>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<DiskName></DiskName>
<Threshold></Threshold>
<CurrentUsage></CurrentUsage>
</Disk>
</DiskEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<DiskEvent xmlns="http://www.h3c.com/netconf/event:1.0/Diagnostic:1.0">
<Disk>
<Chassis>0</Chassis>
<Slot><0/Slot>
<CPUID>0</CPUID>
<DiskName>flash</DiskName>
<Threshold>80</Threshold>
<CurrentUsage>45.55</CurrentUsage>
</Disk>
</DiskEvent>
</notification>

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 CPU Identification.
Value range: 0 to 65535.

15
Column name Column description Data type and restrictions
String.
DiskName Disk name.
Length: 1 to 64 characters.
Unsigned integer.
Threshold Disk usage threshold (%).
Value range: 1 to 100.
Double.
CurrentUsage Current disk usage (%).
Value range: 0.00 to 100.00.

16
Contents
DIM ·······························································································1
DIM/CompileInspectEngine ············································································································ 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1

i
DIM
DIM/CompileInspectEngine
This table tiggers the inspect engine to activate all DPI settings.

XML structure
<DIM>
<CompileInspectEngine>
<Compile></Compile>
</CompileInspectEngine>
</DIM>

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

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
Activate all DPI
Compile
settings
N/A • true N/A
• false

1
Contents
DIM ·······························································································1
DIM/BlockParameters ··················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
DIM/CaptureParameters ················································································································ 1
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 2
DIM/LoggingParameters ················································································································ 2
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
DIM/RedirectParameters ··············································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4
DIM/MailParameters ····················································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 5
Columns ······························································································································ 5
DIM/InspectBypass ······················································································································ 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 6
DIM/ProxyServerParameters ·········································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 7
Columns ······························································································································ 7
DIM/DimFileUncompress ··············································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 8

i
DIM
DIM/BlockParameters
This table contains block parameters.

XML structure
<DIM>
<BlockParameters>
<BlockParameter>
<ParameterName></ParameterName>
<Denyperiod></Denyperiod>
</BlockParameter>
</BlockParameters>
</DIM>

Table description
Item Description
Feature name DIM
Table name BlockParameters
Table type Multi-instance table
Row name BlockParameter
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ParameterNa String, case-insensitive.
Parameter name Index N/A
me Length: 1 to 63 characters.
Unsigned integer.
Denyperiod Deny period N/A Default is 1800s
Value range: 1 to 86400s

DIM/CaptureParameters
This table contains capture parameters.

1
XML structure
<DIM>
<CaptureParameters>
<CaptureParameter>
<ParameterName></ParameterName>
<CaptureMax></CaptureMax>
<CaptureExceedURL></CaptureExceedURL>
<StartTime></StartTime>
</CaptureParameter>
</CaptureParameters>
</DIM>

Table description
Item Description
Feature name DIM
Table name CaptureParameters
Table type Multi-instance table
Row name CaptureParameter
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ParameterNa String, case-insensitive.
Parameter name Index N/A
me Length: 1 to 63 characters.

Max space for Unsigned integer.

CaptureMax N/A Default is 512 Kbytes
captured packets Value range: 0 to 1024
The URL while
the packets size String, case-insensitive.
CaptureExce
exceeds the max N/A N/A
edURL Length: 1 to 255 characters.
space, they will
be sent to
Time when the Time.
StartTime system sends N/A Default is 01:00:00
the packets Format: HH:MM:SS

DIM/LoggingParameters
This table contains logging parameters.

2
XML structure
<DIM>
<LoggingParameters>
<LoggingParameter>
<ParameterName></ParameterName>
<IsLogToHost></IsLogToHost>
<IsLogMail></IsLogMail>
</LoggingParameter>
</LoggingParameters>
</DIM>

Table description
Item Description
Feature name DIM
Table name BlockParameters
Table type Multi-instance table
Row name BlockParameter
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ParameterNa String, case-insensitive.
Parameter name Index N/A
me Length: 1 to 63 characters.
Boolean:
Sending log to
IsLogToHost
host or not
N/A • true N/A
• false

Email the logs to Boolean:

IsLogMail an email server N/A • true N/A
or not • false

DIM/RedirectParameters
This table contains redirect parameters.

XML structure
<DIM>
<RedirectParameters>

3
 <RedirectParameter>
<ParameterName></ParameterName>
<url></url>
</RedirectParameter>
</RedirectParameters>
</DIM>

Table description
Item Description
Feature name DIM
Table name RedirectParameters
Table type Multi-instance table
Row name RedirectParameter
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ParameterNa String, case-insensitive.
Parameter name Index N/A
me Length: 1 to 63 characters.

Target URL for String, case-insensitive.

url N/A N/A
redirect Length: 1 to 255 characters.

DIM/MailParameters
This table contains mail parameters.

XML structure
<DIM>
<MailParameters>
<MailParameter>
<ParameterName></ParameterName>
<ServerAddr></ServerAddr>
<SrcMailAddr></SrcMailAddr>
<DstMailAddr></DstMailAddr>
<LocalDomain></LocalDomain>
<UserName></UserName>
<Password></Password>
<IsNeedAuthentication></IsNeedAuthentication>

4
 <IsNeedSPA></IsNeedSPA>
</MailParameter>
</MailParameters>
</DIM>

Table description
Item Description
Feature name DIM
Table name MailParameters
Table type Multi-instance table
Row name MailParameter
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ParameterNa String, case-insensitive.
Parameter name Index N/A
me Length: 1 to 63 characters.

Mail server’s String, case-insensitive.

ServerAddr N/A N/A
address Length: 1 to 63 characters.

Source mail String, case-insensitive.

SrcMailAddr N/A N/A
address Length: 1 to 63 characters.

Destination mail String, case-insensitive.

DstMailAddr N/A N/A
address Length: 1 to 511 characters.

Local domain String, case-insensitive.

LocalDomain N/A N/A
name Length: 1 to 63 characters.
String, case-insensitive.
UserName Mail user name N/A N/A
Length: 1 to 63 characters.
String, case-insensitive.
Password Password N/A N/A
Length: 1 to 63 characters.
Requires Boolean:
IsNeedAuthen authentication by
tication the mail server or
N/A • true N/A
not • false

Requires using Boolean:

IsNeedSPA SPA by the mail N/A • true N/A
server or not • false

5
DIM/InspectBypass
This table contains bypass parameters.

XML structure
<DIM>
<InspectBypass>
<BypassByConfig></BypassByConfig>
</InspectBypass>
</DIM>

Table description
Item Description
Feature name DIM
Table name InspectBypass
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:
BypassByConfig Value of bypass. N/A • true N/A
• false

DIM/ProxyServerParameters
This table contains information about DIM proxy server parameters.

XML structure
<DIM>
<ProxyServerParameters>
<ProxyServerParameter>
<ProxyAddress></ProxyAddress>
<ProxyPort></ProxyPort>
<UserName></UserName>
<PassWord></PassWord>
<ProxyServerParameter>
</ProxyServerParameters>

6
 </DIM>

Table description
Item Description
Feature name DIM
Table name ProxyServerParameters
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
Proxy server String, case-insensitive
ProxyAddress N/A N/A
address Length: 3 to 63 characters.
Unsigned integer:
ProxyPort Proxy server port N/A N/A
Value range: 1 to 65535.
String, case-insensitive
UserName Proxy username N/A N/A
Length: 1 to 31 characters.
String, case-sensitive
PassWord Proxy password N/A N/A
Length: 1 to 31 characters.

DIM/DimFileUncompress
This table contains the maximum length of file uncompressing.

XML structure
<DIM>
<DimFileUncompress>
<Size></Size>
</DimFileUncompress>
</DIM>

Table description
Item Description
Feature name DIM
Table name DimFileUncompress

7
 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
Maximum szie Unsigned integer.
Size that can be N/A N/A
uncompressed Value range: 1 to 200MB.

8
Contents
DIM ·······························································································1
DIM/BlockParameters ··················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
DIM/CaptureParameters ················································································································ 1
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 2
DIM/LoggingParameters ················································································································ 2
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
DIM/RedirectParameters ··············································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4
DIM/MailParameters ····················································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 5
Columns ······························································································································ 5
DIM/ActivePercentage ·················································································································· 5
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 6
DIM/InspectBypass ······················································································································ 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 7
DIM/ProxyServerParameters ·········································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 7
DIM/DimFileUncompress ··············································································································· 8
XML structure ······················································································································· 8
Table description ··················································································································· 8
Columns ······························································································································ 8
DIM/DeviceInfo ···························································································································· 8
XML structure ······················································································································· 9
Table description ··················································································································· 9
Columns ······························································································································ 9

i
DIM
DIM/BlockParameters
This table contains block parameters.

XML structure
<DIM>
<BlockParameters>
<BlockParameter>
<ParameterName></ParameterName>
<Denyperiod></Denyperiod>
</BlockParameter>
</BlockParameters>
</DIM>

Table description
Item Description
Feature name DIM
Table name BlockParameters
Table type Multi-instance table
Row name BlockParameter
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ParameterNa String, case-insensitive.
Parameter name Index N/A
me Length: 1 to 63 characters.
Unsigned integer.
Denyperiod Deny period N/A Default is 1800s
Value range: 1 to 86400s.

DIM/CaptureParameters
This table contains capture parameters.

1
XML structure
<DIM>
<CaptureParameters>
<CaptureParameter>
<ParameterName></ParameterName>
<CaptureMax></CaptureMax>
<CaptureExceedURL></CaptureExceedURL>
<UploadTime></UploadTime>
</CaptureParameter>
</CaptureParameters>
</DIM>

Table description
Item Description
Feature name DIM
Table name CaptureParameters
Table type Multi-instance table
Row name CaptureParameter
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ParameterNa String, case-insensitive.
Parameter name Index N/A
me Length: 1 to 63 characters.

Max space for Unsigned integer.

CaptureMax N/A Default is 512 Kbytes
captured packets Value range: 0 to 1024
The URL while
the packets size String, case-insensitive.
CaptureExcee
exceeds the max N/A N/A
dURL Length: 1 to 255 characters.
space, they will
be sent to
Time when the Time.
UploadTime system sends N/A Default is 01:00:00
the packets Format: HH:MM:SS

DIM/LoggingParameters
This table contains logging parameters.

2
XML structure
<DIM>
<LoggingParameters>
<LoggingParameter>
<ParameterName></ParameterName>
<IsLogToHost></IsLogToHost>
<IsLogMail ></IsLogMail>
</LoggingParameter>
</LoggingParameters>
</DIM>

Table description
Item Description
Feature name DIM
Table name BlockParameters
Table type Multi-instance table
Row name BlockParameter
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ParameterNa String, case-insensitive.
Parameter name Index N/A
me Length: 1 to 63 characters.
Boolean:
Sending log to
IsLogToHost
host or not
N/A • true N/A
• false

Email the logs to Boolean:

IsLogMail an email server N/A • true N/A
or not • false

DIM/RedirectParameters
This table contains redirect parameters.

XML structure
<DIM>
<RedirectParameters>
<RedirectParameter>

3
 <ParameterName></ParameterName>
<url></url>
</RedirectParameter>
</RedirectParameters>
</DIM>

Table description
Item Description
Feature name DIM
Table name RedirectParameters
Table type Multi-instance table
Row name RedirectParameter
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ParameterNa String, case-insensitive.
Parameter name Index N/A
me Length: 1 to 63 characters.

Target URL for String, case-insensitive.

url N/A N/A
redirect Length: 1 to 255 characters.

DIM/MailParameters
This table contains mail parameters.

XML structure
<DIM>
<MailParameters>
<MailParameter>
<ParameterName></ParameterName>
<ServerAddr></ServerAddr>
<SrcMailAddr></SrcMailAddr>
<DstMailAddr></DstMailAddr>
<LocalDomain></LocalDomain>
<UserName></UserName>
<Password></Password>
<IsNeedAuthentication></IsNeedAuthentication>
<IsNeedSPA></IsNeedSPA>
</MailParameter>

4
 </MailParameters>
</DIM>

Table description
Item Description
Feature name DIM
Table name MailParameters
Table type Multi-instance table
Row name MailParameter
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ParameterNa String, case-insensitive.
Parameter name Index N/A
me Length: 1 to 63 characters.

Mail server’s String, case-insensitive.

ServerAddr N/A N/A
address Length: 1 to 63 characters.

Source mail String, case-insensitive.

SrcMailAddr N/A N/A
address Length: 1 to 63 characters.

Destination mail String, case-insensitive.

DstMailAddr N/A N/A
address Length: 1 to 511 characters.

Local domain String, case-insensitive.

LocalDomain N/A N/A
name Length: 1 to 63 characters.
String, case-insensitive.
UserName Mail user name N/A N/A
Length: 1 to 63 characters.
String, case-insensitive.
Password Password N/A N/A
Length: 1 to 63 characters.
Requires Boolean:
IsNeedAuthen authentication by
tication the mail server or
N/A • true N/A
not • false

Requires using Boolean:

IsNeedSPA SPA by the mail N/A • true N/A
server or not • false

DIM/ActivePercentage
This table contains active percentage.

5
XML structure
<DIM>
<ActivePercentage>
<Percentage></Percentage>
</ActivePercentage>
</DIM>

Table description
Item Description
Feature name DIM
Table name ActivePercentage
Table Type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
When the value range
Percentage of Unsigned integer: is 0 to 100,it means in
Percentage N/A
active. Value range: 0 to 100. active, Otherwise,
means error

DIM/InspectBypass
This table contains bypass information.

XML structure
<DIM>
<InspectBypass>
<BypassByConfig></BypassByConfig>
</InspectBypass>
</DIM>

Table description
Item Description
Feature name DIM
Table name InspectBypass
Table Type Single-instance table

6
 Item Description
Row name N/A
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
BypassByCon
fig
Value of bypass. N/A • true N/A
• false

DIM/ProxyServerParameters
This table contains information about DIM proxy server parameters.

XML structure
<DIM>
<ProxyServerParameters>
<ProxyServerParameter>
<ProxyAddress></ProxyAddress>
<ProxyPort></ProxyPort>
<UserName></UserName>
<PassWord></PassWord>
<ProxyServerParameter>
</ProxyServerParameters>
</DIM>

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

Columns
Column Column Data type and
Column name Remarks
description type restrictions
ProxyAddress Proxy server N/A String, case-insensitive N/A

7
 Column Column Data type and
Column name Remarks
description type restrictions
address Length: 3 to 63 characters.
Unsigned integer:
ProxyPort Proxy server port N/A N/A
Value range: 1 to 65535.
String, case-insensitive
UserName Proxy username N/A N/A
Length: 1 to 31 characters.
String, case-sensitive
PassWord Proxy password N/A N/A
Length: 1 to 31 characters.

DIM/DimFileUncompress
This table contains the maximum length of file uncompressing.

XML structure
<DIM>
<DimFileUncompress>
<Size></Size>
</DimFileUncompress>
</DIM>

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

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Maximum size Unsigned integer.
Size that can be N/A N/A
uncompressed Value range: 1 to 200MB.

DIM/DeviceInfo
This table contains the device node where main dpid running on.

8
XML structure
<DIM>
<DeviceInfo>
<ModuleName></ModuleName>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
</DeviceInfo>
</DIM>

Table description
Item Description
Feature name DIM
Table name DeviceInfo
Table type Multi-instance table
Row name N/A
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
The name of String.
ModuleName Index N/A
current module. Length: 1 to 63 characters..

Chassis of a Unsigned integer.

Chassis N/A N/A
node. Value range: 0 to 65535.
Unsigned integer.
Slot Slot of a node. N/A N/A
Value range: 0 to 65535.
Unsigned integer.
CPUID Cpu id of a node. N/A N/A
Value range: 0 to 65535.

9
Contents
DNS ······························································································1
DNS/DNSClearHost ····················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1

i
DNS
DNS/DNSClearHost
This table is used to clear DNS host entries.

XML structure
<DNS>
<DNSClearHost>
<ClearHost>
<VRF></VRF>
<Type></Type>
<QueryType></QueryType>
</ClearHost>
</DNSClearHost>
</DNS>

Table description
Item Description
Feature name DNS
Table name DNSClearHost
Table type Multi-instance table
Row name ClearHost
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case sensitive. If the DNS host is on the
VRF instance
VRF Index public network, the
name Length: 1 to 31 characters. length of characters is 0.
Domain Enumeration:
name-to-IP
Type
address mapping
Index • 1—Static. N/A
type • 2—Dynamic.

1
Column Column Column Data type and
Remarks
name description type restrictions
A type A query resolves
a domain name to the
mapped IPv4 address.
Enumeration: A type AAAA query
resolves a domain name
QueryType Query type Index • 1—A. to the mapped IPv6
• 2—AAAA. address.
If all the query type is set,
the length of the column
is 0.

2
Contents
DNS ······························································································1
DNS/DNSHost ····························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
DNS/DNSServer ·························································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 3
DNS/DNSDomain ························································································································ 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4
DNS/DNSConfig ·························································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 5
Columns ······························································································································ 5
DNS/DNSIfServer ························································································································ 5
XML structure ······················································································································· 5
Table description ··················································································································· 6
Columns ······························································································································ 6

i
DNS
DNS/DNSHost
This table contains DNS host configuration information.

XML structure
<DNS>
<DNSHost>
<Host>
<VRF></VRF>
<HostName></HostName>
<Type></Type>
<QueryType></QueryType>
<Result></Result>
</Host>
</DNSHost>
</DNS>

Table description
Item Description
Feature name DNS
Table name DNSHost
Table type Multi-instance table
Row name Host
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case sensitive. If the DNS host is on the
VRF instance
VRF Index public network, the
name Length: 1 to 31 characters. length of characters is 0.

String, case insensitive. It can include letters,

digits, hyphens (-),
HostName Host name Index Length: 1 to 253 underscores (_), and
characters. dots (.).

1
 Column Column Column Data type and
Remarks
name description type restrictions
Domain
name-to-IP Enumeration:
Type Index N/A
address mapping • 1—Static.
type
A type A query resolves
a domain name to the
Enumeration: mapped IPv4 address.
QueryType Query type Index • 1—A. A type AAAA query
• 2—AAAA. resolves a domain name
to the mapped IPv6
address.
Required.
String, case insensitive. An IPv4 address as
Result Replied result N/A QueryType is A, an IPv6
Length: 1 to 45 characters.
address as QueryType is
AAAA.

DNS/DNSServer
This table contains DNS server configuration information.

XML structure
<DNS>
<DNSServer>
<Server>
<VRF></VRF>
<Type></Type>
<AddressType></AddressType>
<IpAddress></IpAddress>
<IfIndex></IfIndex>
</Server>
</DNSServer>
</DNS>

Table description
Item Description
Feature name DNS
Table name DNSServer
Table type Multi-instance table
Row name Server
Restrictions None
Support for row creation and deletion Yes

2
Columns

Column Column Column Data type and

Remarks
name description type restrictions
String, case sensitive. If the DNS server is on
VRF instance
VRF Index the public network, the
name Length: 1 to 31 characters. length of characters is 0.

Enumeration:
Type DNS server type Index N/A
• 1—Static.
Enumeration:
AddressTyp Type of the DNS
e server IP address
Index • 1—IPv4. N/A
• 2—IPv6.
IPv4 address string as
IP address of the String, case insensitive. AddressType is IPv4,
IpAddress Index
DNS server Length: 1 to 45 characters. IPv6 address string as
AddressType is IPv6.
Must and can only be
specified when the IPv6
address of the DNS
server is a link-local
address.
Some versions support
Output interface interface name. For
IfIndex Index Unsigned integer. relevant information, see
Index
the XSD document of
your product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

DNS/DNSDomain
This table contains domain name suffix configuration information.

XML structure
<DNS>
<DNSDomain>
<Domain>
<VRF></VRF>
<Type></Type>
<DomainName></DomainName>
</Domain>
</DNSDomain>
</DNS>

3
Table description
Item Description
Feature name DNS
Table name DNSDomain
Table type Multi-instance table
Row name Domain
Restrictions None
Support for row creation and deletion Yes

Columns

Column Column Column Data type and

Remarks
name description type restrictions
If the domain name suffix
VRF instance String, case sensitive. is on the public network,
VRF Index
name Length: 1 to 31 characters. the length of characters
is 0.

Domain name Enumeration:

Type Index N/A
suffix type • 1—Static.
It is a dot-separated,
case-insensitive string
that can include letters,
digits, hyphens (-),
underscores (_), and
String, case insensitive. dots (.) (for example,
DomainNam Domain name
Index Length: 1 to 253 aabbcc.com). The
e suffix
characters. domain name suffix can
include at most 253
characters, and each
separated string includes
no more than 63
characters.

DNS/DNSConfig
This table contains DNS configuration information.

XML structure
<DNS>
<DNSConfig>
<DNSProxyEnable></DNSProxyEnable>
<DNSDSCP></DNSDSCP>
<DNSDSCP6></DNSDSCP6>
</DNSConfig>
</DNS>

4
Table description
Item Description
Feature name DNS
Table name DNSConfig
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 Boolean: Support for this function
DNSProxyE
nable
function of DNS N/A • true depends on the device
proxy is enabled • false(default) model.

DSCP value for Unsigned integer.

DNS packets sent
DNSDSCP N/A Value range: 0 to 63. N/A
by a DNS client or
DNS proxy Default: 0.

DSCP value for

IPv6 DNS packets Unsigned integer.
DNSDSCP6 sent by an IPv6 N/A Value range: 0 to 63. N/A
DNS client or DNS Default: 0.
proxy

DNS/DNSIfServer
This table contains DNS server of interface information.

XML structure
<DNS>
<DNSIfServer>
<Server>
<IfIndex></IfIndex>
<VRF></VRF>
<Type></Type>
<AddressType></AddressType>
<IpAddress></IpAddress>
<IfIndexOut></IfIndexOut>
</Server>
</DNSIfServer>
</DNS>

5
Table description
Item Description
Feature name DNS
Table name DNSIfServer
Table type Multi-instance table
Row name Server
Restrictions None
Support for row creation and deletion Yes

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 product.

String, case sensitive. If the DNS server is on

VRF instance
VRF Index the public network, the
name Length: 1 to 31 characters. length of characters is 0.
Enumeration:
Type DNS server type Index N/A
• 1—Static.
Enumeration:
AddressTyp Type of the DNS
e server IP address
Index • 1—IPv4. N/A
• 2—IPv6.
IPv4 address string as
IP address of the String, case insensitive. AddressType is IPv4,
IpAddress Index
DNS server Length: 1 to 45 characters. IPv6 address string as
AddressType is IPv6.

Must and can only be

specified when the IPv6
address of the DNS
server is a link-local
address.
Some versions support
Output interface interface name. For
IfIndexOut Index Unsigned integer. relevant information, see
Index
the XSD document of
your product. For
information about
IfIndex, see IfMgr in
Ifmgr NETCONF XML
API Configuration
Reference.

6
Contents
DNS ······························································································1
DNS/DNSHost ····························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
DNS/DNSServer ·························································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 3
Columns ······························································································································ 3
DNS/DNSDomain ························································································································ 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4
DNS/DNSConfig ·························································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 5
DNS/DNSSpecification ·················································································································· 5
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 6
DNS/DNSIfServer ························································································································ 6
XML structure ······················································································································· 6
Table description ··················································································································· 7
Columns ······························································································································ 7

i
DNS
DNS/DNSHost
This table contains DNS host information.

XML structure
<DNS>
<DNSHost>
<Host>
<VRF></VRF>
<HostName></HostName>
<Type></Type>
<QueryType></QueryType>
<AgeTime></AgeTime>
<Result></Result>
</Host>
</DNSHost>
</DNS>

Table description
Item Description
Feature name DNS
Table name DNSHost
Table type Multi-instance table
Row name Host
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case sensitive. If the DNS host is on the
VRF instance
VRF Index public network, the
name Length: 1 to 31 characters. length of characters is 0.

String, case insensitive. It can include letters,

digits, hyphens (-),
HostName Host name Index Length: 1 to 253 underscores (_), and
characters. dots (.).

1
 Column Column Column Data type and
Remarks
name description type restrictions
Domain Enumeration:
name-to-IP
Type
address mapping
Index • 1—Static. N/A
type • 2—Dynamic.

A type A query resolves

a domain name to the
Enumeration: mapped IPv4 address.
QueryType Query type Index • 1—A. A type AAAA query
• 2—AAAA. resolves a domain name
to the mapped IPv6
address.
Time in seconds Unsigned integer.
that a mapping No aging time for a static
AgeTime N/A Value range: 1 to 65535
can be stored in mapping.
the cache. seconds.

IPv4 address string as

QueryType is A, IPv6
address string as
QueryType is AAAA.
Seperated by space if
Result Replied result N/A String, case insensitive. there are multiple
addresses.
Example:
1.1.1.1 2.2.2.2 3.3.3.3.
1::1 2::2 3::3.

DNS/DNSServer
This table contains DNS server information.

XML structure
<DNS>
<DNSServer>
<Server>
<VRF></VRF>
<Type></Type>
<AddressType></AddressType>
<IpAddress></IpAddress>
<IfIndex></IfIndex>
<Priority></Priority>
</Server>
</DNSServer>
</DNS>

2
Table description
Item Description
Feature name DNS
Table name DNSServer
Table type Multi-instance table
Row name Server
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case sensitive. If the DNS server is on
VRF instance
VRF Index the public network, the
name Length: 1 to 31 characters. length of characters is 0.

Enumeration:
Type DNS server type Index • 1—Static. N/A
• 2—Dynamic.
Enumeration:
AddressTyp Type of the DNS
e server IP address
Index • 1—IPv4. N/A
• 2—IPv6.
IPv4 address string as
IP address of the String, case insensitive. AddressType is IPv4,
IpAddress Index
DNS server Length: 1 to 45 characters. IPv6 address string as
AddressType is IPv6.
Equal 0 if AddressType
Output interface
IfIndex Index Unsigned integer. is 1or the IpAddress is
Index
not a link-local address.

The lower the value, the

greater the priority.
Priority of DNS Unsigned integer. The priority indicates
Priority N/A
server Value range: 0 to 5. query sequence when
resolving a domain
name.

DNS/DNSDomain
This table contains domain name suffix information.

XML structure
<DNS>
<DNSDomain>
<Domain>
<VRF></VRF>

3
 <Type></Type>
<DomainName></DomainName>
<Priority></Priority>
</Domain>
</DNSDomain>
</DNS>

Table description
Item Description
Feature name DNS
Table name DNSDomain
Table type Multi-instance table
Row name Domain
Restrictions None

Columns

Column Column Column Data type and

Remarks
name description type restrictions
If the domain name suffix
VRF instance String, case sensitive. is on the public network,
VRF Index
name Length: 1 to 31 characters. the length of characters
is 0.
Enumeration:
Domain name
Type
suffix type
Index • 1—Static. N/A
• 2—Dynamic.
It is a dot-separated,
case-insensitive string
that can include letters,
digits, hyphens (-),
underscores (_), and
String, case insensitive. dots (.) (for example,
DomainNam Domain name
Index Length: 1 to 253 aabbcc.com). The
e suffix
characters. domain name suffix can
include at most 253
characters, and each
separated string includes
no more than 63
characters.
The lower the value, the
greater the priority.
Priority of domain Unsigned integer. The priority indicates
Priority N/A
name suffix Value range: 0 to 15. query sequence when
resolving a domain
name.

4
DNS/DNSConfig
This table contains DNS configuration information.

XML structure
<DNS>
<DNSConfig>
<DNSProxyEnable></DNSProxyEnable>
<DNSDSCP></DNSDSCP>
<DNSDSCP6></DNSDSCP6>
</DNSConfig>
</DNS>

Table description
Item Description
Feature name DNS
Table name DNSConfig
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: Support for this function
DNSProxyE
nable
function of DNS N/A • true depends on the device
proxy is enabled • False model.

DSCP value for

DNS packets sent Unsigned integer.
DNSDSCP N/A N/A
by a DNS client or Value range: 0 to 63.
DNS proxy

DSCP value for

IPv6 DNS packets Unsigned integer.
DNSDSCP6 sent by an IPv6 N/A N/A
DNS client or DNS Value range: 0 to 63.
proxy

DNS/DNSSpecification
This table contains DNS specification information.

5
XML structure
<DNS>
<DNSSpecification>
<SupportDNSProxy></SupportDNSProxy>
</DNSSpecification>
</DNS>

Table description
Item Description
Feature name DNS
Table name DNSSpecification
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:
SupportDNS function of DNS
Proxy proxy is
N/A • true N/A
supported. • false

DNS/DNSIfServer
This table contains DNS server of interface information.

XML structure
<DNS>
<DNSIfServer>
<Server>
<IfIndex></IfIndex>
<VRF></VRF>
<Type></Type>
<AddressType></AddressType>
<IpAddress></IpAddress>
<IfIndexOut></IfIndexOut>
<Priority></Priority>
</Server>
</DNSIfServer>

6
 </DNS>

Table description
Item Description
Feature name DNS
Table name DNSIfServer
Table type Multi-instance table
Row name Server
Restrictions None

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 product.

String, case sensitive. If the DNS server is on

VRF instance
VRF Index the public network, the
name Length: 1 to 31 characters. length of characters is 0.
Enumeration:
Type DNS server type Index • 1—Static. N/A
• 2—Dynamic.
Enumeration:
AddressTyp Type of the DNS
e server IP address
Index • 1—IPv4. N/A
• 2—IPv6.
IPv4 address string as
IP address of the String, case insensitive. AddressType is IPv4,
IpAddress Index
DNS server Length: 1 to 45 characters. IPv6 address string as
AddressType is IPv6.
Equal 0 if AddressType
Output interface
IfIndexOut Index Unsigned integer. is 1or the IpAddress is
Index
not a link-local address.
The lower the value, the
greater the priority.
Priority of DNS Unsigned integer. The priority indicates
Priority N/A
server Value range: 0 to 5. query sequence when
resolving a domain
name.

7
Contents
DNS ······························································································1
DNS/DNSHost ····························································································································· 1
DNS/DNSServer ·························································································································· 1
DNS/DNSDomain ························································································································ 2
DNS/DNSConfig ·························································································································· 2

i
DNS
DNS/DNSHost
Message Explanation
Invalid host name. Invalid host name configuration.
Maximum number of VRFs already reached. ,please check
Maximum number of VRFs already reached.
configuration or specifications.
Maximum number of IPv4 DNS entries Maximum number of IPv4 DNS entries already reached,
already reached. please check configuration or specifications.
Failed to create the IPv4 DNS entry, please modify
Failed to create the IPv4 DNS entry.
configuration under guidance.
Invalid IPv6 address. nvalid IPv6 address configuration.
The configuration doesn't meet the Invalid configuration, please modify configuration under
requirements. guidance.
The configuration doesn't meet the Invalid configuration, please modify configuration under
requirements. guidance.
Maximum number of IPv6 DNS entries Maximum number of IPv6 DNS entries already
already reached. reached ,please check configuration or specifications
Failed to create the IPv6 DNS entry, please modify
Failed to create the IPv6 DNS entry.
configuration under guidance.

DNS/DNSServer
Message Explanation
Maximum number of VRFs already reached, please check
Maximum number of VRFs already reached.
configuration or specifications.

Maximum number of DNS servers already Maximum number of DNS servers already reached.
reached. , please check configuration or specifications.
Failed to specify the DNS server, please modify
Failed to specify the DNS server.
configuration under guidance.
An output interface must be specified when
Invalid configuration, please modify configuration under
the IPv6 address of the DNS server is a
guidance.
link-local address.
An output interface is not configurable when
Invalid configuration, please modify configuration under
the IPv6 address of the DNS server is a
guidance.
global unicast address.
Invalid IPv6 address. Invalid IPv6 address configuration.
Failed to specify the IPv6 DNS server, please modify
Failed to specify the IPv6 DNS server.
configuration under guidance.
The configuration doesn't meet the Invalid configuration, please modify configuration under
requirements. guidance.

1
An output interface is not configurable when
Invalid configuration, please modify configuration under
you specify a DNS server by its IPv4
guidance.
address.

DNS/DNSDomain
Message Explanation
Maximum number of VRFs already reached, please check
Maximum number of VRFs already reached.
configuration or specifications.
Invalid configuration, please modify configuration under
Invalid domain name suffix.
guidance.
Invalid configuration, please modify configuration under
Failed to create the domain name suffix.
guidance.
Maximum number of domain name suffixes Maximum number of domain name suffixes already
already reached. reached, please check configuration or specifications.

DNS/DNSConfig
Message Explanation
Failed to enable DNS proxy, please modify configuration
Failed to enable DNS proxy.
under guidance.

2
Contents
Domain············································································································ 1
Domain/Domains ··············································································································································· 1
XML structure ············································································································································· 1
Table description ········································································································································ 1
Columns ····················································································································································· 1
Domain/ResetUserRecords ······························································································································· 1
XML structure ············································································································································· 1
Table description ········································································································································ 2
Columns ····················································································································································· 2

i
Domain
Domain/Domains
Domain status table.

XML structure
<Domain>
<Domains>
<Domain>
<DomainName></DomainName>
<State></State>
</Domain>
</Domains>
</Domain>

Table description
Item Description
Feature name Domain
Table name Domains
Table type Multi-instance table
Row name Domain
Restrictions None

Columns
Column Column Column
Data type and restrictions
name description type
String, case-insensitive.
DomainName Domain name Index
Length: 1 to 255 characters.
Enumeration:
Status of the
State
domain
N/A • 0—Block.
• 1—Active.

Domain/ResetUserRecords
This table clears user online or offline records.

XML structure
<Domain>

1
 <ResetUserRecords>
<RecordType></RecordType>
</ResetUserRecords>
</Domain>

Table description
Item Description
Feature name Domain
Table name ResetUserRecords
Table type Single-instance table
Row name ResetUserRecord
Restrictions None

Columns
Colu
Data type and
Column name Column description mn
restrictions
type
Enumeration:
• 0—Abnormal offline records.
Type of user records to
RecordType
be cleared
Index • 1—Normal offline records.
• 2—Offline records.
• 3—Online failure records.

2
Contents
Domain ··························································································1
Domain/GlobalConfig ·················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Domain/SessionLimit ·················································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
Domain/Domains ······················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
Domain/Schemes······················································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7
Domain/BroadcastSchemes ········································································································· 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
Domain/EnableAbnormalOfflineRecords ······················································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
Domain/EnableNormalOfflineRecords ·························································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 12
Domain/EnableOfflineRecords ···································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 12
Domain/EnableOnlineFailRecords ······························································································· 12
XML structure ··················································································································· 13
Table description ··············································································································· 13
Columns ·························································································································· 13

i
Domain
Domain/GlobalConfig
Global domain configuration information table.

XML structure
<Domain>
<GlobalConfig>
<DefaultDomain></DefaultDomain>
<IfUnknownDomain></IfUnknownDomain>
</GlobalConfig>
</Domain>

Table description
Item Description
Feature name Domain
Table name GlobalConfig
Table type Single-instance table
Row name None
Restrictions A maximum of 16 domains can be created.
Support for row creation and
No
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
By default, the default
DefaultDomai String, case-insensitive. domain is the
Default domain. N/A
n Length: 1 to 255 characters. predefined domain
named system.

ISP domain that String, case-insensitive.

accommodates Length: 1 to 255 characters.
IfUnknownDo
users assigned N/A The domain name can't N/A
main
to nonexistent contain the following
domains. characters: \ | / : * ? " < > @

Domain/SessionLimit
The maximum number of concurrent users that can log on to the device through the specified
method.

1
XML structure
<Domain>
<SessionLimit>
<Ftp></Ftp>
<Telnet></Telnet>
<Http></Http>
<Ssh></Ssh>
<Https></Https>
</SessionLimit>
</Domain>

Table description
Item Description
Feature name Domain
Table name SessionLimit
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
Default: 32.

Maximum • In non-FIPS mode,

number of Unsigned integer. the value for this
Ftp N/A column can take
concurrent FTP Value range: 1 to 64.
users. effect.
• In FIPS mode, this
column is ignored.
Default: 32.

Maximum • In non-FIPS mode,

number of Unsigned integer. the value for this
Telnet N/A column can take
concurrent Value range: 1 to 32.
Telnet users. effect.
• In FIPS mode, this
column is ignored.
Default: 32.

Maximum • In non-FIPS mode,

number of Unsigned integer. the value for this
Http N/A column can take
concurrent HTTP Value range: 1 to 64.
users. effect.
• In FIPS mode, this
column is ignored.

2
 Column Column Column
Data type and restrictions Remarks
name description type
Maximum
number of Unsigned integer.
Ssh N/A Default: 32.
concurrent SSH Value range: 1 to 32.
users.
Maximum
number of Unsigned integer.
Https N/A Default: 32.
concurrent Value range: 1 to 64.
HTTPS users.

Domain/Domains
Basic domain information table.

XML structure
<Domain>
<Domains>
<Domain>
<DomainName></DomainName>
<SessTimeIncldeIdle></SessTimeIncldeIdle>
<AcctStartFailAction></AcctStartFailAction>
<ServiceType></ServiceType>
<UserAddrType></UserAddrType>
<AuthorAttrs>
<IdleTime></IdleTime>
<IdleFlow></IdleFlow>
<ProfileName></ProfileName>
<IpPoolName></IpPoolName>
<Ipv6PoolName></Ipv6PoolName>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
<PrimDnsIpaddr></PrimDnsIpaddr>
<PrimDnsIpv6addr></PrimDnsIpv6addr>
<SecDnsIpaddr></SecDnsIpaddr>
<SecDnsIpv6addr></SecDnsIpv6addr>
<PortalUrl></PortalUrl>
<VRF></VRF>
<IgmpMaxAccessNum></IgmpMaxAccessNum>
<MldMaxAccessNum></MldMaxAccessNum>
<SessTimeOut></SessTimeOut>
<InboundUserPriority></InboundUserPriority>
<OutboundUserPriority></OutboundUserPriority>
</AuthorAttrs>
</Domain>
</Domains>
</Domain>

3
Table description
Item Description
Feature name Domain
Table name Domains
Table type Multi-instance table
Row name Domain
A maximum of 16 domains can be created. The domain
Restrictions
named system is predefined and can't be deleted.
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Domain name String, case-insensitive. A predefined domain
Length: 1 to 255 characters. named system exists.
DomainName Index The domain name can't
contain the following
characters: \ | / : * ? " < > @
Whether to Boolean: Default: false.
include the idle • true—The idle cut period Only portal users
cut period or or user online detection support the user online
user online period is included in the detection period.
detection period user online duration to be
SessTimeIncl in the user online N/A sent to the server.
deIdle duration to be
sent to the server • false—The idle cut period
or user online detection
period is excluded from
the user online duration to
be sent to the server.
Access control Enumeration:
for users that
AcctStartFail
encounter N/A • 0—Allow the users to stay Default: 0.
Action online.
accounting-start
failures • 1—Log off the users.

Service type of Enumeration: Default: 0.

the domain • 0—High-Speed Internet
(HSI) service.
ServiceType N/A • 1—Set Top Box (STB)
service.
• 2—Voice over IP (VoIP)
service.
User address Enumeration: N/A
type of the • 0—public-ipv4.
domain
UserAddrTyp • 1—private-ipv4.
N/A
e • 2—public-ds.
• 3—private-ds.
• 4—ds-lite.

4
 • 5—ipv6.
• 6—nat64.
Authorization Members include: N/A
attributes • IdleTime.
• IdleFlow.
• ProfileName.
• IpPoolName.
• Ipv6PoolName.
• Ipv6Address.
• Ipv6PrefixLength.
Data
AuthorAttrs
structure • PrimDnsIpaddr.
• PrimDnsIpv6addr.
• SecDnsIpaddr.
• SecDnsIpv6addr.
• PortalUrl.
• VRF.
• IgmpMaxAccessNum.
• MldMaxAccessNum.
• SessTimeOut.
Idle timeout Unsigned integer. N/A
IdleTime period N/A Value range: 1 to 600, in
minutes.
The minimum Unsigned integer. Default: 10240 bytes.
traffic that must Value range: 1 to 10240000, in
IdleFlow be generated in N/A bytes.
the idle timeout
period
User profile String, case-sensitive. Valid characters include
name Length: 1 to 31 characters. letters, digits, and
underscores (_). The
ProfileName N/A
name must start with a
letter and must be
unique.
IPv4 address String, case-sensitive. N/A
IpPoolName pool name N/A
Length: 1 to 31 characters.

Ipv6PoolNam IPv6 address String, case-sensitive. N/A

pool name N/A
e Length: 1 to 63 characters.
IPv6 address for Hexadecimal string, For example,
Ipv6Address specifying the N/A colon-separated. 2001:12::22:33.
prefix

Ipv6PrefixLen IPv6 prefix length Unsigned integer. N/A

N/A
gth Value range: 1 to 128.
IPv4 address of
PrimDnsIpad IPv4: String, dotted decimal IPv4 example:
the primary DNS N/A
dr notation. 10.1.1.1.
server
IPv6 address of
PrimDnsIpv6 IPv6 example:
the primary DNS N/A IPv6: Hexadecimal string.
addr 2001:12::22:33.
server
IPv4 address of
SecDnsIpadd IPv4: String, dotted decimal IPv4 example:
the secondary N/A
r notation. 10.1.1.1.
DNS server

5
 IPv6 address of
SecDnsIpv6a IPv6 example:
the secondary N/A IPv6: Hexadecimal string.
ddr 2001:12::22:33.
DNS server
Portal redirect String, case-sensitive. N/A
PortalUrl URL N/A
Length: 1 to 255 characters.
VPN instance String, case-sensitive. N/A
VRF name N/A
Length: 1 to 31 characters.
The maximum Unsigned integer. Default: 4.
number of IGMP Value range: 1 to 64.
IgmpMaxAcc
groups that an N/A
essNum
IPv4 user can
join concurrently
The maximum Unsigned integer. Default: 4.
number of MLD Value range: 1 to 64.
MldMaxAcces
groups that an N/A
sNum
IPv6 user can
join concurrently
Session timeout Unsigned integer. Users are logged off
timer Value range: 1 to 4294967295. when the session
SessTimeOut N/A
timeout timer expires
for the users.

InboundUser Inbound user Unsigned integer. N/A

priority N/A
Priority Value range: 0 to 7.

OutboundUse Outbound user Unsigned integer. N/A

priority N/A
rPriority Value range: 0 to 7.

Domain/Schemes
Domain scheme table.

XML structure
<Domain>
<Schemes>
<Scheme>
<DomainName></DomainName>
<AaaType></AaaType>
<AccessType></AccessType>
<SchemeList></SchemeList>
<SchemeNameList></SchemeNameList>
</Scheme>
</Schemes>
</Domain>

Table description
Item Description
Feature name Domain
Table name Schemes

6
 Table type Multi-instance table
Row name Scheme
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-insensitive.
DomainName Domain name. Index N/A
Length: 1 to 255 characters.
Enumeration:
• 0—Authentication.
AaaType AAA type. Index
• 4—Authorization.
• 5—Accounting.
Enumeration:
• 0—Login.
• 1—Super.
• 2—Command.
• 3—LAN access.
• 4—PPP.
AccessType Access type. Index
• 5—Default.
• 6—Portal.
• 7—IKE.
• 8—IPoE. There are some
• 9—SSL VPN. restrictions among the
• 10—ADVPN. column AccessType,
the column AaaType,
String. and the column
Length: 1 to 9 characters, SchemeList. Those
using the format of 1-2-4. restrictions will be
described in the
The hyphen (-) is used to
Restrictions section
separate the digits that
below the table.
represent different AAA
methods, including:
• 1—HWTACACS.
• 2—RADIUS.
AAA method • 3—LDAP.
SchemeList N/A
types. • 4—Local.
• 5—None.
The string 1-2-4 indicates that
HWTACACS is specified as
the primary authentication,
authorization, or accounting
method. If the HWTACACS
method fails, the RADIUS
method applies. If the RADIUS
method fails, the local method
applies.

SchemeNam Scheme name N/A String, case-insensitive. If this column is not

7
 Column Column Column
Data type and restrictions Remarks
name description type
eList list. Length: 0 to 68 characters, available, no schemes
may contain 0 to 2 scheme are specified.
names.
Every scheme name contains
two parts: Scheme name
length and scheme name
string.
The scheme name is in the
format of xxmm……mm.
• The xx argument
represents the scheme
name length. Use two
digits to set the scheme
name length.
• The mm……mm
argument represents the
scheme name string. The
string is 1 to 32
characters.
For example:
• The string 08abcdefgh
represents a scheme
whose name is abcdefgh
and whose name length is
8 characters.
• The string
10testtestte04test
represents two schemes.
One scheme is named as
testtestte and the name
length is 10 characters.
The other scheme is
named as test and the
name length is 4
characters.

Restrictions:
• The letter Y indicates that a specific access type supports a specific method for authentication,
authorization, or accounting.
• You can specify one primary method and multiple backup methods for authentication,
authorization, or accounting. An AAA method with a lower level can be the backup of another
method that has a higher level. The following list arranges the methods from high level to low
level:
 RADIUS, TACACS, and LDAP.
 Local.
 None.
Among the highest-level methods, the RADIUS method and TACACS method can be the
backup of each other.
• In FIPS mode, all access types can't use the none method for authentication, authorization, or
accounting.
AAA method RADIUS TACACS LDAP Local None
(level) (3) (3) (3) (2) (1)
Access type

8
 +AAA type
Default Authentication Y Y Y Y Y
Authorization Y Y Y Y
Accounting Y Y Y Y
Login Authentication Y Y Y Y Y
Authorization Y Y Y Y
Accounting Y Y Y Y
Super Authentication Y Y
Command Authorization Y Y Y
Accounting Y
LAN Authentication Y Y Y Y
access
(MAC Authorization Y Y Y
authenticat Accounting Y Y Y
ion or
802.1X)
PPP Authentication Y Y Y Y
Authorization Y Y Y Y
Accounting Y Y Y Y
Portal Authentication Y Y Y Y
Authorization Y Y Y
Accounting Y Y Y
IKE Authentication Y Y Y
IPoE Authentication Y Y Y
Authorization Y Y Y
Accounting Y Y Y
SSL VPN Authentication Y Y Y Y
Authorization Y Y Y Y
Accounting Y Y Y
ADVPN Authentication Y Y Y
Authorization Y Y Y
Accounting Y Y Y

Domain/BroadcastSchemes
RADIUS broadcast scheme table for a domain.

XML structure
<Domain>
<BroadcastSchemes>
<BroadcastScheme>
<DomainName></DomainName>

9
 <AccessType></AccessType>
<SchemeName></SchemeName>
</BroadcastScheme>
</BroadcastSchemes>
</Domain>

Table description
Item Description
Feature name Domain
Table name BroadcastSchemes
Table type Multi-instance table
Row name BroadcastScheme
Configure this table only for domains that have been
Restrictions
configured RADIUS accounting.
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Domain name. String, case-insensitive.
Length: 1 to 255 characters.
DomainName Index The name can't contain the N/A
following characters: \ | / : * ? "
<>@
Access type. Enumeration:
• 3—LAN access.
AccessType Index • 4—PPP. At present, only one
• 6—Portal. RADIUS broadcast
scheme is supported for
• 8—IPoE.
a domain.
SchemeNam RADIUS scheme String.
name. Index
e Length: 1 to 32 characters.

Domain/EnableAbnormalOfflineRecords
This table controls the enabling status of the user abnormal offline recording feature.

XML structure
<Domain>
<EnableAbnormalOfflineRecords>
<Enable></Enable>
</EnableAbnormalOfflineRecords>
</Domain>

10
Table description
Item Description
Feature name Domain
Table name EnableAbnormalOfflineRecords
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
Whether to Boolean:
enable the user The default varies by
Enable
abnormal offline
N/A • true—Enable. device model.
recording feature • false—Disable.

Domain/EnableNormalOfflineRecords
This table controls the enabling status of the user normal offline recording feature.

XML structure
<Domain>
<EnableNormalOfflineRecords>
<Enable></Enable>
</EnableNormalOfflineRecords>
</Domain>

Table description
Item Description
Feature name Domain
Table name EnableNormalOfflineRecords
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and
No
deletion

11
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Whether to Boolean:
enable the user The default varies by
Enable
normal offline
N/A • true—Enable. device model.
recording feature • false—Disable.

Domain/EnableOfflineRecords
This table controls the enabling status of the user offline recording feature.

XML structure
<Domain>
<EnableOfflineRecords>
<Enable></Enable>
</EnableOfflineRecords>
</Domain>

Table description
Item Description
Feature name Domain
Table name EnableOfflineRecords
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
Whether to Boolean:
enable the user The default varies by
Enable
offline recording
N/A • true—Enable. device model.
feature • false—Disable.

Domain/EnableOnlineFailRecords
This table controls the enabling status of the user online failure recording feature.

12
XML structure
<Domain>
<EnableOnlineFailRecords>
<Enable></Enable>
</EnableOnlineFailRecords>
</Domain>

Table description
Item Description
Feature name Domain
Table name EnableOnlineFailRecords
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
Whether to Boolean:
enable the user The default varies by
Enable
online failure
N/A • true—Enable. device model.
recording feature • false—Disable.

13
Contents
Domain ··························································································1
Domain/GlobalConfig ·················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Domain/SessionLimit ·················································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
Domain/Domains ······················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
Domain/Schemes······················································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 7
Columns ···························································································································· 7
Domain/BroadcastSchemes ········································································································· 9
XML structure ··················································································································· 10
Table description ··············································································································· 10
Columns ·························································································································· 10
Domain/Specification ················································································································ 10
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 11
Domain/UserAbnormalOfflineRecords ·························································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 13
Columns ·························································································································· 13
Domain/UserNormalOfflineRecords ····························································································· 14
XML structure ··················································································································· 14
Table description ··············································································································· 15
Columns ·························································································································· 15
Domain/UserOfflineRecords ······································································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 17
Columns ·························································································································· 17
Domain/UserOnlineFailRecords ·································································································· 18
XML structure ··················································································································· 18
Table description ··············································································································· 19
Columns ·························································································································· 19
Domain/EnableAbnormalOfflineRecords ······················································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 21
Domain/EnableNormalOfflineRecords ·························································································· 21
XML structure ··················································································································· 21
Table description ··············································································································· 21
Columns ·························································································································· 21
Domain/EnableOfflineRecords ···································································································· 22
XML structure ··················································································································· 22
Table description ··············································································································· 22
Columns ·························································································································· 22
Domain/EnableOnlineFailRecords ······························································································· 22
XML structure ··················································································································· 22
Table description ··············································································································· 23
Columns ·························································································································· 23

1
Domain
Domain/GlobalConfig
Global domain configuration information table.

XML structure
<Domain>
<GlobalConfig>
<DefaultDomain></DefaultDomain>
<IfUnknownDomain></IfUnknownDomain>
</GlobalConfig>
</Domain>

Table description
Item Description
Feature name Domain
Table name GlobalConfig
Table type Single-instance table
Row name None
Restrictions A maximum of 16 domains can be created.

Columns
Column Column Column
Data type and restrictions Remarks
name description type
By default, the default
DefaultDomai String, case-insensitive. domain is the
Default domain. N/A
n Length: 1 to 255 characters. predefined domain
named system.

ISP domain that String, case-insensitive.

accommodates Length: 1 to 255 characters.
IfUnknownDo
main
users assigned N/A The domain name cannot N/A
to nonexistent contain the following
domains. characters: \ | / : * ? " < > @

Domain/SessionLimit
The maximum number of concurrent users that can log on to the device through the specific
method.

1
XML structure
<Domain>
<SessionLimit>
<Ftp></Ftp>
<Telnet></Telnet>
<Http></Http>
<Ssh></Ssh>
<Https></Https>
</SessionLimit>
</Domain>

Table description
Item Description
Feature name Domain
Table name SessionLimit
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Default: 32.

Maximum • In non-FIPS mode,

number of Unsigned integer. the value for this
Ftp N/A column can take
concurrent FTP Value range: 1 to 64.
users. effect.
• In FIPS mode, this
column is ignored.
Default: 32.

Maximum • In non-FIPS mode,

number of Unsigned integer. the value for this
Telnet N/A column can take
concurrent Value range: 1 to 32.
Telnet users. effect.
• In FIPS mode, this
column is ignored.
Default: 32.

Maximum • In non-FIPS mode,

number of Unsigned integer. the value for this
Http N/A column can take
concurrent HTTP Value range: 1 to 64.
users. effect.
• In FIPS mode, this
column is ignored.
Maximum Unsigned integer.
Ssh number of N/A Default: 32.
concurrent SSH Value range: 1 to 32.

2
 Column Column Column
Data type and restrictions Remarks
name description type
users.
Maximum
number of Unsigned integer.
Https N/A Default: 32.
concurrent Value range: 1 to 64.
HTTPS users.

Domain/Domains
Basic domain information table.

XML structure
<Domain>
<Domains>
<Domain>
<DomainName></DomainName>
<SessTimeIncldeIdle></SessTimeIncldeIdle>
<State></State>
<AcctStartFailAction></AcctStartFailAction>
<ServiceType></ServiceType>
<UserAddrType></UserAddrType>
<AuthorAttrs>
<IdleTime></IdleTime>
<IdleFlow></IdleFlow>
<ProfileName></ProfileName>
<IpPoolName></IpPoolName>
<Ipv6PoolName></Ipv6PoolName>
<Ipv6Address></Ipv6Address>
<Ipv6PrefixLength></Ipv6PrefixLength>
<PrimDnsIpaddr></PrimDnsIpaddr>
<PrimDnsIpv6addr></PrimDnsIpv6addr>
<SecDnsIpaddr></SecDnsIpaddr>
<SecDnsIpv6addr></SecDnsIpv6addr>
<PortalUrl></PortalUrl>
<VRF></VRF>
<IgmpMaxAccessNum></IgmpMaxAccessNum>
<MldMaxAccessNum></MldMaxAccessNum>
<SessTimeOut></SessTimeOut>
<InboundUserPriority></InboundUserPriority>
<OutboundUserPriority></OutboundUserPriority>
</AuthorAttrs>
</Domain>
</Domains>
</Domain>

3
Table description
Item Description
Feature name Domain
Table name Domains
Table type Multi-instance table
Row name Domain
A maximum of 16 domains can be created. The domain
Restrictions
named system is predefined and cannot be deleted.

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Domain name String, case-insensitive. A predefined domain
Length: 1 to 255 characters. named system exists.
DomainName Index The domain name cannot
contain the following
characters: \ | / : * ? " < > @
Whether to Boolean: Default: false.
include the idle • True—The idle cut period Only portal users
cut period or or user online detection support the user online
user online period is included in the detection period.
detection period user online duration to be
SessTimeIncl in the user online sent to the server.
duration to be N/A
deIdle • False—The idle cut
sent to the server
period or user online
detection period is
excluded from the user
online duration to be sent
to the server.
Status of the Boolean: Default: 1.
State domain N/A • 0—Blocked.
• 1—Active.
Access control Boolean: Default: 0.
for users that • 0—Allow the users to stay
AcctStartFail
encounter N/A online.
Action
accounting-start
failures • 1—Log off the users.

Service type of Enumeration: Default: 0.

the domain • 0—High-Speed Internet
(HSI) service.
ServiceType N/A • 1—Set Top Box (STB)
service.
• 2—Voice over IP (VoIP)
service.
User address Enumeration: N/A
UserAddrTyp type of the • 0—public-ipv4.
domain N/A
e • 1—private-ipv4.
• 2—public-ds.

4
Column Column Column
Data type and restrictions Remarks
name description type
• 3—private-ds.
• 4—ds-lite.
• 5—ipv6.
• 6—nat64.
Authorization Members include: N/A
attributes • IdleTime.
• IdleFlow.
• ProfileName.
• IpPoolName.
• Ipv6PoolName.
• Ipv6Address.
• Ipv6PrefixLength.
Data
AuthorAttrs
structure • PrimDnsIpaddr.
• PrimDnsIpv6addr.
• SecDnsIpaddr.
• SecDnsIpv6addr.
• PortalUrl.
• VRF.
• IgmpMaxAccessNum.
• MldMaxAccessNum.
• SessTimeOut.
Idle timeout Unsigned integer. N/A
IdleTime period N/A Value range: 1 to 600, in
minutes.
The minimum Unsigned integer. Default: 10240 bytes.
traffic that must Value range: 1 to 10240000, in
IdleFlow be generated in N/A bytes.
the idle timeout
period
User profile String, case-sensitive. Valid characters include
name Length: 1 to 31 characters. letters, digits, and
underscores (_). The
ProfileName N/A
name must start with a
letter and must be
unique.
IPv4 address String, case-sensitive. N/A
IpPoolName pool name N/A
Length: 1 to 31 characters.

Ipv6PoolNam IPv6 address String, case-sensitive. N/A

pool name N/A
e Length: 1 to 63 characters.
IPv6 address for Hexadecimal string, For example,
Ipv6Address specifying the N/A colon-separated. 2001:12::22:33.
prefix

Ipv6PrefixLen IPv6 prefix length Unsigned integer. N/A

N/A
gth Value range: 1 to 128.
IPv4 address of
PrimDnsIpad IPv4: String, dotted decimal
the primary DNS N/A IPv4 example: 1.1.1.1.
dr notation.
server
IPv6 address of N/A IPv6: Hexadecimal string.
PrimDnsIpv6 IPv6 example:
the primary DNS

5
 Column Column Column
Data type and restrictions Remarks
name description type
addr server 1:2:3:4:5:6:7:8.
IPv4 address of
SecDnsIpadd IPv4: String, dotted decimal
the secondary N/A IPv4 example: 1.1.1.1.
r notation.
DNS server
IPv6 address of
SecDnsIpadd IPv6 example:
the secondary N/A IPv6: Hexadecimal string.
r 1:2:3:4:5:6:7:8.
DNS server
Portal redirect String, case-sensitive. N/A
PortalUrl URL N/A
Length: 1 to 255 characters.
VPN instance String, case-sensitive. N/A
VRF name N/A
Length: 1 to 31 characters.
The maximum Unsigned integer. Default: 4.
number of IGMP Value range: 1 to 64.
IgmpMaxAcc
groups that an N/A
essNum
IPv4 user can
join concurrently
The maximum Unsigned integer. Default: 4.
number of MLD Value range: 1 to 64.
MldMaxAcces
groups that an N/A
sNum
IPv6 user can
join concurrently
The users will be Unsigned integer. N/A
SessTimeOut offline when the N/A Value range: 1 to 4294967295.
time is over

InboundUser Inbound user Unsigned integer. N/A

priority N/A
Priority Value range: 0 to 7.

OutboundUse Outbound user Unsigned integer. N/A

priority N/A
rPriority Value range: 0 to 7.

Domain/Schemes
Domain scheme table.

XML structure
<Domain>
<Schemes>
<Scheme>
<DomainName></DomainName>
<AaaType></AaaType>
<AccessType></AccessType>
<SchemeList></SchemeList>
<SchemeNameList></SchemeNameList>
</Scheme>
</Schemes>
</Domain>

6
Table description
Item Description
Feature name Domain
Table name Schemes
Table type Multi-instance table
Row name Scheme
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-insensitive.
DomainName Domain name. Index N/A
Length: 1 to 255 characters.
Enumeration:
• 0—Authentication.
AaaType AAA type. Index
• 4—Authorization.
• 5—Accounting.
Enumeration:
• 0—Login.
• 1—Super.
• 2—Command.
• 3—LAN access.
• 4—PPP.
AccessType Access type. Index
• 5—Default.
• 6—Portal.
• 7—IKE. There are some
• 8—IPoE. restrictions among the
columns AccessType,
• 9—SSL VPN.
AaaType, and
• 10—ADVPN. SchemeList. Those
String. restrictions will be
described in the
Length: 1 to 9 characters, Restrictions section
using the format of 1-2-4. below the table.
A hyphen (-) is used to
separate the digits that
represent different AAA
methods, including:
• 1—HWTACACS.
AAA method
SchemeList N/A • 2—RADIUS.
types.
• 3—LDAP.
• 4—Local.
• 5—None.
The string 1-2-4 indicates that
HWTACACS is specified as
the primary authentication,
authorization, or accounting
method. If the HWTACACS

7
 Column Column Column
Data type and restrictions Remarks
name description type
method fails, the RADIUS
method applies. If the RADIUS
method fails, the local method
applies.
String, case-insensitive.
Length: 0 to 68 characters,
which can contain 0 to 2
scheme names.
Every scheme name contains
two parts: Scheme name
length and scheme name
string.
The scheme name is in the
format of xxmm……mm.
• The xx argument
represents the scheme
name length. Use two
digits to set the scheme
name length.
• The mm……mm
argument represents the If this column is not
SchemeNam Scheme name
N/A scheme name string. The available, no schemes
eList list.
string is 1 to 32 are specified.
characters.
For example:
• The string 08abcdefgh
represents a scheme
whose name is abcdefgh
and whose name length is
8 characters.
• The string
10testtestte04test
represents two schemes.
One scheme is named as
testtestte and the name
length is 10 characters.
The other scheme is
named as test and the
name length is 4
characters.

Restrictions:
• The letter Y indicates that a specific access type supports a specific method for authentication,
authorization, or accounting.
• You can specify one primary method and multiple backup methods for authentication,
authorization, or accounting. An AAA method with a lower level can be the backup of another
method that has a higher level. The following list arranges the methods from high level to low
level:
 RADIUS, TACACS, or LDAP.
 Local.
 None.
Among the highest-level methods, the RADIUS method and the TACACS method can be the
backup of each other.
• In FIPS mode, all access types cannot use the none method for authentication, authorization,
or accounting.

8
 AAA method RADIUS TACACS LDAP Local None
(level) (3) (3) (3) (2) (1)
Access type
+AAA type
Default Authentication Y Y Y Y Y
Authorization Y Y Y Y
Accounting Y Y Y Y
Login Authentication Y Y Y Y Y
Authorization Y Y Y Y
Accounting Y Y Y Y
Super Authentication Y Y
Command Authorization Y Y Y
Accounting Y
LAN Authentication Y Y Y Y
access
(MAC Authorization Y Y Y
authenticat Accounting Y Y Y
ion or
802.1X)
PPP Authentication Y Y Y Y
Authorization Y Y Y Y
Accounting Y Y Y Y
Portal Authentication Y Y Y Y
Authorization Y Y Y
Accounting Y Y Y
IKE Authentication Y Y Y
IPoE Authentication Y Y Y
Authorization Y Y Y
Accounting Y Y Y
SSL VPN Authentication Y Y Y Y
Authorization Y Y Y Y
Accounting Y Y Y
ADVPN Authentication Y Y Y
Authorization Y Y Y
Accounting Y Y Y

Domain/BroadcastSchemes
RADIUS broadcast scheme table for a domain.

9
XML structure
<Domain>
<BroadcastSchemes>
<BroadcastScheme>
<DomainName></DomainName>
<AccessType></AccessType>
<SchemeName></SchemeName>
</BroadcastScheme>
</BroadcastSchemes>
</Domain>

Table description
Item Description
Feature name Domain
Table name BroadcastSchemes
Table type Multi-instance table
Row name BroadcastScheme
Configure this table only for domains that have been
Restrictions
configured RADIUS accounting.

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Domain name. String, case-insensitive.
Length: 1 to 255 characters.
DomainName Index The name can't contain the N/A
following characters: \ | / : * ? "
<>@
Access type. Enumeration:
• 3—LAN access.
AccessType Index • 4—PPP. At present, only one
• 6—Portal. RADIUS broadcast
scheme is supported for
• 8—IPoE.
a domain.
SchemeNam RADIUS scheme String.
name. Index
e Length: 1 to 32 characters.

Domain/Specification
The domain feature capability differs on different devices or on the same device in different states.
• Additional description for the table Domain/SessionLimit, including what service types are
supported on the device in the current state. The device can limit the number of concurrent
online users only for the service types that are supported in the current state.

10
 • Additional description for the table Domain/Schemes. Whether the device supports the none
method as the authentication, authorization, or accounting method.

XML structure
<Domain>
<Specification>
<SessionLimitSpecification>
<Ftp></Ftp>
<Telnet></Telnet>
<Http></Http>
</SessionLimitSpecification>
<SchemesSpecification>
<None></None>
</SchemesSpecification>
</Specification>
</Domain>

Table description
Item Description
Feature name Domain
Table name Specification
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Additional Members include:
description for • Ftp.
SessionLimit Data
Specification
the table
structure • Telnet. N/A
Domain/Session
Limit. • Http.

Whether to Boolean:
support the • true.
column Ftp in the • false.
Ftp
table N/A
Domain/Session
Limit. • In FIPS mode, the
default is false.
Whether to Boolean:
• In non-FIPS mode,
support the • true.
column Telnet in the default is true.
Telnet N/A • false.
the table
Domain/Session
Limit.
Http Whether to N/A Boolean:

11
 Column Column Column
Data type and restrictions Remarks
name description type
support the • true.
column Http in • false.
the table
Domain/Session
Limit.
Additional The member is None.
description for
SchemesSpe Data
the table N/A
cification structure
Domain/Scheme
s.
Whether to Boolean: In FIPS mode, the none
support the none • true. method is not
method for supported for
None
authentication,
N/A • false. authentication,
authorization, authorization, or
and accounting. accounting of all users.

Domain/UserAbnormalOfflineRecords
This table contains user abnormal offline records.

XML structure
<Domain>
<UserAbnormalOfflineRecords>
<UserAbnormalOfflineRecord>
<SerialNumber></SerialNumber>
<OfflineTime></OfflineTime>
<UserName></UserName>
<AccessType></AccessType>
<DomainName></DomainName>
<Interface></Interface>
<Ip></Ip>
<Ipv6></Ipv6>
<MacAddress></MacAddress>
<OfflineReason></OfflineReason>
<OnlineRequestTime></OnlineRequestTime>
<Svlan></Svlan>
<Cvlan></Cvlan>
<Slot></Slot>
<Chassis></Chassis>
</UserAbnormalOfflineRecord>
</UserAbnormalOfflineRecords>
</Domain>

12
Table description
Item Description
Feature name Domain
Table name UserAbnormalOfflineRecords
Table type Multi-instance table
Row name UserAbnormalOfflineRecord
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
Serial number of a user Unsigned integer.
SerialNumber Index 64
abnormal offline record Value range: 1 to 2 -1.
DateTime.
Format:
YYYY-MM-DDTHH:MM:SS.
Value range for YYYY: 2000 to
2035.
Time when the user went Value range for MM: 1 to 12.
OfflineTime N/A
offline
Value range for DD depends on
the specified month.
Value range for HH: 0 to 23.
Value range for MM: 0 to 59.
Value range for SS: 0 to 59.
String, case-sensitive.
UserName Username N/A
Length: 1 to 253 characters.
Enumeration:
• 1—PPP.
• 2—IPoE.
AccessType Access type of the user N/A
• 3—Portal.
• 4—Login.
• 5—LAN access.

Name of the ISP domain to String, case-insensitive.

DomainName N/A
which the user belongs Length: 1 to 255 characters.

Interface through which the String, case-insensitive.

Interface N/A
user accesses the network Length: 1 to 47 characters.
Ip IP address of the user N/A String, dotted decimal notation.
Hexadecimal string,
Ipv6 IPv6 address of the user N/A
colon-separated.
MacAddress MAC address of the user N/A MAC address format: ff-ff-ff-ff-ff-ff.
Reason that the user went
OfflineReason N/A String, case-sensitive.
offline

OnlineRequestTi Time when the user N/A DateTime.

13
 Column name Column description Column type Data type and restrictions
me requested to come online Format:
YYYY-MM-DDTHH:MM:SS.
Value range for YYYY: 2000 to
2035.
Value range for MM: 1 to 12.
Value range for DD depends on
the specified month.
Value range for HH: 0 to 23.
Value range for MM: 0 to 59.
Value range for SS: 0 to 59.
ID of the service provider Unsigned integer.
Svlan network VLAN to which the N/A
user belongs Value range: 1 to 4094.

ID of the customer network Unsigned integer.

Cvlan VLAN to which the user N/A
belongs Value range: 1 to 4094.

Unsigned integer.
Slot Slot number N/A 16
Value range: 0 to 2 -1.
Unsigned integer.
Chassis Chassis number N/A 16
Value range: 0 to 2 -1.

Domain/UserNormalOfflineRecords
This table contains user normal offline records.

XML structure
<Domain>
<UserNormalOfflineRecords>
<UserNormalOfflineRecord>
<SerialNumber></SerialNumber>
<OfflineTime></OfflineTime>
<UserName></UserName>
<AccessType></AccessType>
<DomainName></DomainName>
<Interface></Interface>
<Ip></Ip>
<Ipv6></Ipv6>
<MacAddress></MacAddress>
<OfflineReason></OfflineReason>
<OnlineRequestTime></OnlineRequestTime>
<Svlan></Svlan>
<Cvlan></Cvlan>
<Slot></Slot>
<Chassis></Chassis>
</UserNormalOfflineRecord>

14
 </UserNormalOfflineRecords>
</Domain>

Table description
Item Description
Feature name Domain
Table name UserNormalOfflineRecords
Table type Multi-instance table
Row name UserNormalOfflineRecord
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
Serial number of a user Unsigned integer.
SerialNumber Index 64
normal offline record Value range: 1 to 2 -1.
DateTime.
Format: YYYY-MM-DDTHH:MM:SS.
Value range for YYYY: 2000 to
2035.
Time when the user went Value range for MM: 1 to 12.
OfflineTime N/A
offline Value range for DD depends on the
specified month.
Value range for HH: 0 to 23.
Value range for MM: 0 to 59.
Value range for SS: 0 to 59.
String, case-sensitive.
UserName Username N/A
Length: 1 to 253 characters.
Enumeration:
• 1—PPP.
• 2—IPoE.
AccessType Access type of the user. N/A
• 3—Portal.
• 4—Login.
• 5—LAN access.

Name of the ISP domain String, case-insensitive.

DomainName N/A
to which the user belongs Length: 1 to 255 characters.
Interface through which String, case-insensitive.
Interface the user accesses the N/A
network Length: 1 to 47 characters.

Ip IP address of the user N/A String, dotted decimal notation.

Hexadecimal string,
Ipv6 IPv6 address of the user N/A
colon-separated.
MacAddress MAC address of the user N/A MAC address format: ff-ff-ff-ff-ff-ff.
OfflineReason Reason that the user N/A String, case-sensitive.

15
 Column name Column description Column type Data type and restrictions
went offline
DateTime.
Format: YYYY-MM-DDTHH:MM:SS.
Value range for YYYY: 2000 to
2035.
OnlineRequestTi Time when the user Value range for MM: 1 to 12.
N/A
me requested to come online Value range for DD depends on the
specified month.
Value range for HH: 0 to 23.
Value range for MM: 0 to 59.
Value range for SS: 0 to 59.
ID of the service provider Unsigned integer.
Svlan network VLAN to which N/A
the user belongs Value range: 1 to 4094.

ID of the customer Unsigned integer.

Cvlan network VLAN to which N/A
the user belongs Value range: 1 to 4094.

Unsigned integer.
Slot Slot number N/A 16
Value range: 0 to 2 -1.
Unsigned integer.
Chassis Chassis number N/A 16
Value range: 0 to 2 -1.

Domain/UserOfflineRecords
This table contains user offline records, including user abnormal offline records and user normal
offline records.

XML structure
<Domain>
<UserOfflineRecords>
<UserOfflineRecord>
<SerialNumber></SerialNumber>
<OfflineTime></OfflineTime>
<UserName></UserName>
<AccessType></AccessType>
<DomainName></DomainName>
<Interface></Interface>
<Ip></Ip>
<Ipv6></Ipv6>
<MacAddress></MacAddress>
<OfflineReason></OfflineReason>
<OnlineRequestTime></OnlineRequestTime>
<Svlan></Svlan>
<Cvlan></Cvlan>
<Slot></Slot>

16
 <Chassis></Chassis>
</UserOfflineRecord>
</UserOfflineRecords>
</Domain>

Table description
Item Description
Feature name Domain
Table name UserOfflineRecords
Table type Multi-instance table
Row name UserOfflineRecord
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
Serial number of a user Unsigned integer.
SerialNumber Index 64
offline record Value range: 1 to 2 -1.
DateTime.
Format: YYYY-MM-DDTHH:MM:SS.
Value range for YYYY: 2000 to 2035.
Value range for MM: 1 to 12.
Time when the user
OfflineTime N/A Value range for DD depends on the
went offline
specified month.
Value range for HH: 0 to 23.
Value range for MM: 0 to 59.
Value range for SS: 0 to 59.
String, case-sensitive.
UserName Username N/A
Length: 1 to 253 characters.
Enumeration:
• 1—PPP.
• 2—IPoE.
AccessType Access type of the user N/A
• 3—Portal.
• 4—Login.
• 5—LAN access.
Name of the ISP String, case-insensitive.
DomainName domain to which the N/A
user belongs Length: 1 to 255 characters.

Interface through which String, case-insensitive.

Interface the user accesses the N/A
network Length: 1 to 47 characters.

Ip IP address of the user N/A String, dotted decimal notation.

IPv6 address of the
Ipv6 N/A Hexadecimal string, colon-separated.
user

17
 Column name Column description Column type Data type and restrictions
MAC address of the
MacAddress N/A MAC address format: ff-ff-ff-ff-ff-ff.
user
Reason that the user
OfflineReason N/A String, case-sensitive.
went offline
DateTime.
Format: YYYY-MM-DDTHH:MM:SS.
Value range for YYYY: 2000 to 2035.
Time when the user Value range for MM: 1 to 12.
OnlineRequestTi
requested to come N/A Value range for DD depends on the
me
online specified month.
Value range for HH: 0 to 23.
Value range for MM: 0 to 59.
Value range for SS: 0 to 59.
ID of the service
provider network VLAN Unsigned integer.
Svlan N/A
to which the user Value range: 1 to 4094.
belongs
ID of the customer Unsigned integer.
Cvlan network VLAN to which N/A
the user belongs Value range: 1 to 4094.

Unsigned integer.
Slot Slot number N/A 16
Value range: 0 to 2 -1.
Unsigned integer.
Chassis Chassis number N/A 16
Value range: 0 to 2 -1.

Domain/UserOnlineFailRecords
This table contains user online failure records.

XML structure
<Domain>
<UserOnlineFailRecords>
<UserOnlineFailRecord>
<SerialNumber></SerialNumber>
<OnlineRequestTime></OnlineRequestTime>
<UserName></UserName>
<AccessType></AccessType>
<DomainName></DomainName>
<Interface></Interface>
<Ip></Ip>
<Ipv6></Ipv6>
<MacAddress></MacAddress>
<ServerReplyMessage></ServerReplyMessage>
<OnlineFailureReason></OnlineFailureReason>
<Svlan></Svlan>

18
 <Cvlan></Cvlan>
<Slot></Slot>
<Chassis></Chassis>
</UserOnlineFailRecord>
</UserOnlineFailRecords>
</Domain>

Table description
Item Description
Feature name Domain
Table name UserOnlineFailRecords
Table type Multi-instance table
Row name UserOnlineFailRecord
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
Serial number of a user Unsigned integer.
SerialNumber Index 64
online failure record Value range: 1 to 2 -1.
DateTime.
Format:
YYYY-MM-DDTHH:MM:SS.
Value range for YYYY: 2000 to
2035.
Time when the user
OnlineRequestTime requested to come N/A Value range for MM: 1 to 12.
online Value range for DD depends on
the specified month.
Value range for HH: 0 to 23.
Value range for MM: 0 to 59.
Value range for SS: 0 to 59.
String, case-sensitive.
UserName Username N/A
Length: 1 to 253 characters.
Enumeration:
• 1—PPP.
• 2—IPoE.
AccessType Access type of the user N/A
• 3—Portal.
• 4—Login.
• 5—LAN access.
Name of the ISP String, case-insensitive.
DomainName domain to which the N/A
user belongs Length: 1 to 255 characters.

Interface through which String, case-insensitive.

Interface the user accesses the N/A
network Length: 1 to 47 characters.

19
 Column name Column description Column type Data type and restrictions
Ip IP address of the user N/A String, dotted decimal notation.
IPv6 address of the Hexadecimal string,
Ipv6 N/A
user colon-separated.
MAC address of the
MacAddress N/A MAC address format: ff-ff-ff-ff-ff-ff.
user
String, case-sensitive.
ServerReplyMessage Server reply message N/A
Length: 1 to 252 characters.
OnlineFailureReason Online failure reason N/A String, case-sensitive.
ID of the service
provider network VLAN Unsigned integer.
Svlan N/A
to which the user Value range: 1 to 4094.
belongs
ID of the customer Unsigned integer.
Cvlan network VLAN to which N/A
the user belongs Value range: 1 to 4094.

Unsigned integer.
Slot Slot number N/A 16
Value range: 0 to 2 -1.
Unsigned integer.
Chassis Chassis number N/A 16
Value range: 0 to 2 -1.

Domain/EnableAbnormalOfflineRecords
This table contains the enabling status of the user abnormal offline recording feature.

XML structure
<Domain>
<EnableAbnormalOfflineRecords>
<Enable></Enable>
</EnableAbnormalOfflineRecords>
</Domain>

Table description
Item Description
Feature name Domain
Table name EnableAbnormalOfflineRecords
Table type Single-instance table
Row name None
Restrictions None

20
Columns

C
ol
Colu
u
mn
m Data type and
desc Remarks
n restrictions
riptio
na
n
m
e

Whether the user Boolean:

abnormal offline The default varies by
Enable
recording feature
N/A • true—Enabled. device model.
is enabled • false—Disabled.

Domain/EnableNormalOfflineRecords
This table contains the enabling status of the user normal offline recording feature.

XML structure
<Domain>
<EnableNormalOfflineRecords>
<Enable></Enable>
</EnableNormalOfflineRecords>
</Domain>

Table description
Item Description
Feature name Domain
Table name EnableNormalOfflineRecords
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Whether the user Boolean:
normal offline The default varies by
Enable
recording feature
N/A • true—Enabled. device model.
is enabled • false—Disabled.

21
Domain/EnableOfflineRecords
This table contains the enabling status of the user offline recording feature.

XML structure
<Domain>
<EnableOfflineRecords>
<Enable></Enable>
</EnableOfflineRecords>
</Domain>

Table description
Item Description
Feature name Domain
Table name EnableOfflineRecords
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Whether the user Boolean:
offline recording The default varies by
Enable
feature is
N/A • true—Enabled. device model.
enabled • false—Disabled.

Domain/EnableOnlineFailRecords
This table contains the enabling status of the user online failure recording feature.

XML structure
<Domain>
<EnableOnlineFailRecords>
<Enable></Enable>
</EnableOnlineFailRecords>
</Domain>

22
Table description
Item Description
Feature name Domain
Table name EnableOnlineFailRecords
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Whether the user Boolean:
online failure The default varies by
Enable
recording feature
N/A • true—Enabled. device model.
is enabled • false—Disabled.

23
Contents
Domain ··························································································1
Domain/GlobalConfig ···················································································································· 1
Domain/Domains ························································································································· 1

i
Domain
Domain/GlobalConfig
Message Explanation
Domain name must not include \\, |, /, :, *, ?, "", <, >
Domain name must not include \\, |, /, :, *, ?, "", <, > and @.
and @.
When the default domain is modified, the specified ISP domain
The specified domain does not exist.
does not exist.

Domain/Domains
Message Explanation
Domain name must not include \\, |, /, :, *, ?, "", <, >
Domain name must not include \\, |, /, :, *, ?, "", <, > and @.
and @.

The number of domains has reached the limit. The number of domains has reached the limit.
It's system domain, cannot be deleted! Connot delele the predefined ISP domain in the system.
It's default domain, cannot be deleted! Connot delete the default ISP domain in the system.
The specified domain does not exist. The specified ISP domain does not exist.

1
Contents
Dot1X ····························································································1
Dot1X/ClearAllStatistics ················································································································ 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
Dot1X/ClearInterStatistics ·············································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 2
Columns ······························································································································ 2
Dot1X/ResetGVLANUser ··············································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 3
Dot1X/ResetOneGVLANUser ········································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3

i
Dot1X
Dot1X/ClearAllStatistics
This table clear Dot1X all interfaces’ statisitcs.

XML structure
<Dot1X>
<ClearAllStatistics>
<Clear></Clear>
</ClearAllStatistics>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name ClearAllStatistics
Table type Single-instance table
Row name None
Restrictions None

Columns
Column
Column name Column description Data type and restrictions
type
Clear all interfaces’
Clear N/A • This column must be empty
statistics.

Dot1X/ClearInterStatistics
This table clears Dot1X interface statisitcs information.

XML structure
<Dot1X>
<ClearInterStatistics>
<Interface>
<IfIndex></IfIndex>
<Clear></Clear>
</Interface>
</ClearInterStatistics>

1
 </Dot1X>

Table description
Item Description
Feature name Dot1X
Table name ClearInterStatistics
Table type Multi-instance table
Row name Interface
Restrictions None

Columns

Column
Column name Column description Data type and restrictions
type
Resets the interface’s
IfIndex statistics or guest VLAN’s Index Unsigned integer.
users.

Clears the interface’s

Clear N/A • This column must be empty
statistics.

Dot1X/ResetGVLANUser
This table resets Dot1X interface’s all users in guest VLAN.

XML structure
<Dot1X>
<ResetGVLANUser>
<Interface>
<IfIndex></IfIndex>
<ResetAll></ResetAll>
</Interface>
</ResetGVLANUser>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name ResetGVLANUser
Table type Multi-instance table
Row name Interface

2
 Item Description
Restrictions None

Columns

Column
Column name Column description Data type and restrictions
type
Clears the interface’s
IfIndex Index Unsigned integer.
guest VLAN’s users.
Resets the interface’
ResetAll N/A • This column must be empty
users in guest VLAN.

Dot1X/ResetOneGVLANUser
This table resets one of Dot1X interface users of guest VLAN.

XML structure
<Dot1X>
<ResetOneGVLANUser>
<Interface>
<IfIndex></IfIndex>
<UserMAC></UserMAC>
<Reset></Reset>
</Interface>
</ResetOneGVLANUser>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name ResetOneGVLANUser
Table type Multi-instance table
Row name Interface
Restrictions None

Columns

3
 Column
Column name Column description Data type and restrictions
type
Resets the interface’s
IfIndex Index Unsigned integer.
guest VLAN’s user.
The designated user’s
UserMAC Index MAC address
MAC.
Resets the interface’s
Reset designated user in guest N/A • This column must be empty
VLAN

4
Contents
Dot1X ····························································································1
Dot1X/Protocol ·························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Dot1X/EAD ······························································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
DOT1X/EADFreeIPs ··················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
Dot1X/Smarton ·························································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
Dot1X/Interfaces ························································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6

i
Dot1X
Dot1X/Protocol
This table contains Dot1X protocol related parameters information.

XML structure
<Dot1X>
<Protocol>
<Enable></Enable>
<AuthenMethod></AuthenMethod>
<DomainDelimiterAt></DomainDelimiterAt>
<DomainDelimiterSlash></DomainDelimiterSlash>
<DomainDelimiterBackSlash></DomainDelimiterBackSlash>
<DomainDelimiterDot></DomainDelimiterDot>
<QuietEnable></QuietEnable>
<QuietInterval></QuietInterval>
<HandshakeInterval></HandshakeInterval>
<ReauthenInterval></ReauthenInterval>
<ServerInterval></ServerInterval>
<SupplicantInterval></SupplicantInterval>
<ReqIDInterval></ReqIDInterval>
<RequestRetryCount></RequestRetryCount>
</Protocol>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name Protocol
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column
Column name Column description Data type and restrictions
type
Boolean:
Enable Global Dot1X feature N/A
• true—Enabled

1
 Column
Column name Column description Data type and restrictions
type
• false—Disabled(default)
Enumeration:
Authentication Method of • 1—Chap(default)
AuthenMethod N/A
802.1X • 2—PAP
• 3—EAP
Boolean:
Delimiter "@” between
DomainDelimiterAt N/A • true—Enabled(default)
username and domain name
• false—Disabled
Boolean:
Delimiter “/” between
DomainDelimiterSlash
username and domain name
N/A • true—Enabled
• false—Disabled(default)
Boolean:
Delimiter “\” between
DomainDelimiterBackslash
username and domain name
N/A • true—Enabled
• false—Disabled(default)
Boolean:
Delimiter “.” between
DomainDelimiterDot
username and domain
N/A • true—Enabled
• false—Disabled(default)
Boolean:
QuietEnable Enable 802.1X quiet function N/A • true—Enabled
• false—Disabled(default)
Unsigned integer
Value range: 10 to 120
QuietInterval Period value of Quiet timer N/A seconds.
Default value is 60 second.
Unsigned integer.
Period value of handshake Value range: 5 to 1024
HandshakeInterval N/A seconds.
timer
Default value is 15 second.
Unsigned integer.
Period value of Value range: 60 to 7200
ReauthenInterval N/A seconds.
re-authentication timer
Default value is 3600 second.
Unsigned integer.
Period value of server Value range: 100 to 300
ServerInterval N/A seconds.
response timer
Default value is 100 second.

Period value of supplicant Unsigned integer.

SupplicantInterval response timer(other than N/A Value range: 1 to 120 seconds.
EAP-Response/ID) Default value is 30 second.
Unsigned integer.
Period value of supplicant Value range: 10 to 120
ReqIDInterval N/A seconds.
EAP-Response /ID timer
Default value is 30 second.

Max count of retrying to send Unsigned integer.

RequestRetryCount out dot1X’s Request N/A Value range: 1 to 10.
packets Default value is 2.

2
Dot1X/EAD
This table contains Dot1X’s EAD feature.

XML structure
<Dot1X>
<EAD>
<AssistEnable></AssistEnable>
<AssistURL></AssistURL>
</EAD>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name EAD
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and
No
deletion

Columns
Column
Column name Column type Data type and restrictions
description
Boolean:
Enable EAD
AssistEnable
assistant function
N/A • true—Enabled
• false—Disabled(default)
The redirect URL String.
AssistURL used with EAD N/A
assistant function Length: 1 to 64 characters.

DOT1X/EADFreeIPs
This table contains Dot1X’s EAD assistant free IP.

XML structure
<Dot1X>
<EADFreeIPs>
<FreeIP>

3
 <IPv4Address></IPv4Address>
<IPv4Mask></IPv4Mask>
</FreeIP>
</EADFreeIPs>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name EADFreeIPs
Table type Multi-instance table
Row name FreeIP
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column
Column name Column type Data type and restrictions
description
IP address used in
IPv4Address EAD assistance Index String, dotted decimal notation.
feature
IPv4Mask IP address mask Index Ipv4Mask.

Dot1X/Smarton
This table contains Dot1X’s Smarton feature table.

XML structure
<Dot1X>
<Smarton>
<SwitchID></SwitchID>
<Password></Password>
<RetryCount></RetryCount>
</Smarton>
</Dot1X>

Table description
Item Description
Feature name Dot1X

4
 Item Description
Table name Smarton
Table type Single-instance table
Row name None
Restrictions None

Columns
Column
Column name Column type Data type and restrictions
description
Dot1x smarton String.
SwitchID N/A
switchid • Length: 1 to 30 characters.

String.
Dot1x smarton
Password N/A Length: 1 to 16 characters.
password
Not return.

Maxium attempt
count to send out Unsigned integer.
RetryCount Request packets N/A Value range: 1 to 10.
with smarton Default value is 3.
notification

Dot1X/Interfaces
This table contains Dot1X interface’s information .

XML structure
<Dot1X>
<Interfaces>
<Interface>
<IfIndex></IfIndex>
<Enable></Enable>
<SmartonEnable></SmartonEnable>
<PortControl></PortControl>
<PortMethod></PortMethod>
<ReauthenEnable></ReauthenEnable>
<MulticastTrigger></MulticastTrigger>
<UnicastTrigger></UnicastTrigger>
<HandshakeEnable></HandshakeEnable>
<SecHandshakeEnable></SecHandshakeEnable>
<ReauthUnreachableMode></ReauthUnreachableMode>
<MandDomain></MandDomain>
<MaxUser></MaxUser>
<FailVLAN></FailVLAN>
<CriticalVLAN></CriticalVLAN>

5
 <GuestVLAN></GuestVLAN>
</Interface>
</Interfaces>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name Interfaces
Table type Multi-instance table
Row name interface
Restrictions None
Support for row creation and deletion No

Columns
Colum
Column name Column description Data type and restrictions
n type
IfIndex Interface index Index Unsigned integer.
Boolean:
Enable Enable 802.1X N/A • true—Enabled
• false—Disabled(default)
Boolean:
SmartonEnable Enable Smarton feature N/A • true—Enabled
• false—Disabled(default)
Enumeration:
Port control status of the • 1—authorized-force
PortControl N/A
interface • 2—unauthorized-force
• 3—auto(default)
Enumeration:
Control Method of the
PortMethod
interface
N/A • 1—Portbased
• 2—MACbased(default)
Boolean:
Enable periodic
ReauthenEnable
reauthentication feature
N/A • true—Enabled
• false—Disabled(default)
Unsigned integer.
VLAN for users failed in Value range: 1 to 4094.
FailVLAN N/A
authentication
Default Value is not configured.
Unsigned integer.
VLAN for users as the Value range: 1 to 4094.
CriticalVLAN N/A
server is unreachable
Default Value is not configured.

VLAN used before Unsigned integer.

GuestVLAN N/A
authentication Value range: 1 to 4094.

6
 Colum
Column name Column description Data type and restrictions
n type
Default Value is not configured.
Boolean:
HandshakeEnable Enable handshake feature N/A • true—Enabled(default)
• false—Disabled
Boolean:
SecHandshakeEnabl Enable secure handshake
e feature
N/A • true—Enabled
• false—Disabled(default)
Set user online or offline Enumeration:
ReauthUnreachableM when the AAA server is not
ode available during
N/A • 0—Offline(default)
re-authenticating • 1—Online

Mandatory authentication String.

MandDomain N/A
domain on this interface Length: 1 to 255 characters.
Unsigned integer.
Maximum user number on
MaxUser N/A Value range: 1 to 4096.
this interface
Default Value is 4096.
Boolean:
Enable multicast trigger
MulticastTrigger
function on the interface
N/A • true—Enabled(default)
• false—Disabled
Boolean:
Enable unicast trigger
UnicastTrigger
function on the interface
N/A • true—Enabled
• false—Disabled(default)

7
Contents
Dot1X ····························································································1
Dot1X/Protocol ·························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
Dot1X/EAD ······························································································································· 2
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
DOT1X/EADFreeIPs ··················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
Dot1X/Smarton ·························································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
Dot1X/Interfaces ························································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6
Dot1X/InterfaceUsers·················································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 9

i
Dot1X
Dot1X/Protocol
This table contains Dot1X protocol parameters table.

XML structure
<Dot1X>
<Protocol>
<Enable></Enable>
<AuthenMethod></AuthenMethod>
<DomainDelimiterAt></DomainDelimiterAt>
<DomainDelimiterSlash></DomainDelimiterSlash>
<DomainDelimiterBackSlash></DomainDelimiterBackSlash>
<DomainDelimiterDot></DomainDelimiterDot>
<QuietEnable></QuietEnable>
<QuietInterval></QuietInterval>
<HandshakeInterval></HandshakeInterval>
<ReauthenInterval></ReauthenInterval>
<ServerInterval></ServerInterval>
<SupplicantInterval></SupplicantInterval>
<ReqIDInterval></ReqIDInterval>
<RequestRetryCount></RequestRetryCount>
<OnlineUserNum></OnlineUserNum>
</Protocol>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name Protocol
Table type Single-instance table
Row name None
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
Boolean:
Dot1X globally
Enable
enabled status
N/A • true—Enabled
• false—Disabled

1
 Column name Column description Column type Data type and restrictions
Enumeration:
Authentication • 1—Chap
AuthenMethod N/A
Method of 802.1X • 2—PAP
• 3—EAP

Delimiter “@” Boolean:

DomainDelimiterAt between username N/A • true—Enabled
and domain name • false—Disabled

Delimiter “/” between Boolean:

DomainDelimiterSlash username and N/A • true—Enabled
domain name • false—Disabled

Delimiter “\” between Boolean:

DomainDelimiterBackslash username and N/A • true—Enabled
domain name • false—Disabled

Delimiter “.” between Boolean:

DomainDelimiterDot username and N/A • true—Enabled
domain name • false—Disabled
Boolean:
Status Of Dot1X quiet
QuietEnable N/A • true—Enabled
function
• false—Disabled
Unsigned integer.
Period value of Quiet
QuietInterval N/A Value range: 10 to 120
timer
seconds.
Unsigned integer.
Period value of
HandshakeInterval N/A Value range: 5 to 1024
handshake timer
seconds.
Period value of Unsigned integer.
ReauthenInterval re-authentication N/A Value range: 60 to 7200
timer seconds.
Unsigned integer.
Period value of server
ServerInterval N/A Value range: 100 to 300
response timer
seconds.
Period value of
supplicant response Unsigned integer.
SupplicantInterval timer(other than N/A
EAP-Response/ID Value range: 1 to 120 seconds.
packets)
Period value of Unsigned integer.
supplicant
ReqIDInterval N/A Value range: 10 to 120
EAP-Response/ID
timer seconds.

Max count of retrying Unsigned integer.

RequestRetryCount to send out dot1X’s N/A
Request packets Value range: 1 to 10.

Current online user

OnlineUserNum N/A Unsigned integer.
count

Dot1X/EAD
This table contains Dot1X’s EAD(Endpoint Admission Defense) feature table.

2
XML structure
<Dot1X>
<EAD>
<AssistEnable></AssistEnable>
<AssistURL></AssistURL>
</EAD>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name EAD
Table type Single-instance table
Row name None
Restrictions None.

Columns
Column
Column name Column type Data type and restrictions
description
Boolean:
Status of EAD
AssistEnable
assistant function
N/A • true—Enabled
• false—Disabled
The redirect URL String.
AssistURL used with EAD N/A
assistant function Length: 1 to 64 characters.

DOT1X/EADFreeIPs
This table contains Dot1X’s EAD assistant free IP.

XML structure
<Dot1X>
<EADFreeIPs>
<FreeIP>
<IPv4Address></IPv4Address>
<IPv4Mask></IPv4Mask>
</FreeIP>
</EADFreeIPs>
</Dot1X>

3
Table description
Item Description
Feature name Dot1X
Table name EADFreeIPs
Table type Multi-instance table
Row name FreeIP
Restrictions None

Columns
Column
Column name Column type Data type and restrictions
description
IP address used in
IPv4Address EAD assistance Index String, dotted decimal notation.
feature
IPv4Mask IP address mask Index IPv4Mask.

Dot1X/Smarton
This table contains Dot1X’s Smarton feature table.

XML structure
<Dot1X>
<Smarton>
<SwitchID></SwitchID>
<Password></Password>
<RetryCount></RetryCount>
</Smarton>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name Smarton
Table type Single-instance table
Row name None
Restrictions None

4
Columns
Column
Column name Column type Data type and restrictions
description
Dot1x smarton String.
SwitchID N/A
switchid • Length: 1 to 30 characters.

Dot1x smarton
Password N/A Null or ****Not return.
password

Maxium attempt
count to send out Unsigned integer.
RetryCount Request packets N/A
Value range: 1 to 10.
with smarton
notification

Dot1X/Interfaces
This table contains Dot1X interface’s information.

XML structure
<Dot1X>
<Interfaces>
<Interface>
<IfIndex></IfIndex>
<Enable></Enable>
<SmartonEnable></SmartonEnable>
<PortControl></PortControl>
<PortMethod></PortMethod>
<PortRole></PortRole>
<ReauthenEnable></ReauthenEnable>
<MulticastTrigger></MulticastTrigger>
<UnicastTrigger></UnicastTrigger>
<HandshakeEnable></HandshakeEnable>
<SecHandshakeEnable></SecHandshakeEnable>
<ReauthUnreachableMode></ReauthUnreachableMode>
<MandDomain></MandDomain>
<MaxUser></MaxUser>
<FailVLAN></FailVLAN>
<CriticalVLAN></CriticalVLAN>
<GuestVLAN></GuestVLAN>
<OnlineUserNum></OnlineUserNum>
<RcvPktNum></RcvPktNum>
<SndPktNum></SndPktNum>
<StartPktNum></StartPktNum>
<LogoffPktNum></LogoffPktNum>
<RespIDPktNum></RespIDPktNum>

5
 <RespPktNum></RespPktNum>
<ReqIDPktNum></ReqIDPktNum>
<ReqPktNum></ReqPktNum>
<RcvErrorPktNum></RcvErrorPktNum>
</Interface>
</Interfaces>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name Interfaces
Table type Multi-instance table
Row name interface
Restrictions None

Columns
Column
Column name Column description Data type and restrictions
type
IfIndex Interface index Index Unsigned integer.
Boolean:
Enable Status of
Enable
802.1X
N/A • true—Enabled
• false—Disabled
Boolean:
Enable Status of
SmartonEnable
Smarton feature
N/A • true—Enabled
• false—Disabled
Enumeration:
Port control status of • 1—authorized-force
PortControl N/A
the interface • 2—unauthorized-force
• 3—auto
Enumeration:
Control Method of the
PortMethod
interface
N/A • 1—Portbased
• 2—MACbased

Role of the interface in Enumeration:

PortRole N/A
authentication • 1—Authenticator

Enable Status of Boolean:

ReauthenEnable periodic N/A • true—Enabled
reauthentication feature • false—Disabled

VLAN for users failed in Unsigned integer.

FailVLAN N/A
authentication Value range: 1 to 4094.

VLAN for users as the Unsigned integer.

CriticalVLAN N/A
server is unreachable Value range: 1 to 4094.

6
 Column
Column name Column description Data type and restrictions
type
VLAN used before Unsigned integer.
GuestVLAN N/A
authentication Value range: 1 to 4094.

Enable status of Boolean:

HandshakeEnable handshake feature on N/A • true—Enabled
the interface • false—Disabled

Enable status of secure Boolean:

SecHandshakeEnable handshake feature on N/A • true—Enabled
the interface • false—Disabled
Status of user online or Enumeration:
offline when the AAA
ReauthUnreachableMode
server is not available
N/A • 0—Offline
during re-authenticating • 1—Online

Mandatory String.
MandDomain authentication domain N/A
on this interface Length: 1 to 255 characters.

Maximum user number Unsigned integer.

MaxUser N/A
on this interface Value range: 1 to 4096.
Enable status of Boolean:
multicast trigger
MulticastTrigger
function on the
N/A • true—Enabled
interface • false—Disabled

Enable status of unicast Boolean:

UnicastTrigger trigger function on the N/A • true—Enabled
interface • false—Disabled
Number of online Unsigned integer64.
OnlineUserNum 802.1X users of the N/A 64
interface Value range: 0 to 2 - 1.

Number of received
Unsigned integer64.
RcvPktNum EAPOL packets on the N/A 64
interface Value range: 0 to 2 - 1.

Number of sent EAPOL Unsigned integer64.

SndPktNum N/A 64
packets on the interface Value range: 0 to 2 - 1.
Number of received Unsigned integer64.
StartPktNum EAPOL-Start packets N/A 64
on the interface Value range: 0 to 2 - 1.

Number of received Unsigned integer64.

LogoffPktNum EAPOL-LogOff packets N/A 64
on the interface Value range: 0 to 2 - 1.

Number of received Unsigned integer64.

RespIDPktNum EAP-Response/ID N/A 64
packets on the interface Value range: 0 to 2 - 1.

Number of received
EAP-Response(other Unsigned integer64.
RespPktNum than N/A 64
EAP-Response/ID) Value range: 0 to 2 - 1.
packets on the interface
ReqIDPktNum Number of sent Unsigned integer64.
EAP-Request/ID N/A 64
packets on the interface Value range: 0 to 2 - 1.

7
 Column
Column name Column description Data type and restrictions
type
ReqPktNum Number of sent
EAP-Request (other Unsigned integer64.
N/A 64
than EAP-Request /ID) Value range: 0 to 2 - 1.
packets on the interface
RcvErrorPktNum Number of received Unsigned integer64.
error packets on the N/A 64
interface Value range: 0 to 2 - 1.

Dot1X/InterfaceUsers
This table displays Dot1X users’ information.

XML structure
<Dot1X>
<InterfaceUsers>
<Interface>
<IfIndex></IfIndex>
<UserMAC></UserMAC>
<Name></Name>
<Domain></Domain>
<Ipv4Addr></Ipv4Addr>
<Ipv6Addr></Ipv6Addr>
<InitialVLAN></InitialVLAN>
<AuthzVLAN></AuthzVLAN>
<AuthzACLGroup></AuthzACLGroup>
<AuthzUserProfile></AuthzUserProfile>
<TermAction></TermAction>
<TimeoutPeriod></TimeoutPeriod>
<LogonTime></LogonTime>
<OnlineDuration></OnlineDuration>
</Interface>
</InterfaceUsers>
</Dot1X>

Table description
Item Description
Feature name Dot1X
Table name InterfaceUsers
Table type Multi-instance table
Row name Interface
Restrictions None

8
Columns
Column
Column name Column description Data type and restrictions
type
IfIndex Interface index Index Unsigned integer.
UserMAC MAC address of user on the interface. Index MAC address
String.
Name User name when logs on N/A
Length: 1 to 253 characters.
String.
Domain User’s domain when logs on N/A
Length: 1 to 255 characters.
Ipv4Addr IPv4 address of the user N/A String, dotted decimal notation.
Hexadecimal string,
Ipv6Addr IPv6 address of the user N/A
colon-separated.
Unsigned integer
InitialVLAN VLAN ID used by the user when logs on N/A
Value range: 1 to 4094.

VLAN ID allocated for authecticated user Unsigned integer

AuthzVLAN N/A
by the AAA server Value range: 1 to 4094.
ACL group number allocated for
AuthzACLGroup N/A Unsigned integer
authecticated user by the AAA server
User Profile name allocated for
AuthzUserProfile N/A String.
authecticated user by the AAA server

Action attribute assigned by the AAA Enumeration:

TermAction server when the session timeout timer N/A • 0—Default.
expires • 1—Radius-request.
Period value of session timeout timer
TimeoutPeriod N/A Unsigned integer
assigned by the server timer
String.Format: YYYY-MM-DD
LogonTime Time from which the user logs on N/A
HH:MM:SS.
OnlineDuration Online duration of the user N/A Unsigned integer.

9
Contents
802.1X ···························································································1
802.1X/IF ································································································································· 1
802.1X /FreeIp ·························································································································· 2
802.1X /Protocol ························································································································ 2
802.1X /EadAssist ······················································································································ 2

i
802.1X
802.1X/IF
Message Explanation
Can't set a nonexistent VLAN as a guest VLAN. VLAN do not exist。
无法将一个不存在的VLAN配置为Guest VLAN。 指定的VLAN不存在
Can't set a nonexistent VLAN as an Auth-Fail
VLAN. VLAN do not exist。
指定的VLAN不存在
无法将一个不存在的VLAN配置为Auth-Fail VLAN。

Can't set a nonexistent VLAN as a critical VLAN. VLAN do not exist。

无法将一个不存在的VLAN配置为Critical VLAN。 指定的VLAN不存在
Failed to enable 802.1X on the interface, because Failed to enable 802.1X on the interface, because it is a link
it is a link aggregation member port aggregation member port
端口使能802.1X失败，因为端口为聚合口成员。 聚合口成员不能配置802.1X
Can't enable 802.1X for port security mode is Can't enable 802.1X for port security mode is configured on the
configured on the port. port.
使能802.1X失败，因为该端口已经使能端口安全。 使能802.1X失败，因为该端口已经使能端口安全。
Can't enable 802.1x for port security is enabled. Can't enable 802.1x for port security is enabled.
使能802.1x失败，因为已经使能端口安全。 使能802.1x失败，因为已经使能端口安全。
Can't configure port-control for port security is
Can't configure port-control for port security is enabled.
enabled.
配置端口控制失败，因为已经使能端口安全。
配置端口控制失败，因为已经使能端口安全。
Can't configure port-control for port security mode Can't configure port-control for port security mode is configured
is configured on the port. on the port.
配置端口控制失败，因为该端口已经使能端口安全。 配置端口控制失败，因为该端口已经使能端口安全。
Can't configure port-method for port security is
Can't configure port-method for port security is enabled.
enabled.
配置端口控制方式失败，因为已经使能端口安全。
配置端口控制方式失败，因为已经使能端口安全。
Can't configure port-method for port security mode
Can't configure port-method for port security mode is configured
is configured on the port.
on the port.
配置端口控制方式失败，因为该端口已经使能端口
配置端口控制方式失败，因为该端口已经使能端口安全。
安全。
Can't configure port-method for MAC Can't configure port-method for MAC authentication is enabled
authentication is enabled on the port. on the port.
配置端口控制方式失败，因为MACA认证已经使能。 配置端口控制方式失败，因为MACA认证已经使能。
The specified number must be higher than the The specified number must be higher than the current number of
current number of online users. online users.
配置的最大用户数必须大于当先在线用户数。 配置的最大用户数必须大于当先在线用户数。
Can't set a dynamic VLAN as an guest VLAN. Can't set a dynamic VLAN as an guest VLAN.
无法将一个动态VLAN配置成Guest VLAN。 无法将一个动态VLAN配置成Guest VLAN。
Can't set a dynamic VLAN as a Auth-Fail VLAN. Can't set a dynamic VLAN as a Auth-Fail VLAN.

1
无法将一个动态VLAN配置成Auth-Fail VLAN。 无法将一个动态VLAN配置成Auth-Fail VLAN。
Can't set a dynamic VLAN as a critical VLAN. Can't set a dynamic VLAN as a critical VLAN.
无法将一个动态VLAN配置成Critical VLAN。 无法将一个动态VLAN配置成Critical VLAN。
Port security, MAC authentication, and 802.1X
Port security, MAC authentication, and 802.1X authentication are
authentication are not supported on Layer 2
not supported on Layer 2 aggregate interfaces.
aggregate interfaces.
端口安全，MAC地址认证和802.1X认证不支持在二层以太网聚合
端口安全，MAC地址认证和802.1X认证不支持在二
接口上配置。
层以太网聚合接口上配置。

802.1X /FreeIp
Message Explanation
The maximum number of free-IP segments has The maximum number of free-IP segments has reached.
reached.
Free-IP 片段的最大数目无法达到。. Free-IP 片段数超限。
Invalid IP address or subnet mask. Invalid IP address or subnet mask.
无效的IP地址或子网掩码。 无效的IP地址或子网掩码。

802.1X /Protocol
Message Explanation
Can't enable 802.1x for port security is enabled. Can't enable 802.1x for port security is enabled.
使能802.1x失败，因为已经使能端口安全。 使能802.1x失败，因为已经使能端口安全。
Can't disable 802.1X for port security is enabled. Can't disable 802.1X for port security is enabled.
去使能802.1x失败，因为已经使能端口安全。 去使能802.1x失败，因为已经使能端口安全。

802.1X /EadAssist
Message Explanation
Can't enable the EAD assistant function when Can't enable the EAD assistant function when MAC
MAC authentication is enabled globally. authentication is enabled globally.
使能EAD快速部署失败，因为已经使能MAC认证 使能EAD快速部署失败，因为已经使能MAC认证
Can't enable the EAD assistant function when port Can't enable the EAD assistant function when port security is
security is enabled globally. enabled globally..
使能EAD快速部署失败，因为已经使能端口安全 使能EAD快速部署失败，因为已经使能端口安全

2
Contents
DRNI/Base ································································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
DRNI/Role ·································································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 2
DRNI/Keepalive ··························································································································· 2
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
DRNI/IPPTable ···························································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 5
Columns ······························································································································ 5
DRNI/DRPortTable ······················································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 6
DRNI/PortTable ··························································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 6

i
DRNI
DRNI/Base
This table contains DRNI Base information.

XML structure
<DRNI>
<Base>
<SystemMAC></SystemMAC>
<SystemPriority></SystemPriority>
<SystemNumber></SystemNumber>
<RestoreDelay></RestoreDelay>
<AutoRecoveryReloadDelay></AutoRecoveryReloadDelay>
</Base>
</DRNI>

Table description
Item Description
Feature name DRNI
Table name Base
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Example: 0-1-0-1-0-1
DR system Six groups of two hexadecimal Configure the same DR
SystemMAC N/A MAC address for the
MAC address digits, hyphen-separated.
DR member devices in
a DR system.
Configure the same DR
DR system Unsigned integer. system priority for the
SystemPriority N/A
priority Value range: 0 to 65535. DR member devices in
a DR system.
Assign different DR
DR system Unsigned integer. system numbers to the
SystemNumber N/A
number Value range: 1 or 2. DR member devices in
a DR system.

1
 Data Unsigned integer.
restoration
RestoreDelay N/A Value range: 1 to 3600. N/A
interval in
seconds Default: 30.

Reload delay
timer in Unsigned integer.
AutoRecoveryR
seconds for N/A N/A
eloadDelay Value range: 240 to 3600.
DR system
auto-recovery

DRNI/Role
This table contains DRNI Role information.

XML structure
<DRNI>
<Role>
<LocalRolePriority></LocalRolePriority>
</Role>
</DRNI>

Table description
Item Description
Feature name DRNI
Table name Role
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column
Column name Data type and restrictions Remarks
description type
DR role
priority of the Unsigned integer.
The lower the value,the
LocalRolePriority local DR N/A Value range: 0 to 65535.
higher the priority.
member Default: 32768.
device

DRNI/Keepalive
This table contains DRNI Keepalive information.

2
XML structure
<DRNI>
<Keepalive>
<IPV4Addr>
<KeepaliveDestinationIPV4></KeepaliveDestinationIPV4>
<KeepaliveSourceIPV4></KeepaliveSourceIPV4>
</IPV4Addr>
<IPV6Addr>
<KeepaliveDestinationIPV6></KeepaliveDestinationIPV6>
<KeepaliveSourceIPV6></KeepaliveSourceIPV6>
</IPV6Addr>
<KeepaliveUDPPort></KeepaliveUDPPort>
<KeepaliveInterval></KeepaliveInterval>
<KeepaliveTimeout></KeepaliveTimeout>
<KeepaliveHoldTime></KeepaliveHoldTime>
<VRF></VRF>
</Keepalive>
</DRNI>

Table description
Item Description
Feature name DRNI
Table name Keepalive
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
Source and Members include:

IPV4Addr
destination IPv4 Data • KeepaliveDestinationIPV N/A
address of the structure 4.
keepalive link • KeepaliveSourceIPV4.
Destination IPv4 Example: 1.1.1.1
KeepaliveDes
address of the N/A String,dotted decimal notation.
tinationIPV4
keepalive link

Example: 1.1.1.2
Source IPv4 This column must be
KeepaliveSou
address of the N/A String,dotted decimal notation. with the
rceIPV4
keepalive link KeepaliveDestinationI
PV4 column.

3
 Source and Members include:

IPV6Addr
destination IPv6 Data • KeepaliveDestinationIPV N/A
address of the structure 6.
keepalive link • KeepaliveSourceIPV6.
Destination IPv6 Example: 1:1::1:1
KeepaliveDes Hexadecimal
address of the N/A
tinationIPV6 string,colon-separated.
keepalive link
Example: 1:1::1:2
Source IPv6 This column must be
KeepaliveSou Hexadecimal
address of the N/A with the
rceIPV6 string,colon-separated.
keepalive link KeepaliveDestinationI
PV6 column.
The
KeepaliveUDPPort
Keepalive Unsigned integer. must be with the IP
KeepaliveUD address and
destination UDP N/A Value range: 1 to 65535.
PPort
port Default: 6400 KeepaliveUDPPort will
be deleted when you
delete IP address.

Keepalive Unsigned integer

KeepaliveInte
interval in N/A Value range: 100 to 10000. N/A
rval
milliseconds Default: 1000.
The DR keepalive
Keepalive Unsigned integer. timeout timer must be
KeepaliveTim
timeout time in N/A Value range: 3 to 20 two times the DR
eout
seconds Default: 5. keepalive interval at
minimum.
Unsigned integer.
KeepaliveHol Keepalive hold
N/A Value range: 3 to 10. N/A
dTime time in seconds
Default: 3.

String, case-sensitive. If the local device is on

VRF instance
VRF N/A the public network, the
name Length: 0 to 31 characters. length of the string is 0.

DRNI/IPPTable
This table contains information about IPP ports.

XML structure
<DRNI>
<IPPTable>
<IPP>
<IPPNumber></IPPNumber>
<IfIndex></IfIndex>
</IPP>
</IPPTable>
</DRNI>

4
Table description
Item Description
Feature name DRNI
Table name IPPTable

Table type Multi-instance table

Row name IPP

Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
The IPP ID must be
IPPNumber IPP ID Index Unsigned integer.
fixed at 1.

IfIndex Interface index N/A Unsigned integer. N/A

DRNI/DRPortTable
This table contains information about DR ports.

XML structure
<DRNI>
<DRPortTable>
<DRPort>
<DRGroupId></DRGroupId>
<IfIndex></IfIndex>
</DRPort>
</DRPortTable>
</DRNI>

Table description
Item Description
Feature name DRNI

Table name DRPortTable

Table type Multi-instance table
Row name DRPort
Restrictions None

5
 Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions
name description type
Unsigned integer.
DRGroupId DR group ID Index
Value range: 1 to 1024.

IfIndex value of
the Layer 2
IfIndex N/A Unsigned integer.
aggregate
interface

DRNI/PortTable
This table contains information about DRNI ports.

XML structure
<DRNI>
<PortTable>
<Port>
<IfIndex></IfIndex>
<DrcpShortPeriodEnable></DrcpShortPeriodEnable>
</Port>
</PortTable>
</DRNI>

Table description
Item Description
Feature name DRNI
Table name PortTable
Table type Multi-instance table
Row name Port
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions
name description type
IfIndex Interface index Index Unsigned integer.

6
 Boolean:

DrcpShortPer Short DRCP • true—Enable the short

N/A DRCP timout timer.
iodEnable timout timer flag
• false—Disabled the short
DRCP timout timer.

7
Contents
DRNI ·····························································································1
DRNI/Base ································································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
DRNI/Role ·································································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 2
DRNI/Keepalive ··························································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4
DRNI/IPPTable ···························································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 6
DRNI/DRPortTable ······················································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 6
DRNI/PortTable ··························································································································· 7
XML structure ······················································································································· 7
Table description ··················································································································· 7
Columns ······························································································································ 7

i
DRNI
DRNI/Base
This table contains DRNI Base information.

XML structure
<DRNI>
<Base>
<SystemMAC></SystemMAC>
<SystemPriority></SystemPriority>
<SystemNumber></SystemNumber>
<RestoreDelay></RestoreDelay>
<AutoRecoveryReloadDelay></AutoRecoveryReloadDelay>
</Base>
</DRNI>

Table description
Item Description
Feature name DRNI
Table name Base
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Example: 0-1-0-1-0-1.
DR system Six groups of two hexadecimal Configure the same DR
SystemMAC N/A MAC address for the
MAC address digits, hyphen-separated.
DR member devices in
a DR system.
Configure the same DR
DR system Unsigned integer. system priority for the
SystemPriority N/A
priority Value range: 0 to 65535. DR member devices in
a DR system.

Assign different DR
DR system Unsigned integer. system numbers to the
SystemNumber N/A
number Value range: 1 to.2. DR member devices in
a DR system.

RestoreDelay Data N/A Unsigned integer. N/A

restoration

1
 interval in Value range: 1 to 3600.
seconds

Reload delay
timer in Unsigned integer.
AutoRecoveryR
seconds for N/A N/A
eloadDelay Value range: 240 to 3600.
DR system
auto-recovery

DRNI/Role
This table contains DRNI Role information.

XML structure
<DRNI>
<Role>
<LocalRolePriority></LocalRolePriority>
<PeerRolePriority></PeerRolePriority>
<LocalBridgeMAC></LocalBridgeMAC>
<PeerBridgeMAC></PeerBridgeMAC>
<LocalConfiguredRole></LocalConfiguredRole>
<PeerConfiguredRole></PeerConfiguredRole>
<LocalEffectiveRole></LocalEffectiveRole>
<PeerEffectiveRole></PeerEffectiveRole>
</Role>
</DRNI>

Table description
Item Description
Feature name DRNI
Table name Role
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
DR role priority Unsigned integer.
LocalRolePrio The lower the value,the
of the local DR N/A
rity Value range: 0 to 65535. higher the priority.
member device
DR role priority Unsigned integer.
PeerRolePrio The lower the value,the
of the peer DR N/A
rity Value range: 0 to 65535. higher the priority.
member device

2
 Bridge MAC
LocalBridgeM address of the Six groups of two hexadecimal
N/A N/A
AC local DR member digits,hyphen-separated.
device
Bridge MAC
PeerBridgeM address of the Six groups of two hexadecimal
N/A N/A
AC peer DR member digits,hyphen-separated.
device
DR role
calculated based
on the role Enumeration:
LocalConfigur priority and • 0—none.
N/A N/A
edRole bridge MAC • 1—primary.
address of the
• 2—secondary.
local DR member
device
DR role
calculated based
on the role Enumeration:
PeerConfigur priority and • 0—none.
N/A N/A
edRole bridge MAC • 1—primary.
address of the
• 2—secondary.
peer DR member
device
Enumeration:
Current role of
LocalEffective • 0—none.
the local DR N/A N/A
Role
member device • 1—primary.
• 2—secondary.
Enumeration:
Current role of
PeerEffective • 0—none.
the peer DR N/A N/A
Role
member device • 1—primary.
• 2—secondary.

DRNI/Keepalive
This table contains DRNI Keepalive information.

XML structure
<DRNI>
<Keepalive>
<IPV4Addr>
<KeepaliveDestinationIPV4></KeepaliveDestinationIPV4>
<KeepaliveSourceIPV4></KeepaliveSourceIPV4>
</IPV4Addr>
<IPV6Addr>
<KeepaliveDestinationIPV6></KeepaliveDestinationIPV6>
<KeepaliveSourceIPV6></KeepaliveSourceIPV6>
</IPV6Addr>
<KeepaliveUDPPort></KeepaliveUDPPort>
<KeepaliveInterval></KeepaliveInterval>
<KeepaliveTimeout></KeepaliveTimeout>

3
 <KeepaliveHoldTime></KeepaliveHoldTime>
<KeepaliveLinkStatus></KeepaliveLinkStatus>
<VRF></VRF>
</Keepalive>
</DRNI>

Table description
Item Description
Feature name DRNI
Table name Keepalive
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Source and Members include:

IPV4Addr
destination IPv4 Data • KeepaliveDestinationIPV N/A
address of the structure 4.
keepalive link • KeepaliveSourceIPV4.
Destination IPv4 Example: 1.1.1.1
KeepaliveDes
address of the N/A String,dotted decimal notation.
tinationIPV4
keepalive link
Example: 1.1.1.2
Source IPv4 This column must be
KeepaliveSou
address of the N/A String,dotted decimal notation. with the
rceIPV4
keepalive link KeepaliveDestinationI
PV4 column.

Source and Members include:

IPV6Addr
destination IPv6 Data • KeepaliveDestinationIPV N/A
address of the structure 6.
keepalive link • KeepaliveSourceIPV6.
Destination IPv6 Example: 1:1::1:1
KeepaliveDes Hexadecimal
address of the N/A
tinationIPV6 string,colon-separated.
keepalive link

Example: 1:1::1:2
Source IPv6 This column must be
KeepaliveSou Hexadecimal
address of the N/A with the
rceIPV6 string,colon-separated.
keepalive link KeepaliveDestinationI
PV6 column.

The
KeepaliveUDPPort
Keepalive Unsigned integer. must be with the IP
KeepaliveUD
destination UDP N/A address and
PPort Value range: 1 to 65535.
port
KeepaliveUDPPort will
be deleted when you

4
 delete IP address.

Keepalive Unsigned integer.

KeepaliveInte
Interval in N/A N/A
rval Value range: 100 to 10000.
milliseconds

The DR keepalive
Keepalive Unsigned integer. timeout timer must be
KeepaliveTim
timeout time in N/A two times the DR
eout Value range: 3 to 20.
seconds keepalive interval at
minimum.

KeepaliveHol Keepalive hold Unsigned integer.

N/A N/A
dTime time in seconds Value range: 3 to 10.
Enumeration:
KeepaliveLink Keepalive link • 0—unknow.
N/A N/A
Status status • 1—up.
• 2—down.

String, case-sensitive. If the local device is on

VPN instance
VRF N/A the public network, the
name Length: 0 to 31 characters. length of the string is 0.

DRNI/IPPTable
This table contains DRNI IPP information

XML structure
<DRNI>
<IPPTable>
<IPP>
<IPPNumber></IPPNumber>
<IfIndex></IfIndex>
</IPP>
</IPPTable>
</DRNI>

Table description
Item Description
Feature name DRNI
Table name IPPTable
Table type Multi -instance table
Row name IPP
Restrictions None

5
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer. The IPP ID must be
IPPNumber IPP ID Index
Value range: 1. fixed at 1.

IfIndex Interface index N/A Unsigned integer. N/A

DRNI/DRPortTable
This table contains information about DR ports.

XML structure
<DRNI>
<DRPortTable>
<DRPort>
<DRGroupId></DRGroupId>
<IfIndex></IfIndex>
</DRPort>
</DRPortTable>
</DRNI>

Table description
Item Description
Feature name DRNI
Table name DRPortTable
Table type Multi-instance table
Row name DRPort
Restrictions None

Columns
Column Column Column
Data type and restrictions
name description type
Unsigned integer.
DRGroupId DR group ID Index
Value range: 1 to 1024.
IfIndex value of
the Layer 2
IfIndex N/A Unsigned integer.
aggregate
interface

6
DRNI/PortTable
This table contains information about DRNI ports.

XML structure
<DRNI>
<PortTable>
<Port>
<IfIndex></IfIndex>
<DrcpShortPeriodEnable></DrcpShortPeriodEnable>
<PortStatus></PortStatus>
<LocalDRCPState></LocalDRCPState>
<PeerDRCPState></PeerDRCPState>
<LocalSelectedMemberList></LocalSelectedMemberList>
<PeerSelectedMemberList></PeerSelectedMemberList>
</Port>
</PortTable>
</DRNI>

Table description
Item Description
Feature name DRNI
Table name PortTable
Table type Multi-instance table
Row name Port
Restrictions None

Columns
Column Column Column
Data type and restrictions
name description type

IfIndex Interface index Index Unsigned integer.

Boolean:

DrcpShortPer Short DRCP • true—Enable the short

N/A DRCP timout timer.
iodEnable timout timer flag
• false—Disabled the short
DRCP timout timer.
Enumeration:
PortStatus Port status N/A • 0—down.
• 1—up.

LocalDRCPSt DRCP state on DRCP state flags.The flag field

N/A is one byte long,represented
ate the local port
by ABCDEFGH from the

7
 lowest bit to the highest bit.A
letter is displayed when its bit
is 1 and is not displayed when
its bit is 0.
• A—Indicates whether
DRCP is enabled on the
local device.1 indicates
enabled.0 indicates
disabled.
• B—Indicates whether
DRCP is enabled on the
DR peer.1 indicates
enabled.0 indicates
disabled.
• C—Indicates whether
DRCP is enabled on a
third DR member device.
1 indicates enabled.0
indicates disabled.
• D—Indicates whether the
local IPP has determined
that DRCP is enabled on
the DR peer.1 indicates
yes.0 indicates no.
• E—Indicates the DRCP
timeout timer.1 indicates
the short timeout timer.0
indicates the long timeout
timer.
• F—Indicates whether the
local IPP permits the
packets that contain the
negotiated gateway
conversation IDs.1
indicates yes.0 indicates
no.
• G—Indicates whether the
local IPP permits the
packets that contain the
negotiated port
conversation IDs.1
indicates yes.0 indicates
no.
• H—Indicates whether the
local DRCPDU receive
machine is in default or
expired state.1 indicates
yes.0 indicates no.
This column has the same data
PeerDRCPSt DRCP state on
N/A type and restrictions as
ate the peer port
LocalDRCPState.
Bitmap. No length restrictions.
Each octet within this value
Local DR specifies a set of eight
member device’s ports,with the first octet
selected specifying ports 1 through
LocalSelecte
aggregate N/A 8,the second octet specifying
dMemberList
member ports in ports 9 through 16,and so
a distributed on.Within each octet,the most
relay group significant bit represents the
lowest numbered port,and the
least significant bit represents

8
 the highest numbered
port.Each port of the bridge is
represented by a single bit
within the value of this object.If
a bit has a value of 1 then the
port is included in the set of
ports;a port is not included if its
bit has a value of 0.
Peer DR
member device’s
selected This column has the same data
PeerSelected
aggregate N/A type and restrictions as
MemberList
member ports in LocalSelectedMemberList.
a distributed
relay group

9
Contents
DRNI ·····························································································2
DRNI/Base ······························································································································· 2
DRNI/Role ································································································································ 2
DRNI/Keepalive ························································································································· 2
DRNI/IPPTable ·························································································································· 3
DRNI/DRPortTable ····················································································································· 3
DRNI/PortTable ························································································································· 3

i
DRNI
DRNI/Base
Message Explanation
The MAC address cannot be an all-zero address, a
multicast address, or a broadcast address. The system MAC address cannot be an all-zero address, a
不允许配置MAC地址为全零MAC地址、组播MAC地 multicast address, or a broadcast address.
址或广播MAC地址。

DRNI/Role
Message Explanation
None.
None.
无。

DRNI/Keepalive
Message Explanation
Please specify the destination IP addresses of
keepalive packets. Specify the destination IP address of keepalive link.
指定Keepalive报文的目的IP地址。

The destination and source IP addresses cannot

be the same. The destination address must be different from the source.
目的IP地址和源IP地址不能相同。

You cannot specify both IPv4 and IPv6 addresses

for keepalive packets. The destination and source address of keepalive link must be the
same family.
不能同时指定IPv4地址和IPv6地址。

Invalid destination or source IP address. The IP address is invalid,keepalive must config with a legal
无效的源/目的IP地址。 address.

Please delete all parameters of keepalive

configuration. You need to delete all parameters.
请删除所有的keepalive配置参数。

The source and destination IP addresses of

keepalive packets must have the same internet
protocol version. The family of destination and source address must be the same.
Keepalive报文的源IP地址和目的IP地址必须使用相
同的IP地址协议。

2
DRNI/IPPTable
Message Explanation
The interface is already configured as a DR
interface. The interface is a DR interface, you can’t configure to an IPP
again.
该接口已经是DR口。

The device already has an IPP.

A device can only configure an IPP.
设备已经存在一个IPP口。

Please specify a valid interface index.

对于merge、create、replace操作，请指定有效的接 The ifindex must set to a interface exist.
口索引。

The interface must be a Layer 2 aggregate

interface or tunnel interface. The IPP must configure to a Layer 2 aggregate interface or tunnel
interface.
该接口必须是二层聚合接口或Tunnel接口。

DRNI/DRPortTable
Message Explanation
The interface is already configured as a DR
interface. The interface is with another DR id.
该接口已经是DR口。

The interface is already configured as an IPP. The interface is already a IPP,you can not.set it to a DR interface
该接口已经是IPP口。 again.

The interface must be a Layer 2 aggregate

interface. The DR id must set to a Layer 2 aggregate interface.
该接口必须是二层聚合接口。

The DR group with the specified ID is already

configured on another interface. A device can not have two group with the same DR id.
该DR口ID已经存在。

Please specify a valid interface index.

对于merge、create、replace操作，请指定有效的接 The ifindex must set to a interface exist.
口索引。

DRNI/PortTable
Message Explanation
None.
None.
无。

3
Contents
DRNI event stream ···········································································1
BaseInfoEvent event····················································································································· 1
XML structure for event subscription ························································································· 1
XML structure for event report ································································································· 1
RoleInfoEvent event ····················································································································· 2
XML structure for event subscription ························································································· 2
XML structure for event report ································································································· 3
PortInfoEvent event ······················································································································ 3
XML structure for event subscription ························································································· 3
XML structure for event report ································································································· 4
DRNI event stream
BaseInfoEvent event
This event is used to report DRNI BaseInfo.

XML structure for event subscription

<BaseInfoEvent>
</BaseInfoEvent>

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>DRNI</stream>
<filter type="subtree">
<BaseInfoEvent xmlns="http://www.h3c.com/netconf/event:1.0/DRNI:1.0">
</BaseInfoEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name DRNI
Event name BaseInfoEvent
Event namespace http://www.h3c.com/netconf/event:1.0/DRNI:1.0
Support for extended query No

XML structure for event report

<BaseInfoEvent>
<BaseInfo>
<SystemMAC></SystemMAC>
<OperationType></OperationType>
</BaseInfo>
</BaseInfoEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<BaseInfoEvent xmlns="http://www.h3c.com/netconf/event:1.0/DRNI:1.0">
<BaseInfo>
<SystemMAC>00-01-00-01-00-01</SystemMAC>
<OperationType>1</OperationType>
 </BaseInfo>
</BaseInfoEvent>
</notification>

Table description

Support for
Column Column Data type and
extended Remarks
name description restrictions
query
Six groups of two You must configure the
hexadecimal digits, same DR system MAC
DR system hyphen-separated.
SystemMAC No address for the DR
MAC address
Example: member devices in a DR
00-01-00-01-00-01. system.

Enumeration: The operation type

OperationTyp • 1—Create. specifies the operation
Operation type No
e • 2—Modify. that DRNI BaseInfo
should perform.
• 3—Delete.

RoleInfoEvent event
This event is used to report DRNI RoleInfo.

XML structure for event subscription

<RoleInfoEvent>
</RoleInfoEvent>

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>DRNI</stream>
<filter type="subtree">
<RoleInfoEvent xmlns="http://www.h3c.com/netconf/event:1.0/DRNI:1.0">
</RoleInfoEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name DRNI
Event name RoleInfoEvent
Event namespace http://www.h3c.com/netconf/event:1.0/DRNI:1.0
Support for extended query No
XML structure for event report
<RoleInfoEvent>
<LocalBridgeMAC></LocalBridgeMAC>
<PeerBridgeMAC></PeerBridgeMAC>
</RoleInfoEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<RoleInfoEvent xmlns="http://www.h3c.com/netconf/event:1.0/DRNI:1.0">
<RoleInfo>
<LocalBridgeMAC>00-01-00-01-00-01</LocalBridgeMAC>
<PeerBridgeMAC>00-01-00-01-00-03</PeerBridgeMAC>
</RoleInfo>
</RoleInfoEvent>
</notification>

Table description

Column Support for

Column description Data type and restrictions
name extended query
Six groups of two hexadecimal
LocalBridgeM Bridge MAC address of the
digits, hyphen-separated. No
AC local device
Example: 00-01-00-01-00-01.
Six groups of two hexadecimal
PeerBridgeM Bridge MAC address of the
digits, hyphen-separated. No
AC peer device
Example: 00-01-00-01-00-01.

PortInfoEvent event
This event is used to report DRNI PortInfo.

XML structure for event subscription

<PortInfoEvent>
</PortInfoEvent>

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>DRNI</stream>
<filter type="subtree">
<PortInfoEvent xmlns="http://www.h3c.com/netconf/event:1.0/DRNI:1.0">
</PortInfoEvent>
</filter>
</create-subscription>
</rpc>
Table description

Item Description
Event stream name DRNI
Event name PortInfoEvent
Event namespace http://www.h3c.com/netconf/event:1.0/DRNI:1.0
Support for extended query No

XML structure for event report

<PortInfoEvent>
<PortInfo>
<IfIndex></IfIndex>
<DRGroupId></DRGroupId>
<OperationType></OperationType>
</PortInfo>
</PortInfoEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<PortInfoEvent xmlns="http://www.h3c.com/netconf/event:1.0/DRNI:1.0">
<PortInfo>
<IfIndex>66</IfIndex>
<DRGroupId>66</DRGroupId>
<OperationType>1</OperationType>
</PortInfo>
</PortInfoEvent>
</notification>

Table description

Support for
Column Column Data type and
extended Remarks
name description restrictions
query
Aggregation
Interface name is not
IfIndex interface Unsigned integer. No
supported.
ifIndex

Unsigned integer.
DRGroupId DR group ID No N/A
Value range: 1 to 1024.
Enumeration: The operation type
OperationTyp • 1—Create. specifies the operation
Operation type No
e • 2—Modify. that DNRI PortInfo
should perform.
• 3—Delete.
Contents
DropStatistics ·································································································· 1
DropStatistics/ClearAppStatistics ······················································································································ 1
XML structure ············································································································································· 1
Table description ········································································································································ 1
Columns ····················································································································································· 1
DropStatistics/ExportPacket ······························································································································ 2
XML structure ············································································································································· 2
Table description ········································································································································ 2
Columns ····················································································································································· 2

i
DropStatistics
DropStatistics/ClearAppStatistics
This table contains information about the cleared statistics of packet loss.

XML structure
<DropStatistics>
<ClearAppStatistics>
<ClearAppStatistic>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<AppName></AppName>
<Clear></Clear>
</ClearAppStatistic>
</ClearAppStatistics>
</DropStatistics>

Table description
Item Description
Feature name DropStatistics
Table name ClearAppStatistics
Table type Multi-instance table
Row name ClearAppStatistic
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ID of the member Unsigned integer.
Chassis where the Index N/A
interface resides. Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot Index N/A
interface. Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID. Index N/A
Value range: 0 to 7.

Name of the String.

AppName N/A N/A
application Length: 1 to 15 characters.

Clear Clear statistics of N/A This column must be empty. N/A

packet loss for

1
 Column Column Column
Data type and restrictions Remarks
name description type
an application

DropStatistics/ExportPacket
This table is used to export captured packets to a file.

XML structure
<DropStatistics>
<ExportPacket>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<AppName></AppName>
</ExportPacket>
</DropStatistics>

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

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ID of the member Unsigned integer.
Chassis where the N/A N/A
interface resides Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot N/A N/A
interface Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID N/A N/A
Value range: 0 to 7.

Name of the String.

AppName N/A This column is required.
application Length: 1 to 15 characters.

2
Contents
DropStatistics ·································································································· 1
DropStatistics/StatisticsCfg ································································································································ 1
XML structure ············································································································································· 1
Table description ········································································································································ 1
Columns ····················································································································································· 1

i
DropStatistics
DropStatistics/StatisticsCfg
This table contains the dropped-packet statistics settings.

XML structure
<DropStatistics>
<StatisticsCfg>
<FilterType></FilterType>
<SrcAddress></SrcAddress>
<DstAddress></DstAddress>
<UserName></UserName>
<DomainName></DomainName>
</StatisticsCfg>
</DropStatistics>

Table description
Item Description
Feature name DropStatistics
Table name StatisticsCfg
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:
Leaving this column
• 0—Does not filter.
FilterType Filter type N/A empty has the same
• 1—Filters by address. effect as setting it to 0.
• 2—Filters by user.
IPv4: String, dotted decimal
IPv4 example: 1.1.1.1.
notation.
SrcAddress Source address N/A IPv6 example:
IPv6: Hexadecimal string,
1:2:3:4:5:6:7:8.
colon-separated.

IPv4: String, dotted decimal IPv4 example: 1.1.1.1.

Destination notation.
DstAddress N/A IPv6 example:
address
IPv6: Hexadecimal string, 1:2:3:4:5:6:7:8.
Column Column Column
Data type and restrictions Remarks
name description type
colon-separated.
String, case sensitive.
UserName Username N/A N/A
Length: 1 to 55 characters.
String, case insensitive.
DomainName Domain name N/A N/A
Length: 1 to 255 characters.
Contents
DropStatistics ·································································································· 1
DropStatistics/SummaryStatistics ······················································································································ 1
XML structure ············································································································································· 1
Table description ········································································································································ 1
Columns ····················································································································································· 1
DropStatistics/AppDetailStatistics ······················································································································ 2
XML structure ············································································································································· 2
Table description ········································································································································ 2
Columns ····················································································································································· 2
DropStatistics/AppSupportInfos ························································································································· 3
XML structure ············································································································································· 3
Table description ········································································································································ 3
Columns ····················································································································································· 3
DropStatistics/AppDropAddresses ····················································································································· 4
XML structure ············································································································································· 4
Table description ········································································································································ 4
Columns ····················································································································································· 5
DropStatistics/AppDetailDropAddresses ··········································································································· 5
XML structure ············································································································································· 5
Table description ········································································································································ 6
Columns ····················································································································································· 6
DropStatistics/StatisticsCfg ································································································································ 7
XML structure ············································································································································· 7
Table description ········································································································································ 7
Columns ····················································································································································· 7
DropStatistics/SummaryIPCounts ······················································································································ 8
XML structure ············································································································································· 8
Table description ········································································································································ 8
Columns ····················································································································································· 8
DropStatistics/DetailIPCounts ···························································································································· 9
XML structure ············································································································································· 9
Table description ········································································································································ 9
Columns ··················································································································································· 10

i
DropStatistics
DropStatistics/SummaryStatistics
This table contains the summaries of packet loss.

XML structure
<DropStatistics>
<SummaryStatistics>
<SummaryStatistic>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<SumStatisticsString></SumStatisticsString>
</SummaryStatistic>
</SummaryStatistics>
</DropStatistics>

Table description
Item Description
Feature name DropStatistics
Table name SummaryStatistics
Table type Multi-instance table
Row name SummaryStatistic
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ID of the member Unsigned integer.
Chassis where the Index N/A
interface resides. Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot Index N/A
interface. Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID. Index N/A
Value range: 0 to 7.
Separate the pack loss
applications with
SumStatistics Summaries of comma(,).
N/A String.
String packet loss.
Separate the
application and value

1
 Column Column Column
Data type and restrictions Remarks
name description type
with colon(:).
Can not contain
spaces.

DropStatistics/AppDetailStatistics
This table contains the details of packet loss for an application.

XML structure
<DropStatistics>
<AppDetailStatistics>
< AppDetailStatistic>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<AppName></AppName>
<AppDetailString></AppDetailString>
</AppDetailStatistic>
</AppDetailStatistics>
</DropStatistics>

Table description
Item Description
Feature name DropStatistics
Table name AppDetailStatistics
Table type Multi-instance table
Row name AppDetailStatistic
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ID of the member Unsigned integer.
Chassis where the Index N/A
interface resides. Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot Index N/A
interface. Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID. Index N/A
Value range: 0 to 7.

2
 Column Column Column
Data type and restrictions Remarks
name description type
Name of the String.
AppName Index N/A
Application Length: 1 to 15 characters.
Separate the pack loss
types with comma(,).
Details of
AppDetailStri Separate the type and
theapplication’s N/A String.
ng value with colon(:).
packet loss.
Can not contain
spaces.

DropStatistics/AppSupportInfos
This table contains support of applications for packet capture.

XML structure
<DropStatistics>
<AppSupportInfos>
<AppSupportInfo>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<AppName></AppName>
<SupportPktCapture></SupportPktCapture>
</AppSupportInfo>
</AppSupportInfos>
</DropStatistics>

Table description
Item Description
Feature name DropStatistics
Table name AppSupportInfos
Table type Multi-instance table
Row name AppSupportInfo
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ID of the member Unsigned integer.
Chassis where the Index N/A
interface resides Value range: 0 to 65535.

3
 Column Column Column
Data type and restrictions Remarks
name description type
Slot ID of the Unsigned integer.
Slot Index N/A
interface Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID. Index N/A
Value range: 0 to 7.

Name of the String.

AppName Index N/A
application Length: 1 to 15 characters.
Boolean:

SupportPktCa Support for • true—Supports packet

N/A capture. N/A
pture packet capture
• false—Does not support
packet capture.

DropStatistics/AppDropAddresses
This table contains dropped-packet statistics for connections of features.

XML structure
<DropStatistics>
<AppDropAddresses>
<AppDropAddress>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<AppName></AppName>
<SrcAddress></SrcAddress>
<DstAddress></DstAddress>
<UserName></UserName>
<DomainName></DomainName>
<OriginalNum></OriginalNum>
<ReplyNum></ReplyNum>
</AppDropAddress>
</AppDropAddresses>
</DropStatistics>

Table description
Item Description
Feature name DropStatistics
Table name AppDropAddresses
Table type Multi-instance table
Row name AppDropAddress
Restrictions None

4
Columns
Column Column Column
Data type and restrictions Remarks
name description type
ID of the member Unsigned integer.
Chassis where the Index N/A
interface resides Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot Index N/A
interface Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index N/A
Value range: 0 to 7.
String.
AppName Feature name Index N/A
Length: 1 to 15 characters.
IPv4: String, dotted decimal
IPv4 example: 1.1.1.1.
notation.
SrcAddress Source address Index IPv6 example:
IPv6: Hexadecimal string,
1:2:3:4:5:6:7:8.
colon separated.
IPv4: String, dotted decimal
IPv4 example: 1.1.1.1.
Destination notation.
DstAddress Index IPv6 example:
address IPv6: Hexadecimal string,
1:2:3:4:5:6:7:8.
colon separated.
String, case sensitive.
UserName Username N/A N/A
Length: 1 to 55 characters.
String, case insensitive.
DomainName Domain name N/A N/A
Length: 1 to 255 characters.
Number of Unsigned integer.
OriginalNum packets dropped N/A N/A
for original Value range: 0 to 264 - 1.

Number of Unsigned integer.

ReplyNum packets dropped N/A 64 N/A
for reply Value range: 0 to 2 - 1.

DropStatistics/AppDetailDropAddresses
This table contains detailed dropped-packet statistics for connections of features.

XML structure
<DropStatistics>
<AppDetailDropAddresses>
<AppDetailDropAddress>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<AppName></AppName>

5
 <DropReason></DropReason>
<SrcAddress></SrcAddress>
<DstAddress></DstAddress>
<UserName></UserName>
<DomainName></DomainName>
<OriginalNum></OriginalNum>
<ReplyNum></ReplyNum>
</AppDetailDropAddress>
</AppDetailDropAddresses>
</DropStatistics>

Table description
Item Description
Feature name DropStatistics
Table name AppDetailDropAddresses
Table type Multi-instance table
Row name AppDetailDropAddress
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ID of the member Unsigned integer.
Chassis where the Index N/A
interface resides Value range: 0 to 65535.

Slot ID of the Unsigned integer.

Slot Index N/A
interface Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index N/A
Value range: 0 to 7.
String.
AppName Feature name Index N/A
Length: 1 to 15 characters.
String.
DropReason Drop reason Index N/A
Length: 1 to 63 characters.
IPv4: String, dotted decimal
IPv4 example: 1.1.1.1.
notation.
SrcAddress Source address Index IPv6 example:
IPv6: Hexadecimal string,
1:2:3:4:5:6:7:8.
colon separated.
IPv4: String, dotted decimal
IPv4 example: 1.1.1.1.
Destination notation.
DstAddress Index IPv6 example:
address IPv6: Hexadecimal string,
1:2:3:4:5:6:7:8.
colon separated.
String, case sensitive.
UserName Username N/A N/A
Length: 1 to 55 characters.

6
 String, case insensitive.
DomainName Domain name N/A N/A
Length: 1 to 255 characters.
Number of Unsigned integer.
OriginalNum packets dropped N/A 64 N/A
for original Value range: 0 to 2 - 1.

Number of Unsigned integer.

ReplyNum packets dropped N/A 64 N/A
for reply Value range: 0 to 2 - 1.

DropStatistics/StatisticsCfg
This table contains the dropped-packet statistics settings.

XML structure
<DropStatistics>
<StatisticsCfg>
<FilterType></FilterType>
<SrcAddress></SrcAddress>
<DstAddress></DstAddress>
<UserName></UserName>
<DomainName></DomainName>
</StatisticsCfg>
</DropStatistics>

Table description
Item Description
Feature name DropStatistics
Table name StatisticsCfg
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
Leaving this column
• 0—Does not filter.
FilterType Filter type N/A empty has the same
• 1—Filter by address. effect as setting it to 0.
• 2—Filters by user.
IPv4: String, dotted decimal IPv4 example: 1.1.1.1.
SrcAddress Source address N/A notation. IPv6 example:
IPv6: Hexadecimal string, 1:2:3:4:5:6:7:8.

7
 Column Column Column
Data type and restrictions Remarks
name description type
colon separated.
IPv4: String, dotted decimal
IPv4 example: 1.1.1.1.
Destination notation.
DstAddress N/A IPv6 example:
address IPv6: Hexadecimal string,
1:2:3:4:5:6:7:8.
colon separated.
String, case sensitive.
UserName UserName N/A N/A
Length: 1 to 55 characters.
String, case insensitive.
DomainName DomainName N/A N/A
Length: 1 to 255 characters.

DropStatistics/SummaryIPCounts
This table is used to obtain the number of connections of a feature for which dropped-packet
statistics are configured.

XML structure
<DropStatistics>
<SummaryIPCounts>
<SummaryIPCount>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<AppName></AppName>
<Count></Count>
</SummaryIPCount>
</SummaryIPCounts>
</DropStatistics>

Table description
Item Description
Feature name DropStatistics
Table name SummaryIPCounts
Table type Multi-instance table
Row name SummaryIPCount
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
Chassis ID of the member Index Unsigned integer.

8
 Column name Column description Column type Data type and restrictions
where the interface Value range: 0 to 65535.
resides
Unsigned integer.
Slot Slot ID of the interface Index
Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index
Value range: 0 to 7.
String.
AppName Feature name Index
Length: 1 to 15 characters.
Number of connections
of a feature for which Unsigned integer.
Count N/A 64
dropped-packet Value range: 0 to 2 - 1.
statistics are configured

DropStatistics/DetailIPCounts
This table is used to obtain the number of connections of a feature that have packets dropped due
to a specific reason.

XML structure
<DropStatistics>
<DetailIPCounts>
<DetailIPCount>
<Chassis></Chassis>
<Slot></Slot>
<CPUID></CPUID>
<AppName></AppName>
<DropReason></DropReason>
<Count></Count>
</DetailIPCount>
</DetailIPCounts>
</DropStatistics>

Table description
Item Description
Feature name DropStatistics
Table name DetailIPCounts
Table type Multi-instance table
Row name DetailIPCount
Restrictions None

9
Columns
Column name Column description Column type Data type and restrictions
ID of the member Unsigned integer.
Chassis where the interface Index
resides Value range: 0 to 65535.

Unsigned integer.
Slot Slot ID of the interface Index
Value range: 0 to 65535.
Unsigned integer.
CPUID CPU ID Index
Value range: 0 to 7.
String.
AppName Feature name Index
Length: 1 to 15 characters.
String.
DropReason Drop reason Index
Length: 1 to 63 characters.
Number of connections
of a feature that have Unsigned integer.
Count N/A 64
packets dropped due to Value range: 0 to 2 - 1.
a specific reason

10
Contents
ETH ······························································································1
ETH/SubInterfaces ······················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
ETH/VlanQinQTermination ············································································································ 2
XML structure ······················································································································· 2
Table description ··················································································································· 3
Columns ······························································································································ 3
ETH/UnderlayForwardBypass ········································································································ 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 5

i
ETH
ETH/SubInterfaces
This table contains VLAN termination information.

XML structure
<ETH>
<SubInterfaces>
<SubInterface>
<IfIndex></IfIndex>
<EncapType></EncapType>
<VlanID></VlanID>
<FirstVlanList></FirstVlanList>
<EncapFlag></EncapFlag>
<IsUserVlanMode></IsUserVlanMode>
</SubInterface>
</SubInterfaces>
</ETH>

Table description
Item Description
Feature name ETH
Table name SubInterfaces
Table type Multi-instance table
Row name SubInterface
Restrictions No
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
IfIndex Interface index Index Unsigned integer.
information, see
the XSD document
of your product.

1
 Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 0—None.
VLAN • 1—Dot1q unambiguous.
EncapType N/A N/A
termination type • 2—Dot1q ambiguous.
• 5—Untagged.
• 6—Default.
Outermost VLAN
tag for
Unsigned integer. unambiguous
Outermost VLAN VLAN termination.
VlanID N/A Value range:
ID
1 to 4094 Used when the
“EncapType”
column is 1.
Specifies a
space-separated
VLAN ID list items.
Each item specifies
a VLAN ID or a
range of VLAN IDs
in the form of
vlan-id1 to vlan-id2.
The value range for
Outermost VLAN VLAN IDs is 1 to
FirstVlanList N/A String. 4094. The value for
ID list
the vlan-id2
argument must be
equal to or greater
than the value for
the vlan-id1
argument.
Used when the
“EncapType”
column is 2.
Configures the
subinterface to
terminate Unsigned integer.
• 0—STRICT
EncapFlag packets that N/A Value range:
include one or • 1—LOOSE
0 to 1
more layers of
VLAN tags

VLAN Boolean: Some version

IsUserVlanM
ode
termination N/A • true—user-vlan. might not support
mode • false—vlan-type. this column.

ETH/VlanQinQTermination
This table contains QinQ VLAN termination information.

XML structure
<ETH>
<VlanQinQTermination>

2
 <QinqTermination>
<IfIndex></IfIndex>
<VlanID></VlanID>
<SecondVlan></SecondVlan>
<QinqAny></QinqAny>
<EncapFlag></EncapFlag>
<IsUserVlanMode></IsUserVlanMode>
</QinqTermination>
</VlanQinQTermination>
</ETH>

Table description
Item Description
Feature name ETH
Table name VlanQinQTermination
Table type Multi-instance table
Row name QinqTermination
Restrictions No
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
IfIndex Interface index Index Unsigned integer.
information, see
the XSD document
of your product.
Unsigned integer.
VlanID Layer 1 VLAN ID Index Value range: N/A
1 to 4094
Specifies a
space-separated
VLAN ID list items.
Each item specifies
a VLAN ID or a
range of VLAN IDs
in the form of
Layer 2 VLAN ID vlan-id1 to vlan-id2.
SecondVlan N/A String.
or VLAN ID list The value range for
VLAN IDs is 1 to
4094. The value for
the vlan-id2
argument must be
equal to or greater
than the value for
the vlan-id1

3
 Column Column Column
Data type and restrictions Remarks
name description type
argument.
Note: The
“SecondVlan”
column and the
“QinqAny” column
cannot be
configured at the
same time.
Note: The
“SecondVlan”
Specifies all Unsigned integer. column and the
QinqAny values between N/A Value range: “QinqAny” column
1 and 4094 1 cannot be
configured at the
same time.
Configures the
subinterface to
receive and Unsigned integer.
terminate • 0—STRICT
EncapFlag N/A Value range:
packets that • 1—LOOSE
include two or 0 to 1
more layers of
VLAN tags

VLAN Boolean: Some versions

IsUserVlanM
ode
termination N/A • true—user-vlan. might not support
mode • false—vlan-type. this column.

ETH/UnderlayForwardBypass
This table contains underlay forward bypass information.

XML structure
<ETH>
<UnderlayForwardBypass>
<Bypass>
<IfIndex></IfIndex>
<Enable></Enable>
</Bypass>
</UnderlayForwardBypass>
</ETH>

Table description
Item Description
Feature name ETH
Table name UnderlayForwardBypass
Table type Multi-instance table

4
 Item Description
Row name Bypass
Restrictions No
Support for row creation and
Yes
deletion

Columns
Column Column Colum Data type and
Remarks
name description n type restrictions
Only Layer 3
physical interfaces
are supported.
Some versions
support interface
name. For relevant
information, see
Interface
IfIndex Index Unsigned integer. the XSD document
index
of your product. For
information about
IfIndex, see
“Appendix” in Ifmgr
NETCONF XML
API Configuration
Reference.
Specifies
the action of Boolean:

Enable
whether or not to
N/A • true—Enable the function. N/A
bypass the • false—Disable the
VXLAN packets function.
from ETH.

5
Contents
ETH ······························································································1
ETH/SubInterfaces ······················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
ETH/ETHSpecification ·················································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 3
ETH/VlanQinQTermination ············································································································ 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4
ETH/UnderlayForwardBypass ········································································································ 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 5

i
ETH
ETH/SubInterfaces
This table contains VLAN termination information.

XML structure
<ETH>
<SubInterfaces>
<SubInterface>
<IfIndex></IfIndex>
<EncapType></EncapType>
<VlanID></VlanID>
<FirstVlanList></FirstVlanList>
<EncapFlag></EncapFlag>
<IsUserVlanMode></IsUserVlanMode>
</SubInterface>
</SubInterfaces>
</ETH>

Table description
Item Description
Feature name ETH
Table name SubInterfaces
Table type Multi-instance table
Row name SubInterface
Restrictions No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Some versions
support interface
name. For relevant
IfIndex Interface index Index Unsigned integer.
information, see
the XSD document
of your product.

1
 Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 0—None.
• 1—Dot1q unambiguous.
VLAN • 2—Dot1q ambiguous.
EncapType N/A N/A
termination type • 3—Qinq unambiguous.
• 4—Qinq ambiguous.
• 5—Untagged.
• 6—Default.

Unsigned integer. Outermost VLAN

Outermost VLAN tag for
VlanID N/A Value range:
ID unambiguous
1 to 4094 VLAN termination.
A range of
Outermost VLAN
FirstVlanList N/A String. outermost VLAN
ID list
IDs.
Configures the
subinterface to
terminate Unsigned integer.
• 0—STRICT
EncapFlag packets that N/A Value range:
include one or • 1—LOOSE
0 to 1
more layers of
VLAN tags

VLAN Boolean: Some versions

IsUserVlanM
ode
termination N/A • true—user-vlan. might not support
mode • false—vlan-type. this column.

ETH/ETHSpecification
This table contains VLAN termination support information.

XML structure
<ETH>
<ETHSpecification>
<SupportDot1q></SupportDot1q>
<SupportQinq></SupportQinq>
<SupportUntagged></SupportUntagged>
<SupportDefault></SupportDefault>
<SupportLoose></SupportLoose>
</ETHSpecification>
</ETH>

Table description
Item Description
Feature name ETH

2
 Table name ETHSpecification
Table type Multi-instance table
Row name N/A
Restrictions No

Columns
Column Data type and
Column description Column type
name restrictions
Boolean:
SupportDot1q Whether Dot1q termination is supported N/A • true
• false
Boolean:
SupportQinq Whether Qinq termination is supported N/A • true
• false
Boolean:
SupportUntag
ged
Whether Untagged termination is supported N/A • true
• false
Boolean:
SupportDefau
lt
Whether Default termination is supported N/A • true
• false

Whether the subinterface supports Boolean:

SupportLoose terminating packets that include one or more N/A • true
layers of VLAN tags. • false

ETH/VlanQinQTermination
This table contains QinQ VLAN termination information.

XML structure
<ETH>
<VlanQinQTermination>
<QinqTermination>
<IfIndex></IfIndex>
<VlanID></VlanID>
<SecondVlan></SecondVlan>
<QinqAny></QinqAny>
<EncapFlag></EncapFlag>
<IsUserVlanMode></IsUserVlanMode>
</QinqTermination>
</VlanQinQTermination>
</ETH>

3
Table description
Item Description
Feature name ETH
Table name VlanQinQTermination
Table type Multi-instance table
Row name QinqTermination
Restrictions No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Some versions
support interface
name. For relevant
IfIndex Interface index Index Unsigned integer.
information, see
the XSD document
of your product.
Unsigned integer.
VlanID Layer 1 VLAN ID Index Value range: N/A
1 to 4094
Specifies a
space-separated
VLAN ID list items.
Each item specifies
a VLAN ID or a
range of VLAN IDs
in the form of
vlan-id1 to vlan-id2.
The value range for
VLAN IDs is 1 to
4094. The value for
Layer 2 VLAN ID the vlan-id2
SecondVlan N/A String. argument must be
or VLAN ID list
equal to or greater
than the value for
the vlan-id1
argument.
Note: The
“SecondVlan”
column and the
“QinqAny” column
cannot be
configured at the
same time.
Note: The
“SecondVlan”
Specifies all Unsigned integer. column and the
QinqAny values between N/A Value range: “QinqAny” column
1 and 4094 1 cannot be
configured at the
same time.

4
 Column Column Column
Data type and restrictions Remarks
name description type
Configures the
subinterface to
receive and Unsigned integer.
terminate • 0—STRICT
EncapFlag N/A Value range:
packets that • 1—LOOSE
include two or 0 to 1
more layers of
VLAN tags

VLAN Boolean: Some versions

IsUserVlanM
ode
termination N/A • true—user-vlan. might not support
mode • false—vlan-type. this column.

ETH/UnderlayForwardBypass
This table contains underlay forward bypass information.

XML structure
<ETH>
<UnderlayForwardBypass>
<Bypass>
<IfIndex></IfIndex>
<Enable></Enable>
</Bypass>
</UnderlayForwardBypass>
</ETH>

Table description
Item Description
Feature name ETH
Table name UnderlayForwardBypass
Table type Multi-instance table
Row name Bypass
Restrictions No

Columns
Column Column Colum Data type and
Remarks
name description n type restrictions
Only Layer 3
physical interfaces
Interface are supported.
IfIndex Index Unsigned integer.
index Some versions
support interface
name. For relevant

5
 Column Column Colum Data type and
Remarks
name description n type restrictions
information, see
the XSD document
of your product. For
information about
IfIndex, see
“Appendix” in Ifmgr
NETCONF XML
API Configuration
Reference.
Specifies
the action of Boolean:

Enable
whether or not to
N/A • true—Enable the function. N/A
bypass the • false—Disable the
VXLAN packets function.
from ETH.

6
Contents
FCFabric ························································································1
FCFabric/SmartSANStatus ············································································································ 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1

i
FCFabric
FCFabric/SmartSANStatus
This table contains the status of Smart SAN for FC/FCoE and iSCSI.

XML structure
<FCFabric>
<SmartSANStatus>
<FCoEStatus></FCoEStatus>
<iSCSIStatus></iSCSIStatus>
</SmartSANStatus>
</FCFabric>

Table description
Item Description
Feature name FCFabric
Table name SmartSANStatus
Table type Single-instance table
Row name None
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
Boolean:
FCoEStatus Status of Smart SAN for FC/FCoE. N/A • true—Enabled.
• false—Disabled(default).
Boolean:
iSCSIStatus Status of Smart SAN for iSCSI. N/A • true—Enabled.
• false—Disabled(default).

1
Contents
FCFabric ························································································1
FCFabric/SmartSANStatus ············································································································ 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1

i
FCFabric
FCFabric/SmartSANStatus
This table contains the status of Smart SAN for FC/FCoE and iSCSI.

XML structure
<FCFabric>
<SmartSANStatus>
<FCoEStatus></FCoEStatus>
<iSCSIStatus></iSCSIStatus>
</SmartSANStatus>
</FCFabric>

Table description
Item Description
Feature name FCFabric
Table name SmartSANStatus
Table type Single-instance table
Row name None
Restrictions None

Columns
Column name Column description Column type Data type and restrictions
Boolean:
FCoEStatus Status of Smart SAN for FC/FCoE. N/A • true—Enabled.
• false—Disabled.
Boolean:
iSCSIStatus Status of Smart SAN for iSCSI. N/A • true—Enabled.
• false—Disabled.

1
Contents
FCLink ···························································································1
FCLink/PortEntryInfo ···················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1

i
FCLink
FCLink/PortEntryInfo
This table contains information about a port.

XML structure
<FCLink>
<PortEntryInfo>
<EntryInfo>
<IfIndex></IfIndex>
<PortWwn></PortWwn>
</EntryInfo>
</PortEntryInfo>
</FCLink>

Table description
Item Description
Feature name FCLink
Table name PortEntryInfo
Table type Multi-instance table
Row name EntryInfo
Restrictions None

Columns
Column Data type and
Column description Column type Remarks
name restrictions
Some versions
support interface
names. 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.

PortWwn WWN of the port. N/A Eight groups of two Example:

hexadecimal digits, 50:01:43:80:12:09

1
Column Data type and
Column description Column type Remarks
name restrictions
colon-separated. :54:f4.

2
Contents
FCZone ··························································································1
FCZone/ZoneStatus ····················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1

i
FCZone
FCZone/ZoneStatus
This table contains zone status information in a VSAN.

XML structure
<FCZone>
<ZoneStatus>
<StatusInfo>
<VSANID></VSANID>
<DefaultZoneStatus></DefaultZoneStatus>
<Mode></Mode>
</StatusInfo>
</ZoneStatus>
</FCZone>

Table description
Item Description
Feature name FCZone
Table name ZoneStatus
Table type Multi-instance table
Row name StatusInfo
Restrictions None
Support for row creation and
No
deletion

Columns
Column name Column description Column type Data type and restrictions
Unsigned integer.
VSANID VSAN ID. Index
Value range: 1 to 3839.
Enumeration:
DefaultZoneStatus Default zone status. N/A • 1—Deny(default).
• 2—Permit.
Enumeration:
Mode Zoning mode. N/A • 1—Basic zoning(default).
• 2—Enhanced zoning.

1
Contents
FCZone ··························································································1
FCZone/ZoneStatus ····················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
FCZone/ActiveZones ···················································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 2
FCZone/ActiveZoneMembers ········································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 4

i
FCZone
FCZone/ZoneStatus
This table contains zone status information in a VSAN.

XML structure
<FCZone>
<ZoneStatus>
<StatusInfo>
<VSANID></VSANID>
<DefaultZoneStatus></DefaultZoneStatus>
<Mode></Mode>
</StatusInfo>
</ZoneStatus>
</FCZone>

Table description
Item Description
Feature name FCZone
Table name ZoneStatus
Table type Multi-instance table
Row name StatusInfo
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
VSANID VSAN ID. Index N/A
Value range: 1 to 3839.
Enumeration:
DefaultZoneS Default zone
N/A • 1—Deny. N/A
tatus status.
• 2—Permit.
Enumeration:
Mode Zoning mode. N/A • 1—Basic zoning. N/A
• 2—Enhanced zoning.

1
FCZone/ActiveZones
This table contains zone information about the active zone set in a VSAN.

XML structure
<FCZone>
<ActiveZones>
<ActiveZone>
<VSANID></VSANID>
<ZoneName></ZoneName>
<ZoneSetName></ZoneSetName>
<ZoneType></ZoneType>
</ActiveZone>
</ActiveZones>
</FCZone>

Table description
Item Description
Feature name FCZone
Table name ActiveZones
Table type Multi-instance table
Row name ActiveZone
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
VSANID VSAN ID. Index N/A
Value range: 1 to 3839.
The first character of a
given name must be a
letter. Any character
other than the first
String. character can be a
Name of the
ZoneName Index lowercase character
zone. Length: 1 to 64 characters. (a-z), an uppercase
character (A-Z), a
number (0-9), or one of
the following symbols
($-^_).

2
 Column Column Column
Data type and restrictions Remarks
name description type
The first character of a
given name must be a
letter. Any character
other than the first
String. character can be a
ZoneSetNam Name of the
N/A lowercase character
e zone set. Length: 1 to 64 characters. (a-z), an uppercase
character (A-Z), a
number (0-9), or one of
the following symbols
($-^_).
Enumeration:
ZoneType Zone type. N/A • 1—Base zone. N/A
• 2—Peer zone.

FCZone/ActiveZoneMembers
This table contains zone member information about the active zone set in a VSAN.

XML structure
<FCZone>
<ActiveZoneMembers>
<ActiveZoneMember>
<VSANID></VSANID>
<ZoneName></ZoneName>
<ZoneMemberIndex></ZoneMemberIndex>
<ZoneMemberLoginFlag></ZoneMemberLoginFlag>
<ZoneMemberPrincipalFlag></ZoneMemberPrincipalFlag>
<ZoneMemberType></ZoneMemberType>
<ZoneMemberFCID></ZoneMemberFCID>
<ZoneMemberWWN></ZoneMemberWWN>
<ZoneMemberRole></ZoneMemberRole>
</ActiveZoneMember>
</ActiveZoneMembers>
</FCZone>

Table description
Item Description
Feature name FCZone
Table name ActiveZoneMembers
Table type Multi-instance table
Row name ActiveZoneMember
Restrictions None

3
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Unsigned integer.
VSANID VSAN ID. Index N/A
Value range: 1 to 3839.
The first character of a
given name must be a
letter. Any character
other than the first
String. character can be a
Name of the
ZoneName Index lowercase character
zone. Length: 1 to 64 characters. (a-z), an uppercase
character (A-Z), a
number (0-9), or one
of the following
symbols ($-^_).
Index of the
ZoneMemberIndex Index Unsigned integer. N/A
zone member.
Whether the
zone member Boolean:
ZoneMemberLogin can be found
N/A • true. N/A.
Flag in the local
name server • false.
database.
Whether the
Boolean: This column is
zone member
ZoneMemberPrinci displayed only when
is a principal N/A • true.
palFlag the zone type is peer
member in a • false. zone.
peer zone.
Enumeration:
Zone member • 1—PWWN.
ZoneMemberType N/A N/A.
type. • 3—FCID.
• 6—FWWN.
This column is
FC address of Hexadecimal displayed only when
ZoneMemberFCID the zone N/A representation of the three the ZoneMemberType
member. bytes. column is 3.
Example: 050012.
This column is
displayed only when
Eight groups of two the ZoneMemberType
WWN of the column is 1 or 6.
ZoneMemberWWN N/A hexadecimal digits,
zone member.
colon-separated. Example:
11:11:11:11:11:11:11:
12.
Enumeration:
Role of the • 0—initiator and target.
ZoneMemberRole N/A N/A.
zone member. • 1—initiator.
• 2—target.

4
Contents
FDMI ·····························································································1
FDMI/RDPInterval ························································································································ 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1

i
FDMI
FDMI/RDPInterval
This table contains configurations of the interval for sending RDP request packets.

XML structure
<FDMI>
<RDPInterval>
<Interval></Interval>
</RDPInterval>
</FDMI>

Table description
Item Description
Feature name FDMI
Table name RDPInterval
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
Interval for Unsigned integer. The default value is 30
Interval sending RDP N/A
Value range: 5 to 1440. minutes.
request packet

1
Contents
FDMI ·····························································································1
FDMI/HBAAttributes ····················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 2
FDMI/PortAttributes ······················································································································ 3
XML structure ······················································································································· 3
Table description ··················································································································· 4
Columns ······························································································································ 4
FDMI/DiagnosticParameterDescriptors····························································································· 7
XML structure ······················································································································· 7
Table description ················································································································· 10
Columns ···························································································································· 11
FDMI/RDPInterval ······················································································································ 27
XML structure ····················································································································· 27
Table description ················································································································· 27
Columns ···························································································································· 27

i
FDMI
FDMI/HBAAttributes
This table contains the HBA(Host Bus Adapter) attribute descriptions.

XML structure
<FDMI>
<HBAAttributes>
<Attribute>
<VSANID></VSANID>
<HBAID></HBAID>
<Manufacturer></Manufacturer>
<SerialNumber></SerialNumber>
<Model></Model>
<ModelDescription></ModelDescription>
<NodeName></NodeName>
<NodeSymbolicName></NodeSymbolicName>
<HardwareVersion></HardwareVersion>
<DriverVersion></DriverVersion>
<OptionROMVersion></OptionROMVersion>
<FirmwareVersion></FirmwareVersion>
<OSName></OSName>
<MaxCTPayload></MaxCTPayload>
<VendorID></VendorID>
<VendorInformation></VendorInformation>
<PortNumber></PortNumber>
<FabricName></FabricName>
<BootBIOSVersion></BootBIOSVersion>
<BootBIOSState></BootBIOSState>
</Attribute>
</HBAAttributes>
</FDMI>

Table description
Item Description
Feature name FDMI
Table name HBAAttributes
Table type Multi-instance table
Row name Attribute
Restrictions None

1
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
VSANID VSAN ID. Index N/A
Value range: 1 to 3839.
Eight groups of two Example:
HBAID HBA ID. Index hexadecimal digits, 50:01:43:80:12:09:54:f4
colon-separated. .

Manufacturer of String.
Manufacturer N/A N/A
the HBA. Length: 1 to 63 characters.

Serial number of String.

SerialNumber N/A N/A
the HBA. Length: 1 to 63 characters.

Model of the String.

Model N/A N/A
HBA. Length: 1 to 255 characters.
Model String.
ModelDescrip
description of the N/A N/A
tion Length: 1 to 255 characters.
HBA.
WWN of the Eight groups of two Example:
NodeName node containing N/A hexadecimal digits, 50:01:43:80:12:09:54:f5
the HBA. colon-separated. .

NodeSymboli Node symbolic String.

N/A N/A
cName name. Length: 1 to 255 characters.
Hardware String.
HardwareVer
version of the N/A N/A
sion Length: 1 to 255 characters.
HBA.

Version of the String.

DriverVersion N/A N/A
driver software. Length: 1 to 255 characters.

OptionROMV ROM version of String.

N/A N/A
ersion the HBA. Length: 1 to 255 characters.

FirmwareVers Version of the String.

N/A N/A
ion firmware. Length: 1 to 255 characters.
Type and version String.
OSName of the operating N/A N/A
system. Length: 1 to 255 characters.

MaxCTPaylo Maximum CT
N/A Unsigned integer. N/A
ad payload.
This column contains
String. the T10 vendor ID of
VendorID Vendor identifier. N/A the manufacturer of the
Length: 1 to 8characters. HBA, or an OEM of the
HBA.
VendorInform Vendor-specific
N/A Unsigned integer. N/A
ation information.
Number of the
PortNumber Nx_Port on the N/A Unsigned integer. N/A
HBA.

2
 Column Column Column
Data type and restrictions Remarks
name description type
Eight groups of two Example:
FabricName Fabric name. N/A hexadecimal digits, 20:01:00:e0:fc:a1:58:00
colon-separated. .

BootBIOSVer Boot BIOS String.

N/A N/A
sion version. Length: 1 to 255 characters.
If the HBA provides a
boot BIOS and the boot
BIOS is enabled, the
value of the Boot BIOS
Enumeration: State attribute is set to
BootBIOSStat FF FF FF FFh. If the
e
Boot BIOS state. N/A • 4294967295—Enabled. HBA provides a boot
• 0—Disabled. BIOS and the boot
BIOS is disabled, the
value of the Boot BIOS
State attribute is set to
zero.

FDMI/PortAttributes
This table contains port attributes that are registered with the Name Server or HBA Management
Server.

XML structure
<FDMI>
<PortAttributes>
<Attribute>
<VSANID></VSANID>
<HBAID></HBAID>
<PortName></PortName>
<PortSymbolicName></PortSymbolicName>
<PortID></PortID>
<PortType></PortType>
<ServiceClass></ServiceClass>
<SupportedFC4Types></SupportedFC4Types>
<PortActiveFC4Types></PortActiveFC4Types>
<SupportedSpeed></SupportedSpeed>
<CurrentPortSpeed></CurrentPortSpeed>
<MaximumFrameSize></MaximumFrameSize>
<OSDeviceName></OSDeviceName>
<HostName></HostName>
<NodeName></NodeName>
<PortFabricName></PortFabricName>
<PortState></PortState>
<DiscoveredPortNumber></DiscoveredPortNumber>
<SmartSANServiceCategory></SmartSANServiceCategory>
<SmartSANGUID></SmartSANGUID>

3
 <SmartSANVersion></SmartSANVersion>
<SmartSANProductName></SmartSANProductName>
<SmartSANPortInfomation></SmartSANPortInfomation>
<SmartSANQoSSupport></SmartSANQoSSupport>
<SmartSANSecuritySupport></SmartSANSecuritySupport>
<SmartSANConnectedPorts></SmartSANConnectedPorts>
</Attribute>
</PortAttributes>
</FDMI>

Table description
Item Description
Feature name FDMI
Table name PortAttributes
Table type Multi-instance table
Row name Attribute
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
VSANID VSAN ID. Index N/A
Value range: 1 to 3839.
Eight groups of two Example:
HBAID HBA ID. Index hexadecimal digits, 50:01:43:80:12:09:54:f4
colon-separated. .
Eight groups of two Example:
PortName WWN of the port. Index hexadecimal digits, 50:01:43:80:12:09:54:f4
colon-separated. .

PortSymbolic Symbolic name String.

N/A N/A
Name of the port. Length: 1 to 255 characters.
FC address of Hexadecimal representation of
PortID N/A Example: 020000.
the Port. the three bytes.
• 0—Unidentified.
• 1—N_Port.
• 2—NL_Port.
• 3—FL_Port/
NL_Port.
PortType Port type. N/A Unsigned integer. • 127—Nx_Port.
• 129—F_Port.
• 130—FL_Port.
• 132—E_Port.
• 133—B_Port.
• Other—Unknown.

4
Column Column Column
Data type and restrictions Remarks
name description type
Each bit represents a type.
As follows:
• 1—Class F.
• 2—Class 1.
Supported class
ServiceClass
of service.
N/A • 4—Class 2. N/A
• 8—Class 3.
• 16—Class 4.
• 64—Class 6.
• Other—Unknown.
Data transmission using
Base64 encoding, decoding is
as follows:
Bitmap. Length: 256 bits.
Each octet within this value
specifies a set of eight types,
SupportedFC Supported FC-4 with the first octet specifying
N/A types 0 through 7, the second N/A
4Types types.
octet specifying ports 8
through 15, etc. Within each
octet, the most significant bit
represents the lowest
numbered type, and the least
significant bit represents the
highest numbered type.
Data transmission using
Base64 encoding, decoding is
as follows:
Bitmap. Length: 256 bits.
Each octet within this value
specifies a set of eight types,
PortActiveFC Active FC-4 with the first octet specifying
N/A types 0 through 7, the second N/A
4Types types of the port.
octet specifying ports 8
through 15, etc. Within each
octet, the most significant bit
represents the lowest
numbered type, and the least
significant bit represents the
highest numbered type.
Each bit represents a speed.
As follows:
• 1—1 Gbps.
• 2—2 Gbps.
• 4—10 Gbps.
• 8—4 Gbps.
SupportedSp Supported • 16—8 Gbps. Other values are
N/A
eed speed. reserved.
• 32—16 Gbps.
• 64—32 Gbps.
• 128—20 Gbps.
• 256—40 Gbps.
• 32768—The speed has
not been obtained or
cannot be obtained.

5
Column Column Column
Data type and restrictions Remarks
name description type
Each bit represents a speed.
As follows:
• 1—1 Gbps.
• 2—2 Gbps.
• 4—10 Gbps.
• 8—4 Gbps.
CurrentPortS Current port • 16—8 Gbps. Other values are
N/A
peed speed. reserved.
• 32—16 Gbps
• 64—32 Gbps.
• 128—20 Gbps.
• 256—40 Gbps.
• 32768—The speed has
not been obtained or
cannot be obtained.
Maximum FC
MaximumFra
frame payload N/A Unsigned integer. N/A
meSize
size.

OSDeviceNa String.
OS device name. N/A N/A
me Length: 1to 255 characters.
Name of the host String.
HostName associated with N/A N/A
the Nx_Port. Length: 1to 255 characters.

WWN of the Eight groups of two Example:

NodeName node containing N/A hexadecimal digits, 50:01:43:80:12:09:54:f4
the port . colon-separated. .
Eight groups of two Example:
PortFabricNa
Port fabric name. N/A hexadecimal digits, 20:01:00:e0:fc:a1:58:00
me
colon-separated. .

PortState Port state. N/A Unsigned integer. N/A

DiscoveredPo Number of
N/A Unsigned integer. N/A
rtNumber discovered ports.

SmartSANSe Smart SAN String.

N/A N/A
rviceCategory service category. Length: 1to 255 characters
Five groups of hexadecimal
Smart SAN digits, hyphen-separated. Example:
SmartSANGU
globally unique N/A Format: 50014380-1209-54f5-5
ID
identifier. XXXXXXXX-XXXX-XXXX-XXX 001-4380120954f4.
X-XXXXXXXXXXXX

SmartSANVe Smart SAN String.

N/A N/A
rsion version. Length: 1to 255 characters
Smart SAN String.
SmartSANPr
product name N/A N/A
oductName Length: 1to 255 characters
(model).

6
 Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 1—Physical.
SmartSANPo Smart SAN port
N/A • 2—NPIV. N/A
rtInfomation information.
• 3—SRIOV.
• Other—Unknown.
Enumeration:
SmartSANQo Smart SAN QoS • 0—Not supported.
N/A N/A
SSupport support. • 1—Supported.
• Other—Unknown.
Enumeration:
• 0—Not supported.
SmartSANSe Smart SAN • 1—Tier-1.
N/A N/A
curitySupport security support. • 2—Tier-2.
• 3—Tier-3.
• Other—Unknown.
Smart SAN
connected ports.
For Host Port
registration, this
field will display
the connected
SmartSANCo Target Port The combination of the WWNs
N/A N/A
nnectedPorts information. For of ports, blank-separated.
Target Port
registration, this
field will display
the connected
Initiator Port
information.

FDMI/DiagnosticParameterDescriptors
This table contains diagnostic parameter descriptors for the Fx_Port and Nx_Port.

XML structure
<FDMI>
<DiagnosticParameterDescriptors>
<Descriptor>
<PortName></PortName>
<NodeName></NodeName>
<FabricPortName></FabricPortName>
<FabricNodeName></FabricNodeName>
<PortSpeed>
<SpeedCapabilities></SpeedCapabilities>
<OperatingSpeed></OperatingSpeed>
</PortSpeed>
<PortPhyType></PortPhyType>

7
<FCoELinkErrorStatusBlock>
<FCoELinkFailureCount></FCoELinkFailureCount>
<VirtualLinkFailureCount></VirtualLinkFailureCount>
<MissingFIPCount></MissingFIPCount>
<SymbolErrorCount></SymbolErrorCount>
<ErroredBlockCount></ErroredBlockCount>
<FCSErrorCount></FCSErrorCount>
</FCoELinkErrorStatusBlock>
<FCLinkErrorStatusBlock>
<FCLinkFailureCount></FCLinkFailureCount>
<LossOfSyncCount></LossOfSyncCount>
<LossOfSignalCount></LossOfSignalCount>
<ProtocolError></ProtocolError>
<InvalidWord></InvalidWord>
<InvalidCRCCount></InvalidCRCCount>
</FCLinkErrorStatusBlock>
<SFPDiagnosticsParameters>
<SFPNotValid></SFPNotValid>
<SFPTemperature></SFPTemperature>
<SFPTempState></SFPTempState>
<SFPTempHAlarm></SFPTempHAlarm>
<SFPTempLAlarm></SFPTempLAlarm>
<SFPTempHWarn></SFPTempHWarn>
<SFPTempLWarn></SFPTempLWarn>
<SFPVoltage></SFPVoltage>
<SFPVoltageState></SFPVoltageState>
<SFPVoltageHAlarm></SFPVoltageHAlarm>
<SFPVoltageLAlarm></SFPVoltageLAlarm>
<SFPVoltageHWarn></SFPVoltageHWarn>
<SFPVoltageLWarn></SFPVoltageLWarn>
<TxBias></TxBias>
<TxBiasState></TxBiasState>
<TxBiasHAlarm></TxBiasHAlarm>
<TxBiasLAlarm></TxBiasLAlarm>
<TxBiasHWarn></TxBiasHWarn>
<TxBiasLWarn></TxBiasLWarn>
<TxPower></TxPower>
<TxPowerState></TxPowerState>
<TxPowerHAlarm></TxPowerHAlarm>
<TxPowerLAlarm></TxPowerLAlarm>
<TxPowerHWarn></TxPowerHWarn>
<TxPowerLWarn></TxPowerLWarn>
<RxPower></RxPower>
<RxPowerState></RxPowerState>
<RxPowerHAlarm></RxPowerHAlarm>
<RxPowerLAlarm></RxPowerLAlarm>
<RxPowerHWarn></RxPowerHWarn>
<RxPowerLWarn></RxPowerLWarn>

8
 <SFPPortTxType></SFPPortTxType>
<SFPOpticalPort></SFPOpticalPort>
<SFPConnectorType></SFPConnectorType>
<SFPFECActive></SFPFECActive>
</SFPDiagnosticsParameters>
<QSFPDiagnosticsParameters>
<QSFPNotValid></QSFPNotValid>
<QSFPTemperature></QSFPTemperature>
<QSFPTempState></QSFPTempState>
<QSFPTempHAlarm></QSFPTempHAlarm>
<QSFPTempLAlarm></QSFPTempLAlarm>
<QSFPTempHWarn></QSFPTempHWarn>
<QSFPTempLWarn></QSFPTempLWarn>
<QSFPVoltage></QSFPVoltage>
<QSFPVoltageState></QSFPVoltageState>
<QSFPVoltageHAlarm></QSFPVoltageHAlarm>
<QSFPVoltageLAlarm></QSFPVoltageLAlarm>
<QSFPVoltageHWarn></QSFPVoltageHWarn>
<QSFPVoltageLWarn></QSFPVoltageLWarn>
<LaneIdentifierFlag></LaneIdentifierFlag>
<LaneIdentifier></LaneIdentifier>
<QSFPTxBiasHAlarm></QSFPTxBiasHAlarm>
<QSFPTxBiasLAlarm></QSFPTxBiasLAlarm>
<QSFPTxBiasHWarn></QSFPTxBiasHWarn>
<QSFPTxBiasLWarn></QSFPTxBiasLWarn>
<Lane0TxBias></Lane0TxBias>
<Lane0TxBiasState></Lane0TxBiasState>
<Lane1TxBias></Lane1TxBias>
<Lane1TxBiasState></Lane1TxBiasState>
<Lane2TxBias></Lane2TxBias>
<Lane2TxBiasState></Lane2TxBiasState>
<Lane3TxBias></Lane3TxBias>
<Lane3TxBiasState></Lane3TxBiasState>
<QSFPTxPowerHAlarm></QSFPTxPowerHAlarm>
<QSFPTxPowerLAlarm></QSFPTxPowerLAlarm>
<QSFPTxPowerHWarn></QSFPTxPowerHWarn>
<QSFPTxPowerLWarn></QSFPTxPowerLWarn>
<Lane0TxPower></Lane0TxPower>
<Lane0TxPowerState></Lane0TxPowerState>
<Lane1TxPower></Lane1TxPower>
<Lane1TxPowerState></Lane1TxPowerState>
<Lane2TxPower></Lane2TxPower>
<Lane2TxPowerState></Lane2TxPowerState>
<Lane3TxPower></Lane3TxPower>
<Lane3TxPowerState></Lane3TxPowerState>
<QSFPRxPowerHAlarm></QSFPRxPowerHAlarm>
<QSFPRxPowerLAlarm></QSFPRxPowerLAlarm>
<QSFPRxPowerHWarn></QSFPRxPowerHWarn>

9
 <QSFPRxPowerLWarn></QSFPRxPowerLWarn>
<Lane0RxPower></Lane0RxPower>
<Lane0RxPowerState></Lane0RxPowerState>
<Lane1RxPower></Lane1RxPower>
<Lane1RxPowerState></Lane1RxPowerState>
<Lane2RxPower></Lane2RxPower>
<Lane2RxPowerState></Lane2RxPowerState>
<Lane3RxPower></Lane3RxPower>
<Lane3RxPowerState></Lane3RxPowerState>
<QSFPPortTxType></QSFPPortTxType>
<QSFPOpticalPort></QSFPOpticalPort>
<QSFPConnectorType></QSFPConnectorType>
<QSFPFECActive></QSFPFECActive>
</QSFPDiagnosticsParameters>
<FECStatusDescriptor>
<CorrectedBlocks></CorrectedBlocks>
<UnCorrectableBlocks></UnCorrectableBlocks>
</FECStatusDescriptor>
<BufferCredit>
<BBCredit></BBCredit>
<AttachedBBCredit></AttachedBBCredit>
<RoundTripTime></RoundTripTime>
</BufferCredit>
<OpticalProductData>
<VendorName></VendorName>
<Partnumber></Partnumber>
<Serialnumber></Serialnumber>
<Revision></Revision>
<Date></Date>
</OpticalProductData>
</Descriptor>
</DiagnosticParameterDescriptors>
</FDMI>

Table description
Item Description
Feature name FDMI
Table name DiagnosticParameterDescriptors
Table type Multi-instance table
Row name Descriptor
Restrictions None

10
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Eight groups of two
Example:
PortName WWN of the port. Index hexadecimal digits,
28:05:00:e0:fc:f1:58:2a.
colon-separated.

WWN of the Eight groups of two

Example:
NodeName node containing N/A hexadecimal digits,
20:00:00:e0:fc:f1:e8:00.
the port. colon-separated.
Name of a port Eight groups of two
FabricPortNa
on a node in the N/A hexadecimal digits, N/A
me
fabric. colon-separated.
This column takes
Eight groups of two
FabricNodeN Name of a node effect only when the
N/A hexadecimal digits,
ame in the fabric. FabricPortName
colon-separated.
column is valid.

Members include:
Port speed Data
PortSpeed
descriptor. structure • SpeedCapabilities. N/A
• OperatingSpeed.
Each bit represents a port
speed capability.
As follows:
• 1—1 Gbps.
• 2—2 Gbps.
SpeedCapabil Port speed
N/A • 4—10 Gbps. N/A
ities capabilities.
• 8—4 Gbps.
• 16—8 Gbps.
• 32—16 Gbps.
• 64—32 Gbps.
• Other—Unknown.
Each bit represents a port
operating speed.
As follows:
• 1—1 Gbps.
• 2—2 Gbps.
• 4—10 Gbps.
OperatingSpe Port operating
ed speed.
N/A • 8—4 Gbps. N/A
• 16—8 Gbps.
• 32—16 Gbps.
• 64—32 Gbps.
• 32768—Speed not
established.
• Other—Unknown.
Type of the
physical Enumeration:
interface for the
• 0—No Information about
PN_Port or
PortPhyType N/A Phy Type is provided. N/A
PF_Port through
which the RNID • 64—FC.
request was • 128—VFC.
received.

11
Column Column Column
Data type and restrictions Remarks
name description type
Members include:
• FCoELinkFailureCount.
• VirtualLinkFailureCount. This data structure
Link error status
FCoELinkErro Data takes effect only when
rStatusBlock
block format for
structure • MissingFIPCount. the PortPhyType
FCoE • SymbolErrorCount. column is 128.
• ErroredBlockCount.
• FCSErrorCount.
FCoELinkFail Number of link
N/A Unsigned integer. N/A
ureCount failures.
Number of
VirtualLinkFail
Virtual Link N/A Unsigned integer. N/A
ureCount
failures.

Number of
missing FIP
MissingFIPCo
keepalives or N/A Unsigned integer. N/A
unt
discovery
advertisements.
Number of
SymbolErrorC
symbol errors N/A Unsigned integer. N/A
ount
during carrier.

Cumulative
count of the
ErroredBlock events counted
N/A Unsigned integer. N/A
Count by the eight-bit
errored blocks
counter.
Number of frame
FCSErrorCou
check sequence N/A Unsigned integer. N/A
nt
errors.
Members include:
• FCLinkFailureCount.
• LossOfSyncCount. This data structure
Link error status
FCLinkErrorS Data takes effect only when
tatusBlock
block format for
structure • LossOfSignalCount. the PortPhyType
FC. • ProtocolError. column is 64.
• InvalidWord.
• InvalidCRCCount.
FCLinkFailure Number of link
N/A Unsigned integer. N/A
Count failures.
Number of
LossOfSyncC
loss-of-synchroni N/A Unsigned integer. N/A
ount
zation errors.

Number of
LossOfSignal
loss-of-signal N/A Unsigned integer. N/A
Count
errors.
Number of
primitive
ProtocolError N/A Unsigned integer. N/A
sequence
protocol errors.

12
Column Column Column
Data type and restrictions Remarks
name description type
Number of
invalid
InvalidWord N/A Unsigned integer. N/A
transmission
words.
Number of
InvalidCRCC
invalid CRC N/A Unsigned integer. N/A
ount
errors.

Members include:
• SFPNotValid.
• SFPTemperature.
• SFPTempState.
• SFPTempHAlarm.
• SFPTempLAlarm.
• SFPTempHWarn.
• SFPTempLWarn.
• SFPVoltage.
• SFPVoltageState.
• SFPVoltageHAlarm.
• SFPVoltageLAlarm.
• SFPVoltageHWarn.
• SFPVoltageLWarn.
• TxBias. Data structure of
• TxBiasState. SFPDiagnosticsParam
• TxBiasHAlarm. eters and data structure
SFP diagnostic of
SFPDiagnosti Data • TxBiasLAlarm.
parameters QSFPDiagnosticsPara
csParameters
descriptor.
structure • TxBiasHWarn. meters are mutual
• TxBiasLWarn. exclusive and only one
• TxPower. of them can be set in a
single message.
• TxPowerState.
• TxPowerHAlarm.
• TxPowerLAlarm.
• TxPowerHWarn.
• TxPowerLWarn.
• RxPower.
• RxPowerState.
• RxPowerHAlarm.
• RxPowerLAlarm.
• RxPowerHWarn.
• RxPowerLWarn.
• SFPPortTxType.
• SFPOpticalPort.
• SFPConnectorType.
• SFPFECActive.

13
Column Column Column
Data type and restrictions Remarks
name description type
If the value is 1, the
following columns are
not valid:
• SFPTemperature.
• SFPTempState.
• SFPTempHAlarm.
• SFPTempLAlarm.
• SFPTempHWarn.
• SFPTempLWarn.
• SFPVoltage.
• SFPVoltageState.
• SFPVoltageHAlar
m.
• SFPVoltageLAlar
m.
• SFPVoltageHWarn
.
SFP diagnostic Enumeration: • SFPVoltageLWarn.
SFPNotValid parameters not N/A
• 0—Valid. • TxBias.
valid. • TxBiasState.
• 1—Invalid.
• TxBiasHAlarm.
• TxBiasLAlarm.
• TxBiasHWarn.
• TxBiasLWarn.
• TxPower.
• TxPowerState.
• TxPowerHAlarm.
• TxPowerLAlarm.
• TxPowerHWarn.
• TxPowerLWarn.
• RxPower.
• RxPowerState.
• RxPowerHAlarm.
• RxPowerLAlarm.
• RxPowerHWarn.
• RxPowerLWarn.

SFPTemperat Short.
Temperature. N/A N/A
ure Unit is 1/256 °C.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
SFPTempStat Running state of • 2—Transgress the high
N/A N/A
e temperature. warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

14
Column Column Column
Data type and restrictions Remarks
name description type
SFPTempHAl High alarm of Short.
N/A N/A
arm temperature. Unit is 1/256 °C.

SFPTempLAl Low alarm of Short.

N/A N/A
arm temperature. Unit is 1/256 °C.

SFPTempHW High warning of Short.

N/A N/A
arn temperature. Unit is 1/256 °C.

SFPTempLW Low warning of Short.

N/A N/A
arn temperature. Unit is 1/256 °C.
Unsigned short.
SFPVoltage Voltage. N/A N/A
Unit is 100uV.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
SFPVoltageSt Running state of • 2—Transgress the high
N/A N/A
ate Voltage. warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

SFPVoltageH High alarm of Unsigned short.

N/A N/A
Alarm Voltage. Unit is 100uV.

SFPVoltageL Low alarm of Unsigned short.

N/A N/A
Alarm Voltage. Unit is 100uV.

SFPVoltageH High warning of Unsigned short.

N/A N/A
Warn Voltage. Unit is 100uV.

SFPVoltageL Low warning of Unsigned short.

N/A N/A
Warn Voltage. Unit is 100uV.

Tx laser bias Unsigned short.

TxBias N/A N/A
current. Unit is 2uA.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Running state of • 2—Transgress the high
TxBiasState N/A N/A
TxBias. warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

15
Column Column Column
Data type and restrictions Remarks
name description type
TxBiasHAlar High alarm of Unsigned short.
N/A N/A
m TxBias. Unit is 2uA.

Low alarm of Unsigned short.

TxBiasLAlarm N/A N/A
TxBias. Unit is 2uA.

High warning of Unsigned short.

TxBiasHWarn N/A N/A
TxBias. Unit is 2uA.

Low warning of Unsigned short.

TxBiasLWarn N/A N/A
TxBias. Unit is 2uA.
Unsigned short.
TxPower Tx output power. N/A N/A
Unit is 0.1uW.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Running state of • 2—Transgress the high
TxPowerState N/A N/A
TxPower. warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

TxPowerHAla High alarm of Unsigned short.

N/A N/A
rm TxPower. Unit is 0.1uW.

TxPowerLAlar Low alarm of Unsigned short.

N/A N/A
m TxPower. Unit is 0.1uW.

TxPowerHWa High warning of Unsigned short.

N/A N/A
rn TxPower. Unit is 0.1uW.

TxPowerLWa Low warning of Unsigned short.

N/A N/A
rn TxPower. Unit is 0.1uW.

Received optical Unsigned short.

RxPower N/A N/A
TxPower. Unit is 0.1uW.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
RxPowerStat Running state of • 2—Transgress the high
N/A N/A
e RxPower. warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

16
Column Column Column
Data type and restrictions Remarks
name description type
RxPowerHAla High alarm of Unsigned short.
N/A N/A
rm RxPower. Unit is 0.1uW.

RxPowerLAla Low alarm of Unsigned short.

N/A N/A
rm RxPower. Unit is 0.1uW.

RxPowerHWa High warning of Unsigned short.

N/A N/A
rn RxPower. Unit is 0.1uW.

RxPowerLWa Low warning of Unsigned short.

N/A N/A
rn RxPower. Unit is 0.1uW.
Enumeration:
• 0—Other or unknown.
• 1—Short Wave Laser.
SFPPortTxTy
Port tx type. N/A • 2—Long Wave Laser LC N/A
pe
1310nm.
• 3—Long Wave Laser LL
1550nm.
If the value is 1, the
Enumeration: FC_Port is an optical
SFPOpticalPo
Optical port flag. N/A port. If the value is 0,
rt • 0—No.
the FC_Port is not an
• 1—Yes. optical port.

Enumeration:
SFPConnecto • 0—Other or unknown.
rType
Connector type. N/A N/A
• 64—SFP+.
• Other—Reserved.

Enumeration:
SFPFECActiv State of FEC
N/A • 0—16G FEC status is N/A
e active
inactive or unknown.
• 1—16G FEC is active.

17
Column Column Column
Data type and restrictions Remarks
name description type
Members include:
• QSFPNotValid.
• QSFPTemperature.
• QSFPTempState.
• QSFPTempHAlarm.
• QSFPTempLAlarm.
• QSFPTempHWarn.
• QSFPTempLWarn.
• QSFPVoltage.
• QSFPVoltageState.
• QSFPVoltageHAlarm.
• QSFPVoltageLAlarm.
• QSFPVoltageHWarn.
• QSFPVoltageLWarn.
• LaneIdentifierFlag.
• LaneIdentifier.
• QSFPTxBiasHAlarm.
• QSFPTxBiasLAlarm.
• QSFPTxBiasHWarn.
• QSFPTxBiasLWarn.
• Lane0TxBias.
• Lane0TxBiasState.
• Lane1TxBias.
• Lane1TxBiasState.
Data structure of
• Lane2TxBias. SFPDiagnosticsPara
• Lane2TxBiasState. meters and data
• Lane3TxBias. structure of
QSFPDiagno QSFP diagnostic
Data • Lane3TxBiasState. QSFPDiagnosticsPar
sticsParamet parameters
ers descriptor.
structure • QSFPTxPowerHAlarm. ameters are mutual
• QSFPTxPowerLAlarm. exclusive and only
• QSFPTxPowerHWarn. one of them can be
set in a single
• QSFPTxPowerLWarn.
message.
• Lane0TxPower.
• Lane0TxPowerState.
• Lane1TxPower.
• Lane1TxPowerState.
• Lane2TxPower.
• Lane2TxPowerState.
• Lane3TxPower.
• Lane3TxPowerState.
• QSFPRxPowerHAlarm.
• QSFPRxPowerLAlarm.
• QSFPRxPowerHWarn.
• QSFPRxPowerLWarn.
• Lane0RxPower.
• Lane0RxPowerState.
• Lane1RxPower.
• Lane1RxPowerState.
• Lane2RxPower.
• Lane2RxPowerState.
• Lane3RxPower.
18 • Lane3RxPowerState.
• QSFPPortTxType.
• QSFPOpticalPort.
• QSFPConnectorType.
Column Column Column
Data type and restrictions Remarks
name description type
If the value is 1, the
following columns are
invalid:
• QSFPTemperature
.
• QSFPTempState.
• QSFPTempHAlar
m.
• QSFPTempLAlarm
.
• QSFPTempHWarn
.
• QSFPTempLWarn.
• QSFPVoltage.
• QSFPVoltageState
.
• QSFPVoltageHAla
rm.
• QSFPVoltageLAlar
m.
• QSFPVoltageHWa
rn.
• QSFPVoltageLWar
n.
• LaneIdentifierFlag.
• LaneIdentifier.
• QSFPTxBiasHAlar
m.
• QSFPTxBiasLAlar
m.
• QSFPTxBiasHWar
n.
• QSFPTxBiasLWar
n.
• Lane0TxBias.
• Lane0TxBiasState
.
• Lane1TxBias.
• Lane1TxBiasState
.
• Lane2TxBias.
Whether QSFP • Lane2TxBiasState
QSFPNotVali diagnostic Enumeration: .
N/A
d parameters are • 0—Valid. • Lane3TxBias.
valid. • 1—Invalid. • Lane3TxBiasState
.
• QSFPTxPowerHAl
arm.
• QSFPTxPowerLAl
arm.
• QSFPTxPowerHW
arn.
• QSFPTxPowerLW
arn.
• Lane0TxPower.
19 • Lane0TxPowerSta
te.
• Lane1TxPower.
• Lane1TxPowerSta
te.
Column Column Column
Data type and restrictions Remarks
name description type
QSFPTemper Short.
Temperature. N/A N/A
ature Unit is 1/256 °C.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
QSFPTempSt Running state of • 2—Transgress the high
ate Temperature.
N/A N/A
warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

QSFPTempH High alarm of Short.

N/A N/A
Alarm Temperature. Unit is 1/256 °C.

QSFPTempL Low alarm of Short.

N/A N/A
Alarm Temperature. Unit is 1/256 °C.

QSFPTempH High warning of Short.

N/A N/A
Warn Temperature. Unit is 1/256 °C.

QSFPTempL Low warning of Short.

N/A N/A
Warn Temperature. Unit is 1/256 °C.
Unsigned short.
QSFPVoltage Voltage. N/A N/A
Unit is 100uV.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
QSFPVoltage Running state of • 2—Transgress the high
State Voltage.
N/A N/A
warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

QSFPVoltage High alarm of Unsigned short.

N/A N/A
HAlarm Voltage. Unit is 100uV.

QSFPVoltage Low alarm of Unsigned short.

N/A N/A
LAlarm Voltage. Unit is 100uV.

QSFPVoltage High warning of Unsigned short.

N/A N/A
HWarn Voltage. Unit is 100uV.

QSFPVoltage Low warning of Unsigned short.

N/A N/A
LWarn Voltage. Unit is 100uV.

20
Column Column Column
Data type and restrictions Remarks
name description type
If the value is 0, the
LaneIdentifier column
is not meaningful. If
LaneIdentifier Lane identifier Enumeration: the value is 1, the
N/A
Flag validity flag. • 0—Invalid. single lane is
• 1—Valid. indicated by the
LaneIdentifier
column.
This column takes
effect only when the
LaneIdentifierFlag
Enumeration: column is 1, and the
• 0—Lane 0. value decide which
LaneIdentifier Lane identifier. N/A
• 1—Lane 1.
lane is valide about
TxBias, TxBiasState,
• 2—Lane 2.
TxPower,
• 3—Lane 3. TxPowerState,RxPo
wer and
RxPowerState.
QSFPTxBias High alarm of Unsigned short.
N/A N/A
HAlarm TxBias of a lane. Unit is 2uA.

QSFPTxBias Low alarm of Unsigned short.

N/A N/A
LAlarm TxBias of a lane. Unit is 2uA.

QSFPTxBias High warning of Unsigned short.

N/A N/A
HWarn TxBias of a lane. Unit is 2uA.

QSFPTxBias Low warning of Unsigned short.

N/A N/A
LWarn TxBias of a lane. Unit is 2uA.

Tx laser bias Unsigned short.

Lane0TxBias N/A N/A
current of lane 0. Unit is 2uA.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Lane0TxBias Running state of • 2—Transgress the high
State TxBias of lane 0.
N/A N/A
warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

Tx laser bias Unsigned short.

Lane1TxBias N/A N/A
current of lane 1. Unit is 2uA.

21
Column Column Column
Data type and restrictions Remarks
name description type
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Lane1TxBias Running state of • 2—Transgress the high
N/A N/A
State TxBias of lane 1. warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

Tx laser bias Unsigned short.

Lane2TxBias N/A N/A
current of lane 2. Unit is 2uA.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Lane2TxBias Running state of • 2—Transgress the high
N/A N/A
State TxBias of lane 2. warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

Tx laser bias Unsigned short.

Lane3TxBias N/A N/A
current of lane 3. Unit is 2uA.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Lane3TxBias Running state of • 2—Transgress the high
N/A N/A
State TxBias of lane 3. warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

QSFPTxPow High alarm of Unsigned short.

N/A N/A
erHAlarm TxPow of a lane. Unit is 0.1uW.

QSFPTxPow Low alarm of Unsigned short.

N/A N/A
erLAlarm TxPow of a lane. Unit is 0.1uW.

QSFPTxPow High warning of Unsigned short.

N/A N/A
erHWarn TxPow of a lane. Unit is 0.1uW.

QSFPTxPow Low warning of Unsigned short.

N/A N/A
erLWarn TxPow of a lane. Unit is 0.1uW.

22
Column Column Column
Data type and restrictions Remarks
name description type
Lane0TxPow Tx output power Unsigned short.
N/A N/A
er of lane 0. Unit is 0.1uW.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Lane0TxPow Running state of • 2—Transgress the high
erState TxPow of lane 0.
N/A N/A
warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

Lane1TxPow Tx output power Unsigned short.

N/A N/A
er of lane 1. Unit is 0.1uW.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Lane1TxPow Running state of • 2—Transgress the high
N/A N/A
erState TxPow of lane 1. warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

Lane2TxPow Tx output power Unsigned short.

N/A N/A
er of lane 2. Unit is 0.1uW.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Lane2TxPow Running state of • 2—Transgress the high
N/A N/A
erState TxPow of lane 2. warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

Lane3TxPow Tx output power Unsigned short.

N/A N/A
er of lane 3. Unit is 0.1uW.

23
Column Column Column
Data type and restrictions Remarks
name description type
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Lane3TxPow Running state of • 2—Transgress the high
N/A N/A
erState TxPow of lane 3. warning level.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.
High alarm of Unsigned short.
QSFPRxPow
RxPower of a N/A N/A
erHAlarm Unit is 0.1uW.
lane.
Low alarm of Unsigned short.
QSFPRxPow
RxPower of a N/A N/A
erLAlarm Unit is 0.1uW.
lane.

High warning of Unsigned short.

QSFPRxPow
RxPower of a N/A N/A
erHWarn Unit is 0.1uW.
lane.

Low warning of Unsigned short.

QSFPRxPow
RxPower of a N/A N/A
erLWarn Unit is 0.1uW.
lane.

Lane0RxPow Received optical Unsigned short.

N/A N/A
er power of lane 0. Unit is 0.1uW.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Running state of
Lane0RxPow • 2—Transgress the high
RxPower of lane N/A N/A
erState warning level.
0.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

Lane1RxPow Received optical Unsigned short.

N/A N/A
er power of lane 1. Unit is 0.1uW.

24
Column Column Column
Data type and restrictions Remarks
name description type
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Running state of
Lane1RxPow • 2—Transgress the high
RxPower of lane N/A N/A
erState warning level.
1.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

Lane2RxPow Received optical Unsigned short.

N/A N/A
er power of lane 2. Unit is 0.1uW.

Each bit represents a type.

As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Running state of
Lane2RxPow • 2—Transgress the high
RxPower of lane N/A N/A
erState warning level.
2.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.

Lane3RxPow Received optical Unsigned short.

N/A N/A
er power of lane 3. Unit is 0.1uW.
Each bit represents a type.
As follows:
• 0—Normal.
• 1—Transgress the low
warning level.
Running state of
Lane3RxPow • 2—Transgress the high
RxPower of lane N/A N/A
erState warning level.
3.
• 4—Transgress the low
alarm level.
• 8—Transgress the high
alarm level.
• Other—Unknown.
Enumeration:
QSFPPortTxT • 0—Other or unknown.
Port tx type. N/A N/A
ype • 1—Short Wave Laser.
• 2—Long Wave Laser LC.
If the value is 1, the
Enumeration: FC_Port is an optical
QSFPOptical
Optical port flag. N/A port. If the value is 0,
Port • 0—No.
the FC_Port is not an
• 1—Yes. optical port.

25
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
QSFPConnec • 0—Other or unknown.
Connector type. N/A N/A
torType • 64—QSFP.
• Other—Reserved.

Enumeration:
QSFPFECAct State of FEC
N/A • 0—16G FEC status is N/A
ive active.
inactive or unknown.
• 1—16G FEC is active.
Members include:
FECStatusDe FEC status Data
scriptor descriptor. structure • CorrectedBlocks. N/A
• UnCorrectableBlocks.
Number of FEC
encoding blocks
CorrectedBlo
reported as N/A Unsigned integer. N/A
cks
corrected by
hardware.
Number of FEC
encoding blocks
UnCorrectabl
reported as N/A Unsigned integer. N/A
eBlocks
uncorrectable by
hardware.
Members include:
Buffer Credit Data • BBCredit.
BufferCredit N/A
descriptor. structure • AttachedBBCredit.
• RoundTripTime.
FC_Port
BBCredit buffer-to-buffer N/A Unsigned integer. N/A
credit.
Attached
AttachedBBC FC_Port
N/A Unsigned integer. N/A
redit buffer-to-buffer
credit.
A value of zero
indicates the RTT is
unknown and a
RoundTripTi Nominal
me
N/A Unsigned integer. non-zero value
FC_Port RTT.
indicates the RTT of
the link expressed in
nanoseconds.
Members include:
• VendorName.
OpticalProduc Optical Element Data • Partnumber.
N/A
tData Data Descriptor. structure • Serialnumber.
• Revision.
• Date.
String.
VendorName Vendor name. N/A N/A
Length: 1 to 16 characters.

26
 Column Column Column
Data type and restrictions Remarks
name description type
Vendor part String.
Partnumber N/A N/A
number. Length: 1 to 16 characters.

Vendor serialn String.

Serialnumber N/A N/A
number. Length: 1 to 16 characters.
String.
Revision Vendor revision. N/A N/A
Length: 1 to 2 characters.
Vendor's String.
Date manufacturing N/A N/A
date code. Length: 1 to 8 characters.

FDMI/RDPInterval
This table contains the interval for sending RDP request packets.

XML structure
<FDMI>
<RDPInterval>
<Interval></Interval>
</RDPInterval>
</FDMI>

Table description
Item Description
Feature name FDMI
Table name RDPInterval
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Data type and
Column description Column type Remarks
name restrictions
Interval for sending Unsigned integer.
Interval N/A N/A
RDP request packet. Value range: 5 to 1440.

27
Contents
FFILTER ························································································1
FFILTER/Policy ··························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
FFILTER/PolicyInProfile ················································································································ 1
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 2
FFILTER/RuleInPolicy··················································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 3
Columns ······························································································································ 3
FFILTER/FGroup ························································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 4
FFILTER/PatternInFGroup ············································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 5
Columns ······························································································································ 5
FFILTER/FalseExtensionAction ······································································································ 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 6

i
FFILTER
FFILTER/Policy
This table contains file filter policie information.

XML structure
<FFILTER>
<Policies>
<Policy>
<PolicyName></PolicyName>
<PolicyDescription></PolicyDescription>
</Policy>
</Policies>
</FFILTER>

Table description
Item Description
Feature name FFILTER
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 file String, case-insensitive
PolicyName Index N/A
filter policy Length: 1 to 31 characters.
Description of String, case-sensitive
PolicyDescrip
the file filter N/A N/A
tion Length: 1 to 255 characters.
policy

FFILTER/PolicyInProfile
This table contains file filter policies applied to the profile.

1
XML structure
<FFILTER>
<PolicyInProfile>
<Profile>
<ProfileName></ProfileName>
<PolicyName></PolicyName>
</Profile>
</PolicyInProfile>
</FFILTER>

Table description
Item Description
Feature name FFILTER
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.

FFILTER/RuleInPolicy
This table contains information about rules in a file filter policy.

XML structure
<FFILTER>
<RuleInPolicy>
<Rule>
<PolicyName></PolicyName>
<RuleName></RuleName>
<FGroupName></FGroupName>
<Application></Application>
<Direction></Direction>

2
 <Action></Action>
<Logging></Logging>
</Rule>
</RuleInPolicy>
</FFILTER>

Table description
Item Description
Feature name FFILTER
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 file String, case-insensitive.

FGroupName N/A N/A
type 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
FFILTER/FGroup
This table contains file filter file type group information.

XML structure
<FFILTER>
<FGroups>
<FGroup>
<FGroupName></FGroupName>
<FGroupDescription></FGroupDescription>
</FGroup>
</FGroups>
</FFILTER>

Table description
Item Description
Feature name FFILTER
Table name FGroups
Table type Multi-instance table
Row name FGroup
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the file String, case-insensitive.
FGroupName Index N/A
type group Length: 1 to 31 characters.
Description of String, case-sensitive
FGroupDescri
the file type N/A N/A
ption Length: 1 to 255 characters.
group

FFILTER/PatternInFGroup
This table contains information about pattern in a file filter file type group.

XML structure
<FFILTER>
<PatternInFGroups>
<PatternInFGroup>
<FGroupName></FGroupName>

4
 <PatternName></PatternName>
<PatternValue></PatternValue>
</PatternInFGroup>
</PatternInFGroups>
</FFILTER>

Table description
Item Description
Feature name FFILTER
Table name PatternInFGroups
Table type Multi-instance table
Row name PatternInFGroup
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the file String, case-insensitive.
FGroupName Index N/A
type group Length: 1 to 31 characters.

Name of the String, case-insensitive.

PatternName Index N/A
pattern Length: 1 to 31 characters.

Value of the String.

PatternValue N/A N/A
pattern Length: 1 to 8 characters.

FFILTER/FalseExtensionAction
This table contains information about the default action when the externsion name of file is false.

XML structure
<FFILTER>
<FalseExtensionAction>
<Action></Action>
</FalseExtensionAction>
</FFILTER>

Table description
Item Description
Feature name FFILTER

5
 Table name FalseExtensionAction
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
Remarks
name description type restrictions
Enumeration:
Value of the
Action
action
N/A • 0—permit Default is 0.
• 1—drop

6
Contents
FFILTER ························································································1
FFILTER/Policy ··························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
FFILTER/PolicyInProfile ················································································································ 1
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 2
FFILTER/RuleInPolicy··················································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 3
Columns ······························································································································ 3
FFILTER/FGroup ························································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 4
FFILTER/PatternInFGroup ············································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 5
Columns ······························································································································ 5
FFILTER/FalseExtensionAction ······································································································ 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 6
FFILTER/FileTypes ······················································································································ 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 6

i
FFILTER
FFILTER/Policy
This table contains file filter policies information.

XML structure
<FFILTER>
<Policies>
<Policy>
<PolicyName></PolicyName>
<PolicyDescription></PolicyDescription>
</Policy>
</Policies>
</FFILTER>

Table description
Item Description
Feature name FFILTER
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 file String, case-insensitive
PolicyName Index N/A
filter policy Length: 1 to 31 characters.
Description of String, case-sensitive
PolicyDescrip
the file filter N/A N/A
tion Length: 1 to 255 characters.
policy

FFILTER/PolicyInProfile
This table contains file filter policies applied to the profile.

1
XML structure
<FFILTER>
<PolicyInProfile>
<Profile>
<ProfileName></ProfileName>
<PolicyName></PolicyName>
</Profile>
</PolicyInProfile>
</FFILTER>

Table description
Item Description
Feature name FFILTER
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.

FFILTER/RuleInPolicy
This table contains information about rules in a file filter policy.

XML structure
<FFILTER>
<RuleInPolicy>
<Rule>
<PolicyName></PolicyName>
<RuleName></RuleName>
<FGroupName></FGroupName>
<Application></Application>
<Direction></Direction>
<Action></Action>

2
 <Logging></Logging>
</Rule>
</RuleInPolicy>
</FFILTER>

Table description
Item Description
Feature name FFILTER
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 file String, case-insensitive.

FGroupName N/A N/A
type 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
FFILTER/FGroup
This table contains file filter file type group information.

XML structure
<FFILTER>
<FGroups>
<FGroup>
<FGroupName></FGroupName>
<FGroupDescription></FGroupDescription>
</FGroup>
</FGroups>
</FFILTER>

Table description
Item Description
Feature name FFILTER
Table name FGroups
Table type Multi-instance table
Row name FGroup
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the file String, case-insensitive.
FGroupName Index N/A
type group Length: 1 to 31 characters.

Description of String, case-sensitive

FGroupDescri
the file type N/A N/A
ption Length: 1 to 255 characters.
group

FFILTER/PatternInFGroup
This table contains the information of pattern in a file filter file type group.

XML structure
<FFILTER>
<PatternInFGroups>
<PatternInFGroup>
<FGroupName></FGroupName>
<PatternName></PatternName>

4
 <PatternValue></PatternValue>
</PatternInFGroup>
</PatternInFGroups>
</FFILTER>

Table description
Item Description
Feature name FFILTER
Table name PatternInFGroups
Table type Multi-instance table
Row name PatternInFGroup
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Name of the file String, case-insensitive.
FGroupName Index N/A
type group Length: 1 to 31 characters.

Name of the String, case-insensitive.

PatternName Index N/A
pattern Length: 1 to 31 characters.

Value of the String.

PatternValue N/A N/A
pattern Length: 1 to 8 characters.

FFILTER/FalseExtensionAction
This table contains information about the default action when the externsion name of file is false.

XML structure
<FFILTER>
<FalseExtensionAction>
<Action></Action>
</FalseExtensionAction>
</FFILTER>

Table description
Item Description
Feature name FFILTER
Table name FalseExtensionAction
Table type Single-instance table

5
 Row name N/A
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
Value of the
Action
action
N/A • 0—permit Default is 0.
• 1—drop

FFILTER/FileTypes
This table contains the information of file types.

XML structure
<FFILTER>
<FileTypes>
<FileTypeInfo>
<FileTypeName></FileTypeName>
<PatternName></PatternName>
</FileTypeInfo>
</FileTypes>
</FFILTER>

Table description
Item Description
Feature name FFILTER
Table name FileTypes
Table type Multi-instance table
Row name FileTypeInfo
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
FileTypeNam Name of the file String, case-insensitive.
Index N/A
e type Length: 1 to 31 characters.

Name of the String, case-insensitive.

PatternName Index N/A
pattern Length: 1 to 31 characters.

6
7
Contents
FileSystem ······················································································1
FileSystem/Files ························································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 2
FileSystem/RecycleBin················································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
FileSystem/Media ······················································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
FileSystem/Partitions ·················································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6

i
FileSystem
FileSystem/Files
This table describes the actions that can be performed to the file.

XML structure
<FileSystem>
<Files>
<File>
<SrcName></SrcName>
<DstName></DstName>
<VRF></VRF>
<Operations>
<Delete></Delete>
<UnReservedDelete></UnReservedDelete>
<Copy></Copy>
<Move></Move>
<Rename></Rename>
<Gzip></Gzip>
<Gunzip></Gunzip>
<sha256sum></sha256sum>
<md5sum></md5sum>
<MkDir></MkDir>
<RmDir></RmDir>
</Operations>
</File>
</Files>
</FileSystem>

Table description
Item Description
Feature name FileSystem
Table name Files
Table type Multi-instance table
Row name File
Delete, UnReservedDelete, Copy, Move, Rename, More, Gzip,
Restrictions Gunzip, Sha256sum, Md5sum, MkDir and RmDir are mutually
execlusive.

1
Columns
Column Column Column
Data type and restrictions Remarks
name description type
SrcNam Full path and file
e name.
For examples:
NameString
flash:/logfile/logfile.l Index N/A
og Length: 1 to 4096 characters.
chassis3#slot1#cfa0
:/main.cfg
DstNam Full path and file
e name.
For examples:
NameString
flash:/logfile/logfile.l N/A N/A
og Length: 1 to 4096 characters.

chassis3#slot1#cfa0
:/main.cfg
VRF String. If VRF is not specified, it is
The VRF name. N/A Length: 1 to 31 represented that host is on
Characters. the public network.

Delete Delete a file. N/A This column must be empty. N/A

UnReser
Delete a file
vedDelet N/A This column must be empty. N/A
permanently.
e
Copy This column must be empty.
Copy a file. N/A DstName column must not N/A
be empty.
Move This column must be empty.
Move a file. N/A DstName column must not N/A
be empty.
Rename This column must be empty.
Rename a file or
N/A DstName column must not N/A
directory.
be empty.
Gzip This column must be empty.
Compress file. N/A DstName column must be N/A
empty.
Gunzip This column must be empty.
Decompress file. N/A DstName column must be N/A
empty.
Sha256s Compute the hash This column must be empty.
um digest of a file using
N/A DstName column must be N/A
the SHA256
algorithm. empty.

Md5sum Compute the hash This column must be empty.

digest of a file using DstName column must be N/A
the MD5 algorithm. empty.
MkDir Create a new N/A This column must be empty. N/A

2
 Column Column Column
Data type and restrictions Remarks
name description type
directory. DstName column must be
empty.
RmDir This column must be empty.
Remove an empty
N/A DstName column must be N/A
directory.
empty.

FileSystem/RecycleBin
This table describes the actions that can be performed to the file under recycle-bin.

XML structure
<FileSystem>
<RecycleBin>
<RecycleBinFile>
<Name></Name>
<Operations>
<Undelete></Undelete>
<Clear></Clear>
</Operations>
</RecycleBinFile>
</RecycleBin>
</FileSystem>

Table description
Item Description
Feature name FileSystem
Table name RecycleBin
Table type Multi-instance table
Row name RecycleBinFile
Restrictions None

3
Columns
Data type and
Column name Column description Column type
restrictions

Name Full path and file name.

String.
For examples:
Index Length: 1 to 4096
flash:/logfile/logfile.log
characters.
chassis3#slot1#cfa0:/main.cfg

Undelete This column must be

Recover a deleted file. N/A
empty.

Clear Delete a deleted file This column must be

N/A
permanently. empty.

FileSystem/Media
This table describes the actions that can be performed to the media.

XML structure
<FileSystem>
<Media>
<Medium>
<Name></Name>
<Fdisk></Fdisk>
<Part1Size></Part1Size>
<Part2Size></Part2Size>
<Part3Size></Part3Size>
<Part4Size></Part4Size>
</Medium>
</Media>
</FileSystem>

Table description
Item Description
Feature name FileSystem
Table name Media
Table type Multi-instance table
Row name Medium
Part1Size, Part2Size, Part3Size and Part4Size should
Restrictions be assigned in order.
It is not permitted to assign Part2Size without Part1Size.

4
Columns
Data type and
Column name Column description Column type
restrictions

Name Storage medium name.

String.
For examples:
Index Length: 1 to 255
flash:
characters.
chassis3#slot1#cfa:

Fdisk This column must be

Partition a storage medium. N/A
empty.

Part1Size The size of partition1. Unsigned

N/A
Unit: Mbyte. integer.

Part2Size The size of partition2. Unsigned

N/A
Unit: Mbyte. integer.

Part3Size The size of partition3. Unsigned

N/A
Unit: Mbyte. integer.

Part4Size The size of partition4. Unsigned

N/A
Unit: Mbyte. integer.

FileSystem/Partitions
XML structure
<FileSystem>
<Partitions>
<Partition>
<Name></Name>
<Operations>
<Format></Format>
<FixDisk></FixDisk>
<Umount></Umount>
<Mount></Mount>
</Operations>
</Partition>
</Partitions>
</FileSystem>

Table description
Item Description
Feature name FileSystem

5
 Table name Partitions
Table type Multi-instance table
Row name Partition
Restrictions None

Columns
Data type and
Column name Column description Column type
restrictions

Name Storage medium partition

name.
String.
For examples: Index Length: 1 to 255
flash: characters.
chassis3#slot1#cfa0:

Format Format a storage medium This column must be

N/A
partition. empty.

FixDisk Check and repair a storage This column must be

N/A
medium partition. empty.

Umount Unmount a storage medium This column must be

N/A
partition. empty.

Mount Mount a storage medium This column must be

N/A
partition. empty.

6
Contents
FileSystem ······················································································1
FileSystem/Files ·························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
FileSystem/RecycleBin ················································································································· 2
XML structure ······················································································································· 2
Table description ··················································································································· 2
Columns ······························································································································ 3
FileSystem/Media ························································································································ 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
FileSystem/Partitions ···················································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 4

i
FileSystem
FileSystem/Files
This table contains the file information.

XML structure
<FileSystem>
<Files>
<File>
<Name></Name>
<Path></Path>
<Size></Size>
<Time></Time>
<IsDirectory></IsDirectory>
</File>
</Files>
</FileSystem>

Table description
Item Description
Feature name FileSystem
Table name Files
Table type Multi-instance table
Row name File
Restrictions None

Columns
Column Column Column Data type and
Remark
name description type restrictions
Name Examples:
• flash:/lo
gfile/log
Fully qualified name String, case insensitive. file.log
Index • chassis
of a directory or file Length: 1 to 4096 characters.
3#slot1
#cfa0:/
main.cf
g

1
 Column Column Column Data type and
Remark
name description type restrictions
N/A
Path Examples:
• flash:/lo
Absolute path to the String, case insensitive.
gfile
file Length: 1 to 4096 characters. • chassis
3#slot1
#cfa0:

Size N/A Unsigned integer.

File size in bytes 64 N/A
Value range: 0 to2 - 1.
Time N/A DateTime.
Latest modification
Format: N/A
time.
YYYY-MM-DDTHH:MM:SS.

IsDirector N/A
Whether the Name Boolean:

y
column carries a • true N/A
directory • false

FileSystem/RecycleBin
This Table contains recycle bin files information.

XML structure
<FileSystem>
<RecycleBin>
<RecycleBinFile>
<Medium></Medium>
<TrashFiles>
<FileName></FileName>
</TrashFiles>
</RecycleBinFile>
</RecycleBin>
</FileSystem>

Table description
Item Description
Feature name FileSystem
Table name RecycleBin
Table type Multi-instance table
Row name RecycleBinFile
Restrictions None

2
Columns

Column Column Data type and

Column name Remark
description type restrictions

Medium String. Examples:

File system name Index Length: 1 to 255 • chassis2#slot1#flash:
characters. • chassis1#slot2#cfa0:
TrashFiles Data Members:
Files in the recycle bin N/A
structure FileName
FileName String, case
Examples:
insensitive.
File name. N/A • logfile/logfile.log
Length: 1 to 4096
characters. • main.cfg

FileSystem/Media
This Table contains medium information.

XML structure
<FileSystem>
<Media>
<Medium>
<Name></Name>
<PartitionCapability></PartitionCapability>
</Medium>
</Media>
</FileSystem>

Table description
Item Description
Feature name FileSystem
Table name Media
Table type Multi-instance table
Row name Medium
Restrictions None

Columns

3
 Column Column Data type and
Column name Remark
description type restrictions

Name String. Examples:

Storage medium name Index Length: 1 to 255 • chassis2#slot1#flash:
characters. • chassis1#slot2#cfa:
PartitionCapability Whether the medium N/A Boolean:
can be partitioned • true N/A
• false

FileSystem/Partitions
This Table contains partition information.

XML structure
<FileSystem>
<Partitions>
<Partition>
<Name></Name>
<Total></Total>
<Used></Used>
<Free></Free>
<Bootable></Bootable>
<MountState></MountState>
</Partition>
</Partitions>
</FileSystem>

Table description
Item Description
Feature name FileSystem
Table name Partitions
Table type Multi-instance table
Row name Partition
Restrictions None

Columns

Column Column Column Data type and

Remark
name description type restrictions

Name Partition name Index String. Examples:

4
Column Column Column Data type and
Remark
name description type restrictions
Length: 1 to 255 • chassis2#slot1#flash:
characters. • chassis1#slot2#cfa0:
Total Total size of the partition N/A Unsigned integer.
64
in bytes Value range: 0 to 2 – N/A
1.
Used Used size of the partition N/A Unsigned integer.
64
in bytes. Value range: 0 to 2 - N/A
1.
Free Available size of the N/A Unsigned integer.
64
partition in bytes Value range: 0 to 2 - N/A
1.
Bootable Whether the partition is N/A Boolean:
the startup partition • true N/A
• false
MountState Whether the partition is N/A Boolean: If the value of this column
mounted • true is false, only this column
and the Name column can
• false be read.

5
Contents
FileSystem ······················································································1
FileSystem/Files ·························································································································· 1
FileSystem/Media ························································································································ 2
FileSystem/Partitions ···················································································································· 2

i
FileSystem
FileSystem/Files
Message Explanation
The destination file name can’t be the same as the During executing copy or move operation, the destination file
source file name. name must not be the same as the source file name.

During executing copy, move, delete or rename operation, user

Permission denied.
lacks permissions.
During executing copy, move, delete or rename operation on a file
The file or directory doesn't exist.
or directory, the file or directory doesn't exist.
During executing copy or move operation, insufficient storage or
Insufficient storage or disk space.
disk space.
During executing rename operation, the source file name and the
Wrong file name or directory name. Please check.
destination file name must not end with ‘\’.
SrcName and DstName are not in the same During executing rename operation, the source file and the
directory. destination file must in the same parent directory.
During executing rename operation, the destination file name
The destination file name is already used.
must not be used.
During executing make directory operation, the directory must not
The directory already exists.
exist.
During executing make directory operation, the parent directory
The parent directory doesn't exist.
doesn't exist.
During executing make directory operation, the directory must not
A file with the same name already exists
be the same as an exist file.
During executing delete directory operation, the directory must be
Can't remove the directory because it is not empty.
empty.
Can't execute this command. The security log file is Before partition a storage device, delete all the saved security log
already saved in the storage medium. files first.
Please use 'RmDir' to remove the directory. The directory can't be deleted by ‘Delete’ operation, but ‘RmDir’.
During executing copy or move operation, the destination file
Can't overwrite directory %s with non-directory %s.
name must not be the same as an exist directory.
The ‘DstName’ must not be set in operation ‘Delete’,’
DstName is not required for this operation. UnReservedDelete’, ‘Gzip’,
‘Gunzip’,‘Sha256sum’,’Md5sum’,’MkDir’ and ’Rmdir’.
The ‘DstName’ must be set in operation ‘Copy’, ‘Move’,
Please enter a value for the DstName column.
‘Rename’,‘Sha256sum’,’Md5sum’,’MkDir’ and ’Rmdir’.
Operation failed. Curl unsupported protocol. Failed to copy file through network, unsupported protocol.
Failed to copy file through network, wrong user name or
Operation failed. Remote server login denied.
password.

Failed to copy file through network, remote file or directory not

Operation failed. Remote file or directory not found.
found.

Operation failed. Remote server can't connect. Failed to copy file through network, remote server can't connect.
Invalid VPN name. Failed to copy file through network, invalid VPN name.

1
Invalid URL. Failed to copy file through network, invalid URL.

FileSystem/Media
Message Explanation
Storage device error. Can't read storage device.
The storage space is too small to partition. Do not need to partition.
The partition size must be greater than or equal
The partition size is set too small.
to %dMB.

The partition size must be less than or equal

The partition size is set too big.
to %uMB.

The remaining space is less than %uMB. The remaining space is not enough.

FileSystem/Partitions
Message Explanation
The storage device is being used and locked by
Wait for the storage device to be released.
another process.

Operation failed. The device is in use and locked by

Operation failed, wait for the storage device to be released.
another process.

2
Contents
FTP ·······························································································1
FTP/Server ································································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1

i
FTP
FTP/Server
This table contains information about global FTP Server functions.

XML structure
<FTP>
<Server>
<State></State>
<Ipv4DSCP></Ipv4DSCP>
<Ipv6DSCP></Ipv6DSCP>
<Ipv4ACLNum></Ipv4ACLNum>
<Ipv6ACLNum></Ipv6ACLNum>
<Timeout></Timeout>
<SslServerPolicy></SslServerPolicy>
</Server>
</FTP>

Table description
Item Description
Feature name FTP
Table name Server
Table type Single-instance table
Row name None
Restrictions This table supports only global FTP Server functions.
Support for row creation and deletion No

Columns
Column
Column name Column type Data type and restrictions
description
EnableState:
Global FTP Server • enable Enable FTP Server
State N/A
feature • disable Disable FTP
Server(default)
Set the IPv4 Unsigned integer.
Differentiated
Ipv4DSCP N/A Value range: 0 to 63.
Services Codepoint
(DSCP) value Default value:0

1
 Column
Column name Column type Data type and restrictions
description
Set the IPv6 Unsigned integer.
Differentiated
Ipv6DSCP N/A Value range: 0 to 63.
Services Codepoint
(DSCP) value Default value:0.

Specify an IPv4
ACL used to control Unsigned integer.
Ipv4ACLNum N/A
the FTP clients' Value range: 2000 to 3999.
access
Specify an IPv6
ACL used to control Unsigned integer.
Ipv6ACLNum N/A
the FTP clients' Value range: 2000 to 3999.
access

Unsigned integer.
Specify FTP timeout
Timeout N/A Value range: 1 to 35791.
value
Default value: 30.
Specify an SSL String.
SslServerPolicy server poloicy for N/A
the FTP server Length: 1 to 31 characters.

2
Contents
FTP ·······························································································1
FTP/Capabilities ·························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
FTP/Server ································································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 2
Columns ······························································································································ 2

i
FTP
FTP/Capabilities
This table contains the capabilities information of the FTP.

XML structure
<FTP>
<Capabilities>
<FtpServerSupport></FtpServerSupport>
</Capabilities>
</FTP>

Table description
Item Description
Feature name FTP
Table name Capabilities
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Data type and
Column name Column description
type restrictions
FtpServerSupport Boolean:
Whether The FTP Server capability
is supported.
N/A • true
• false

FTP/Server
This table contains global FTP Server information.

XML structure
<FTP>
<Server>
<State></State>
<Ipv4DSCP></Ipv4DSCP>
<Ipv6DSCP></Ipv6DSCP>
<Ipv4ACLNum></Ipv4ACLNum>

1
 <Ipv6ACLNum></Ipv6ACLNum>
<Timeout></Timeout>
<SslServerPolicy></SslServerPolicy>
</Server>
</FTP>

Table description
Item Description
Feature name FTP
Table name Server
Table type Single-instance table
Row name None
Restrictions This table supports only global FTP Server functions.
Support for row creation and deletion No

Columns
Column name Column description Column type Data type and restrictions
EnableState:
• enable Enable FTP
Global FTP Server
State N/A Server
feature
• disable Disable FTP
Server(default)

Set the IPv4 Unsigned integer.

Ipv4DSCP Differentiated Services N/A Value range: 0 to 63.
Codepoint (DSCP) value Default value:0

Set the IPv6 Unsigned integer.

Ipv6DSCP Differentiated Services N/A Value range: 0 to 63.
Codepoint (DSCP) value Default value:0.
Specify an IPv4 ACL Unsigned integer.
Ipv4ACLNum used to control the FTP N/A
clients' access Value range: 2000 to 3999.

Specify an IPv6 ACL Unsigned integer.

Ipv6ACLNum used to control the FTP N/A
clients' access Value range: 2000 to 3999.

Unsigned integer.
Specify FTP timeout
Timeout N/A Value range: 1 to 35791.
value
Default value: 30.
Specify an SSL server String.
SslServerPolicy poloicy for the FTP N/A
server Length: 1 to 31 characters.

2
Contents
FTP ················································································································· 1
FTP/Server ························································································································································· 1

i
FTP
FTP/Server
Message Explanation
Failed to enable FTP server. When the FTP service port number has been used by other
使能FTP server失败 services, it does not support to enable FTP server.

Failed to set the idle-timeout interval for FTP If the idle-timeout interval for FTP connections can’t be processed
connections. by the daemon of FTP, the configuration of specified idle-timeout
配置空闲超时失败. interval for FTP will fail.

Failed to specify ACL. If the ACL configuration can’t be processed by the daemon of
配置ACL失败. FTP, the specified ACL configuration will fail.

Failed to specify the SSL server policy. The specified SSL server policy name that need to be configured
配置SSL失败. must already exist.

1
Contents
Fundamentals ·················································································1
Fundamentals/CurrentSessionOpt ··································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1

i
Fundamentals
Fundamentals/CurrentSessionOpt
This table describes the actions that can be performed to current session.

XML structure
<Fundamentals>
<CurrentSessionOpt>
<DisableEditConfigWhenRollback/>
<EnableLightRollback/>
</CurrentSessionOpt>
</Fundamentals>

Table description
Item Description
Feature name Fundamentals
Table name CurrentSessionOpt
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Reject
edit-config Boolean:
DisableEditC
request when
onfigWhenRol
system is
N/A • true N/A
lback • false
performing
rollback.
This column is used to
enable or disable the light
rollback(a light way to
Enable rollback Boolean: rollback when you get an
EnableLightR
ollback
in a light weight N/A • true error in the edit-config
method. • false operation while the
error-option is set to be
rollback-on-error).
By default, it is false

1
Contents
Fundamentals ·················································································1
Fundamentals/WebUI ··················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1

i
Fundamentals
Fundamentals/WebUI
This table contains Web service information.

XML structure
<Fundamentals>
<WebUI>
<SessionAgingTime></SessionAgingTime>
<HTTP>
<State></State>
<Port></Port>
<AclNumber></AclNumber>
<AclName></AclName>
</HTTP>
<HTTPS>
<State></State>
<Port></Port>
<AclNumber></AclNumber>
<AclName></AclName>
</HTTPS>
</WebUI>
</Fundamentals>

Table description
Item Description
Feature name Fundamentals
Table name WebUI
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
Web user Unsigned integer.
SessionAgingTi
connection N/A N/A
me Value range: 1 to 999.
timeout (minutes)

1
 Column Column Data type and
Column name Remarks
description type restrictions
HTTP HTTP Data Members include: N/A
configuration structure • State
information. • Port
• AclNumber
State HTTP status. N/A Enumeration: N/A
• enable
• disable
Port HTTP port N/A Unassigned integer. N/A
number. Value range: 1 to 65535.
Only basic ACLs are
Number of the Unassigned integer. supported. This column
AclNumber ACL for HTTP N/A Value range: 2000 to and the AclName
access control. 2999. column overwrites each
other.
String, case insensitive. Only basic ACLs are
Name of the ACL Length: 1 to 63 supported. This column
AclName for HTTP access N/A characters. and the AclNumber
control. The string must start with column overwrites each
an English letter. other.

Data Members include:

HTTPS structure • State
HTTPS configuration N/A
information. • Port
• AclNumber
Enumeration:
State HTTPS status. N/A • enable N/A
• disable

HTTPS port Unassigned integer.

Port N/A N/A
number. Value range: 1 to 65535.
Only basic ACLs are
Number of the Unassigned integer. supported. This column
AclNumber ACL for HTTP N/A Value range: 2000 to and the AclName
access control. 2999. column overwrites each
other.
String, case insensitive. Only basic ACLs are
Name of the ACL Length: 1 to 63 supported. This column
AclName for HTTP access N/A characters. and the AclNumber
control. The string must start with column overwrites each
an English letter other.

2
Contents
Fundamentals ·················································································1
Fundamentals/WebUI ··················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 2
Fundamentals/NetconfResXPath ···································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
Fundamentals/WebMenuPath ········································································································ 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 5

i
Fundamentals
Fundamentals/WebUI
This table contains Web service information.

XML structure
<Fundamentals>

<WebUI>

<SessionAgingTime></SessionAgingTime>

<HTTP>

<State></State>

<Port></Port>

<AclNumber></AclNumber>

<AclName></AclName>

</HTTP>

<HTTPS>

<State></State>

<Port></Port>

<AclNumber></AclNumber>

<AclName></AclName>

</HTTPS>

</WebUI>

</Fundamentals>

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

1
Columns
Column Column Data type and
Column name Remarks
description type restrictions
Web user
SessionAgingTi connection Unsigned integer.
N/A N/A
me timeout in Value range: 1 to 999.
minutes.
HTTP HTTP Data Members include: N/A
configuration structure • State
information. • Port
• AclNumber
State HTTP status. N/A Enumeration: N/A
• enable
• disable
Port HTTP port N/A Unassigned integer. N/A
number. Value range: 1 to 65535.
Only basic ACLs are
Number of the Unassigned integer. supported. This column
AclNumber ACL for HTTP N/A Value range: 2000 to and the AclName
access control. 2999. column overwrites each
other.
String, case insensitive. Only basic ACLs are
Name of the ACL Length: 1 to 63 supported. This column
AclName for HTTP access N/A characters. and the AclNumber
control. The string must start with column overwrites each
an English letter. other.

Data Members include:

HTTPS structure • State
HTTPS configuration N/A
information. • Port
• AclNumber
Enumeration:
State HTTPS status. N/A • enable N/A
• disable

HTTPS port Unassigned integer.

Port N/A N/A
number. Value range: 1 to 65535.
Only basic ACLs are
Number of the Unassigned integer. supported. This column
AclNumber ACL for HTTPS N/A Value range: 2000 to and the AclName
access control. 2999. column overwrites each
other.
String, case-insensitive. Only basic ACLs are
Name of the ACL Length: 1 to 63 supported. This column
AclName for HTTPS access N/A characters. and the AclNumber
control. The string must start with column overwrites each
an English letter. other.

2
Fundamentals/NetconfResXPath
This table contains NETCONF XML path information.

XML structure
<Fundamentals>

<NetconfResXPath>

<XPath>

<Path></Path>

<Type></Type>

</XPath>

</NetconfResXPath>

</Fundamentals>

Table description
Item Description
Feature name Fundamentals
Table name NetconfResXPath
Table type Multi-instance table

Row name XPath

Restrictions None

Columns
Column name Column description Column type Data type and restrictions
The operational XML resource String.
Path Index
path . case-insensitive.

3
 Column name Column description Column type Data type and restrictions
Enumeration:
• 0 —The XML path of
NETCONF protocol.
Example:
“rpc/kill-session”.
• 1— The intermediate
XML path of NETCONF
protocol.
The type of the operational Example:
XML resource path . “rpc/”.
Type N/A • 2 —The XML path of
device resources.
Example:
“ifmgr/interfaces/interface/if
index”.
• 3 —The intermediate
XML path of device
resources.
Example:
“ifmgr/interfaces/interface/”
.

Fundamentals/WebMenuPath
This table contains web menu path information.

XML structure
<Fundamentals>

<WebMenuPath>

<MenuPath>
<Path></Path>

<Title></Title>

<Type></Type>

</MenuPath>

</WebMenuPath>

</Fundamentals>

Table description
Item Description
Feature name Fundamentals
Table name WebMenuPath
Table type Multi-instance table
Row name MenuPath

4
 Item Description
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
Web path of String.
Path Index N/A
menu. Case-insensitive.
Title The description of N/A String. Depend on the
WEB menu. Length: 1 to 31 language of current
characters. user.

Type The type of WEB N/A Enumeration: N/A

menu. • 0 – Leaf menu which
is corresponding to
the specific web
page.
• 1 – Intermediate
menu node which is
not corresponding to
the specific web
page.

5
Contents
GDVPNGM ·····················································································1
ResetAllGdoiGmInfo ····················································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
ResetGdoiGmInfo ························································································································ 1
XML structure ······················································································································· 1
Table description ··················································································································· 2
Columns ······························································································································ 2

i
GDVPNGM
ResetAllGdoiGmInfo
The table is used to clear GDOI information for all GM groups, and trigger to the GMs to re-register
with the KS.

XML structure
<ResetAllGdoiGmInfo>
<Reset></Reset>
</ResetAllGdoiGmInfo>

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

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Clear gdoi gm
This column must not
Reset information of all N/A N/A
be empty.
groups.

ResetGdoiGmInfo
The table is used to clear GDOI information for a GDOI GM group, and to trigger the GMs to
re-register with the KS.

XML structure
<ResetGdoiGmInfo>
<Reset>
<GroupName></GroupName>
</Reset>
</ResetGdoiGmInfo>

1
Table description
Item Description
Feature name GDVPNGM
Table name ResetGdoiGmInfo
Table type Multi-instance table
Row name Reset
Restrictions None

Columns
Column
Column name Column description Data type and restrictions
type
Name of the GDOI GM String, Case insensitive
GroupName Index
group. Length: 1 to 63 characters.

2
Contents
GDVPNGM ·····················································································1
GdoiGmGroups ··························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 2
GdoiGmGroupServers ·················································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
GdoiGmGroupTransformSets ········································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 4
GdoiIPv4Policies ·························································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 5
Columns ······························································································································ 5
GdoiIPv6Policies ·························································································································· 6
XML structure ······················································································································· 6
Table description ··················································································································· 6
Columns ······························································································································ 7

i
GDVPNGM
GdoiGmGroups
This table displays GM group information.

XML structure
<GdoiGmGroups>
<GdoiGmGroup>
<GroupName></GroupName>
<IPVersion></IPVersion>
<Identity>
<Type></Type>
<Number></Number>
<Address></Address>
</Identity>
<RegistrationInterface></RegistrationInterface>
<Encryption>
<ThreeDesCbc></ThreeDesCbc>
<AesCbc128></AesCbc128>
<AesCbc192></AesCbc192>
<AesCbc256></AesCbc256>
<DesCbc></DesCbc>
</Encryption>
</GdoiGmGroup>
</GdoiGmGroups>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiGmGroups
Table type Multi-instance table
Row name GdoiGmGroup
Restrictions None
Support for row creation and deletion Yes

1
Columns
Column Column Column
Data type and restrictions Remarks
name description type
String.
Name of the
GroupName Index Length: 1 to 63 characters N/A.
GDOI GM group
Case insensitive.
Enumeration:
GM group IP
IPVersion
version.
N/A • 1—IPv4(Default). N/A.
• 2—IPv6.
Members include:
GDOI GM group Data • Type Use Type to specify
Identity
ID. structure • Address which member is valid
• Number
0 means Identity is not
specified. In this case
neither Address nor
Enumeration: Number is valid.
• 0—invalid(Default) 1 means Identity is
Type Identity type N/A
• 1—Number Type Address. In this case,
only Address is valid.
• 2—Address Type
2 means Identity is
Number. In this case
only Number is valid.

A number to Unsigned integer.

Number is ignored if
Number identify the GDOI N/A Value range of 0 to Type is not 2.
GM group. 2147483647.
IPv4 address to
Address is ignored if
Address identify the GDOI N/A IPv4 address.
Type is not 1.
GM group
Registration String, case-insensitive.
RegistrationIn interface name
N/A Length: 1 to 63 characters N/A.
terface for a group
member The default is empty.

Members include:
The encryption
• ThreeDesCbc algorithms is from 0 to
KEK encryption Data • AesCbc128 1.”1”means the
Encryption
algorithms structure • AesCbc192 encryption algorithms is
enable, “0” means
• AesCbc256
disable.
• DesCbc

The 3DES-CBC Unsigned integer.

ThreeDesCbc encryption N/A Value range: 0 to 1. N/A
algorithm The default is 1.
The Unsigned integer.
AES-CBC-128
AesCbc128 N/A Value range: 0 to 1. N/A
encryption
algorithm The default is 1

2
 Column Column Column
Data type and restrictions Remarks
name description type
The Unsigned integer.
AES-CBC-192
AesCbc192 N/A Value range: 0 to 1. N/A
encryption
algorithm The default is 1.

The Unsigned integer.

AES-CBC-256
AesCbc256 N/A Value range: 0 to 1 N/A
encryption
algorithm The default is 1.

The DEC-CBC Unsigned integer.

DecCbc encryption N/A Value range: 0 to 1. N/A
algorithm The default is 1

GdoiGmGroupServers
This table displays key servers (KS) of a GM group.

XML structure
<GdoiGmGroupServers>
<Server>
<GroupName></GroupName>
<Host></Host>
<Vrf></Vrf>
</Server>
</GdoiGmGroupServers>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiGmGroupServers
Table type Multi-instance table
Row name Server
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.
GroupName
GDOI GM group
Index N/A.
Length: 1 to 63 characters.

3
 Column Column Column
Data type and restrictions Remarks
name description type
IPv4 example: 1.1.1.1.
IPv4: String, dotted decimal
notation. IPv6 example:
Key server IP 1:2:3:4:5:6:7:8.
IPv6: Hexadecimal string,
Host address or Index Hostname can contains
colon-separated.
hostname letters, digits, hyphens
Hostname: String, 1 to 253
(-), and underscores
characters, case-sensitive.
(_).

String, case-sensitive. If the server is on the

VRF instance public network, the
Vrf Index Length: 0 to 31 characters.
name length of characters is
The default is empty. 0.

GdoiGmGroupTransformSets
This table displays transform sets of a GM group.

XML structure
<GdoiGmGroupTransformSets>
<TransformSet>
<GroupName></GroupName>
<TransformSetList>
<TransformSetName></TransformSetName>
</TransformSetList>
</TransformSet>
</GdoiGmGroupTransformSets>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiGmGroupTransformSets
Table type Multi-instance table
Row name TransformSet
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.
GroupName
GDOI GM group
Index N/A.
Length: 1 to 63 characters.

4
 Column Column Column
Data type and restrictions Remarks
name description type
TransformSet List of transform Data Members include:
N/A.
List set names structure • TransformSetName

String, case-insensitive. This Column can be

TransformSet IPsec transform
Column repeated for 0 to 6
Name set name Length :1 to 63 characters. times.

GdoiIPv4Policies
This table displays GDOI policies of a GM group.

XML structure
<GdoiIPv4Policies>
<Policy>
<PolicyName></PolicyName>
<SeqNum></SeqNum>
<GroupName></GroupName>
<ACL>
<Name></Name>
<Number></Number>
</ACL>
</Policy>
</GdoiIPv4Policies>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiIPv4Policies
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
An IPv4 IPsec policy
Name of the String, case-insensitive. and an IPv6 IPsec
PolicyName Index
IPsec policy Length: 1 to 63 characters. policy can use the
same PolicyName.

5
 Column Column Column
Data type and restrictions Remarks
name description type
An IPv4 IPsec policy
Sequence
Unsigned integer. and an IPv6 IPsec
number of the
SeqNum Index policy can use the
IPsec policy • Value range: 1 to 65535. same sequence
entry
number.

Name of the String, case-insensitive.

GroupName N/A N/A.
GDOI GM group Length: 1 to 63 characters.

Reference an Members include:

Data
ACL ACL for an IPsec
structure • Name N/A
policy • Number
String. If ACL Name is not
Name ACL name N/A • Length: 1 to 63 characters. empty,the ACL Number
• Default is empty. does not make sense.

 Only when the

Integer. ACL Name is
empty, does
Number ACL number N/A Value range: 3000 to 3999.
the ACL
• Default is -1. Number make
sense.

GdoiIPv6Policies
This table displays GDOI IPv6 policies of a GM group.

XML structure
<GdoiIPv6Policies>
<Policy>
<PolicyName></PolicyName>
<SeqNum></SeqNum>
<GroupName></GroupName>
<ACL>
<Name></Name>
<Number></Number>
</ACL>
</Policy>
</GdoiIPv6Policies>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiIPv6Policies
Table type Multi-instance table
Row name Policy

6
 Item Description
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
An IPv4 IPsec policy
Name of the String, case-insensitive. and an IPv6 IPsec
PolicyName Index
IPsec policy Length: 1 to 63 characters. policy can use the
same PolicyName.
An IPv4 IPsec policy
Sequence
Unsigned integer. and an IPv6 IPsec
number of the
SeqNum Index policy can use the
IPsec policy • Value range: 1 to 65535. same sequence
entry
number.

Name for the String, case-insensitive.

GroupName N/A N/A.
GDOI GM group Length: 1 to 63 characters.

Reference an Members include:

Data
ACL ACL for an IPsec
structure • Name N/A
policy • Number
String. If ACL Name is not
Name ACL name N/A • Length: 1 to 63 characters. empty,the ACL Number
• Default is empty. does not make sense.

 Only when the

Unsigned integer. ACL Name is
empty, does
Number ACL number N/A Value range: 3000 to 3999.
the ACL
• Default is 0. Number make
sense.

7
Contents
GDVPNGM ·····················································································1
GdoiGmGroups ··························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 2
GdoiGmGroupServers ·················································································································· 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
GdoiGmGroupTransformSets ········································································································· 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 5
GdoiGroupMembers ····················································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 6
Columns ······························································································································ 6
GdoiGmDownloadIPv4AclRules ······································································································ 8
XML structure ······················································································································· 8
Table description ··················································································································· 9
Columns ······························································································································ 9
GdoiGmDownloadIPv6AclRules ···································································································· 10
XML structure ····················································································································· 10
Table description ················································································································· 11
Columns ···························································································································· 11
GdoiGmLocalIPv4AclRules ·········································································································· 12
XML structure ····················································································································· 12
Table description ················································································································· 12
Columns ···························································································································· 13
GdoiGmLocalIPv6AclRules ·········································································································· 15
XML structure ····················································································································· 15
Table description ················································································································· 16
Columns ···························································································································· 16
GdoiKeks ································································································································· 18
XML structure ····················································································································· 18
Table description ················································································································· 18
Columns ···························································································································· 19
GdoiGmTeks ····························································································································· 19
XML structure ····················································································································· 19
Table description ················································································································· 20
Columns ···························································································································· 20
GdoiIPv4Policies ························································································································ 21
XML structure ····················································································································· 21
Table description ················································································································· 21
Columns ···························································································································· 21
GdoiIPv6Policies ························································································································ 22
XML structure ····················································································································· 22
Table description ················································································································· 22
Columns ···························································································································· 23

i
GDVPNGM
GdoiGmGroups
This table displays GM group information.

XML structure
<GdoiGmGroups>
<GdoiGmGroup>
<GroupName></GroupName>
<IPVersion></IPVersion>
<Identity>
<Type></Type>
<Number></Number>
<Address></Address>
</Identity>
<RegistrationInterface></RegistrationInterface>
<Encryption>
<ThreeDesCbc></ThreeDesCbc>
<AesCbc128></AesCbc128>
<AesCbc192></AesCbc192>
<AesCbc256></AesCbc256>
<DesCbc></DesCbc>
</Encryption>
</GdoiGmGroup>
</GdoiGmGroups>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiGmGroups
Table type Multi-instance table
Row name GdoiGmGroup
Restrictions None
Support for row creation and deletion Yes

1
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String, Case insensitive.
GroupName Index N/A.
GDOI GM group Length: 1 to 63 characters
It is not suggested to
Enumeration: change a group`s
GM group IP IPVersion from IPv4 to
IPVersion
version.
N/A • 1—IPv4(Default) IPV6 or IPV6 to IPV4,
• 2—IPv6 some config of the
group may lost.
Members include:
GDOI GM group Data • Type Use Type to specify
Identity
ID. structure • Address which member is valid
• Number
0 means Identity is not
specified,in this case
neither Address nor
Enumeration: Number is valid.
• 0—invalid(Default) 1 means Identity is
Type Identity type N/A
• 1—Number Type Address,in this case,
only Address is valid.
• 2—Address Type
2 means Identity is
Number,in this case
only Number is valid.

A number to Unsigned integer.

Number is ignored if
Number identify the GDOI N/A Value range of 0 to Type is not 2.
GM group. 2147483647.
IPv4 address to
Address is ignored if
Address identify the GDOI N/A IPv4 address.
Type is not 1.
GM group
Registration String, Case insensitive.
RegistrationIn interface name
N/A Length: 1 to 63 characters N/A.
terface for a group
member The default is empty.

Members include:
The encryption
• ThreeDesCbc algorithms is from 0 to
KEK encryption Data • AesCbc128 1.”1”means the
Encryption
algorithms structure • AesCbc192 encryption algorithms is
enable, “0” means
• AesCbc256
disable.
• DesCbc

The 3DES-CBC Unsigned integer.

ThreeDesCbc encryption N/A Value range: 0 to 1. N/A
algorithm The default is 1.
The Unsigned integer.
AES-CBC-128
AesCbc128 N/A Value range: 0 to 1. N/A
encryption
algorithm The default is 1

2
 Column Column Column
Data type and restrictions Remarks
name description type
The Unsigned integer.
AES-CBC-192
AesCbc192 N/A Value range: 0 to 1. N/A
encryption
algorithm The default is 1.

The Unsigned integer.

AES-CBC-256
AesCbc256 N/A Value range: 0 to 1 N/A
encryption
algorithm The default is 1.

The DEC-CBC Unsigned integer.

DecCbc encryption N/A Value range: 0 to 1. N/A
algorithm The default is 1

GdoiGmGroupServers
This table displays key servers (KS) of a GM group.

XML structure
<GdoiGmGroupServers>
<Server>
<GroupName></GroupName>
<Host></Host>
<Vrf></Vrf>
</Server>
</GdoiGmGroupServers>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiGmGroupServers
Table type Multi-instance table
Row name Server
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.
GroupName
GDOI GM group
Index N/A.
Length: 1 to 63 characters.

3
 Column Column Column
Data type and restrictions Remarks
name description type
IPv4 example: 1.1.1.1.
IPv4: String, dotted decimal
notation. IPv6 example:
Key server IP 1:2:3:4:5:6:7:8.
IPv6: Hexadecimal string,
Host address or Index Hostname can contains
colon-separated.
hostname letters, digits, hyphens
Hostname: String, 1 to 253
(-), and underscores
characters, case-sensitive.
(_).

String, case-sensitive. If the server is on the

VRF instance public network, the
Vrf Index Length: 0 to 31 characters.
name length of characters is
The default is empty. 0.

GdoiGmGroupTransformSets
This table displays transform sets of a GM group.

XML structure
<GdoiGmGroupTransformSets>
<TransformSet>
<GroupName></GroupName>
<TransformSetList>
<TransformSetName></TransformSetName>
</TransformSetList>
</TransformSet>
</GdoiGmGroupTransformSets>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiGmGroupTransformSets
Table type Multi-instance table
Row name TransformSet
Restrictions None
Support for row creation and deletion Yes

4
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String, case-insensitive.
GroupName Index N/A.
GDOI GM group Length: 1 to 63 characters.

TransformSet List of transform Data Members include:

N/A.
List set names structure • TransformSetName

String, case-insensitive. This Column can be

TransformSet IPsec transform
Column repeated for 0 to 6
Name set name Length :1 to 63 characters. times.

GdoiGroupMembers
This table displays GDOI group members.

XML structure
<GdoiGroupMembers>
<GroupMember>
<GroupName></GroupName>
<IPAddress></IPAddress>
<VRFName></VRFName>
<RegStatus></RegStatus>
<RegServer></RegServer>
<ReRegTime></ReRegTime>
<SucceedRegs></SucceedRegs>
<AttemptedRegs></AttemptedRegs>
<LastRekeyFrom></LastRekeyFrom>
<LastRekeySeqNum></LastRekeySeqNum>
<MulticastRekeysReceived></MulticastRekeysReceived>
<UnicastRekeysReceived></UnicastRekeysReceived>
<RekeyAcKSent></RekeyAcKSent>
<AllowableRekeyCipher></AllowableRekeyCipher>
<AllowableRekeyHash></AllowableRekeyHash>
<AllowableTransforms>
<AllowableTransform></AllowableTransform>
<AllowableTransforms>
<RekeyCumulative>
<TotalReceived></TotalReceived>
<AfterLatestReg></AfterLatestReg>
<LastRekeyReceivedFor></LastRekeyReceivedFor>
<TotalRekeyAckSent></TotalRekeyAckSent>
</RekeyCumulative>
</GroupMember>
</GdoiGroupMembers>

5
Table description
Item Description
Feature name GDVPNGM
Table name GdoiGroupMembers
Table type Multi-instance table
Row name GroupMember
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
GroupNam GDOI GM String, case-insensitive.
Index N/A
e group name. Length: 1 to 63 characters.
IPv4: String, dotted decimal
IPv4 example: 1.1.1.1.
IP address of notation.
IPAddress N/A IPv6 example:
the GM. IPv6: Hexadecimal string,
1:2:3:4:5:6:7:8.
colon-separated.

Name of the String. If the KS belongs to

VRF to which
VRFName N/A Length: 0 to 31 characters. the public network, this
the KS
field is not displayed.
belongs.
The default is empty.
Enumeration:
The
• 1—Not registered.
RegStatus registration N/A N/A
status. • 2—Registering.
• 3—Registered.
IPv4 example: 1.1.1.1.
IPv4: String, dotted decimal
IP address or notation. IPv6 example:
host name of 1:2:3:4:5:6:7:8.
IPv6: Hexadecimal string,
RegServer the KS with N/A Hostname can
colon-separated.
which the GM contains letters, digits,
registers. Hostname: String, 1 to 253
hyphens (-), and
characters.
underscores (_).
Period of time
after which
ReRegTime the GM N/A Unsigned integer. Unit: second.
re-registers
with a KS.
Number of
SucceedRe
successful N/A Unsigned integer. N/A
gs
registrations.
Number of
AttemptedR
registration N/A Unsigned integer. N/A
egs
attempts.

6
Column Column Column
Data type and restrictions Remarks
name description type
IPv4 example: 1.1.1.1.
IPv4: String, dotted decimal
KS from which notation. IPv6 example:
the GM 1:2:3:4:5:6:7:8.
LastRekeyF IPv6: Hexadecimal string,
receives the N/A Hostname can
rom colon-separated.
last rekey contains letters, digits,
message. Hostname: String, 1 to 253
hyphens (-), and
characters.
underscores (_).
Sequence
number of the
LastRekeyS
last received N/A Unsigned integer. N/A
eqNum
rekey
message.
Number of
MulticastRe Valid only when the
multicast
keysReceiv N/A Unsigned integer. GDOI GM group is a
rekeys
ed multicast group.
received.
UnicastRek Number of Valid only when the
eysReceive unicast rekeys N/A Unsigned integer. GDOI GM group is a
d received. unicast group.
Number of This field is displayed
RekeyAcKS rekey ACK only when the GDOI
N/A Unsigned integer.
ent messages GM group is a unicast
sent. group.
In non-FIPS mode, a
GM supports
Each bit represents a algorithm DES-CBC,
As follows: 3DES-CBC,
Rekey AES-CBC-128,
encryption • 1—DES-CBC. AES-CBC-192, and
AllowableR
ekeyCipher
algorithms N/A • 2—3DES-CBC. AES-CBC-256.
that the GM • 4—AES-CBC-128.
allows. In FIPS mode, a GM
• 8—AES-CBC-192. supports
• 16—AES-CBC-256. AES-CBC-128,
AES-CBC-192, and
AES-CBC-256.
Each bit represents a algorithm
As follows:
• 1—MD5
Rekey hash • 2—SHA1
AllowableR algorithms 0 represents any hash
ekeyHash that the GM
N/A • 4—SHA2-224 algorithm.
allows. • 8—SHA2-256
• 16—SHA2-384
• 32—SHA2-512
• 64—AES-XCBC
List of
AllowableTr Data Members include:
transform set N/A
ansforms structure
names • TransformSetName
IPsec String, case-insensitive. This column can be
TransformS
transform set N/A repeated for 0 to 6
etName Length :1 to 63 characters.
name times.

7
 Column Column Column
Data type and restrictions Remarks
name description type
Members include:
RekeyCum Rekey Data • TotalReceived.
N/A
ulative statistics. structure • AfterLatestReg.
• TotalRekeyAckSent.
Total number
TotalReceiv of rekeys that
N/A Unsigned integer. N/A
ed the GM has
received.
Number of
rekeys that
the GM has
AfterLatest
received after N/A Unsigned integer. N/A
Reg
the last
successful
registration.
Period of time
for which the
LastRekey Unit: second
key has
ReceivedFo N/A Unsigned integer.
existed after 0 represents N/A.
r
the last rekey
operation.
Number of
TotalRekey rekey ACK
N/A Unsigned integer. N/A
AckSent messages
sent.

GdoiGmDownloadIPv4AclRules
This table displays ACL information that the GM downloaded from the KS.

XML structure
<GdoiGmDownloadIPv4AclRules>
<Rule>
<GroupName></GroupName>
<ID></ID>
<KeyServer></KeyServer>
<Action></Action>
<Protocol></Protocol>
<Source>
<SrcAddr></SrcAddr>
<SrcWildLen></SrcWildLen>
<SrcPort></SrcPort>
</Source>
<Destination>
<DesAddr></DesAddr>
<DesWildLen></DesWildLen>
<DesPort></DesPort>

8
 </Destination>
</Rule>
</GdoiGmDownloadIPv4AclRules>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiGmDownloadIPv4AclRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
GroupNam GDOI GM String, case-insensitive.
Index N/A
e group name. Length: 1 to 63 characters.
The ID of a
ID Index Unsigned integer. N/A
rule.
IPv4: String, dotted decimal
The key IPv4 example: 1.1.1.1.
notation.
KeyServer server IP N/A IPv6 example:
address IPv6: Hexadecimal string,
1:2:3:4:5:6:7:8.
colon-separated.

Enumeration:
The rule
Action
action
N/A • 1—Deny. N/A
• 2—Permit.
Protocols common to
IP protocol
Protocol N/A Unsigned integer. RFC 1700, POSIX,
number
and X/Open

Members include:
ACL of source Data • SrcAddr.
Source
address structure • SrcWildLen
• SrcPort.
The source
SrcAddr address of N/A IPv4 address. N/A
packets.

The wildcard
length of
SrcWildLen N/A Unsigned integer. N/A
source
address.
The source Unsigned integer.
SrcPort port of N/A N/A
packets. Range: 1to 65535.

9
 Column Column Column
Data type and restrictions Remarks
name description type
Members include:
ACL of
Data • DesAddr.
Destination destination
address
structure • DesWildLen
• DesPort.
The
destination
DesAddr N/A IPv4 address. N/A
address of
packets.
The wildcard
length of
DesWildLen N/A Unsigned integer. N/A
destination
address.
The
destination Unsigned integer.
DesPort N/A N/A
port of Range: 1 to 65535.
packets.

GdoiGmDownloadIPv6AclRules
This table displays ACL information that the GM downloaded from the KS.

XML structure
<GdoiGmDownloadIPv6AclRules>
<Rule>
<GroupName></GroupName>
<ID></ID>
<KeyServer></KeyServer>
<Action></Action>
<Protocol></Protocol>
<Source>
<SrcAddr></SrcAddr>
<SrcWildLen></SrcWildLen>
<SrcPort></SrcPort>
</Source>
<Destination>
<DesAddr></DesAddr>
<DesWildLen></DesWildLen>
<DesPort></DesPort>
</Destination>
</Rule>
</GdoiGmDownloadIPv6AclRules>

10
Table description
Item Description
Feature name GDVPNGM
Table name GdoiGmDownloadIPv6AclRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
GroupNam GDOI GM String, case-insensitive.
Index N/A
e group name. Length: 1 to 63 characters.
The ID of a
ID Index Unsigned integer. N/A
rule.
IPv4: String, dotted decimal
The key IPv4 example: 1.1.1.1.
notation.
KeyServer server IP N/A IPv6 example:
address IPv6: Hexadecimal string,
1:2:3:4:5:6:7:8.
colon-separated.

Enumeration:
The rule
Action
action
N/A • 1—Deny. N/A
• 2—Permit.
Protocols common to
IP protocol
Protocol N/A Unsigned integer. RFC 1700, POSIX,
number
and X/Open
Members include:
ACL of source Data • SrcAddr.
Source
address structure • SrcWildLen
• SrcPort.
The source
SrcAddr address of N/A IPv4 address. N/A
packets.
The wildcard
length of
SrcWildLen N/A Unsigned integer. N/A
source
address.
The source Unsigned integer.
SrcPort port of N/A N/A
packets. Range: 1to 65535.

Members include:
ACL of
Data • DesAddr.
Destination destination
address
structure • DesWildLen
• DesPort.

11
 Column Column Column
Data type and restrictions Remarks
name description type
The
destination
DesAddr N/A IPv4 address. N/A
address of
packets.
The wildcard
length of
DesWildLen N/A Unsigned integer. N/A
destination
address.
The
destination Unsigned integer.
DesPort N/A N/A
port of Range: 1 to 65535.
packets.

GdoiGmLocalIPv4AclRules
This table displays the ACL information locally configured on the GM.

XML structure
<GdoiGmLocalIPv4AclRules>
<Rule>
<GroupName></GroupName>
<ID></ID>
<ACL>
<ACLNumber></ACLNumber>
<AclNum></AclNum>
<ACLRuleID></ACLRuleID>
<ACLMode></ACLMode>
<Action></Action>
<Protocol></Protocol>
<SrcAddr></SrcAddr>
<SrcWildLen></SrcWildLen>
<SrcPort></SrcPort>
<DesAddr></DesAddr>
<DesWildLen></DesWildLen>
<DesPort></DesPort>
</ACL>
</Rule>
</GdoiGmLocalIPv4AclRules>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiGmLocalIPv4AclRules

12
 Item Description
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
GroupNam GDOI GM String, case-insensitive.
Index N/A
e group name. Length: 1 to 63 characters.
The ID of a
ID Index Integer
rule.

Members include:
• ACLName
• ACLNumber
• ACLRuleID
If the ACLRuleID is
• ACLMode 65535, it means the
Reference an • Action ACL is an empty ACL.
Data
ACL ACL for a gdoi
structure • Protocol The ACL does not
group • SrcAddr support to display
• SrcWildLen object-group
configuration.
• SrcPort
• DesAddr
• DesWildLen
• DesPort

String. If ACL Name is not

empty,the ACL
ACLName ACL name N/A • Length: 1 to 63 characters. Number does not
• Default is empty. make sense.
 Only when the
Unsigned integer. ACL Name is
ACLNumbe empty, does
ACL number N/A Value range: 3000 to 3999.
r the ACL
• Default is 0. Number make
sense.

Unsigned integer.  65535 means

ACLRuleID ACL Rule ID N/A the ACL rule is
Value range: 0 to 65535. empty

13
Column Column Column
Data type and restrictions Remarks
name description type
 per-rule: One
IPsec tunnel
protects one
data flow. The
data flow
permitted by
an ACL rule is
protected by
one IPsec
tunnel that is
established
solely for it.
 per-host: One
IPsec tunnel
protects one
host-to-host
data flow. One
host-to-host
data flow is
identified by
one ACL rule
and protected
Enumeration: by one IPsec
tunnel
Protection • 1—per-rule(default).
ACLMode N/A established
modes • 2—per-host. solely for it.
• 3—aggregation. This mode
consumes
more system
resources
when multiple
data flows
exist between
two subnets to
be protected.
 aggregation:
One IPsec
tunnel
protects all
data flows
permitted by
all the rules of
an ACL. This
mode is only
used to
communicate
with
old-version
devices.
Enumeration:
The rule
Action
action
N/A • 1—Deny. N/A
• 2—Permit.
Protocols common to
IP protocol
Protocol N/A Unsigned integer. RFC 1700, POSIX,
number
and X/Open
The source
SrcAddr address of N/A IPv4 address. N/A
packets.

14
 Column Column Column
Data type and restrictions Remarks
name description type
The wildcard
length of
SrcWildLen N/A Unsigned integer. N/A
source
address.
The source Unsigned integer.
SrcPort port of N/A N/A
packets. Range: 1to 65535.

The
destination
DesAddr N/A IPv4 address. N/A
address of
packets.
The wildcard
length of
DesWildLen N/A Unsigned integer. N/A
destination
address.
The
destination Unsigned integer.
DesPort N/A N/A
port of Range: 1 to 65535.
packets.

GdoiGmLocalIPv6AclRules
This table displays the ACL information locally configured on the GM.

XML structure
<GdoiGmLocalIPv6AclRules>
<Rule>
<GroupName></GroupName>
<ID></ID>
<ACL>
<ACLName></ACLName>
<ACLNumber></ACLNumber>
<ACLRuleID></ACLRuleID>
<ACLMode></ACLMode>
<Action></Action>
<Protocol></Protocol>
<SrcAddr></SrcAddr>
<SrcWildLen></SrcWildLen>
<SrcPort></SrcPort>
<DesAddr></DesAddr>
<DesWildLen></DesWildLen>
<DesPort></DesPort>
</ACL>
</Rule>
</GdoiGmLocalIPv6AclRules>

15
Table description
Item Description
Feature name GDVPNGM
Table name GdoiGmLocalIPv6AclRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
GroupNam GDOI GM String, case-insensitive.
Index N/A
e group name. Length: 1 to 63 characters.
The ID of a
ID Index Integer
rule.

Members include:
• ACLName
• ACLNumber
• ACLRuleID
If the ACLRuleID is
• ACLMode 65535, it means the
Reference an • Action ACL is an empty ACL.
Data
ACL ACL for a gdoi
structure • Protocol The ACL does not
group • SrcAddr support to display
• SrcWildLen object-group
configuration.
• SrcPort
• DesAddr
• DesWildLen
• DesPort

String. If ACL Name is not

empty,the ACL
ACLName ACL name N/A • Length: 1 to 63 characters. Number does not
• Default is empty. make sense.
 Only when the
Unsigned integer. ACL Name is
ACLNumbe empty, does
ACL number N/A Value range: 3000 to 3999.
r the ACL
• Default is 0. Number make
sense.

Unsigned integer.  65535 means

ACLRuleID ACL Rule ID N/A the ACL rule is
Value range: 0 to 65535. empty

16
Column Column Column
Data type and restrictions Remarks
name description type
 per-rule: One
IPsec tunnel
protects one
data flow. The
data flow
permitted by
an ACL rule is
protected by
one IPsec
tunnel that is
established
solely for it.
 per-host: One
IPsec tunnel
protects one
host-to-host
data flow. One
host-to-host
data flow is
identified by
one ACL rule
and protected
Enumeration: by one IPsec
tunnel
Protection • 1—per-rule(default).
ACLMode N/A established
modes • 2—per-host. solely for it.
• 3—aggregation. This mode
consumes
more system
resources
when multiple
data flows
exist between
two subnets to
be protected.
 aggregation:
One IPsec
tunnel
protects all
data flows
permitted by
all the rules of
an ACL. This
mode is only
used to
communicate
with
old-version
devices.
Enumeration:
The rule
Action
action
N/A • 1—Deny. N/A
• 2—Permit.
Protocols common to
IP protocol
Protocol N/A Unsigned integer. RFC 1700, POSIX,
number
and X/Open
The source
SrcAddr address of N/A IPv6 address. N/A
packets.

17
 Column Column Column
Data type and restrictions Remarks
name description type
The wildcard
length of
SrcWildLen N/A Unsigned integer. N/A
source
address.
The source Unsigned integer.
SrcPort port of N/A N/A
packets. Range: 1to 65535.

The
destination
DesAddr N/A IPv6 address. N/A
address of
packets.
The wildcard
length of
DesWildLen N/A Unsigned integer. N/A
destination
address.
The
destination Unsigned integer.
DesPort N/A N/A
port of Range: 1 to 65535.
packets.

GdoiKeks
This table displays KEK information.

XML structure
<GdoiKeks>
<KEK>
<GroupName></GroupName>
<RekeyTransportType></RekeyTransportType>
<RemainingKeyLifetime></RemainingKeyLifetime>
<EncryptionAlgorithm></EncryptionAlgorithm>
<KeySize></KeySize>
<SignatureAlg></SignatureAlg>
<SignatureHashAlg></SignatureHashAlg>
<SignatureKeyLength></SignatureKeyLength>
</KEK>
</GdoiKeks>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiKeks
Table type Multi-instance table

18
 Item Description
Row name KEK
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
GroupNam GDOI GM String, case-insensitive.
Index N/A
e group name. Length: 1 to 63 characters.

Transport type Enumeration:

RekeyTrans
portType
of rekey N/A • 1—Unicast N/A
messages. • 2—Multicast
Remaining KEK lifetime
N/A Unsigned integer. Unit: second
KeyLifetime in seconds.
Enumeration:
KEK
EncryptionA • 1—DES-CBC.
encryption N/A N/A
lgorithm
algorithm. • 2—3DES-CBC.
• 3—AES-CBC.
KEK key
KeySize N/A Unsigned integer N/A
length.
Enumeration:
• 1—RSA.
• 2—DSS.
SignatureAl KEK signature
g algorithm.
N/A • 3—ECDSS. N/A
• 4—ECDSS-256.
• 5—ECDSS-384.
• 6—ECDSS-521.
Enumeration:
• 1—MD5.
KEK signature
SignatureH • 2—SHA1.
hash N/A N/A
ashAlg
algorithm. • 3—SHA256.
• 4—SHA384.
• 5—SHA512.
KEK signature
SignatureK
key length in N/A Unsigned integer. N/A
eyLength
bits.

GdoiGmTeks
This table displays TEK information of a group member.

XML structure
<GdoiGmTeks>
<TEK>

19
 <GroupName></GroupName>
<SPI></SPI>
<Transform>
<EncryptAlg></EncryptAlg>
<AuthAlg></AuthAlg>
</Transform>
<RemainLifetime></RemainLifetime>
</TEK>
</GdoiGmTeks>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiGmTeks
Table type Multi-instance table
Row name TEK
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name for the String, case-insensitive.
GroupNam
e
GDOI GM Index N/A.
group Length: 1 to 63 characters.

SPI of the IPsec Unsigned integer.

SPI Index N/A
SA. Value range: 256 to 4294967295.
Transform Members include:
encryption and Data
Transform
authentication structure • EncryptAlg. N/A
algorithm • AuthAlg.

Enumeration:
• 0—NULL.
• 1—3DES-CBC.
Encryption • 2—AES-CBC-128.
EncryptAlg N/A N/A
algorithm. • 3—AES-CBC-192.
• 4—AES-CBC-256.
• 5—DES-CBC.
• 6—Unknown.
Enumeration:
• 0—NULL.
Authentication
AuthAlg
algorithm
N/A • 1—MD5. N/A
• 2—SHA1.
• 3—Unknown.

20
 Column Column Column
Data type and restrictions Remarks
name description type
IPsec SA
RemainLifet remaining
N/A Unsigned integer. Unit: second.
ime lifetime in
seconds.

GdoiIPv4Policies
This table displays GDOI policies of a GM group.

XML structure
<GdoiIPv4Policies>
<Policy>
<PolicyName></PolicyName>
<SeqNum></SeqNum>
<GroupName></GroupName>
<ACL>
<Name></Name>
<Number></Number>
</ACL>
</Policy>
</GdoiIPv4Policies>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiIPv4Policies
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
An IPv4 IPsec policy
Name of the String, case-insensitive. and an IPv6 IPsec
PolicyName Index
IPsec policy Length: 1 to 63 characters. policy can use the
same PolicyName.

21
 Column Column Column
Data type and restrictions Remarks
name description type
An IPv4 IPsec policy
Sequence
Unsigned integer. and an IPv6 IPsec
number of the
SeqNum Index policy can use the
IPsec policy Value range: 1 to 65535. same sequence
entry
number.

Name of the String, case-insensitive.

GroupName N/A N/A.
GDOI GM group Length: 1 to 63 characters.

Reference an Members include:

Data Use Type to specify
ACL ACL for an IPsec
structure • Name which member is valid.
policy • Number
String. If ACL Name is not
Name ACL name N/A Length: 1 to 63 characters. empty,the ACL Number
Default is empty. does not make sense.

 Only when the

Unsigned integer. ACL Name is
empty, does
Number ACL number N/A Value range: 3000 to 3999. the ACL
Default is 0. Number make
sense.

GdoiIPv6Policies
This table displays GDOI IPv6 policies of a GM group.

XML structure
<GdoiIPv6Policies>
<Policy>
<PolicyName></PolicyName>
<SeqNum></SeqNum>
<GroupName></GroupName>
<ACL>
<Name></Name>
<Number></Number>
</ACL>
</Policy>
</GdoiIPv6Policies>

Table description
Item Description
Feature name GDVPNGM
Table name GdoiIPv6Policies
Table type Multi-instance table
Row name Policy

22
 Item Description
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
An IPv4 IPsec policy
Name of the String, case-insensitive. and an IPv6 IPsec
PolicyName Index
IPsec policy Length: 1 to 63 characters. policy can use the
same PolicyName.
An IPv4 IPsec policy
Sequence
Unsigned integer. and an IPv6 IPsec
number for the
SeqNum Index policy can use the
IPsec policy Value range: 1 to 65535. same sequence
entry
number.

Name for the String, case-insensitive.

GroupName N/A N/A.
GDOI GM group Length: 1 to 63 characters.

Reference an Members include:

Data
ACL ACL for an
structure • Name N/A
IPsec policy • Number.

String. If ACL Name is not

empty,the ACL
Name ACL name N/A Length: 1 to 63 characters. Number does not
Default is empty. make sense.
 Only when the
Unsigned integer. ACL Name is
empty, does
Number ACL number N/A Value range: 3000 to 3999. the ACL
Default is 0. Number make
sense.

23
Contents
GLB ················································································································· 1
GLB/ClearDNSMapStats ··································································································································· 1
XML structure ············································································································································· 1
Table des