HPE Comware 7

NETCONF XML API Reference

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

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

i
ACL
ACL/Groups
This table contains ACL information.

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

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

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

1
ACL/NamedGroups
This table contains named ACL information.

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

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

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

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

ACL/PfilterApply
This table contains packet filter application information.

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

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

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

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

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

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

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

Name of the String, case insensitive.

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

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

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

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

ii
ACL
ACL/Groups
This table contains ACL information.

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

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

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

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

ACL rule Unsigned integer.

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

ACL/NamedGroups
This table contains named ACL information.

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

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

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

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

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

ACL rule Unsigned integer.

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

ACL/Intervals
This table contains ACL interval information.

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

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

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

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

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

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

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

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

Whether a rule • true—Matches any

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

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

String, case-insensitive. This column and the

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

Whether to • true—Counts the rule

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

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

Whether to log • true—Logs rule match

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

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

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

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

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

Whether a rule • true—Matches any

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

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

String, case-insensitive. This column and the

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

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

Whether to • true—Counts the rule

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

Whether to log • true—Logs rule match

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

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

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

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

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

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

String, case-insensitive. This column and the

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

Whether a rule Boolean:

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

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

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

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

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

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

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

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

String, case-insensitive. This column and the

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

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

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

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

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

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

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

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

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

This column must be

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

String, case-insensitive. This column and the

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

Whether a rule Boolean:

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

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

String, case-insensitive. This column and the

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

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

StartDSC Start DSCP Unsigned integer. The end DSCP must be

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

Unsigned integer. The DSCP priority and the

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

Unsigned integer. The DSCP priority and the

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

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

SrcPortVal Unsigned integer.

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

Members include: Only the TCP and UDP

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

DstPortVal Start destination Unsigned integer.

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

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

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

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

Type of ICMP Unsigned integer. Only the ICMP protocol

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

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

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

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

You cannot specify an

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

EncapTyp Encapsulation • VXLAN encapsulation.

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

You cannot specify an

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

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

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

Unsigned integer Only the VXLAN

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

Boolean:

Whether a rule • true—Matches any

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

Only the VXLAN

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

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

The two members must

both be specified.

Example: 1.1.1.1.

This column is available

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

It must be empty when the

InSrcAny column is true.

Example: 255.255.255.0.

This column is available

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

Boolean:

Whether a rule • true—Matches any

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

Only the VXLAN

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

The two members must

both be specified.

Example: 1.1.1.1.

This column is available

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

It must be empty when the

InDstAny column is true.

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

It must be empty when the

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

Only the TCP and UDP

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

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

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

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

Only the TCP and UDP

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

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

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

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

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

Whether a rule Boolean:

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

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

Whether to log • true—Logs rule match

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

String, case-insensitive. This column is available

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

Whether a rule • true—Matches any user

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

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

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

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

When the TtlOp is 5, the

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

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

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

PktLength Start packet Unsigned integer.

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

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

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

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

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

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

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

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

This column must be

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

String, case-insensitive. This column and the

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

This column must be

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

Wildcard mask for Example: 255.255.255.0.

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

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

String, case-insensitive. This column and the

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

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

StartDSC Start DSCP Unsigned integer. The end DSCP must be

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

Unsigned integer. The DSCP priority and the

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

Unsigned integer. The DSCP priority and the

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

SrcPortVal Unsigned integer.

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

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

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

DstPortVal Start destination Unsigned integer.

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

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

Type of ICMP Unsigned integer. Only the ICMP protocol

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

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

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

You cannot specify an

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

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

You cannot specify an

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

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

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

Unsigned integer Only the VXLAN

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

Boolean:

Whether a rule • true—Matches any

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

Only the VXLAN

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

The two members must

both be specified.

Example: 1.1.1.1.

This column is available

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

It must be empty when the

InSrcAny column is true.

Example: 255.255.255.0.

This column is available

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

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

Boolean:

Whether a rule • true—Matches any

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

Only the VXLAN

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

The two members must

both be specified.

Example: 1.1.1.1.

This column is available

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

It must be empty when the

InDstAny column is true.

Example: 255.255.255.0.

Wildcard mask for This column is available

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

Members include: Only the TCP and UDP

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

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

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

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

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

Only the TCP and UDP

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

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

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

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

Whether a rule Boolean:

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

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

Whether to log • true—Logs rule match

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

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

configured for an existing

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

String, case-insensitive. This column is available

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

Whether a rule • true—Matches any user

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

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

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

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

Whether a rule Data

PktLength Members include: N/A
matches packet structure

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

PktLength Start packet Unsigned integer.

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

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

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

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

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

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

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

Whether a rule Boolean: This column must be

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

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

String, case-insensitive. This column and the

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

Whether a rule • true—Matches any

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

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

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

Flow label value Unsigned integer.

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

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

Members include: Only the TCP and UDP

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

SrcPortValue Unsigned integer.

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

Members include: Only the TCP and UDP

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

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

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

Type of ICMPv6 Unsigned integer. Only the ICMPv6 protocol

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

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

Whether a rule • true—Matches any

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

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

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

String, case-insensitive. This column is available

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

Whether a rule • true—Matches any user

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

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

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

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

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

PktLengthVal Start packet Unsigned integer.

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

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

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

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

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

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

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

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

Whether a rule • true—Matches any

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

String, case-insensitive. This column and the

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

Whether a rule • true—Matches any

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

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

Flow label value Unsigned integer.

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

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

Members include: Only the TCP and UDP

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

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

Members include: Only the TCP and UDP

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

DstPortValue Start destination Unsigned integer.

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

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

Type of ICMPv6 Unsigned integer. Only the ICMPv6 protocol

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

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

Whether a rule • true—Matches any

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

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

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

String, case-insensitive. This column is available

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

Whether a rule • true—Matches any user

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

FragmentTyp Check fragment Unsigned integer.

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

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

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

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

When the TtlOp is 5, the

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

PktLengthVal Start packet Unsigned integer.

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

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

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

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

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

Information The VXLAN

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

Information Members include: The VXLAN

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

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

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

Mask of the Hexadecimal string.

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

Encapsulation • VXLAN encapsulation.

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

Unsigned integer Only the VXLAN

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

Only the VXLAN

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

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

Six groups of two

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

Mask of the Six groups of two

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

Only the VXLAN

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

Inner Six groups of two

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

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

Only the VXLAN

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

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

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

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

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

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

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

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

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

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

Information The VXLAN

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

Information The VXLAN

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

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

Mask of the Hexadecimal string.

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

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

Encapsulation • VXLAN encapsulation.

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

Unsigned integer Only the VXLAN

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

Only the VXLAN

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

Six groups of two

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

Mask of the Six groups of two

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

Only the VXLAN

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

Inner Six groups of two

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

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

Only the VXLAN

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

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

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

Value range: 0 to FFFF.

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

Whether to • true—Counts the rule

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

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

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

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

64
 Restrictions None
Support for row creation and deletion No

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Unsigned integer. If you set this column to

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

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

Specifies that the Members include:

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

Hexadecimal string. The length must be an

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

Specifies that the Members include:

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

Hexadecimal string. The length must be an

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

Specifies that the Members include:

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

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

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

Specifies that the Members include:

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

Hexadecimal string. The length must be an

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

Members include: This column is available

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

Hexadecimal string. The length must be an

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

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

This column must be

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

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

Members include: Only the TCP and UDP

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

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

Unsigned integer. When SrcPortOp is 5, the

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

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

Members include: Only the TCP and UDP

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

Start destination Unsigned integer.

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

When DstPortOp is 5, the

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

Unsigned integer. This column is available

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

String, case-sensitive. A comment can only be

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

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

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

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

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

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

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

Specifies that the Members include:

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

Hexadecimal string. The length must be an

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

Specifies that the Members include:

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

Hexadecimal string. The length must be an

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

Specifies that the Members include:

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

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

Hexadecimal string. The length must be an

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

Specifies that the Members include:

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

Hexadecimal string. The length must be an

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

This column is available

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

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

Hexadecimal string. The length must be an

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

Specifies an Unsigned integer.

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

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

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

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

Boolean: This column is available

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

This column must be

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

Example: 1.1.1.1.

This column is available

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

It must be empty when the

SrcAny column is true.

Example: 255.255.255.0.

This column is available

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

This column must be

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

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

Example: 1:1::1:1.

This column is available

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

It must be empty when the

SrcAny column is true.

This column is available

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

Boolean: This column is available

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

This column must be

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

Example: 1.1.1.1.

This column is available

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

It must be empty when the

DstAny column is true.

Example: 255.255.255.0.

Wildcard mask This column is available

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

This column must be

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

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

Example: 1:1::1:1.

This column is available

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

It must be empty when the

DstAny column is true.

This column is available

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

Only the TCP and UDP

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

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

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

When SrcPortOp is 5, the

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

Only the TCP and UDP

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

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

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

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

When DstPortOp is 5, the

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

Unsigned integer. This column is available

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

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

String, case-sensitive. A comment can only be

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

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

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

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

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

Name of the String, case insensitive. Cannot contain

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

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

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

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

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

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

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

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

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

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

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

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

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

Maximum length of the Unsigned integer.

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

Custom Layer 4 header Members include:

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

Maximum length of the Unsigned integer.

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

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

Maximum length of the Unsigned integer.

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

Custom IPv6 header Members include:

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

Maximum length of the Unsigned integer.

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

ACL/Groups
This table displays ACL information.

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

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

3
 Restrictions None

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

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

4
ACL/NamedGroups
This table displays named ACL information.

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

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

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

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

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

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

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

ACL/Intervals
This table contains ACL interval information.

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

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

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

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

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

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

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

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

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

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

Whether to count • true—Counts the rule

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

Whether to log • true—Logs rule match

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

Index of the rule Unsigned integer.

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

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

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

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

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

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

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

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

Whether to count • true—Counts the rule

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

Whether to log • true—Logs rule match

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

Index of the rule Unsigned integer.

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

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

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

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

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

13
 Item Description
Restrictions None

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

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

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

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

Index of the rule Unsigned integer.

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

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

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

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

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

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

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

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

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

RoutingTypeV Routing header Unsigned integer.

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

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

Index of the rule Unsigned integer.

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

Number of rules Unsigned integer.

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

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

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

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

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

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

20
 Item Description
Restrictions None

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

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

Source object String, case-insensitive.

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

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

Unsigned integer. ECN and TOS cannot be

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

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

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

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

SrcPortValue Start source Unsigned integer.

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

Members include: Only the TCP and UDP

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

DstPortValue Start destination Unsigned integer.

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

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

Type of ICMP Unsigned integer. Only the ICMP protocol

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

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

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

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

Encapsulation • VXLAN encapsulation.

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

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

Unsigned integer Only the VXLAN

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

Boolean:

Whether a rule • true—Matches any

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

Only the VXLAN

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

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

Example: 1.1.1.1.

This column is available

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

Example: 255.255.255.0.

This column is available

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

Boolean:

Whether a rule • true—Matches any

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

Only the VXLAN

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

Example: 1.1.1.1.

This column is available

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

Example: 255.255.255.0.

This column is available

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

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

Only the TCP and UDP

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

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

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

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

Only the TCP and UDP

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

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

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

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

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

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

User group String, case-insensitive.

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

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

Boolean: Only when the

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

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

PktLengthVal Start packet Unsigned integer.

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

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

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

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

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

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

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

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

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

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

Whether a rule • true—Matches any

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

Unsigned integer. ECN and TOS cannot be

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

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

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

Members include: Only the TCP and UDP

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

SrcPortValue Start source Unsigned integer.

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

Members include: Only the TCP and UDP

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

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

DstPortValue Start destination Unsigned integer.

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

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

Type of ICMP Unsigned integer. Only the ICMP protocol

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

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

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

Encapsulation • VXLAN encapsulation.

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

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

Unsigned integer Only the VXLAN

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

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

Boolean:

Whether a rule • true—Matches any

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

Only the VXLAN

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

Example: 1.1.1.1.

This column is available

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

Example: 255.255.255.0.

This column is available

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

Boolean:

Whether a rule • true—Matches any

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

Only the VXLAN

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

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

Example: 1.1.1.1.

This column is available

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

Example: 255.255.255.0.

This column is available

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

Only the TCP and UDP

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

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

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

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

Only the TCP and UDP

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

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

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

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

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

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

User group String, case-insensitive.

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

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

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

Index of the rule Unsigned integer.

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

Number of rules Unsigned integer.

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

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

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

When the TtlOp is 5, the

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

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

PktLengthVal Start packet Unsigned integer.

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

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

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

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

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

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

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

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

Whether a rule • true—Matches any

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

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

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

Destination String, case-insensitive.

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

Flow label value Unsigned integer.

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

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

Whether a rule • true—Matches any

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

RoutingTypeVal Routing header Unsigned integer.

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

Members include: Only the TCP and UDP

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

Start source Unsigned integer.

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

Members include: Only the TCP and UDP

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

Start destination Unsigned integer.

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

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

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

Type of ICMPv6 Unsigned integer. Only the ICMPv6 protocol

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

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

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

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

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

Whether to • true—Counts the

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

Whether a rule • true—Matches any

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

Boolean: Only when the

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

Index of the rule Unsigned integer.

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

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

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

PktLengthValue Start packet Unsigned integer.

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

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

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

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

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

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

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

Whether a rule • true—Matches any

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

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

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

Destination String, case-insensitive.

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

Flow label value Unsigned integer.

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

Whether a rule • true—Matches any

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

RoutingTypeVal Routing header Unsigned integer.

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

Members include: Only the TCP and UDP

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

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

Start source Unsigned integer.

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

Members include: Only the TCP and UDP

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

Start destination Unsigned integer.

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

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

Type of ICMPv6 Unsigned integer. Only the ICMPv6 protocol

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

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

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

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

Whether to • true—Counts the

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

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

Whether a rule • true—Matches any

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

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

Index of the rule Unsigned integer.

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

Number of rules Unsigned integer.

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

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

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

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

PktLengthValue Start packet Unsigned integer.

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

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

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

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

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

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

Information about Members include:

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

Information about Members include:

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

Mask of the link Hexadecimal string.

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

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

Encapsulation • VXLAN encapsulation.

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

Unsigned integer Only the VXLAN

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

Only the VXLAN

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

InSrcMACAddr Inner source MAC Six groups of two hexadecimal Example:

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

Mask of the inner Example:

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

Only the VXLAN

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

InDstMACAddr Inner destination Six groups of two hexadecimal Example:

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

Mask of the inner Example:

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

Only the VXLAN

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

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

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

Value range: 0 to FFFF.

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

Whether to count • true—Counts the rule

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

Index of the rule Unsigned integer.

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

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

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

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

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

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

Information about Members include:

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

Information about Members include:

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

Mask of the link Hexadecimal string.

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

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

Encapsulation • VXLAN encapsulation.

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

Unsigned integer Only the VXLAN

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

Only the VXLAN

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

InSrcMACAddr Inner source MAC Six groups of two hexadecimal Example:

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

Mask of the inner Example:

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

Only the VXLAN

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

InDstMACAddr Inner destination Six groups of two hexadecimal Example:

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

Mask of the inner Example:

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

Only the VXLAN

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

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

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

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

Whether to count • true—Counts the rule

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

Index of the rule Unsigned integer.

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

Number of rules in Unsigned integer.

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

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

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

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

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

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

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

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

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

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

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

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

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

String. The value range

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

Match the inner

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

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

Whether to apply • true—Apply the ACL

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Index of the ACL Unsigned integer.

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

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

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

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

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

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

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

Specifies that the Members include:

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

Offset in bytes after Unsigned integer.

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

Specifies that the Members include:

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

Offset in bytes after Unsigned integer.

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

Specifies that the Members include:

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

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

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

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

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

Specifies an offset in Unsigned integer.

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

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

Unsigned integer.

Value range: 0 to 256.

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

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

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

Members include: The members

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

Example:
1.1.1.1.

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

It must be empty
when the
SrcAny column
is true.

Example:
255.255.255.0.

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

It must be empty
when the
SrcAny column
is true.

Members include: The two

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

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

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

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

Members include: The members

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

Example:
1.1.1.1.

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

It must be empty
when the
DstAny column
is true.

Example:
255.255.255.0.

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

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

Members include: The two

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

Only the TCP

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

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

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

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

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

Only the TCP

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

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

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

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

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

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

Whether to count the • true—Counts the rule

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

Number of packets Unsigned integer.

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

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

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

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

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

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

Specifies that the Members include:

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

Offset in bytes after Unsigned integer.

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

Specifies that the Members include:

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

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

Offset in bytes after Unsigned integer.

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

Specifies that the Members include:

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

Specifies that the Members include:

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

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

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

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

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

Specifies an offset in Unsigned integer.

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

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

Unsigned integer.

Value range: 0 to 256.

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

Boolean:

Whether a rule • true—Matches any source

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

Members include: The members

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

Example:
1.1.1.1.

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

It must be empty
when the
SrcAny column
is true.

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

Example:
255.255.255.0.

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

It must be empty
when the
SrcAny column
is true.

Members include: The two

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

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

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

Members include: The members

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

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

Example:
1.1.1.1.

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

It must be empty
when the
DstAny column
is true.

Example:
255.255.255.0.

This column is
available when
Wildcard mask for the
DstIPv4Wildc the DstAny
destination IPv4 N/A String, dotted decimal notation.
ard column is false.
address.
It must be empty
when the
DstAny column
is true.

Members include: The two

DstIPv6
Destination IPv6 Data • DstIPv6Addr. members must
information. structure both be
• DstIPv6Prefix.
specified.
Example:
1:1::1:1.
This column is
available when
Hexadecimal string, the DstAny
Destination IPv6 column is false.
DstIPv6Addr N/A colon-separated.
address.
It must be empty
when the
DstAny column
is true.
This column is
available when
the DstAny
Length of the Unsigned integer. column is false.
DstIPv6Prefix destination IPv6 N/A Value range: 1 to 128. It must be empty
address prefix. when the
DstAny column
is true.

90
Column Column
Column description Data type and restrictions Remarks
name type

Only the TCP

and UDP
Members include: protocols
support this
Source port Data • SrcPortOp.
SrcPort column.
information. structure • SrcPortValue1.
• SrcPortValue2. The members
must be all
specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
SrcPortOp Source port operator. N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
SrcPortValue
Start source port. N/A N/A
1
Value range: 0 to 65535.

When the
SrcPortOp is 5,
the value range
Unsigned integer. is 0 to 65535.
SrcPortValue Otherwise, it can
End source port. N/A
2 only be 65536.
Value range: 0 to 65536. The value 65536
indicates that the
end source port
is not available.

Only the TCP

and UDP
Members include: protocols
support this
Destination port Data • DstPortOp.
DstPort column.
information. structure • DstPortValue1.
• DstPortValue2. The members
must be all
specified.

Enumeration:
• 1—lt (lower than).
• 2—eq (equal to).
Destination port
DstPortOp
operator.
N/A • 3—gt (greater than). N/A
• 4—neq (not equal to).
• 5—range (inclusive
range).

Unsigned integer.
DstPortValue
Start destination port. N/A N/A
1
Value range: 0 to 65535.

91
 Column Column
Column description Data type and restrictions Remarks
name type

When the
DstPortOp is 5,
the value range
is 0 to 65535.
Unsigned integer. Otherwise, it can
DstPortValue
End destination port. N/A only be 65536.
2
Value range: 0 to 65536. The value 65536
indicates that the
end destination
port is not
available.

Unsigned integer.
DSCP DSCP priority. N/A N/A
Value range: 0 to 63.
String, case-insensitive.
TimeRange Time range. N/A N/A
Length: 1 to 32 characters.
Boolean:

Whether to count the • true—Counts the rule

Counting N/A matches. N/A
rule matches.
• false—Does not count the
rule matches.
String, case-sensitive.
Comment Rule comment. N/A N/A
Length: 1 to 127 characters.
Enumeration:
Status Rule status. N/A • 1—Active. N/A
• 2—Inactive.

Number of packets Unsigned integer.

Count N/A 64 N/A
that match a rule. Value range: 0 to 2 - 1.

ACL/ZonePairPfilterApply
This table contains information about packet filter application for zone pair.

XML structure
<ACL>
<ZonePairPfilterApply>
<Pfilter>
<SrcZone></SrcZone>
<DestZone></DestZone>
<AclType></AclType>
<AclGroup></AclGroup>
<AppSequence></AppSequence>
</Pfilter>
</ZonePairPfilterApply>
</ACL>

92
Table description
Item Description
Feature name ACL
Table name ZonePairPfilterApply
Table type Multi-instance table
Row name Pfilter
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
String, case insensitive.
Name of the Cannot contain
SrcZone
source zone.
Index • Length: 1 to 31 midline( - ).
characters.
String, case insensitive.
Name of the Cannot contain
DestZone
destination zone.
Index • Length: 1 to 31 midline( - ).
characters.
Enumeration:
Type 3 is not supported
• 1—IPv4 ACL.
in the current software
AclType ACL type. Index • 2—IPv6 ACL. version, and is reserved
• 3—Ethernet frame for future support.
header ACL.
An ACL name must start
• ACL name: with an English letter and
Case-insensitive cannot be all.
string of 1 to 63 The value range
ACL name or characters. depends on the
AclGroup Index
number. • ACL number: AppAclType column.
An unsigned integer • 2000 to 5999 if
in the range of 2000 AppAclType is 1.
to 5999. • 2000 to 3999 if
AppAclType is 2.
Unsigned integer.
ACL application
AppSequence N/A Value range: 1 to N/A
sequence.
4294967295.

ACL/ZonePairPfilterRules
This table contains running information about packet filter ACL rules for zone pair.

XML structure
<ACL>
<ZonePairPfilterRules>

93
 <Rule>
<SrcZone></SrcZone>
<DestZone></DestZone>
<AclType></AclType>
<AclGroup></AclGroup>
<AclRuleID></AclRuleID>
<RuleMatchPkts></RuleMatchPkts>
<RuleMatchBytes></RuleMatchBytes>
</Rule>
</ZonePairPfilterRules>
</ACL>

Table description
Item Description
Feature name ACL
Table name ZonePairPfilterRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Data type and
Column name Remarks
description type restrictions
String, case insensitive.
Name of the Cannot contain
SrcZone
source zone.
Index • Length: 1 to 31 midline( - ).
characters.

Name of the String, case insensitive.

Cannot contain
DestZone destination Index • Length: 1 to 31 midline( - ).
zone. characters.
Enumeration:
Type 3 is not supported
• 1—IPv4 ACL.
in the current software
AclType ACL type. Index • 2—IPv6 ACL. version, and is reserved
• 3—Ethernet frame for future support.
header ACL.
An ACL name must start
with an English letter
• ACL name: and cannot be all.
Case-insensitive string
The value range
of 1 to 63 characters.
ACL name or depends on the
AclGroup
number.
Index • ACL number: AppAclType column.
An unsigned integer in
the range of 2000 to • 2000 to 5999 if
5999. AppAclType is 1.
• 2000 to 3999 if
AppAclType is 2.

94
 Column Column Data type and
Column name Remarks
description type restrictions
Index of the Unsigned integer.
AclRuleID Index N/A
ACL rules. Value range: 0 to 65534.
If the device does not
Number of Unsigned integer. support match counting
RuleMatchPkts matched N/A 64 for packet filter,
packets. Value range: 0 to 2 - 1. 0×FFFFFFFFFFFFFFFF
is returned.
If the device does not
Number of Unsigned integer. support match counting
RuleMatchBytes matched N/A 64 for packet filter,
bytes. Value range: 0 to 2 - 1. 0×FFFFFFFFFFFFFFFF
is returned.

95
Contents
ACL·······························································································1
ACL ········································································································································ 1

i
ACL
ACL
Message Explanation
Can't edit rules for an ACL when the match order is
The ACL group created in auto mode cannot modify rules.
auto.
以 auto 形式创建的 ACL 组不能修改规则。
当规则匹配顺序为自动排序时，不能修改规则。

Cannot add rule comment information when the rule does not
The rule doesn't exist. Please create the rule first.
exist.
规则不存在，请在添加描述信息前先添加规则。
规则不存在时不能添加规则评论信息。

Can’t name or rename an existing ACL. Cannot modify the name as an existing ACL.
不能命名或重命名一个已存在的ACL。 不能修改名字为已存在的ACL。

Can't change the match order for an ACL that When an ACL is configured with rules, the matching order cannot
contains rules. be modified.
不能修改一个包含规则的ACL的匹配顺序。 当ACL已经配置了规则，不能修改匹配顺序。

The rule already exists. The newly created rule content is the same as other existing rules.
规则已存在。 新建的规则内容与其他已存在的规则内容相同。

The rule ID is out of range. Automatically assigned rule number is out of range.
规则编号超出范围。 自动分配的规则编码超出了范围。

The modified step size is too large, and the number of rules that
The step is too large to generate sufficient rule IDs.
can be assigned is insufficient.
步长过大，可分配的规则编号不足。
修改后的步长过大，可分配的规则编号不足。

The name is already used by another ACL. The newly created ACL name is occupied by other existing ACLs.
该名字已被另一个ACL使用。 新建的ACL名称被其他已经存在的ACL占用。

Maximum number of rules in the ACL already is The number of rules has reached the upper limit when a new ACL
reached. rule is created.
此ACL的规则数已达上限。 新建ACL规则时规则个数已达到上限。

Resources are insufficient for processing the

Insufficient memory.
request.
设备内存不足。
系统资源不足，请求无法完成。

The ACL doesn't exist. Add a rule to an ACL group that does not exist.
指定的ACL不存在。 向不存在的ACL组下添加规则。

The source IPv4 address object group doesn't The object-group referenced by the source address of the IPv4
exist. type ACL rule does not exist.
指定的源IPv4地址对象组不存在。 IPv4类型ACL规则源地址引用的对象组不存在。

The source IPv6 address object group doesn't The object-group referenced by the source address of the IPv6
exist. type ACL rule does not exist.
指定的源IPv6地址对象组不存在。 IPv6类型ACL规则源地址引用的对象组不存在。

The destination IPv4 address object group doesn't The object-group referenced by the destination address of the
exist. IPv4 type ACL rule does not exist.
指定的目的IPv4地址对象组不存在。 IPv4类型ACL规则目的地址引用的对象组不存在。

1
The destination IPv6 address object group doesn't The object-group referenced by the destination address of the
exist. IPv6 type ACL rule does not exist.
指定的目的IPv6地址对象组不存在。 IPv6类型ACL规则目的地址引用的对象组不存在。

The object-group type referenced by the source address of the

Illegal source IPv4 address object group type.
IPv4 type ACL is not the IPv4 type.
指定的源IPv4地址对象组类型不正确。
IPv4类型ACL规则源地址引用的对象组类型不是IPv4类型。

The object-group type referenced by the source address of the

Illegal source IPv6 address object group type.
IPv6 type ACL is not the IPv6 type.
指定的源IPv6地址对象组类型不正确。
IPv6类型ACL规则源地址引用的对象组类型不是IPv6类型。

The object-group type referenced by the destination address of

Illegal destination IPv4 address object group type.
the IPv4 type ACL is not the IPv4 type.
指定的目的IPv4地址对象组类型不正确。
IPv4类型ACL规则目的地址引用的对象组类型不是IPv4类型。

The object-group type referenced by the destination address of

Illegal destination IPv6 address object group type.
the IPv6 type ACL is not the IPv6 type.
指定的目的IPv6地址对象组类型不正确。
IPv6类型ACL规则目的地址引用的对象组类型不是IPv6类型。

The ACL specified to be deleted is referenced by other modules

Can't delete the ACL because it is being used.
and cannot be deleted.
该ACL正被引用，无法删除。
指定要删除的ACL被其他模块引用，不能被删除。

2
Contents
ADVPN ··························································································1
ResetTunnelAdvpnSession ·········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
ResetAllSessions ······················································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
ResetTunnelAdvpnSessionStat ····································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
ResetAllSessionStats·················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4

i
ADVPN
ResetTunnelAdvpnSession
This table is used to clear ADVPN sessions in the specified tunnel.

XML structure
<ADVPN>
<ResetTunnelAdvpnSession>
<Reset>
<IPVersion></IPVersion>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
</Reset>
</ResetTunnelAdvpnSession>
</ADVPN>

Table description
Item Description
Feature name ADVPN
Table name ResetTunnelAdvpnSession
Table type Multi-instance table
Row name Reset
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration
Version of the IP This column must not
IPVersion Index • 4—IPv4
protocol be empty.
• 6—IPv6
TunnelID Tunnel ID Index Unsigned integer N/A
PrivateAddre IPv4 address or IPv6
Private address N/A String
ss address.

ResetAllSessions
This table is used to clear all ADVPN sessions.

1
XML structure
<ADVPN>
<ResetAllSessions>
<Reset>
<IPVersion></IPVersion>
</Reset>
</ResetAllSessions>
</ADVPN>

Table description
Item Description
Feature name ADVPN
Table name ResetAllSessions
Table type Single-instance table
Row name Reset
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration
Version of the IP This column must not
IPVersion Index • 4—IPv4
protocol be empty.
• 6—IPv6

ResetTunnelAdvpnSessionStat
This table is used to clrear ADVPN session statistics for the specified tunnel.

XML structure
<ADVPN>
<ResetTunnelAdvpnSessionStat>
<Reset>
<IPVersion></IPVersion>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
</Reset>
</ResetTunnelAdvpnSessionStat>
</ADVPN>

2
Table description
Item Description
Feature name ADVPN
Table name ResetSessionStatistics
Table type Multi-instance table
Row name Reset
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration
Version of the IP This column must not
IPVersion Index • 4—IPv4
protocol be empty.
• 6—IPv6
TunnelID Tunnel ID Index Unsigned integer N/A
PrivateAddre IPv4 address or IPv6
Private address N/A String
ss address.

ResetAllSessionStats
This table is used to clear all ADVPN session statistics.

XML structure
<ADVPN>
<ResetAllSessionStats>
<Reset>
<IPVersion></IPVersion>
</Reset>
</ResetAllSessionStats>
</ADVPN>

Table description
Item Description
Feature name ADVPN
Table name ResetAllSessionStatistics
Table type Single-instance table
Row name Reset
Restrictions None

3
Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration
Version of the IP This column must not
IPVersion Index • 4—IPv4
protocol be empty.
• 6—IPv6

4
Contents
ADVPN ··························································································1
TunnelAdvpnCfg ························································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
IPv4Networks ···························································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
IPv6Networks ···························································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4

i
ADVPN
TunnelAdvpnCfg
This table is used to configure ADVPN feature in the specified tunnel.

XML structure
<ADVPN>
<TunnelAdvpnCfg>
<Tunnel>
<TunnelID></TunnelID>
<IPv4Client></IPv4Client>
<Compatible></Compatible>
<IPv6Client></IPv6Client>
<DumbTime></DumbTime>
<IdleTime></IdleTime>
<SourcePort></SourcePort>
</Tunnel>
</TunnelAdvpnCfg>
</ADVPN>

Table description
Item Description
Feature name ADVPN
Table name TunnelAdvpnCfg
Table type Multi-instance table
Row name Tunnel
Restrictions None

Support for row creation and

No
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A
Name of the
VAM client String Case-insensitive and
IPv4Client bounded to an N/A contains only letters,
IPv4 ADVPN Length: 1 to 63 characters
digits, and dots (.).
tunnel interface

1
 Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
The value of “2”
Compatibility • 0—Incompatible means not specifying
Compatible N/A
configuration • 1—Compatible the IPv4 VAM client
• 2—Invalid config.
Name of the
VAM client String Case-insensitive and
IPv6Client bounded to an N/A contains only letters,
IPv6 ADVPN Length: 1 to 63 characters
digits, and dots (.).
tunnel interface
Unsigned integer
Dumb time for an Value range: 10 to 600
DumbTime N/A N/A
ADVPN session The default value is 120
seconds

Idle timeout time Unsigned integer.

for a Value range:60 to 65535.
IdleTime N/A N/A
spoke-spoke The default value is 600
ADVPN tunnel seconds
Only supports tunnel
in the following
modes:
• 9—DVPN tunnel
with the
passenger
protocol being
UDP and the
Unsigned integer
Source UDP port transport
SourcePort N/A Value range: 1025 to 65535 protocol being
number
The default value is 18001 IPv4.
• 11—DVPN
tunnel with the
passenger
protocol being
UDP and the
transport
protocol being
IPv6.

IPv4Networks
This table is used to configure the IPv4 subnets under the specified tunnel which is ADVPN node.

XML structure
<ADVPN>
<IPv4Networks>
<IPv4Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>

2
 </IPv4Network>
</IPv4Networks>
</ADVPN>

Table description
Item Description
Feature name ADVPN
Table name IPv4Networks
Table type Multi-instance table
Row name IPv4Network
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A.
Private IPv4
Address Index IPv4 address N/A.
network address
Mask of the Unsigned integer
MaskLength private IPv4 Index Example: 24
network address Value range: 0 to 32

Preference for Unsigned integer

Preference the route to the N/A Value range: 1 to 255 N/A.
private network The default value is 8

IPv6Networks
This table is used to configure the IPv6 subnets under the specified tunnel which is ADVPN node.

XML structure
<ADVPN>
<IPv6Networks>
<IPv6Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>
</IPv6Network>
</IPv6Networks>
</ADVPN>

3
Table description
Item Description
Feature name ADVPN
Table name IPv6Networks
Table type Multi-instance table
Row name IPv6Network
Restrictions None
Support for row creation and
Yes
deletion

Columns
Column Column Column
Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A.
Private IPv6 Example:
Address Index IPv6 address
network address 1001::
Prefix length of Unsigned integer
MaskLength private IPv6 Index N/A.
network address Value range: 0 to 128

Preference for Unsigned integer

Preference the route to the N/A Value range: 1 to 255 N/A.
private network The default value is 8

4
Contents
ADVPN ··························································································1
TunnelAdvpnCfg ·························································································································· 1
XML structure ······················································································································· 1
Table description ··················································································································· 1
Columns ······························································································································ 1
IPv4Networks ······························································································································ 3
XML structure ······················································································································· 3
Table description ··················································································································· 3
Columns ······························································································································ 3
IPv6Networks ······························································································································ 4
XML structure ······················································································································· 4
Table description ··················································································································· 4
Columns ······························································································································ 4
IPv4TunnelAdvpnSession ·············································································································· 5
XML structure ······················································································································· 5
Table description ··················································································································· 6
Columns ······························································································································ 6
IPv6TunnelAdvpnSession ·············································································································· 9
XML structure ······················································································································· 9
Table description ················································································································· 10
Columns ···························································································································· 10
IPv4TunnelRunInfo····················································································································· 13
XML structure ····················································································································· 13
Table description ················································································································· 14
Columns ···························································································································· 14
IPv6TunnelRunInfo····················································································································· 14
XML structure ····················································································································· 15
Table description ················································································································· 15
Columns ···························································································································· 15

i
ADVPN
TunnelAdvpnCfg
This table displays the configuration about ADVPN tunnels.

XML structure
<ADVPN>
<TunnelAdvpnCfg>
<Tunnel>
<TunnelID></TunnelID>
<IPv4Client></IPv4Client>
<Compatible></Compatible>
<IPv6Client></IPv6Client>
<DumbTime></DumbTime>
<IdleTime></IdleTime>
<SourcePort></SourcePort>
</Tunnel>
</TunnelAdvpnCfg>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name TunnelAdvpnCfg

Table type Multi-instance table

Row name Tunnel

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A

Name of the Case-insensitive and

String
IPv4Client VAM client N/A contains only letters,
Length: 1 to 63 characters
bounded to an digits, and dots (.).

1
Column Column Column
Data type and restrictions Remarks
name description type
IPv4 ADVPN
tunnel interface

Enumeration:
The value of “2”
Compatibility • 0—Incompatible means not specifying
Compatible N/A
configuration • 1—Compatible the IPv4 VAM client
• 2—Invalid config.

Name of the
VAM client Case-insensitive and
String
IPv6Client bounded to an N/A contains only letters,
Length: 1 to 63 characters
IPv6 ADVPN digits, and dots (.).
tunnel interface

Unsigned integer

Dumb time for an Value range: 10 to 600

DumbTime N/A N/A
ADVPN session The default value is 120
seconds

Idle timeout time Unsigned integer.

for a Value range:60 to 65535.

IdleTime N/A N/A
spoke-spoke The default value is 600
ADVPN tunnel seconds

Only supports tunnel

in the following
modes:

• 9—DVPN tunnel
with the
passenger
protocol being
Unsigned integer
UDP and the
Source UDP port
SourcePort N/A Value range: 1025 to 65535 transport protocol
number
The default value is 18001 being IPv4.
• 11—DVPN
tunnel with the
passenger
protocol being
UDP and the
transport protocol
being IPv6.

2
IPv4Networks
This table displays the IPv4 subnets configuration under an ADVPN node.

XML structure
<ADVPN>
<IPv4Networks>
<IPv4Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>
</IPv4Network>
</IPv4Networks>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name IPv4Networks

Table type Multi-instance table

Row name IPv4Network

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A.

Private IPv4
Address Index IPv4 address N/A.
network address

Mask of the
Unsigned integer
MaskLength private IPv4 Index Example: 24
Value range: 0 to 32
network address

Preference for Unsigned integer

Preference the route to the N/A Value range: 1 to 255 N/A.

private network The default value is 8

3
IPv6Networks
This table displays the IPv6 subnets configuration under an ADVPN node.

XML structure
<ADVPN>
<IPv6Networks>
<IPv6Network>
<TunnelID></TunnelID>
<Address></Address>
<MaskLength></MaskLength>
<Preference></Preference>
</IPv6Network>
</IPv6Networks>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name IPv6Networks

Table type Multi-instance table

Row name IPv6Network

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A.

Private IPv6 Example:

Address Index IPv6 address
network address 1001::

Prefix length of
Unsigned integer
MaskLength private IPv6 Index N/A.
Value range: 0 to 128
network address

Preference for Unsigned integer

Preference N/A N/A.
the route to the Value range: 1 to 255

4
 Column Column Column
Data type and restrictions Remarks
name description type
private network The default value is 8

IPv4TunnelAdvpnSession
This table is used to display IPv4 ADVPN tunnel session information.

XML structure
<ADVPN>
<IPv4TunnelAdvpnSession>
<IPv4AdvpnSession>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
<PublicAddress></PublicAddress>
<AdvpnPort></AdvpnPort>
<SPI>
<AhInbound></AhInbound>
<AhOutbound></AhOutbound>
<EspInbound></EspInbound>
<EspOutbound></EspOutbound>
</SPI>
<BehindNAT></BehindNAT>
<SessionType></SessionType>
<TunnelState></TunnelState>
<HoldingTime></HoldingTime>
<Input>
<TotalPackets></TotalPackets>
<DataPackets></DataPackets>
<ControlPackets></ControlPackets>
<Multicasts></Multicasts>
<Errors></Errors>
</Input>
<Output>
<TotalPackets></TotalPackets>
<DataPackets></DataPackets>
<ControlPackets></ControlPackets>
<Multicasts></Multicasts>
<Errors></Errors>
</Output>
<IPsecTunnelID></IPsecTunnelID>
<SAIndex>
<AhInbound></AhInbound>
<AhOutbound></AhOutbound>
<EspInbound></EspInbound>
<EspOutbound></EspOutbound>
</SAIndex>
5
 </IPv4AdvpnSession>
</IPv4TunnelAdvpnSession>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name IPv4TunnelAdvpnSession

Table type Multi-instance table

Row name IPv4AdvpnSession

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A

Private address
PrivateAddres
of the ADVPN Index Ipv4Address IPv4 address
s
tunnel peer

Public address of
IPv4 address.
PublicAddress the ADVPN N/A String
IPv6 address.
tunnel peer

Only supported
UDP port number
Unsigned integer when the link layer
AdvpnPort for the ADVPN N/A
Value range: 1025 to 65535 protocol is UDP or
tunnel
IPsec-UDP.

Members include: Only supported

SP index for the • AhInbound when link layer
Data
SPI inbound and • AhOutbound protocol is
structure
outbound SAs • EspInbound IPsec-UDP or IPsec-

• EspOutbound GRE.

Inbound AH SP Unsigned integer

AhInbound N/A N/A
index 32
Value range: 0 to 2 -1.

Outbound AH SP Unsigned integer

AhOutbound N/A N/A
index 32
Value range: 0 to 2 -1.

6
Column Column Column
Data type and restrictions Remarks
name description type

Inbound ESP SP Unsigned integer

EspInbound N/A N/A
index 32
Value range: 0 to 2 -1.

Outbound ESP Unsigned integer

EspOutbound N/A N/A
SP index 32
Value range: 0 to 2 -1.

Whether the NAT Boolean:

BehindNAT peer node is N/A • true N/A
behind NAT • False

Enumeration:

• 0—Unknown
ADVPN tunnel • 1—Hub-Hub
SessionType N/A N/A
type • 2—Hub-Spoke
• 3—Spoke-Hub
• 4—Spoke-Spoke

Enumeration:

ADVPN tunnel • 0—Establishing

TunnelState N/A N/A
state • 1—Dumb
• 2—Success

Duration that the

tunnel has been
HoldingTime N/A Unsigned integer Unit: seconds
in the current
state

Members include:

• TotalPackets
Statistics for Data • DataPackets
Input N/A
incoming packets structure • ControlPackets
• Multicasts
• Errors

The number of all

TotalPackets N/A Unsigned Integer64 N/A
incoming packets

The number of
DataPackets incoming data N/A Unsigned Integer64 N/A
packets

The number of
ControlPacket
incoming control N/A Unsigned integer 64 N/A
s
packets

Multicasts The number of N/A Unsigned integer 64 N/A

7
Column Column Column
Data type and restrictions Remarks
name description type
incoming
multicast packets

The number of
incoming
Errors N/A Unsigned integer 64 N/A
erroneous
packets

Members include:

• TotalPackets
Statistics for Data • DataPackets
Output N/A
outgoing packets structure • ControlPackets
• Multicasts
• Errors

The number of all

TotalPackets N/A Unsigned integer N/A
outgoing packets

The number of
DataPackets outgoing data N/A Unsigned integer 64 N/A
packets

The number of
ControlPacket
outgoing control N/A Unsigned integer 64 N/A
s
packets

The number of
Multicasts outgoing multicas N/A Unsigned integer 64. N/A
t packets

The number of
Errors outgoing erroneo N/A Unsigned integer 64 N/A
us packets

IPsecTunnelI IPsec tunnel

N/A Unsigned integer 32 N/A
D index

Members include:

• AhInbound
IPsec SA index Data
SAIndex • AhOutbound N/A
information structure
• EspInbound
• EspOutbound

Inbound IPsec
AhInbound N/A Unsigned integer 32 N/A
AH SA index

8
 Column Column Column
Data type and restrictions Remarks
name description type

Outbound IPsec
AhOutbound N/A Unsigned integer 32 N/A
AH SA index

Inbound IPsec
EspInbound N/A Unsigned integer 32 N/A
ESP SA index

Outbound IPsec
EspOutbound N/A Unsigned integer 32 N/A
ESP SA index

IPv6TunnelAdvpnSession
This table is used to display IPv6 ADVPN tunnel session information.

XML structure
<ADVPN>
<IPv6TunnelAdvpnSession>
<IPv6AdvpnSession>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
<PublicAddress></PublicAddress>
<AdvpnPort></AdvpnPort>
<SPI>
<AhInbound></AhInbound>
<AhOutbound></AhOutbound>
<EspInbound></EspInbound>
<EspOutbound></EspOutbound>
</SPI>
<BehindNAT></BehindNAT>
<SessionType></SessionType>
<TunnelState></TunnelState>
<HoldingTime></HoldingTime>
<Input>
<TotalPackets></TotalPackets>
<DataPackets></DataPackets>
<ControlPackets></ControlPackets>
<Multicasts></Multicasts>
<Errors></Errors>
</Input>
<Output>
<TotalPackets></TotalPackets>
<DataPackets></DataPackets>
<ControlPackets></ControlPackets>
<Multicasts></Multicasts>

9
 <Errors></Errors>
</Output>
<IPsecTunnelID></IPsecTunnelID>
<SAIndex>
<AhInbound></AhInbound>
<AhOutbound></AhOutbound>
<EspInbound></EspInbound>
<EspOutbound></EspOutbound>
</SAIndex>
</IPv6AdvpnSession>
</IPv6TunnelAdvpnSession>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name IPv6TunnelAdvpnSession

Table type Multi-instance table

Row name IPv6AdvpnSession

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A

Private address
PrivateAddres
of the ADVPN Index Ipv6Address IPv6 address
s
tunnel peer

Public address of
IPv4 address.
PublicAddress the ADVPN N/A String
IPv6 address.
tunnel peer

Only supported
UDP port number
Unsigned integer when the link layer
AdvpnPort for the ADVPN N/A
Value range: 1025 to 65535 protocol is UDP or
tunnel
IPsec-UDP.

SP index for the Members include: Only supported

Data
SPI inbound and • AhInbound when the link layer
structure
outbound SAs • AhOutbound protocol is

10
Column Column Column
Data type and restrictions Remarks
name description type
• EspInbound IPsec-UDP or IPsec-
• EspOutbound GRE.

Inbound AH SP Unsigned integer

AhInbound N/A N/A
index 32
Value range: 0 to 2 -1.

Outbound AH SP Unsigned integer

AhOutbound N/A N/A
index 32
Value range: 0 to 2 -1.

Inbound ESP SP Unsigned integer

EspInbound N/A N/A
index 32
Value range: 0 to 2 -1.

Outbound ESP Unsigned integer

EspOutbound N/A N/A
SP index 32
Value range: 0 to 2 -1.

Whether the NAT Boolean:

BehindNAT peer node is N/A • true N/A
behind NAT • False

Enumeration:

• 0—Unknown
ADVPN tunnel • 1—Hub-Hub
SessionType N/A N/A
type • 2—Hub-Spoke
• 3—Spoke-Hub
• 4—Spoke-Spoke

Enumeration:

ADVPN tunnel • 0—Establishing

TunnelState N/A N/A
state • 1—Dumb
• 2—Success

Duration that the

tunnel has been
HoldingTime N/A Unsigned integer Unit: seconds
in the current
state

Members include:

• TotalPackets
Statistics for Data • DataPackets
Input N/A
incoming packets structure • ControlPackets
• Multicasts
• Errors

The number of all

TotalPackets N/A Unsigned integer 64 N/A
incoming packets

11
Column Column Column
Data type and restrictions Remarks
name description type
The number of
DataPackets incoming data N/A Unsigned integer 64 N/A
packets

The number of
ControlPacket
incoming control N/A Unsigned integer 64 N/A
s
packets

The number of
Multicasts incoming N/A Unsigned integer 64 N/A
multicast packets

The number of
incoming
Errors N/A Unsigned integer 64 N/A
erroneous
packets

Members include:

• TotalPackets
Statistics for Data • DataPackets
Output N/A
outgoing packets structure • ControlPackets
• Multicasts
• Errors

The number of all

TotalPackets N/A Unsigned integer 64 N/A
outgoing packets

The number of
DataPackets outgoing data N/A Unsigned integer 64 N/A
packets

The number of
ControlPacket
outgoing control N/A Unsigned integer 64 N/A
s
packets

The number of
Multicasts outgoing N/A Unsigned integer 64. N/A
multicast packets

The number of
outgoing
Errors N/A Unsigned integer 64 N/A
erroneous
packets

IPsecTunnelI IPsec tunnel

N/A Unsigned integer 32 N/A
D index

12
 Column Column Column
Data type and restrictions Remarks
name description type

Members include:

• AhInbound
IPsec SA index Data
SAIndex • AhOutbound N/A
information structure
• EspInbound
• EspOutbound

Inbound IPsec
AhInbound N/A Unsigned integer 32 N/A
AH SA index

Outbound IPsec
AhOutbound N/A Unsigned integer 32 N/A
AH SA index

Inbound IPsec
EspInbound N/A Unsigned integer 32 N/A
ESP SA index

Outbound IPsec
EspOutbound N/A Unsigned integer 32 N/A
ESP SA index

IPv4TunnelRunInfo
This table displays the IPv4 interface information.

XML structure
<ADVPN>
<IPv4TunnelRunInfo>
<TunnelRunInfo>
<TunnelID></TunnelID>
<ClientName></ClientName>
<DomainName></DomainName>
<LinkProtocol></LinkProtocol>
<SessionNum></SessionNum>
</TunnelRunInfo>
</IPv4TunnelRunInfo>
</ADVPN>

13
Table description

Item Description
Feature name ADVPN

Table name IPv4TunnelRunInfo

Table type Multi-instance table

Row name TunnelRunInfo

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A

Name of the
String Case-insensitive and
VAM client
ClientName N/A contains only letters,
bound to the Length: 1 to 63 characters
digits, and dots (.).
tunnel interface

Case-insensitive and
Domain name of String
DomainName N/A contains only letters,
the VAM client Length: 1 to 31 characters
digits, and dots (.).

Enumeration:

• 0—Unknown
Link layer
• 1—GRE
LinkProtocol protocol for the N/A N/A
• 2—UDP
ADVPN tunnel
• 3—IPsec-GRE
• 4—IPsec-UDP

Number of
ADVPN tunnels
SessionNum established on N/A Unsigned integer N/A
the tunnel
interface

IPv6TunnelRunInfo
This table displays the IPv6 interface information.

14
XML structure
<ADVPN>
<IPv6TunnelRunInfo>
<TunnelRunInfo>
<TunnelID></TunnelID>
<ClientName></ClientName>
<DomainName></DomainName>
<LinkProtocol></LinkProtocol>
<SessionNum></SessionNum>
</TunnelRunInfo>
</IPv6TunnelRunInfo>
</ADVPN>

Table description

Item Description
Feature name ADVPN

Table name IPv6TunnelRunInfo

Table type Multi-instance table

Row name TunnelRunInfo

Restrictions None

Columns

Column Column Column

Data type and restrictions Remarks
name description type
TunnelID Tunnel ID Index Unsigned integer N/A

Name of the
String Case-insensitive and
VAM client
ClientName N/A contains only letters,
bound to the Length: 1 to 63 characters
digits, and dots (.).
tunnel interface

Case-insensitive and
Domain name of String
DomainName N/A contains only letters,
the VAM client Length: 1 to 31 characters
digits, and dots (.).

Enumeration:

Link layer • 0—Unknown

LinkProtocol protocol for the N/A • 1—GRE N/A
ADVPN tunnel • 2—UDP
• 3—IPsec-GRE

15
Column Column Column
Data type and restrictions Remarks
name description type
• 4—IPsec-UDP

Number of
ADVPN tunnels
SessionNum established on N/A Unsigned integer N/A
the tunnel
interface

16
Contents
SessionDeleted event ··················································································································· 1
XML structure for event subscription ························································································· 1
XML structure for event report ································································································· 2
SessionStateChanged event ·········································································································· 4
XML structure for event subscription ························································································· 4
XML structure for event report ································································································· 5

i
SessionDeleted event
This event is used to report ADVPN tunnel information when the ADVPN tunnel is deleted.

XML structure for event subscription

<SessionDeletedEvent>
<Tunnel>
<TunnelID></TunnelID>
</Tunnel>
</SessionDeletedEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>ADVPN</stream>
<filter type="subtree">
<SessionDeletedEvent xmlns="http://www.h3c.com/netconf/event:1.0/advpn:1.0">
<Tunnel>
<TunnelID>1</TunnelID>
</Tunnel>
</SessionDeletedEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name ADVPN
Event name SessionDeletedEvent
Event namespace http://www.h3c.com/netconf/event:1.0/advpn:1.0
Support for extended query No

Columns

Column Support for

Column name Data type and restrictions
description extended queries
TunnelID Tunnel ID Unsigned integer No

1
XML structure for event report
<SessionDeletedEvent>
<Tunnel>
<TunnelID></TunnelID>
<PrivateAddress></PrivateAddress>
<PublicAddress></PublicAddress>
<PeerPrivateAddress></PeerPrivateAddress>
<PeerPublicAddress></PeerPublicAddress>
<Type></Type>
<LastState></LastState>
<LastStateDuration></LastStateDuration>
<DomainName></DomainName>
<GroupName></GroupName>
</Tunnel>
</SessionDeletedEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<SessionDeletedEvent xmlns="http://www.h3c.com/netconf/event:1.0/advpn:1.0">
<Tunnel>
<TunnelID>1</TunnelID>
<PrivateAddress>112.168.60.56</PrivateAddress>
<PublicAddress>192.168.60.137</PublicAddress>
<PeerPrivateAddress>112.168.60.18</PeerPrivateAddress>
<PeerPublicAddress>192.168.60.11</PeerPublicAddress>
<Type>2</Type>
<LastState>2</LastState>
<LastStateDuration>0H8M8S</LastStateDuration>
<DomainName>abc</DomainName>
<GroupName>aaa</GroupName>
</Tunnel>
</SessionDeletedEvent>
</notification>

Columns

Support for
Column
Column name Data type and restrictions extended
description
queries
TunnelID Tunnel ID Unsigned integer No
PrivateAddress Private address String, dotted decimal notation. No
PublicAddress Public address String, dotted decimal notation. No
PeerPrivateAddre Peer’s private
String, dotted decimal notation. No
ss address

PeerPublicAddre Peer’s public address String, dotted decimal notation. No

2
 Support for
Column
Column name Data type and restrictions extended
description
queries
ss
Enumeration:
• 0—Unknown
• 1—Hub-Hub
Type ADVPN tunnel type No
• 2—Hub-Spoke
• 3—Spoke-Hub
• 4—Spoke-Spoke
Enumeration:
ADVPN tunnel’s last • 0—Establishing
LastState state before the No
tunnel is deleted • 1—Dumb
• 2—Success

ADVPN tunnel’s String, in the format of xxHxxMxxS.

LastStateDuratio
holding time before H, M, and S represent hours, minutes, No
n
the tunnel is deleted. and seconds.
Domain name of the String
DomainName No
VAM client
Group name of the String
GroupName No
ADVPN tunnel

3
SessionStateChanged event
This event is used to report ADVPN tunnel information when the ADVPN tunnel’s state is changed.

XML structure for event subscription

<SessionStateChangedEvent>
<Tunnel>
<TunnelID></TunnelID>
</Tunnel>
</SessionStateChangedEvent>

Example:
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:xs="http://www.h3c.com/netconf/base:1.0">
<create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<stream>ADVPN</stream>
<filter type="subtree">
<SessionStateChangedEvent
xmlns="http://www.h3c.com/netconf/event:1.0/advpn:1.0">
<Tunnel>
<TunnelID>1</TunnelID>
</Tunnel>
</SessionStateChangedEvent>
</filter>
</create-subscription>
</rpc>

Table description

Item Description
Event stream name ADVPN
Event name SessionStateChangedEvent
Event namespace http://www.h3c.com/netconf/event:1.0/advpn:1.0
Support for extended query No

Columns

Column Support for

Column name Data type and restrictions
description extended queries
TunnelID Tunnel ID Unsigned integer No

4
XML structure for event report
<SessionStateChangedEvent>
<Tunnel>
<TunnelID></TunnelID>
<CurrentState></CurrentState>
<NextState></NextState>
<PrivateAddress></PrivateAddress>
<PublicAddress></PublicAddress>
<PeerPrivateAddress></PeerPrivateAddress>
<PeerPublicAddress></PeerPublicAddress>
<Type></Type>
<LastState></LastState>
<LastStateDuration></LastStateDuration>
<DomainName></DomainName>
<GroupName></GroupName>
</Tunnel>
</SessionStateChangedEvent>

Example:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-07-21T09:10:51</eventTime>
<SessionStateChangedEvent xmlns="http://www.h3c.com/netconf/event:1.0/advpn:1.0">
<Tunnel>
<TunnelID>1</TunnelID>
<CurrentState>0</CurrentState>
<NextState>2</NextState>
<PrivateAddress>112.168.60.56</PrivateAddress>
<PublicAddress>192.168.60.137</PublicAddress>
<PeerPrivateAddress>112.168.60.18</PeerPrivateAddress>
<PeerPublicAddress>192.168.60.11</PeerPublicAddress>
<Type>2</Type>
<LastState>0</LastState>
<LastStateDuration>0H0M5S</LastStateDuration>
<DomainName>abc</DomainName>
<GroupName>aaa</GroupName>
</Tunnel>
</SessionStateChangedEvent>
</notification>

Columns

Column Support for extended

Column name Data type and restrictions
description queries
TunnelID Tunnel ID Unsigned integer No

ADVPN tunnel’s Enumeration:

CurrentState No
current state • 0—Establishing

5
 Column Support for extended
Column name Data type and restrictions
description queries
• 1—Dumb
• 2—Success
Enumeration:
ADVPN tunnel’s next • 0—Establishing
NextState No
state • 1—Dumb
• 2—Success
PrivateAddress Private address String, dotted decimal notation. No
PublicAddress Public address String, dotted decimal notation. No
PeerPrivateAddre Peer’s private
String, dotted decimal notation. No
ss address

PeerPublicAddre
Peer’s public address String, dotted decimal notation. No
ss

Enumeration:
• 0—Unknown
• 1—Hub-Hub
Type ADVPN tunnel type No
• 2—Hub-Spoke
• 3—Spoke-Hub
• 4—Spoke-Spoke

ADVPN tunnel’s last Enumeration:

state before the • 0—Establishing
LastState No
tunnel’s state is • 1—Dumb
changed. • 2—Success

ADVPN tunnel’s String, in the format of

LastStateDuratio holding time before xxHxxMxxS.
No
n the tunnel’s state is H, M, and S represent hours,
changed minutes, and seconds.

Domain name of the String

DomainName No
VAM client

Group name of the String

GroupName No
ADVPN tunnel

6
Contents
AFT ·······························································································1
AFT/AftEnable ··························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AFT/AftLogEnable ······················································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AFT/AftFlowBegin ······················································································································ 2
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
AFT/AftFlowEnd ························································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
AFT/AftPrefixNat64 ···················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
AFT/AftAddressGroup ················································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6
AFT/AftAddressGroupMember ······································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
AFT/AftV6toV4SrcDynamicAcl ······································································································ 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 8

i
AFT
AFT/AftEnable
This table contains informations about AFT enabling switch on the interface.

XML structure
<AFT>
<AftEnable>
<Interface>
<IfIndex></IfIndex>
<EnableSwitch></EnableSwitch>
</Interface>
</AftEnable>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftEnable
Table type Multi-instance table
Row name Interface
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Some versions support
interface name. For
relevant information,
you can see the XSD
document of your
Interface index or String. case-sensitive. product. For more
IfIndex Index
interface name Length: 1 to 99 characters. information about
IfIndex, you can
reference “Appendix” in
Ifmgr NETCONF XML
API Configuration
document.

EnableSwitch Whether enable N/A Boolean: N/A

AFT on the

1
 inerface • true—YES
• false—NO(default).

AFT/AftLogEnable
This table contains information about AFT logging switch

XML structure
<AFT>
<AftLogEnable>
<EnableSwitch></EnableSwitch>
</AftLogEnable>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftLogEnable
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether enable
EnableSwitch N/A • true—YES
AFT logging
• false—NO(default).

AFT/AftFlowBegin
This table contains information about AFT flow begin enabling switch

2
XML structure
<AFT>
<AftFlowBegin>
<EnableSwitch></EnableSwitch>
</AftFlowBegin>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftFlowBegin
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether enable
EnableSwitch AFT flow-begin N/A • true—YES
logging
• false—NO(default).

AFT/AftFlowEnd
This table contains information about AFT flow end enabling switch

XML structure
<AFT>
<AftFlowEnd>
<EnableSwitch></EnableSwitch>
</AftFlowEnd>
</AFT>

3
Table description
Item Description
Feature name AFT
Table name AftFlowEnd
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether enable
EnableSwitch AFT flow-end N/A • true—YES
logging
• false—NO(default).

AFT/AftPrefixNat64
This table contains information about AFT NAT64 prefix

XML structure
<AFT>
<AftPrefixNat64>
<PrefixNat64>
<Ipv6Prefix></Ipv6Prefix>
<Ipv6PrefixLength></Ipv6PrefixLength>
</PrefixNat64>
</AftPrefixNat64>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftPrefixNat64
Table type Multi-instance table
Row name PrefixNat64

4
 Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
IPv6 NAT64 IPv6: Hexadecimal string, Example:
Ipv6Prefix Index
prefix colon-separated. 1000::
Unsigned integer.
Ipv6PrefixLen IPv6 NAT64
Index Value N/A
gth prefix length
range:32,40,48,56,64,96.

AFT/AftAddressGroup
This table contains information about AFT address groups.

XML structure
<AFT>
<AftAddressGroup>
<GroupNumbers>
<GroupNumber></GroupNumber>
</GroupNumbers>
</AftAddressGroup>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftAddressGroup
Table type Muti-instance table
Row name GroupNumbers
Restrictions None
Support for row creation and deletion Yes

5
Columns
Column Column Column
Data type and restrictions
name description type
GroupNumbe AFT address Unsigned integer.
Index
r group number Value range: 0 to 65535.

AFT/AftAddressGroupMember
This table contains information about AFT address group members.

XML structure
<AFT>
<AftAddressGroupMember>
<GroupMembers>
<GroupNumber></GroupNumber>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
</GroupMembers>
</AftAddressGroupMember>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftAddressGroupMember
Table type Multi-instance table
Row name GroupMembers
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
GroupNumbe Address group Unsigned integer.
Index N/A
r number Value range: 0 to 65535.

StartIpv4Addr Start IPv4 IPv4: String, dotted decimal The StartIpv4Address

address of the Index cannot be greater than
ess notation.
address group the EndIpv4Address. If

6
 member they are the same, the
group member has only
one IP address.
The IP addresses of
address members on
the device must not
overlap.
The source address in
a packet destined for an
external network is
translated into an
address in one of group
members.
End IPv4
EndIpv4Addr address of the IPv4: String, dotted decimal
Index N/A
ess address group notation.
member

AFT/AftV6toV4SrcDynamicAcl
This table contains information about AFT IPv6 to IPv4 source dynamic acl rules.

XML structure
<AFT>
<AftV6toV4SrcDynamicAcl>
<RuleNumbers>
<Ipv6Acl></Ipv6Acl>
<Type></Type>
<AddressGroup></AddressGroup>
<IfIndex></IfIndex>
<AddrGrpType></AddrGrpType>
<PortBlockSize></PortBlockSize>
<Ipv4VpnName></Ipv4VpnName>
</RuleNumbers>
</AftV6toV4SrcDynamicAcl>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftV6toV4SrcDynamicAcl
Table type Multi-instance table
Row name RuleNumbers
Restrictions None

7
 Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-insensitive.
Must start with a-z or A-Z, the
Ipv6Acl name or word “all” can not be used as
Ipv6Acl Index name. or the acl number N/A
number
Value range: 2000 to 3999.
Length: 1 to 63 characters..
Enumeration:
Address group or
Type N/A • 0—address group. N/A
easy ip
• 1—easy ip.

AddressGrou Address group Unsigned integer.

N/A N/A
p number Value range: 0 to 65535
Some versions support
interface name. For
relevant information,
you can reference the
XSD document of your
Interface index or String. case-sensitive. product. For more
IfIndex N/A
interface name Length: 1 to 99 characters. information about
IfIndex, you can
reference “Appendix”
in Ifmgr NETCONF
XML API Configuration
document.
Enumeration:
Address group
AddrGrpType N/A • 0—NPt. N/A
type:pat or nopat
• 1—PT

Whether to use Unsigned integer.

PortBlockSize N/A Can be empty
port block Value range: 100 to 64512.

Ipv4VpnNam Whether to use String.

N/A Can be empty
e vpn Length:1 to 31 characters

8
Contents
AFT ·······························································································1
AFT/AftEnable ··························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AFT/AftLogEnable ······················································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AFT/AftFlowBegin ······················································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
AFT/AftFlowEnd ························································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
AFT/AftPrefixNat64 ···················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
AFT/AftAddressGroup ················································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
AFT/AftAddressGroupMember ······································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 6
Columns ···························································································································· 6
AFT/AftV6toV4SrcDynamicAcl ······································································································ 6
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7

i
AFT
AFT/AftEnable
This table contains informations about AFT enable switch on the interface.

XML structure
<AFT>
<AftEnable>
<Interface>
<IfIndex></IfIndex>
<EnableSwitch></EnableSwitch>
</Interface>
</AftEnable>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftEnable
Table type Multi-instance table
Row name Interface
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Some versions support
interface name. For
relevant information,
you can reference the
XSD document of your
Interface index or String. case-sensitive. product. For more
IfIndex Index
interface name Length: 1 to 99 characters. information about
IfIndex, you can
reference “Appendix”
in Ifmgr NETCONF XML
API Configuration
document.

Boolean:
Whether enable
EnableSwitch AFT on the N/A • true—YES N/A
inerface
• false—NO

1
AFT/AftLogEnable
This table contains informations about AFT log enable switch

XML structure
<AFT>
<AftLogEnable>
<EnableSwitch></EnableSwitch>
</AftLogEnable>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftLogEnable
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether eanble
EnableSwitch N/A • true—YES
AFT log
• false—NO

AFT/AftFlowBegin
This table contains informations about AFT flow begin enable switch

XML structure
<AFT>
<AftFlowBegin>
<EnableSwitch></EnableSwitch>
</AftFlowBegin>

2
 </AFT>

Table description
Item Description
Feature name AFT
Table name AftFlowBegin
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether eanble
EnableSwitch AFT flow-begin N/A • true—YES
log
• false—NO

AFT/AftFlowEnd
This table contains informations about AFT flow end enable switch

XML structure
<AFT>
<AftFlowEnd>
<EnableSwitch></EnableSwitch>
</AftFlowEnd>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftFlowEnd
Table type Single-instance table
Row name None
Restrictions None

3
Columns
Column Column Column
Data type and restrictions
name description type
Boolean:
Whether eanble
EnableSwitch N/A • true—YES
AFT flow-end log
• false—NO

AFT/AftPrefixNat64
This table contains informations about AFT nat64 prefix

XML structure
<AFT>
<AftPrefixNat64>
<PrefixNat64>
<Ipv6Prefix></Ipv6Prefix>
<Ipv6PrefixLength></Ipv6PrefixLength>
</PrefixNat64>
</AftPrefixNat64>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftPrefixNat64
Table type Multi-instance table
Row name PrefixNat64
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
IPv6: Hexadecimal string, Example:
Ipv6Prefix Ipv6 nat64 prefix index
colon-separated. 1000::
Unsigned integer.
Ipv6PrefixLen Ipv6 nat64 prefix
index Value range:32、40、48、56、 N/A
gth length
64、96.

4
AFT/AftAddressGroup
This table contains informations about AFT address groups.

XML structure
<AFT>
<AftAddressGroup>
<GroupNumbers>
<GroupNumber></GroupNumber>
</GroupNumbers>
</AftAddressGroup>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftAddressGroup
Table type Muti-instance table
Row name GroupNumbers
Restrictions None

Columns
Column Column Column
Data type and restrictions
name description type
GroupNumbe AFT address Unsigned integer.
Index
r group number Value range: 0 to 65535.

AFT/AftAddressGroupMember
This table contains informations about AFT address group members.

XML structure
<AFT>
<AftAddressGroupMember>
<GroupMembers>

5
 <GroupNumber></GroupNumber>
<StartIpv4Address></StartIpv4Address>
<EndIpv4Address></EndIpv4Address>
</GroupMembers>
</AftAddressGroupMember>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftAddressGroupMember
Table type Multi-instance table
Row name GroupMembers
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
GroupNumbe Address group Unsigned integer.
Index N/A
r number Value range: 0 to 65535.
The StartIpv4Address
cannot be greater than
the EndIpv4Address. If
they are the same, the
group member has only
one IP address.
Start IPv4 The IP addresses of
StartIpv4Addr address of the IPv4: String, dotted decimal address members on
Index
ess address group notation. the device must not
member overlap.
The source address in
a packet destined for an
external network is
translated into an
address in one of group
members.
End IPv4
EndIpv4Addr address of the IPv4: String, dotted decimal
Index N/A
ess address group notation.
member

AFT/AftV6toV4SrcDynamicAcl
This table contains the aft ipv6 to ipv4 source dynamic acl rules.

6
XML structure
<AFT>
<AftV6toV4SrcDynamicAcl>
<RuleNumbers>
<Ipv6Acl></Ipv6Acl>
<Type></Type>
<AddressGroup></AddressGroup>
<IfIndex></IfIndex>
<AddrGrpType></AddrGrpType>
<PortBlockSize></PortBlockSize>
<Ipv4VpnName></Ipv4VpnName>
</RuleNumbers>
</AftV6toV4SrcDynamicAcl>
</AFT>

Table description
Item Description
Feature name AFT
Table name AftV6toV4SrcDynamicAcl
Table type Multi-instance table
Row name RuleNumbers
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-insensitive.
Must start with a-z or A-Z, the
Ipv6Acl name or word “all” can not be used as
Ipv6Acl Index name. or the acl number N/A
number
Value range: 2000 to 3999.
Length: 1 to 63 characters..
Enumeration:
Address group or
Type N/A • 0—address group. N/A
easy ip
• 1—easy ip.

AddressGrou Address group Unsigned integer.

N/A N/A
p number Value range: 0 to 65535
Some versions support
interface name. For
Interface index or String. case-sensitive. relevant information,
IfIndex N/A you can reference the
interface name Length: 1 to 99 characters. XSD document of your
product. For more
information about

7
 IfIndex, you can
reference “Appendix”
in Ifmgr NETCONF
XML API Configuration
document.
Enumeration:
Address group
AddrGrpType N/A • 0—NPt. N/A
type:pat or nopat
• 1—PT

Whether to use Unsigned integer.

PortBlockSize N/A Can be empty
port block Value range: 100 to 64512.

Ipv4VpnNam Whether to use String.

N/A Can be empty
e vpn Length:1 to 31 characters

8
Contents
AntiVirus ························································································1
AntiVirus/SignatureManualUpgrading ····························································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AntiVirus/SignatureAutoUpgradeNow ····························································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AntiVirus/SignatureRollback ········································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3

i
AntiVirus
AntiVirus/SignatureManualUpgrading
This table contains the information of AntiVirus signatures manual upgrade.

XML structure
<AntiVirus>
<SignatureManualUpgrading>
<URL></URL>
<Location></Location>
</SignatureManualUpgrading>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureManualUpgrading
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String: case-insensitive
When the file is remote,
URL the upgrade
URL N/A Length: 1 to 255 characters. N/A
signature file.
When the file is local,
Length: 1 to 127 character.
If Location is set to 0,
Enumeration: the device deletes the
The Location of
Location
the file.
N/A • 0—Local signature file after the
• 1—remote signature library update
is complete.

AntiVirus/SignatureAutoUpgradeNow
This table contains the information of AntiVirus signatures upgrade at once.

1
XML structure
<AntiVirus>
<SignatureAutoUpgrade>
<UpgradeNow></UpgradeNow>
</SignatureAutoUpgrade>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureAutoUpgrade
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Auto upgrade at
UpgradeNow N/A This column must be empty. N/A
once.

AntiVirus/SignatureRollback
This table contains the information of AntiVirus signatures rollback.

XML structure
<AntiVirus>
<SignatureRollback>
<Rollback></Rollback>
</SignatureRollback>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureRollback
Table type Single-instance table

2
 Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type

Boolean:
Rollback rollback N/A • true：rollback last version N/A
• false：rollback original
version

3
Contents
AntiVirus ························································································1
AntiVirus/Policies ······················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AntiVirus/PolicyInProfile ·············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AntiVirus/RuleInPolicy ················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
AntiVirus/SignatureAutoUpgrading································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
AntiVirus/ActionDefaultParameters ································································································ 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
AntiVirus/RuleInPolicySigID ········································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
AntiVirus/CloudQueryConfig ········································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7
AntiVirus/RuleInPolicyMd5 ··········································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8

i
AntiVirus
AntiVirus/Policies
This table contains AntiVirus policy.

XML structure
<AntiVirus>
<Policies>
<Policy>
<PolicyName></PolicyName>
<Description></Description>
<CloudQuery></CloudQuery>
</Policy>
</Policies>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

Description of String: case-sensitive.

Description N/A N/A
the policy Length: 1 to 255 characters.
Enumeration:
Enabling status
CloudQuery
of cloud querying
N/A • 1—Enabled. N/A
• 2—Disabled.

1
AntiVirus/PolicyInProfile
This table contains AntiVirus policy applied to the profile.

XML structure
<AntiVirus>
<PolicyInProfile>
<Profile>
<ProfileName></ProfileName>
<PolicyName></PolicyName>
</Profile>
</PolicyInProfil>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name PolicyInProfile
Table type Multi-instance table
Row name Profile
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
ProfileName Index N/A
profile Length: 1 to 100 characters.

Name of the String: case-insensitive.

PolicyName N/A N/A
policy Length: 1 to 63 characters.

AntiVirus/RuleInPolicy
This table contains the information of rules in an AntiVirus policy.

XML structure
<AntiVirus>
<RuleInPolicy>
<Policy>

2
 <PolicyName></PolicyName>
<Protocol>
<ProtocolName></ProtocolName>
<Direction></Direction>
<Action></Action>
</Protocol>
<Application>
<AppName></AppName>
<Action></Action>
</Application>
</Policy>
</RuleInPolicy>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicy
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.
Members include:
Protocol DataStru • ProtocolName
Protocol N/A
configuration cture • Direction
• Action
String: case-insensitive
• HTTP
ProtocolNam • FTP
Protocol name N/A N/A
e • SMTP
• POP3
• IMAP
Enumeration:
Direction of • 0—Upload
Direction N/A N/A
protocol traffic • 1—Download
• 2—Both
Action Actions for the N/A Enumeration: N/A

3
 specified • 1—Alert
protocol's traffic • 2—Block
• 3—Redirect
Members include:
Application Data
Application
configuration Structure • AppName N/A
• Action
String, case-insensitive.
AppName Application name N/A N/A
Length: 1 to 63 characters.
Enumeration:
Actions for the
• 1—Alert
Action specified N/A N/A
application • 2—Block
• 3—Permit

AntiVirus/SignatureAutoUpgrading
This table contains the information of AntiVirus signatures auto upgrading.

XML structure
<AntiVirus>
<SignatureAutoUpgrading>
<Enabled></Enabled>
<StartTime></StartTime>
<Type></Type>
<Day></Day>
</SignatureAutoUpgrading>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureAutoUpgrading
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enabled or Boolean:
Enabled N/A Default is false
disabled • true

4
 • false
The time that the Default is 03:01:00,
StartTime system auto N/A Time.
upgrading HH:MM:SS

Type of the Enumeration:

Type system auto N/A • 0—Week Default is 1
upgrading • 1—Periodic
When Type is 0, the
Unsigned integer. value range is 0 to 6.
Day Days N/A Otherwise, the value
Value range: 0 to 15. range is 1 to 15. The
default is 3.

AntiVirus/ActionDefaultParameters
This table contains Antivirus action default parameter information.

XML structure
<AntiVirus>
<ActionDefaultParameters>
<ActionDefaultParameter>
<Action></Action>
<ParameterName></ParameterName>
</ActionDefaultParameter>
</ActionDefaultParameters>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name ActionDefaultParameters
Table type Multi-instance table
Row name ActionDefaultParameter
Restrictions None
Support for row creation and deletion No

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
Action action Index • 1—Block N/A
• 2—Capture

5
 • 3—Logging
• 4—Redirect
• 5—Mail
The value is from DIM
table. E.g. If Action is
ParameterNa String: case-insensitive. block, the
Parameter-Name N/A
me Length: 1 to 63 characters. ParameterName’s
value is from
DIM/BlockParameters.

AntiVirus/RuleInPolicySigID
This table contains the Exception sigs information of an AntiVirus policy.

XML structure
<AntiVirus>
<RuleInPolicySigID>
<Policy>
<PolicyName></PolicyName>
<ExceptionSigID></ExceptionSigID>
</Policy>
</RuleInPolicySigID>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicySigID
Table type Multi-instance table
Row name Policy
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

ExceptionSigI Unsigned integer.

ID of the virus Index N/A
D Value range: 1 to 536870910.

6
AntiVirus/CloudQueryConfig
This table contains cloud query configuration.

XML structure
<AntiVirus>
<CloudQueryConfig>
<HostName></HostName>
<CacheSize></CacheSize>
<CacheTime></CacheTime>
</CloudQueryConfig>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name CloudQueryConfig
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Name of the String, case-insensitive.
HostName N/A N/A
host Length: 1 to 255 characters.
Unsigned integer.
Size of the
CacheSize N/A Value range: 100000 to N/A
cache
200000.

Lifetime of the Unsigned integer.

CacheTime N/A N/A
cached entries Value range: 10 to 720.

AntiVirus/RuleInPolicyMd5
This table contains the MD5 exception information of an AntiVirus policy.

XML structure
<AntiVirus>
<RuleInPolicyMd5>

7
 <Policy>
<PolicyName></PolicyName>
<ExceptionMd5></ExceptionMd5>
</Policy>
</RuleInPolicyMd5>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicyMd5
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

ExceptionMd String: case-insensitive.

Value of the MD5 Index N/A
5 Length: 32 characters.

8
Contents
AntiVirus ························································································1
AntiVirus/Policies ······················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AntiVirus/PolicyInProfile ·············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AntiVirus/RuleInPolicy ················································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
AntiVirus/Signatures ··················································································································· 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
AntiVirus/SignatureFileInfos ········································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 5
AntiVirus/UpdatePercentage ········································································································ 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
AntiVirus/SignatureAutoUpgrading································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7
AntiVirus/ActionDefaultParameters ································································································ 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 8
AntiVirus/RuleInPolicySigID ········································································································· 8
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ···························································································································· 9
AntiVirus/FamilyInfos ·················································································································· 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
AntiVirus/CloudQueryConfig ······································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
AntiVirus/CloudQueryState ········································································································ 11
XML structure ··················································································································· 11
Table description ··············································································································· 12
Columns ·························································································································· 12
AntiVirus/RuleInPolicyMd5 ········································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 13

i
AntiVirus
AntiVirus/Policies
This table contains AntiVirus policy.

XML structure
<AntiVirus>
<Policies>
<Policy>
<PolicyName></PolicyName>
<Description></Description>
<CloudQuery></CloudQuery>
</Policy>
</Policies>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name Policies
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

Description of String: case-sensitive.

Description N/A N/A
the policy Length: 1 to 255 characters.
Enumeration:
Enabling status
CloudQuery
of cloud querying
N/A • 1—Enabled. N/A
• 2—Disabled.

1
AntiVirus/PolicyInProfile
This table contains AntiVirus policy applied to the profile.

XML structure
<AntiVirus>
<PolicyInProfile>
<Profile>
<ProfileName></ProfileName>
<PolicyName></PolicyName>
</Profile>
</PolicyInProfil>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name PolicyInProfile
Table type Multi-instance table
Row name Profile
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
ProfileName Index N/A
profile Length: 1 to 100 characters.

Name of the String: case-insensitive.

PolicyName N/A N/A
policy Length: 1 to 63 characters.

AntiVirus/RuleInPolicy
This table contains the information of rules in an AntiVirus policy.

XML structure
<AntiVirus>
<RuleInPolicy>
<Policy>
<PolicyName></PolicyName>

2
 <Protocol>
<ProtocolName></ProtocolName>
<Direction></Direction>
<Action></Action>
</Protocol>
<Application>
<AppName></AppName>
<Action></Action>
</Application>
</Policy>
</RuleInPolicy>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicy
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.
Members include:
Protocol DataStru • ProtocolName
Protocol N/A
configuration cture • Direction
• Action
String: case-insensitive.
• HTTP
ProtocolNam • FTP
Protocol name N/A N/A
e • SMTP
• POP3
• IMAP
Enumeration:
Direction of • 0—Upload
Direction N/A N/A
protocol traffic • 1—Download
• 2—Both
Enumeration:
Actions for the
• 1—Alert
Action specified N/A N/A
protocol's traffic • 2—Block
• 3—Redirect

3
 Column Column Column
Data type and restrictions Remarks
name description type
Members include:
Application Data
Application
configuration Structure • AppName N/A
• Action
String, case-insensitive.
AppName Application name N/A N/A
Length: 1 to 63 characters.
Enumeration:
Actions for the
• 1—Alert
Action specified N/A N/A
application • 2—Block
• 3—Permit

AntiVirus/Signatures
This table contains the pre-defined rules information of an AntiVirus policy.

XML structure
<AntiVirus>
<Signatures>
<Signature>
<SignatureID></SignatureID>
<Severity></Severity>
<SignatureName></SignatureName>
</Signature>
</Signatures>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name Signatures
Table type Multi-instance table
Row name Signature
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Unsigned integer.
SignatureID ID of the virus Index From signature file.
Value range: 1 to 536870910.

4
 Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 1—Critical
Severity of the
Severity
virus
N/A • 2—High From signature file.
• 3—Minor
• 4—Low

SignatureNa Name of the String: case-insensitive.

N/A From signature file.
me virus Length: 1 to 127 characters.

AntiVirus/SignatureFileInfos
This table contains AntiVirus policy.

XML structure
<AntiVirus>
<SignatureFileInfos>
<FileInfo>
<Version></Version>
<FileName></FileName>
<PublishedTime></PublishedTime>
<Updates></Updates>
</FileInfo>
</SignatureFileInfos>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureFileInfos
Table type Multi-instance table
Row name FileInfo
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
signature file
Version
version
Index • 1—Current N/A
• 2—Latest

5
 Column Column Column
Data type and restrictions Remarks
name description type
• 3—Factory

Name of the String: case-insensitive.

FileName N/A v.v(2.1)
signature file Length: 1 to 31 characters.

The time when DateTime.

PublishedTim
the signature is N/A Format: Consider time-zone
e
published YYYY-MM-DDTHH:MM:SS.

Updating String: case-insensitive.

Updates N/A N/A
Information Length: 1 to 255 characters.

AntiVirus/UpdatePercentage
This table contains the percentage of update.

XML structure
<AntiVirus>
<UpdatePercentage>
<Percentage></Percentage>
</UpdatePercentage>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name UpdatePercentage
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
When the value range
Unsigned integer. is 0 to 100, it means
Percentage of
Percentage N/A in upgrading,
update Value range: 0 to 100. Otherwise, it means
error

6
AntiVirus/SignatureAutoUpgrading
This table contains the information of AntiVirus signatures auto upgrading.

XML structure
<AntiVirus>
<SignatureAutoUpgrading>
<Enabled></Enabled>
<StartTime></StartTime>
<Type></Type>
<Day></Day>
</SignatureAutoUpgrading>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name SignatureAutoUpgrading
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Boolean:
Enabled or
Enabled
disabled
N/A • true Default is false
• false
The time that the Default is 03:01:00,
StartTime system auto N/A Time.
upgrading HH:MM:SS

Type of the Enumeration:

Type system auto N/A • 0—Week Default is 1
upgrading • 1—Periodic
When Type is 0, the
Unsigned integer. value range is 0 to 6.
Day Days N/A Otherwise, the value
Value range: 0 to 15. range is 1 to 15. The
default is 3.

7
AntiVirus/ActionDefaultParameters
This table contains Antivirus action default parameter information.

XML structure
<AntiVirus>
<ActionDefaultParameters>
<ActionDefaultParameter>
<Action></Action>
<ParameterName></ParameterName>
</ActionDefaultParameter>
</ActionDefaultParameters>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name ActionDefaultParameters
Table type Multi-instance table
Row name ActionDefaultParameter
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Enumeration:
• 1—Block
• 2—Capture
Action action Index N/A
• 3—Logging
• 4—Redirect
• 5—Mail
The value is from DIM
table. E.g. If Action is
String: case-insensitive. block, the
ParameterNa
Parameter-Name N/A ParameterName’s
me Length: 1 to 63 characters. value is from
DIM/BlockParameters
.

AntiVirus/RuleInPolicySigID
This table contains the Exception sigs information of an AntiVirus policy.

8
XML structure
<AntiVirus>
<RuleInPolicySigID>
<Policy>
<PolicyName></PolicyName>
<ExceptionSigID></ExceptionSigID>
</Policy>
</RuleInPolicySigID>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicySigID
Table type Multi-instance table
Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

ExceptionSigI Unsigned integer.

ID of the virus Index N/A
D Value range: 1 to 536870910.

AntiVirus/FamilyInfos
This table contains information about virus families displayed on paginated lists.

XML structure
<AntiVirus>
<FamilyInfos>
<FamilyInfo>
<UserID></UserID>
<Position></Position>
<TotalCount></TotalCount>
<FamilyID></FamilyID>
<FamilyName></FamilyName>
</FamilyInfo>

9
 </FamilyInfos>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name FamilyInfos
Table type Multi-instance table
Row name FamilyInfo
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
The value is used to
identify each query
results in back end,
ID of the current and send to fore-end
UserID Index Unsigned integer.
virtual user. to get other paginated
results when query
results is more than
one page.
Position of the
family on the
Position Index Unsigned integer. N/Az
entire virus
families list.
If the query function is
used, the total
Total number of
TotalCount N/A Unsigned integer. number of virus
virus families.
families in the query
results is displayed.

Unsigned integer. The value is obtained

FamilyID ID of the family. Index from the anti-virus
Value range: 1 to 536870910. signature file.

String: case-insensitive. The value is obtained

Name of the
FamilyName N/A from the anti-virus
family. Length: 1 to 63 characters. signature file.

AntiVirus/CloudQueryConfig
This table contains cloud query configure information.

XML structure
<AntiVirus>
<CloudQueryConfig>

10
 <HostName></HostName>
<CacheSize></CacheSize>
<CacheTime></CacheTime>
</CloudQueryConfig>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name CloudQueryConfig
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Name of the String, case-insensitive.
HostName N/A N/A
host Length: 1 to 255 characters.

Size of the Unsigned integer.

CacheSize N/A N/A
cache Value range: 100000 to 200000.

Lifetime of the Unsigned integer.

CacheTime N/A N/A
cached entries Value range: 10 to 720.

AntiVirus/CloudQueryState
This table contains cloud query status information.

XML structure
<AntiVirus>
<CloudQueryState>
<HostName></HostName>
<HostState></HostState>
<HostStateErrCode></HostStateErrCode>
</CloudQueryState>
</AntiVirus>

11
Table description
Item Description
Feature name AntiVirus
Table name CloudQueryState
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column
Column name Data type and restrictions Remarks
description type
Name of the String, case-insensitive.
HostName N/A N/A
host Length: 1 to 255 characters.
Enumeration:
Status of the
HostState
host
N/A • 0—Available N/A
• 1—Unavailable

HostStateErrCo Error code of Unsigned integer.

N/A N/A
de cloud query Value range: 0 to 3.

AntiVirus/RuleInPolicyMd5
This table contains the MD5 exception information of an AntiVirus policy.

XML structure
<AntiVirus>
<RuleInPolicyMd5>
<Policy>
<PolicyName></PolicyName>
<ExceptionMd5></ExceptionMd5>
</Policy>
</RuleInPolicyMd5>
</AntiVirus>

Table description
Item Description
Feature name AntiVirus
Table name RuleInPolicyMd5
Table type Multi-instance table

12
 Row name Policy
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
Name of the String: case-insensitive.
PolicyName Index N/A
policy Length: 1 to 63 characters.

ExceptionMd String: case-insensitive.

Value of the MD5 Index N/A
5 Length: 32 characters.

13
Contents
AntiVirus ························································································2
AntiVirus/SignatureManualUpgrading ····························································································· 2
AntiVirus/SignatureAutoUpgradeNow ····························································································· 2
AntiVirus/RuleInPolicy ················································································································· 2
AntiVirus/RuleInPolicySigID ········································································································· 3

i
AntiVirus
AntiVirus/SignatureManualUpgrading
Message Explanation
Operation failed because no valid license could be
Please install a valid license.
found.
请安装正确的license。
操作失败：没有找到有效的license。

AntiVirus/SignatureAutoUpgradeNow
Message Explanation
Operation failed because no valid license could be
Please install a valid license.
found.
请安装正确的license。
操作失败：没有找到有效的license。

The signature file is updating. Please try again

Please try later.
later.
正在升级，稍后再试。
特征库正在升级，请稍后再试。

Operation failed because a connection to the

Please examine your network or server.
signature library server could not be established.
请检查网络和服务器是否正常。
操作失败: 连接特征库服务器失败。

Cannot execute this operation because of memory

Please try later.
alert.
待设备内存门限解除后再试。
由于内存门限不能执行此操作。

The signature version is up to date. No update is

No update is needed because the version is up to date.
needed.
不需要升级，已经是最新版本。
特征库已是最新版本，不需要进行升级。

Cannot update the signature library because the Cannot update the signature library because the required service
required service card cannot be found. card cannot be found.
未检测到业务板，特征库升级失败。 特征库升级操作需要有业务板。

AntiVirus/RuleInPolicy
Message Explanation
The maximum number of 100 application
A maximum of 100 application exceptions can be configured.
exceptions already reached.
最多可配置100个应用例外。
最多可配置100个应用例外。

2
AntiVirus/RuleInPolicySigID
Message Explanation
The maximum number of 512 signature exceptions
A maximum of 512 signature exceptions can be configured.
already reached.
最多可配置512个病毒例外。
最多可配置512个病毒例外。

3
Contents
AP ································································································1
AP/ResetAP ····························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AP/ResetAllAP ·························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
AP/PersistentAP ························································································································ 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 3
AP/RegroupAPByName ·············································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 3
AP/RegroupAPByMac ················································································································· 3
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 4
AP/RegroupAPBySerialID ············································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 5
Columns ···························································································································· 5
AP/RegroupAPByGroup ·············································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6
AP/AuthenticateAP ····················································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 6
AP/AuthenticateAllAP ················································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 7
AP/ImportAuthenticateFile ··········································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8
AP/ProvisionAP ························································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 9
AP/RenameAP ·························································································································· 9
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ···························································································································· 9

i
AP
AP/ResetAP
This table contains information of AP resetting.

XML structure
<AP>
<ResetAP>
<AP>
<ApName></ApName>
</AP>
</ResetAP>
</AP>

Table description
Item Description
Feature name AP
Table name ResetAP
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ApName AP name Index String, case-sensitive. N/A.
Length: 1 to 64 characters.

AP/ResetAllAP
This table contains information of resetting all APs.

XML structure
<AP>
<ResetAllAP>
<Global>
<ResetType></ResetType>
</Global>

1
 </ResetAllAP>
</AP>

Table description
Item Description
Feature name AP
Table name ResetAllAP
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column
Column description Column type Data type and restrictions
name
ResetType Which type of APs will be Index Enumeration:
reset. • 1—All.
• 2—Unauthenticated.

AP/PersistentAP
This table contains information of AP persistence.

XML structure
<AP>
<PersistentAP>
<AP>
<ApName></ApName>
</AP>
</PersistentAP>
</AP>

Table description
Item Description
Feature name AP
Table name PersistentAP
Table type Multi-instance table
Row name AP
Restrictions None

2
Columns
Column Column Column
Data type and restrictions Remarks
name description type
ApName AP name Index String, case-sensitive. N/A.
Length: 1 to 64 characters.

AP/RegroupAPByName
This table contains information of AP regrouping.

XML structure
<AP>
<RegroupAPByName>
<AP>
<ApName></ApName>
<GroupName></GroupName>
</AP>
</RegroupAPByName>
</AP>

Table description
Item Description
Feature name AP
Table name RegroupAPByName
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ApName AP name Index String, case-sensitive. N/A.
Length: 1 to 64 characters.
GroupName The name of AP N/A String, lowercase. N/A
group which the Length: 1 to 31 characters.
AP will belong to.

AP/RegroupAPByMac
This table contains information of AP regrouping by MAC address.

3
XML structure
<AP>
<RegroupAPByMac>
<MAC>
<MacAddress></MacAddress>
<GroupName></GroupName>
</MAC>
</RegroupAPByMac>
</AP>

Table description
Item Description
Feature name AP
Table name RegroupAPByMac
Table type Multi-instance table
Row name MAC
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
MacAddress AP MAC address Index Six groups of two hexadecimal Example:
digits, hyphen-separated. 00-0c-af-e3-5d-c0.
GroupName The name of AP N/A String, lowercase. N/A
group which the Length: 1 to 31 characters.
AP will belong to.

AP/RegroupAPBySerialID
This table contains information of AP regrouping by serial ID.

XML structure
<AP>
<RegroupAPBySerialID>
<SerialID>
<SerialID></SerialID>
<GroupName></GroupName>
</SerialID>
</RegroupAPBySerialID>
</AP>

4
Table description
Item Description
Feature name AP
Table name RegroupAPBySerialID
Table type Multi-instance table
Row name SerialID
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
SerialID AP serial ID Index String, uppercase. If this column contains
Length: 1 to 127 characters. lowercase character, it
will be converted to
uppercase
automatically.
GroupName The name of AP N/A String, lowercase. N/A
group which the Length: 1 to 31 characters.
AP will belong to.

AP/RegroupAPByGroup
This table contains information of AP regrouping by group.

XML structure
<AP>
<RegroupAPByGroup>
<Group>
<OldGroupName></OldGroupName>
<NewGroupName></NewGroupName>
</Group>
</RegroupAPByGroup>
</AP>

Table description
Item Description
Feature name AP
Table name RegroupAPByGroup
Table type Multi-instance table
Row name Group

5
 Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
OldGroupNa The name of old Index String, lowercase. If this column contains
me AP group. Length: 1 to 31 characters. uppercase character, it
will be converted to
lowercase automatically.
NewGroupNa The name of AP N/A String, lowercase. If this column contains
me group which the Length: 1 to 31 characters. uppercase character, it
AP in old group will be converted to
will belong to. lowercase automatically.

AP/AuthenticateAP
This table contains information of authenticating APs.

XML structure
<AP>
<AuthenticateAP>
<AP>
<ApName></ApName>
<Action></Action>
</AP>
</AuthenticateAP>
</AP>

Table description
Item Description
Feature name AP
Table name AuthenticateAP
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ApName AP name Index String, case-sensitive. N/A.
Length: 1 to 64 characters.

6
 Column Column Column
Data type and restrictions Remarks
name description type
Action The N/A Enumeration: N/A
authenticating • 1—Accept.
action type.
• 2—Reject.

AP/AuthenticateAllAP
This table contains information of authenticating all APs.

XML structure
<AP>
<AuthenticateAllAP>
<Global>
<Action></Action>
</Global>
</AuthenticateAllAP>
</AP>

Table description
Item Description
Feature name AP
Table name AuthenticateAllAP
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Column
Data type and restrictions
name description type
Action The N/A Enumeration:
authenticating • 1—Accept.
action type.
• 2—Reject.

AP/ImportAuthenticateFile
This table contains information of importing authenticating file.

XML structure
<AP>

7
 <ImportAuthenticateFile>
<FileName></FileName>
</ImportAuthenticateFile>
</AP>

Table description
Item Description
Feature name AP
Table name ImportAuthenticateFile
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Data type and
Column name Column description Remarks
type restrictions
FileName The TXT file name N/A String, case-insensitive.
Should end with “.txt”
with full path which Length: 1 to 255 and specify the
will be imported as characters. authentication ACL
the AP ACL rules for
first.
AP authentication.

AP/ProvisionAP
This table contains information of provisioning APs.

XML structure
<AP>
<ProvisionAP>
<AP>
<ApName></ApName>
<Action></Action>
</AP>
</ProvisionAP>
</AP>

Table description
Item Description
Feature name AP
Table name ProvisionAP
Table type Multi-instance table

8
 Row name AP
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
ApName AP name Index String, case-sensitive. N/A.
Length: 1 to 64 characters.
Action The N/A Enumeration: N/A
authenticating • 1—Provision.
action type.
• 2—Reset provisioning.

AP/RenameAP
This table contains information about renaming APs.

XML structure
<AP>
<RenameAP>
<AP>
<ApName></ApName>
<NewApName></NewApName>
</AP>
</RenameAP>
</AP>

Table description
Item Description
Feature name AP
Table name RenameAP
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String, case-sensitive.
ApName AP name Index N/A.
Length: 1 to 64 characters.

9
Column Column Column
Data type and restrictions Remarks
name description type
String, case-sensitive.
NewApName New AP name Index N/A.
Length: 1 to 64 characters.

10
Contents
AP ································································································1
AP/GlobalCfg ···························································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 2
AP/ManualAP ··························································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
AP/RadioOfManualAP················································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 7
Columns ···························································································································· 7
AP/PrvsOfManualAP ················································································································ 11
XML structure ··················································································································· 11
Table description ··············································································································· 12
Columns ·························································································································· 12
AP/PrvsOfManualAPACIPv4 ······································································································ 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
AP/PrvsOfManualAPACIPv6 ······································································································ 14
XML structure ··················································································································· 14
Table description ··············································································································· 14
Columns ·························································································································· 15
AP/EdcaRadio ························································································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 15
Columns ·························································································································· 16
AP/RadioWmm ························································································································ 16
XML structure ··················································································································· 16
Table description ··············································································································· 17
Columns ·························································································································· 17
AP/Radio11n ·························································································································· 17
XML structure ··················································································································· 17
Table description ··············································································································· 18
Columns ·························································································································· 18
AP/Radio11ac ························································································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 20
Columns ·························································································································· 20
AP/APGroup ··························································································································· 21
XML structure ··················································································································· 21
Table description ··············································································································· 22
Columns ·························································································································· 22
AP/APGroupMACRule ·············································································································· 24
XML structure ··················································································································· 24
Table description ··············································································································· 24
Columns ·························································································································· 24
AP/APGroupSerialIDRule ·········································································································· 24
XML structure ··················································································································· 24
Table description ··············································································································· 25
Columns ·························································································································· 25
AP/APGroupNameRule ············································································································· 25
XML structure ··················································································································· 25
Table description ··············································································································· 26
Columns ·························································································································· 26

i
AP/APGroupIPv4Rule ··············································································································· 26
XML structure ··················································································································· 26
Table description ··············································································································· 26
Columns ·························································································································· 27
AP/APGroupIPv6Rule ··············································································································· 27
XML structure ··················································································································· 27
Table description ··············································································································· 27
Columns ·························································································································· 28
AP/APGroupModel ··················································································································· 28
XML structure ··················································································································· 28
Table description ··············································································································· 28
Columns ·························································································································· 29
AP/APGroupRadio ··················································································································· 29
XML structure ··················································································································· 29
Table description ··············································································································· 30
Columns ·························································································································· 30
AP/APGroupRadio11n ·············································································································· 34
XML structure ··················································································································· 34
Table description ··············································································································· 35
Columns ·························································································································· 35
AP/APGroupRadio11ac ············································································································· 37
XML structure ··················································································································· 37
Table description ··············································································································· 37
Columns ·························································································································· 38
AP/APGroupPrvs ····················································································································· 38
XML structure ··················································································································· 38
Table description ··············································································································· 39
Columns ·························································································································· 39
AP/APGroupPrvsACIPv4 ··········································································································· 40
XML structure ··················································································································· 40
Table description ··············································································································· 40
Columns ·························································································································· 40
AP/APGroupPrvsACIPv6 ··········································································································· 40
XML structure ··················································································································· 40
Table description ··············································································································· 41
Columns ·························································································································· 41
AP/Location ···························································································································· 41
XML structure ··················································································································· 41
Table description ··············································································································· 41
Columns ·························································································································· 42
AP/APAuthentication ················································································································ 42
XML structure ··················································································································· 42
Table description ··············································································································· 42
Columns ·························································································································· 43
AP/LocalAC ···························································································································· 43
XML structure ··················································································································· 43
Table description ··············································································································· 44
Columns ·························································································································· 44
AP/ContainerTopology ·············································································································· 45
XML structure ··················································································································· 45
Table description ··············································································································· 45
Columns ·························································································································· 45
AP/Container ·························································································································· 46
XML structure ··················································································································· 46
Table description ··············································································································· 46
Columns ·························································································································· 46

ii
AP
AP/GlobalCfg
This table contains the informations of global.

XML structure
<AP>
<GlobalCfg>
<AutoAp></AutoAp>
<AutoPersistent></AutoPersistent>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Preempt></Preempt>
<FirmwareUpgrade></FirmwareUpgrade>
<TunnelEncryption></TunnelEncryption>
<Gps></Gps>
<LocalAC></LocalAC>
<CentralACIPv4></CentralACIPv4>
<CentralACIPv6></CentralACIPv6>
<ControlAddress></ControlAddress>
<ControlAddressIPv4></ControlAddressIPv4>
<ControlAddressIPv6></ControlAddressIPv6>
</GlobalCfg>
</AP>

Table description
Item Description
Feature name AP
Table name GlobalCfg
Table type Single-instance table
Row name N/A
Restrictions None
Support for row creation
No
and deletion

1
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Whether an AP Boolean:
can connect the • true—Support. N/A
AutoAp AC without N/A
creating a manual • false—Not support.
AP. Default value is false.

When an auto AP Boolean:

connects the AC , • true—Support. N/A
AutoPersist
whether convert N/A
ent
the AP to manual • false—Not support.
AP automatically. Default value is false.

Region code of Conform to ISO 3166

RegionCode N/A Unsigned short.
AP group. standard.
Boolean:
Whether the • true—Support. N/A
RegionLock region code of the N/A
AC is locked • false—Not support.
Default value is false.
Whether the AP in Boolean:
this group will be
• true: Switch N/A
forced to switch
Preempt N/A • false: Not switch
the backup tunnel
to active by Default value is false.
priority.
Whether the AC Boolean:
will upgrade AP’s N/A
FirmwareUp firmware • true—Enable
N/A
grade automatically if the • false—Disable
software is
mismatch. Default value is disable.

Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable

Whether to open Boolean:

Gps the N/A • true—Enable Only for FatAP Type
Gps report switch. • false—Disable
Whether to enable Boolean:
LocalAC Local ac. N/A • true—Enable Only for Local-ac Type
• false—Disable

CentralACIP The IPv4 Central String, dotted decimal Example: 1.1.1.1.

N/A
v4 AC address. notation. Only for Local-ac Type

CentralACIP The IPv6 Central Hexadecimal string, Example: 1:1::1:1.

N/A
v6 AC address. colon-separated. Only for Local-ac Type
CAPWAP control Boolean:
ControlAddr address
ess
N/A • true—Enable N/A
configuration
• false—Disable

2
 Column Column Column Data type and
Remarks
name description type restrictions
Specify an AC
ControlAddr String, dotted decimal
IPv4 address for N/A Example: 1.1.1.1.
essIPv4 notation.
AC rediscovery
Specify an AC
ControlAddr Hexadecimal string,
IPv4 address for N/A Example: 1:1::1:1.
essIPv6 colon-separated.
AC rediscovery

AP/ManualAP
This table contains manual AP information.

XML structure
<AP>
<ManualAP>
<AP>
<Name></Name>
<Model></Model>
<CfgSerialID></CfgSerialID>
<CfgMacAddress></CfgMacAddress>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
<ControlAddress></ControlAddress>
<ControlAddressIPv4></ControlAddressIPv4>
<ControlAddressIPv6></ControlAddressIPv6>
<ProvisionAutoUpgrade></ProvisionAutoUpgrade>
<ProvisionAutoRecover></ProvisionAutoRecover>
<LedMode></LedMode>
</AP>
</ManualAP>
</AP>

3
Table description
Item Description
Feature name AP
Table name ManualAP
Table type Multi-instance table
Row name AP
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Data type and
Column name Remarks
description type restrictions
String, case-sensitive. N/A.
Name AP name. Index Length: 1 to 64
characters.
Characters will be
automatically convert case.
Refer to AP/APDB.
This column is mandatory
String, case-insensitive. when the row is being
created.
Model AP model name. N/A Length: 1 to 63
characters. This column is not writable
when the row is being
deleted, removed.
This column should not be
changed when the row is
being replaced or merged.

String, uppercase. If this column contains

Configured AP serial lowercase character, it will
CfgSerialID N/A Length: 1 to 127
ID. be converted to uppercase
characters. automatically.
Six groups of two
Configured AP MAC
CfgMacAddress N/A hexadecimal digits, Example: 00-0c-af-e3-5d-c0.
address.
hyphen-separated.
Conform to ISO 3166
RegionCode Region code of AP. N/A Unsigned short.
stantard.

Whether the region Boolean:

RegionLock code of the AP is N/A • true—Support. N/A
locked. • false—Not support.
Unsigned short.
Priority AP connection priority N/A N/A
Value range: 0 to 7.
Whether the AP will be Boolean:
forced to switch the
Preempt N/A • true: Switch N/A
backup tunnel to active
by priority. • false: Not switch

4
 The transmit interval of Unsigned short.
EchoInterval tunnel echo N/A Value range: 0, 5 to 255. N/A
messages. Unit: seconds
The allowed maximum
number of echo
messages which are Unsigned short.
EchoCount N/A N/A
not received. If the Value range: 1 to 20.
count is reached, the
tunnel will be down.
The interval to Unsigned short.
RetransInterval retransmit a request N/A Value range: 1 to 30. N/A
message.
Unit: seconds
The allowed maximum Unsigned short.
number of Value range: 1 to 20.
retransmission
RetransCount N/A Unit: seconds N/A
attempts. If the count
is reached, the tunnel
will be down.
Unsigned short.
The interval of AP
Value range: 0 to 240.
StatisInterval sending the statistics N/A N/A
informations to AC. Default value is 50
seconds.
Whether the AC will Boolean:
upgrade AP’s firmware
FirmwareUpgrade N/A • true—Enable N/A
automatically if the
software is mismatch. • false—Disable

The IPv4 backup AC String, dotted decimal

BackupACIPv4 N/A Example: 1.1.1.1.
address. notation.
The IPv6 backup AC Hexadecimal string,
BackupACIPv6 N/A Example: 1:1::1:1.
address. colon-separated.
String, lowercase.
Which location the AP
LocationName N/A Length: 1 to 31 N/A
group belongs to.
characters.
String,
Description The description of AP. N/A Length: 1 to 64 N/A
characters.
Boolean:
Whether to enable
TunnelEncryption
tunnel encryption.
N/A • true—Enable N/A
• false—Disable
Boolean:
CAPWAP control
ControlAddress
address configuration.
N/A • true—Enable. N/A
• false—Disable.
Specify an AC IPv4
String, dotted decimal
ControlAddressIPv4 address for AC N/A Example: 1.1.1.1.
notation.
rediscovery.
Specify an AC IPv4
Hexadecimal string,
ControlAddressIPv6 address for AC N/A Example: 1:1::1:1.
colon-separated.
rediscovery.

Whether to enable Boolean:

ProvisionAutoUpgrade N/A N/A
provision • true—Enable.

5
 auto-upgrade. • false—Disable.
Boolean:
Whether to enable
ProvisionAutoRecover
provision auto-recover.
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 0—Normal
• 1—Quiet
LedMode LED mode N/A N/A
• 2—Awake
• 3—Always-on
• 4— Inherit

AP/RadioOfManualAP
This table contains radio information of manual AP.

XML structure
<AP>
<RadioOfManualAP>
<Radio>
<ApName></ApName>
<RadioID></RadioID>
<Mode></Mode>
<Bandwidth></Bandwidth>
<Status></Status>
<RateMulticast></RateMulticast>
<RateMandatory></RateMandatory>
<RateSupported></RateSupported>
<RateDisabled></RateDisabled>
<Preamble></Preamble>
<BeaconInterval></BeaconInterval>
<PowerLock></PowerLock>
<Distance></Distance>
<MaxRxDuration></MaxRxDuration>
<FragmentThreshold></FragmentThreshold>
<LongRetryThreshold></LongRetryThreshold>
<ProtectionThreshold></ProtectionThreshold>
<ShortRetryThreshold></ShortRetryThreshold>
<CfgChannel></CfgChannel>
<CfgMaxPower></CfgMaxPower>
<CfgMaxPowerPercent></CfgMaxPowerPercent>
</Radio>
</RadioOfManualAP>
</AP>

6
Table description
Item Description
Feature name AP
Table name RadioOfManualAP
Table type Multi-instance table
Row name Radio
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode. N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth. N/A N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M
Enumeration:
• 0—Disable
Status Radio status N/A N/A
• 1—Enable
• 2—Inherit

7
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
The value can have
• 7—12Mbps multi-selections.
RateMultica
Multicast rate. N/A • 8—18Mbps List of enumeration,
st separated by comma
• 9—24Mbps
Example: 1, 2.
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
• 13—auto
If this column is not
configured, the multicast
rate will be calculated
automatically.
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
The value can have
• 5—9Mbps multi-selections.
RateMandat
Mandatory rate. N/A • 6—11Mbps List of enumeration,
ory separated by comma
• 7—12Mbps
Example: 1, 2.
• 8—18Mbps
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps

8
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateSupport
Supported rate. N/A • 6—11Mbps rate uses.
ed List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateDisable
Disabled rate. N/A • 6—11Mbps rate uses.
d List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Boolean:
• true—Short. N/A
Preamble Preamble. N/A • false—Long.
The column is only for
2.4GHz radio mode.

Unsigned short.
BeaconInter Beacon Interval The value range is
N/A N/A
val time. 32~8191.
Unit: TU. 1TU = 1024ms
Enumeration:
• 0—Disable
PowerLock Lock the power. N/A N/A
• 1—Enable
• 2—Inherit

9
Column Column Column Data type and
Remarks
name description type restrictions
ChanneAuto Lock the channel N/A Boolean: When the value is true,
Lock • true—ChanneAutoLoc the radio automatically
k. selects an optimal
channel, and then locks
• false—ChanneAuto the channel.
UnLock.
When the AC detects
The default value is true.
any radar signals on its
channel, it immediately
selects another channel
(even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
The distance that
Distance N/A The value range is 1~40. N/A
Radio can cover.
Unit: km(kilometre).
Unsigned integer.
Max Reveived The value range is
MaxRxDurat
frame duration N/A 500~250000. N/A
ion
tim.
Unit: ms(millisecond).
Unsigned short.
The value range is
FragmentTh Fragment
N/A 256~2346. And the value N/A
reshold threshold.
must be an even number.
Unit: byte.
Unsigned short.
LongRetryT Long retry
N/A The value range is 1~15. N/A
hreshold threshold.
Unit: null.
N/A Unsigned short.
ProtectionT Protection
The value range is 0~2346. N/A
hreshold threshold.
Unit: byte.
Unsigned short.
ShortRetryT Short retry
N/A The value range is 1~15. N/A
hreshold threshold.
Unit: null.
When the value is true,
the radio automatically
Unsigned short. selects an optimal
The value range conforms channel, and then locks
to the channel.
Configured “AP/ChannelDB/Supported When the AC detects
CfgChannel N/A
channel number. ChannelList” column. If this any radar signals on its
column is not configured, channel, it immediately
the channel number will be selects another channel
calculated automatically. (even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
Value range: 1 to
CfgMaxPow Configured
N/A “AP/PowerDB/ValidMaxPo N/A
er maximum power
wer”.
Unit: dBm

10
 Column Column Column Data type and
Remarks
name description type restrictions
• When both
CfgMaxPower and
CfgMaxPowerPerce
nt are configured,
CfgMaxPowerPerce
Unsigned short. nt has higher
Configured priority.
CfgMaxPow
maximum power N/A Value range: 1 to 10.
erPercent • Value 1 represents
in percentage Unit: null. 10%, 2 represents
20%, etc.
The Remove operation
will set the value of this
parameter to 10 by
default.

AP/PrvsOfManualAP
This table contains provision information of manual AP.

XML structure
<AP>
<PrvsOfManualAP>
<Prvs>
<ApName></ApName>
<ACHostName></ACHostName>
<ACIPv4></ACIPv4>
<ACIPv6></ACIPv6>
<DnsDomain></DnsDomain>
<DnsServerIPv4></DnsServerIPv4>
<DnsServerIPv6></DnsServerIPv6>
<GatewayIPv4></GatewayIPv4>
<GatewayIPv6></GatewayIPv6>
<IPv4Address></IPv4Address>
<IPv6Address></IPv6Address>
<Dot1xSupplAnonyIdent></Dot1xSupplAnonyIdent>
<Dot1xSupplEapMethod></Dot1xSupplEapMethod>
<Dot1xSupplEnable></Dot1xSupplEnable>
<Dot1xSupplPasswdCiper></Dot1xSupplPasswdCiper>
<Dot1xSupplPasswdSimple></Dot1xSupplPasswdSimple>
<Dot1xSupplUsername></Dot1xSupplUsername>
</Prvs>
</PrvsOfManualAP>
</AP>

11
Table description
Item Description
Feature name AP
Table name PrvsOfManualAP
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name Index
Length: 1 to 64 characters.
String.
ACHostNam Specify an AC by
N/A Length: 1 to 253 N/A
e its hostname.
characters.
List of string, dotted
Specify an AC by Example: 1.1.1.1,
ACIPv4 N/A decimal notation,
its IPv4 address. 1.1.1.2.
Separated by comma.
Specify an AC by List of hexadecimal string,
Example:
ACIPv6 its IPv6 address. N/A colon-separated,
1:1::1:1,1:1::1:2.
Separated by comma.
Specify the String.
DnsDomain domain name N/A Length: 1 to 253. N/A
suffix.
Specify a DNS String, dotted decimal
DnsServerI
server by its IPv4 N/A notation. Example: 1.1.1.1.
Pv4
address.
Specify a DNS Hexadecimal string,
DnsServerI
server by its IPv6 N/A colon-separated. Example: 1:1::1:1.
Pv6
address.
Specify a gateway
GatewayIPv String, dotted decimal
by its IPv4 N/A Example: 1.1.1.1.
4 notation.
address.
Specify a gateway
GatewayIPv Hexadecimal string,
by its IPv6 N/A Example: 1:1::1:1.
6 colon-separated.
address
Specify an IP String, dotted decimal
address that the notation.
IPv4Addres
AP uses to N/A Example: 1.1.1.1.
s
establish a
CAPWAP tunnel.

12
 Column Column Column Data type and
Remarks
name description type restrictions
Specify an IPv6
address that the
IPv6Addres Hexadecimal string,
AP uses to N/A Example: 1:1::1:1.
s colon-separated.
establish a
CAPWAP tunnel.
Specify an String.
Dot1xSuppl anonymous Length: 1 to 253
N/A N/A
AnonyIdent identifier for the characters.
supplicant.
Enumeration:
• 1—md5
Specify an EAP • 2—peap-gtc
Dot1xSuppl
authentication N/A N/A
EapMethod
method. • 3—peap-mschapv2
• 4—ttls-gtc
• 5—ttls-mschapv2
Boolean:
Dot1xSuppl Enable the 802.1X
Enable supplicant feature.
N/A • true—Enable. N/A
• false—Disable.
Specify a String.
Dot1xSuppl
ciphertext Length: 1 to 201
PasswdCipe N/A N/A
password for the characters.
r
802.1X supplicant.
Dot1xSuppl Specify a plaintext String.
PasswdSim password for the N/A Length: 1 to 127 N/A
ple 802.1X supplicant. characters.
Specify a String.
Dot1xSuppl username for the N/A Length: 1 to 253 N/A
Username 802.1X supplicant. characters.

AP/PrvsOfManualAPACIPv4
This table contains provision information of manual AP of IPv4 address.

XML structure
<AP>
<PrvsOfManualAPACIPv4>
<Prvs>
<ApName></ApName>
<ACIPv4></ACIPv4>
</Prvs>
</PrvsOfManualAPACIPv4>
</AP>

13
Table description
Item Description
Feature name AP
Table name PrvsOfManualAPACIPv4
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name Index N/A
Length: 1 to 64 characters.
Specify an AC by String, dotted decimal
ACIPv4 N/A Example: 1.1.1.1.
its IPv4 address. notation.

AP/PrvsOfManualAPACIPv6
This table contains provision information of manual AP of IPv6 address.

XML structure
<AP>
<PrvsOfManualAPACIPv6>
<Prvs>
<ApName></ApName>
<ACIPv6></ACIPv6>
</Prvs>
</PrvsOfManualAPACIPv6>
</AP>

Table description
Item Description
Feature name AP
Table name PrvsOfManualAPACIPv6
Table type Multi-instance table
Row name Prvs
Restrictions None

14
 Item Description
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName ApName Index N/A
Length: 1 to 64 characters.
Example: 1.1.1.1.
Specify an AC by Hexadecimal string, This column is available
ACIPv6 N/A
its IPv6 address. colon-separated. when the SrcAny column
is false.

AP/EdcaRadio
This table contains radio EDCA information.

XML structure
<AP>
<EdcaRadio>
<EdcaPara>
<ApName></ApName>
<RadioID></RadioID>
<AccessCategory></AccessCategory>
<Noack></Noack>
<CfgAifsn></CfgAifsn>
<CfgEcwmin></CfgEcwmin>
<CfgEcwmax></CfgEcwmax>
<CfgTxOpLimit></CfgTxOpLimit>
</EdcaPara>
</EdcaRadio>
</AP>

Table description
Item Description
Feature name AP
Table name EdcaRadio
Table type Multi-instance table
Row name EdcaPara
Restrictions None
Support for row creation and deletion No

15
Columns
Column Column
Column description Data type and restrictions Remarks
name type
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
A label for the common set
of enhanced distributed Enumeration:
channel access
• 0—BK.
parameters that are used by
AccessCategory
a WMM STA to conten d for
Index • 1—BE. N/A
the channel in order to • 2—VI.
transmit MSDUs with • 3—VO.
certain priorities.
Boolean:
Whehter acknowledgement is • true—Not required. N/A
Noack N/A
required. • false—Required.
The default value is false.
ArbitrationInter Frame The value range conforms to
CfgAifsn N/A N/A
Spacing Number. “AP/RadiolDB/Aifsn” column.
The value range conforms to
CfgEcwmin Exponent form of CWmin. N/A “AP/RadiolDB/Ecwmin” N/A
column.
The value range conforms to
CfgEcwmax Exponent form of CWmax. N/A “AP/RadiolDB/Ecwmax” N/A
column.
The value range conforms to
Transmission oppurtunity
CfgTxOpLimit N/A “AP/RadiolDB/TxOpLimit” N/A
limit.
column.

AP/RadioWmm
This table contains radio WMM information.

XML structure
<AP>
<RadioWmm>
<Wmm>
<ApName></ApName>
<RadioID></RadioID>
<Status></Status>
</Wmm>
</RadioWmm>
</AP>

16
Table description
Item Description
Feature name AP
Table name RadioWmm
Table type Multi-instance table
Row name Wmm
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length:1to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Boolean:
WMM status of • true—Enable. N/A
Status N/A
radio. • false—Disable.
The default value is true.

AP/Radio11n
This table contains radio 802.11n information.

XML structure
<AP>
<Radio11n>
<Dot11n>
<ApName></ApName>
<RadioID></RadioID>
<MCSMulticast></MCSMulticast>
<MCSMandatory></MCSMandatory>
<MCSSupported></MCSSupported>
<Ampdu></Ampdu>
<Amsdu></Amsdu>
<ShortGI></ShortGI>
<Stbc></Stbc>
<Ldpc></Ldpc>

17
 <Mimo></Mimo>
<Greenap></Greenap>
<SmartAntenna></SmartAntenna>
<SmartAntennaPolicy></SmartAntennaPolicy>
<Protection></Protection>
<Client11nOnly></Client11nOnly>
<BandwidthAutoswitch></BandwidthAutoswitch >
</Dot11n>
</Radio11n>
</AP>

Table description
Item Description
Feature name AP
Table name Radio11n
Table type Multi-instance table
Row name Dot11n
Restrictions The table is only for 802.11n and 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Unsigned short. The MCSMulticast must
MCSMultica The index for Value range: 0 to 76, and be smaller than or equal
N/A to the MCSMandatory.
st multicast MCS. 255.
Default value is 255.
The MCSMandatory
Unsigned short. must be smaller than or
The maximum equal to the
MCSMandat Value range: 0 to 76, and
index for N/A MCSSupported, and the
ory 255.
mandatory MCS. MCSMandatory must be
Default value is 255. greater than or equal to
the MCSMulticast.
Unsigned short. The MCSSupported
The maximum
MCSSuppor Value range: 0 to 76, and must be greater than or
index for N/A
ted 255. equal to the
supported MCS.
Default value is 255. MCSMandatory.

18
Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
Ampdu A-mpdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Amsdu A-msdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
ShortGI Short GI function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Stbc STBC function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Ldpc LDPC function. N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 1: 1X1
Mimo MIMO. N/A • 2: 2X2 N/A
• 3: 3X3
• 4: 4X4
Boolean:
Greenap Green ap function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
SmartAnten Smart antenna
na function.
N/A • true—Enable. N/A
• false—Disable.
Enumeration: Effective only when
SmartAntenna is
SmartAnten Smart antenna • 1: Auto
N/A enabled.
naPolicy policy. • 2: High-availability
• 3: High-throughput

802.11n Boolean:
Protection protection N/A • true—Enable. N/A
function. • false—Disable.
Boolean:
Client11nOn Client dot11n only
N/A • true—Enable. N/A
ly function.
• false—Disable.
Boolean:
• true—Enable. N/A
BandwidthA
Bandwidth • false—Disable.
autoswitch N/A
utoswitch The column is only for
function.
2.4GHz radio mode, and
AP/RadioOfManualAP/Ban
dwidth must be 2..

19
AP/Radio11ac
This table contains radio 802.11ac information.

XML structure
<AP>
<Radio11ac>
<Dot11ac>
<ApName></ApName>
<RadioID></RadioID>
<VHTNSSMulticast></VHTNSSMulticast>
<VHTMCSMulticast></VHTMCSMulticast>
<VHTNSSMandatory></VHTNSSMandatory>
<VHTNSSSupported></VHTNSSSupported>
<Client11acOnly></Client11acOnly>
</Dot11ac>
</Radio11ac>
</AP>

Table description
Item Description
Feature name AP
Table name Radio11ac
Table type Multi-instance table
Row name Dot11ac
Restrictions The table is only for 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Unsigned short. The VHTNSSMulticast
The NSS for
VHTNSSMu Value range: 0 to 8. must be smaller than or
multicast N/A
lticast equal to the
VHT-MCS Default value is 0. VHTNSSMandatory.

20
 Column Column Column Data type and
Remarks
name description type restrictions
The index for Unsigned short.
VHTMCSMu
multicast N/A Value range: 0 to 9, 255. N/A
lticast
VHT-MCS. Default value is 255.
The VHTNSSMandatory
must be smaller than or
The maximum Unsigned short. equal to the
VHTNSSMa NSS for VHTNSSSupported, and
N/A Value range: 0 to 8.
ndatory mandatory the VHTNSSMandatory
VHT-MCS Default value is 0. must be greater than or
equal to the
VHTNSSMulticast.
Unsigned short. The VHTNSSSupported
The maximum
VHTNSSSu Value range: 0 to 8. must be greater than or
NSS for supported N/A
pported equal to the
VHT-MCS. Default value is 0. VHTNSSMandatory.
Boolean:
Client11acO Client dot11ac
N/A • true—Enable. N/A
nly only function.
• false—Disable.

AP/APGroup
This table contains information of AP groups.

XML structure
<AP>
<APGroup>
<Group>
<Name></Name>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
<ProvisionAutoUpgrade></ProvisionAutoUpgrade>
<ProvisionAutoRecover></ProvisionAutoRecover>
<LedMode></LedMode>

21
 </Group>
</APGroup>
</AP>

Table description
Item Description
Feature name AP
Table name APGroup
Table type Multi-instance table
Row name Group
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
Name AP group name. Index N/A
Length: 1 to 31 characters.
Region code of Unsigned short. Conform to ISO 3166
ApName N/A
AP group. stantard.
Boolean:
Whether the
region code of the • true—Support. N/A
RegionLock N/A
AP group is • false—Not support.
locked.
Default value is false.
AP connection Unsigned short.
Priority priority N/A N/A
Value range: 0 to 7.
Whether the AP in Boolean:
this group will be
• true: Switch N/A
forced to switch
Preempt N/A • false: Not switch
the backup tunnel
to active by Default value is false.
priority.
Unsigned short.
The transmit Value range: 0, 5 to 255.
EchoInterval interval of tunnel N/A Unit: seconds N/A
echo messages.
Default value is 10
seconds.
The allowed
maximum number
of echo messges Unsigned short.
which are not
EchoCount N/A Value range: 1 to 20. N/A
received. If the
count is reached, Default value is 3.
the tunnel will be
down.

22
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned short.
The interval to Value range: 1 to 30.
RetransInter
retransmit a N/A N/A
val Unit: seconds
request message.
Default value is 5 seconds.
The allowed
maximum number Unsigned short.
of retransmission Value range: 1 to 20.
RetransCou
attempts. If the N/A N/A
nt Unit: seconds
count is reached,
the tunnel will be Default value is 6.
down.
Unsigned short.
The interval of AP
sending the Value range: 0 to 240.
StatisInterva
statistics N/A Unit: seconds N/A
l
informations to
AC. Default value is 50
seconds.
Whether the AC Boolean:
will upgrade AP’s
• true—Enable N/A
FirmwareUp firmware
N/A
grade automatically if the • false—Disable
software is Default value is disable.
mismatch.
BackupACI The IPv4 backup String, dotted decimal
N/A Example: 1.1.1.1.
Pv4 AC address. notation.
BackupACI The IPv6 backup Hexadecimal string,
N/A Example: 1:1::1:1.
Pv6 AC address. colon-separated.
Which location the String, lowercase.
LocationNa
AP group belongs N/A Length: 1 to 31 characters. N/A
me
to.

The description of String,

Description N/A N/A
APGroup. Length: 1 to 64 cahracters
Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable
Boolean:
Whether to enable
ProvisionAut
oUpgrade
provision N/A • true—Enable N/A
auto-upgrade
• false—Disable
Boolean:
Whether to enable
ProvisionAut
oRecover
provision N/A • true—Enable N/A
auto-recover
• false—Disable
Enumeration:
• 0—Normal
LedMode LED mode N/A • 1—Quiet N/A
• 2—Awake
• 3—Always-on

23
AP/APGroupMACRule
This table contains information of AP groups’ rules of MAC address.

XML structure
<AP>
<APGroupMACRule>
<Rule>
<GroupName></GroupName>
<MacAddress></MacAddress>
</Rule>
</APGroupMACRule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupMACRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
Six groups of two
Example:
MacAddress AP MAC address. Index hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.

AP/APGroupSerialIDRule
This table contains information of AP groups’ rules of serial ID.

XML structure
<AP>
<APGroupSerialIDRule>
<Rule>

24
 <GroupName></GroupName>
<SerialID></SerialID>
<Rule>
</APGroupSerialIDRule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupSerialIDRule
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, uppercase.
SerialID AP serial ID Index Length: 1 to 127 N/A
characters.

AP/APGroupNameRule
This table contains information of AP groups’ rules of AP name.

XML structure
<AP>
<APGroupNameRule>
<Rule>
<GroupName></GroupName>
<APName></APName>
<Rule>
</APGroupNameRule>
</AP>

25
Table description
Item Description
Feature name AP
Table name APGroupNameRule
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, case-sensitive.
APName AP name. Index N/A
Length: 1 to 64 characters.

AP/APGroupIPv4Rule
This table contains information of AP groups’ rules of IPv4 address range.

XML structure
<AP>
<APGroupIPv4Rule>
<Rule>
<GroupName></GroupName>
<IPv4Addr></IPv4Addr>
<IPv4Wildcard></IPv4Wildcard>
<Rule>
</APGroupIPv4Rule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupIPv4Rule
Table type Multi-instance table
Row name Rule

26
 Item Description
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
IPv4 address of String, dotted decimal
IPv4Addr Index Example: 1.1.1.1.
AP. notation.
Wildcard mask for
IPv4Wildcar String, dotted decimal
the IPv4 address Index Example: 255.255.255.0.
d notation.
of AP.

AP/APGroupIPv6Rule
This table contains information of AP groups’ rules of IPv6 address range.

XML structure
<AP>
<APGroupIPv6Rule>
<Rule>
<GroupName></GroupName>
<IPv6Addr></IPv6Addr>
<IPv6Wildcard></IPv6Wildcard>
<Rule>
</APGroupIPv6Rule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupIPv6Rule
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation
Yes
and deletion

27
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
Example: 1:1::1:1.
Source IPv6 Hexadecimal string, This column is available
IPv6Addr Index
address. colon-separated. when the SrcAny column
is false.
Length of the Unsigned integer. This column is available
IPv6Wildcar
source IPv6 Index when the SrcAny column
d Value range: 1 to 128.
address prefix. is false.

AP/APGroupModel
This table contains information of AP group models.

XML structure
<AP>
<APGroupModel>
<Model>
<GroupName></GroupName>
<ModelName></ModelName>
</Model>
</APGroupModel>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupModel
Table type Multi-instance table
Row name Model
Restrictions None
Support for row creation
Yes
and deletion

28
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.

AP/APGroupRadio
This table contains information of AP group radios.

XML structure
<AP>
<APGroupRadio>
<Radio>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<Mode></Mode>
<Bandwidth></Bandwidth>
<Spectrum></Spectrum>
<Status></Status>
<RateMulticast></RateMulticast>
<RateMandatory></RateMandatory>
<RateSupported></RateSupported>
<RateDisabled></RateDisabled>
<Preamble></Preamble>
<BeaconInterval></BeaconInterval>
<PowerLock></PowerLock>
<ChannelAutoLock></ChannelAutoLock>
<Distance></Distance>
<MaxRxDuration></MaxRxDuration>
<FragmentThreshold></FragmentThreshold>
<LongRetryThreshold></LongRetryThreshold>
<ProtectionThreshold></ProtectionThreshold>
<ShortRetryThreshold></ShortRetryThreshold>
<CfgChannel></CfgChannel>
<CfgMaxPower></CfgMaxPower>
</Radio>
</APGroupRadio>
</AP>

29
Table description
Item Description
Feature name AP
Table name APGroupRadio
Table type Multi-instance table
Row name Radio
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode. N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Enumeration:
• 1—20M
• 2—40M
• 3—80M
• 4—160M
• 5—80M + 80M
Bandwidth Radio bandwidth. N/A • 17—5M N/A
• 18—10M
Default value is 1 when the
Mode is 1、2、3、4、6.
Default value is 2 when the
Mode is 5.
Defautl value is 3 when the
Mode is 7.

30
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—Support both
Supported radio 5GHz and 2.4GHz
Spectrum N/A N/A
spectrum. • 2—Support 5GHz only
• 3—Support 2.4GHz
only
Enumeration:
• 0—Disable
Status Radio status. N/A N/A
• 1—Enable
• 2—Inherit
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps The value can have
multi-selections.
RateMultica • 8—18Mbps
Multicast rate. N/A List of enumeration,
st • 9—24Mbps separated by comma
• 10—36Mbps Example: 1, 2.
• 11—48Mbps
• 12—54Mbps
• 13—auto
If this column is not
configured, the multicast
rate will be calculated
automatically.
Default value: auto

31
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps
• 8—18Mbps The value can have
multi-selections.
RateMandat
Mandatory rate. N/A • 9—24Mbps List of enumeration,
ory
• 10—36Mbps separated by comma
• 11—48Mbps Example: 1, 2.
• 12—54Mbps
Default value:
A. 1, 2Mbps(802.11b).
B. 6, 12,
24Mbps(802.11a/802.1
1an)
C. 1, 2, 5.5,
11Mbps(802.11g/802.1
1gn)
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps The value can have
• 8—18Mbps multi-selections, exclude
the one which multicast
RateSupport
Supported rate. N/A • 9—24Mbps rate uses.
ed
• 10—36Mbps List of enumeration,
separated by comma
• 11—48Mbps
Example: 1, 2.
• 12—54Mbps
Default value:
A. 5.5, 11Mbps(802.11b)
B. 9, 18, 24, 36, 48,
54Mbps(802.11a/802.1
1an)
C. 6, 9, 12, 18, 24, 36,
54Mbps(802.11g/802.1
1gn)

32
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
• 5—9Mbps multi-selections, exclude
the one which multicast
RateDisable • 6—11Mbps
Disabled rate. N/A rate uses.
d • 7—12Mbps List of enumeration,
• 8—18Mbps separated by comma
Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Default value: null.
Boolean:
• true—Short. N/A
• false—Long.
Preamble Preamble. N/A
The column is only for
2.4GHz radio mode.
Default value: short.

Unsigned short.
The value range is
BeaconInter Beacon Interval 32~8191.
N/A N/A
val time.
Unit: TU. 1TU = 1024ms
Default value: 100
Enumeration:
• 0—Disable
PowerLock Lock the power. N/A N/A
• 1—Enable
• 2—Inherit
ChanneAuto Lock the channel N/A Boolean: When the value is true,
Lock • true—ChanneAutoLoc the radio automatically
k. selects an optimal
channel, and then locks
• false—ChanneAuto the channel.
UnLock.
When the AC detects
The default value is true.
any radar signals on its
channel, it immediately
selects another channel
(even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
The distance that The value range is 1~40.
Distance N/A N/A
Radio can cover. Unit: km(kilometre).
Default value: 1

33
 Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
Max Reveived The value range is
MaxRxDurat 500~250000.
frame duration N/A N/A
ion
time. Unit: ms.
Default value: 2000
Unsigned short.
The value range is
FragmentTh Fragment 256~2346. And the value
N/A must be an even number. N/A
reshold threshold.
Unit: byte.
Default value: 2346
Unsigned short.
LongRetryT Long retry The value range is 1~15.
N/A N/A
hreshold threshold. Unit: null.
Default value: 4
Unsigned short.
ProtectionT Protection The value range is 0~2346.
N/A N/A
hreshold threshold. Unit: byte.
Default value: 2346
Unsigned short.
ShortRetryT Short retry The value range is 1~15.
N/A N/A
hreshold threshold. Unit: null.
Default value: 7
Unsigned short.
The value range conforms
to
Configured “AP/ChannelDB/Supported
CfgChannel N/A N/A
channel number. ChannelList” column. If this
column is set to zero, the
channel number will be
calculated automatically.
Unsigned short.
Value range: 1 to
CfgMaxPow Configured
N/A “AP/PowerDB/ValidMaxPo N/A
er maximum power.
wer”.
Unit: dBm

AP/APGroupRadio11n
This table contains 802.11n information of AP group radios.

XML structure
<AP>
<APGroupRadio11n>
<Radio11n>

34
 <GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<MCSMulticast></MCSMulticast>
<MCSMandatory></MCSMandatory>
<MCSSupported></MCSSupported>
<Ampdu></Ampdu>
<Amsdu></Amsdu>
<ShortGI></ShortGI>
<Stbc></Stbc>
<Ldpc></Ldpc>
<Mimo></Mimo>
<Greenap></Greenap>
<SmartAntenna></SmartAntenna>
<SmartAntennaPolicy></SmartAntennaPolicy>
<Protection></Protection>
<Client11nOnly></Client11nOnly>
<BandwidthAutoswitch></ BandwidthAutoswitch >
</Radio11n>
</APGroupRadio11n>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupRadio11n
Table type Multi-instance table
Row name Radio11n
Restrictions The table is only for 802.11n and 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.

35
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned short.
The MCSMulticast must
MCSMultica The index for Value range: 0 to 76, and
N/A be smaller than or equal
st multicast MCS. 255. to the MCSMandatory.
Default value is 255.
The MCSMandatory
Unsigned short. must be smaller than or
The maximum equal to the
MCSMandat Value range: 0 to 76, and
index for N/A MCSSupported, and the
ory 255.
mandatory MCS. MCSMandatory must be
Default value is 255. greater than or equal to
the MCSMulticast.
Unsigned short. The MCSSupported
The maximum must be greater than or
MCSSuppor Value range: 0 to 76, and
index for N/A equal to the
ted 255.
supported MCS. MCSMandatory.
Default value is 76.
Boolean:
Ampdu A-mpdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Amsdu A-msdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
ShortGI Short GI function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Stbc STBC function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Ldpc LDPC function. N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 1: 1X1
Mimo MIMO. N/A • 2: 2X2 N/A
• 3: 3X3
• 4: 4X4
Boolean:
Greenap Green ap function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
SmartAnten Smart antenna
na function.
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
Effective only when
SmartAnten Smart antenna • 1: Auto
N/A SmartAntenna is
naPolicy policy. • 2: High-availability enabled.
• 3: High-throughput

36
 Column Column Column Data type and
Remarks
name description type restrictions
802.11n Boolean:
Protection protection N/A • true—Enable. N/A
function. • false—Disable.
Boolean:
Client11nOn Client dot11n only
ly function.
N/A • true—Enable. N/A
• false—Disable.
Boolean:
• true—Enable. N/A
BandwidthA
Bandwidth • false—Disable.
autoswitch N/A
utoswitch The column is only for
function.
2.4GHz radio mode, and
AP/APGroupRadio/Bandwi
dth must be 2.

AP/APGroupRadio11ac
This table contains 802.11ac information of AP group radios.

XML structure
<AP>
<APGroupRadio11ac>
<Radio11ac>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<VHTNSSMulticast></VHTNSSMulticast>
<VHTMCSMulticast></VHTMCSMulticast>
<VHTNSSMandatory></VHTNSSMandatory>
<VHTNSSSupported></VHTNSSSupported>
<Client11acOnly></Client11acOnly>
</Radio11ac>
</APGroupRadio11ac>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupRadio11ac
Table type Multi-instance table
Row name Radio11ac
Restrictions The table is only for 802.11ac radio mode.

37
 Item Description
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Unsigned short. The VHTNSSMulticast
The NSS for
VHTNSSMu Value range: 0 to 8. must be smaller than or
multicast N/A
lticast equal to the
VHT-MCS. Default value is 0. VHTNSSMandatory.

The index for Unsigned short.

VHTMCSMu
multicast N/A Value range: 0 to 9, 255. N/A
lticast
VHT-MCS. Default value is 255.
The VHTNSSMandatory
must be smaller than or
The maximum Unsigned short. equal to the
VHTNSSMa NSS for VHTNSSSupported, and
N/A Value range: 0 to 8.
ndatory mandatory the VHTNSSMandatory
VHT-MCS. Default value is 0. must be greater than or
equal to the
VHTNSSMulticast.
Unsigned short. The VHTNSSSupported
The maximum
VHTNSSSu Value range: 0 to 8. must be greater than or
NSS for supported N/A
pported equal to the
VHT-MCS. Default value is 8. VHTNSSMandatory.
Boolean:
Client11acO Client dot11ac
nly only function.
N/A • true—Enable. N/A
• false—Disable.

AP/APGroupPrvs
This table contains provision information of AP Group.

XML structure
<AP>
<APGroupPrvs>
<Prvs>
<GroupName></GroupName>
<ACHostName></ACHostName>

38
 <ACIPv4></ACIPv4>
<ACIPv6></ACIPv6>
<DnsDomain></DnsDomain>
<DnsServerIPv4></DnsServerIPv4>
<DnsServerIPv6></DnsServerIPv6>
</Prvs>
</APGroupPrvs>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvs
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName GroupName. Index N/A
Length: 1 to 31 characters.
String.
ACHostNam Specify an AC by
N/A Length: 1 to 253 N/A
e its hostname.
characters.
List of string, dotted
Specify an AC by Example: 1.1.1.1,
ACIPv4 N/A decimal notation,
its IPv4 address 1.1.1.2.
Separated by comma.
List of hexadecimal string,
Specify an AC by Example:
ACIPv6 N/A colon-separated,
its IPv6 address 1:1::1:1,1:1::1:2.
Separated by comma.
Specify the String.
DnsDomain domain name N/A N/A
suffix. Length: 1 to 253.

Specify a DNS
DnsServerI String, dotted decimal
server by its IPv4 N/A Example: 1.1.1.1.
Pv4 notation.
address.
Specify a DNS
DnsServerI Hexadecimal string,
server by its IPv6 N/A Example: 1:1::1:1.
Pv6 colon-separated.
address.

39
AP/APGroupPrvsACIPv4
This table contains provision information of AP Group of IPv4 address.

XML structure
<AP>
<APGroupPrvsACIPv4>
<Prvs>
<GroupName></GroupName>
<ACIPv4></ACIPv4>
</Prvs>
</APGroupPrvsACIPv4>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvsACIPv4
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name. Index N/A
Length: 1 to 31 characters.
Specify an AC by String, dotted decimal
ACIPv4 N/A Example: 1.1.1.1.
its IPv4 address. notation.

AP/APGroupPrvsACIPv6
This table contains provision information of AP group of IPv6 address.

XML structure
<AP>
<APGroupPrvsACIPv6>
<Prvs>
<GroupName></GroupName>

40
 <ACIPv6></ACIPv6>
</Prvs>
</APGroupPrvsACIPv6>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvsACIPv6
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName GroupName. Index N/A
Length: 1 to 31 characters.
Example: 1:1::1:1.
Specify an AC by Hexadecimal This column is available
ACIPv6 N/A
its IPv6 address. string,colon-separated. when the SrcAny column
is false.

AP/Location
This table contains the informations of locations.

XML structure
<AP>
<Location>
<Location>
<LocationName></LocationName>
</Location>
</Location>
</AP>

Table description
Item Description
Feature name AP

41
 Item Description
Table name Location
Table type Multi-instance table
Row name Location
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
LocationNa String, lowercase.
Location name. Index N/A
me Length: 1 to 31 characters.

AP/APAuthentication
This table contains the informations of AP authentication.

XML structure
<AP>
<APAuthentication>
<Status></Status>
<Method></Method>
<PermitUnauth></PermitUnauth>
<AuthDomain></AuthDomain>
<AclNumber></AclNumber>
<AclName></AclName>
</APAuthentication>
</AP>

Table description
Item Description
Feature name AP
Table name APAuthentication
Table type Single-instance table
Row name N/A
Restrictions None
Support for row creation
No
and deletion

42
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
The status of AP • true—Enable. N/A
Status N/A
authentication. • false—Disable.
Default value is disable.
Enumeration:
• 1—MAC address.
The authentication
Method
method.
N/A • 2—Serial ID. N/A
Default value is MAC
address.
Boolean:
Whether the
PermitUnaut un-authenticated • true—Allowed. N/A
N/A
h AP is allowed to • false—Not allowed.
join the AC.
Default value is allowed.
The ISP domain of String, case-insensitive.
AuthDomain remote AP N/A N/A
authentication. Length: 1 to 24 characters.

The ACL number Unsigned short. This column is

AclNumber of local AP N/A unavailable when the AC
authentication. Value range: 200 to 299. uses an ACL name.
This column is
The ACL name of unavailable when the AC
String, case-sensitive.
AclName local AP N/A uses an ACL number.
authentication. Length: 1 to 64 characters.
The ACL name should
not be “all”.

AP/LocalAC
This table contains local-ac information.

XML structure
<AP>
<LocalAC>
<AC>
<Name></Name>
<Model></Model>
<CfgSerialID></CfgSerialID>
<EchoInterval></EchoInterval>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<FirmwareUpgrade></FirmwareUpgrade>
</AC>
</LocalAC>
</AP>

43
Table description
Item Description
Feature name AP
Table name LocalAC
Table type Multi-instance table
Row name AC
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Data type and
Column name Column description Remarks
type restrictions
String, N/A.
case-sensitive.
Name Local-ac name. Index
Length: 1 to 64
characters.
Characters will be
automatically convert
case.
Refer to AP/ACDB.
This column is
String, mandatory when the
case-insensitive. row is being created.
Model Local-ac model name. N/A This column is not
Length: 1 to 63
characters. writable when the row
is being deleted,
removed.
This column should not
be changed when the
row is being replaced
or merged.
If this column contains
String, uppercase. lowercase character, it
Configured Local-ac
CfgSerialID N/A Length: 1 to 63 will be converted to
serial ID.
characters. uppercase
automatically.
Unsigned short.
The transmit interval of Value range: 0, 5 to
EchoInterval N/A N/A
tunnel echo messages. 255.
Unit: seconds

The interval to Unsigned short.

RetransInterval retransmit a request N/A Value range: 3 to 8 N/A
message. Unit: seconds

44
 Column Data type and
Column name Column description Remarks
type restrictions
The allowed maximum
number of Unsigned short.
retransmission
RetransCount N/A Value range: 2 to 5. N/A
attempts. If the count is
reached, the tunnel will Unit: seconds
be down.
Whether the AC will Boolean:
upgrade AP’s firmware • true—Enable.
FirmwareUpgrade N/A N/A
automatically if the
software is mismatch. • false—Disable.

AP/ContainerTopology
This table contains information about all PoE ports on the container (such as SPM and WT).

XML structure
<AP>
<ContainerTopology>
<Container>
<ContainerName></ContainerName>
<PoePort></PoePort>
<PoeStatus></PoeStatus>
</Container>
</ContainerTopology>
</AP>

Table description
Item Description
Feature name AP
Table name ContainerTopology
Table type Multi-instance table
Row name Container
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContainerNa String, case-sensitive.
Container name Index N/A
me Length: 1 to 64 characters.

45
 Column Column Column Data type and
Remarks
name description type restrictions
Port on the
PoePort Index Unsigned short. See AP/APDB/.
container
Boolean:
PoeStatus PoE port status N/A • true—Enable N/A
• false—Disable

AP/Container
This table contains information about containers.

XML structure
<AP>
<Container>
<AP>
<Name></Name>
<Model></Model>
<CfgMacAddress></CfgMacAddress>
</AP>
</Container>
</AP>

Table description
Item Description
Feature name AP
Table name Container
Table type Multi-instance table
Row name AP
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name Index N/A
Length: 1 to 64 characters.
String, case-insensitive.
Model AP model name N/A N/A
Length: 1 to 63 characters.

46
Column Column Column Data type and
Remarks
name description type restrictions
Six groups of two
CfgMacAddr Configured AP Example:
N/A hexadecimal digits,
ess MAC address 00-0c-af-e3-5d-c0.
hyphen-separated.

47
Contents
AP ································································································1
AP/APSummary ························································································································ 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
AP/GlobalCfg ···························································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 8
AP/ManualAP ························································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 11
Columns ·························································································································· 11
AP/APRunningCfg···················································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
AP/RunAP ······························································································································ 15
XML structure ··················································································································· 15
Table description ··············································································································· 16
Columns ·························································································································· 17
AP/APHistory ·························································································································· 19
XML structure ··················································································································· 19
Table description ··············································································································· 19
Columns ·························································································································· 20
AP/RadioOfManualAP··············································································································· 20
XML structure ··················································································································· 20
Table description ··············································································································· 21
Columns ·························································································································· 21
AP/RadioRunningCfg ················································································································ 26
XML structure ··················································································································· 26
Table description ··············································································································· 26
Columns ·························································································································· 27
AP/Radio11n ·························································································································· 31
XML structure ··················································································································· 31
Table description ··············································································································· 32
Columns ·························································································································· 32
AP/Radio11ac ························································································································· 34
XML structure ··················································································································· 34
Table description ··············································································································· 34
Columns ·························································································································· 34
AP/RadioRunningCfg11n ··········································································································· 35
XML structure ··················································································································· 35
Table description ··············································································································· 36
Columns ·························································································································· 36
AP/RadioRunningCfg11ac ········································································································· 37
XML structure ··················································································································· 37
Table description ··············································································································· 38
Columns ·························································································································· 38
AP/RadioOfRunAP ··················································································································· 39
XML structure ··················································································································· 39
Table description ··············································································································· 39
Columns ·························································································································· 40
AP/PrvsOfManualAP ················································································································ 41
XML structure ··················································································································· 41
Table description ··············································································································· 41
Columns ·························································································································· 42

1
AP/PrvsOfManualAPACIPv4 ······································································································ 43
XML structure ··················································································································· 43
Table description ··············································································································· 43
Columns ·························································································································· 44
AP/PrvsOfManualAPACIPv6 ······································································································ 44
XML structure ··················································································································· 44
Table description ··············································································································· 44
Columns ·························································································································· 45
AP/APDB ······························································································································· 45
XML structure ··················································································································· 45
Table description ··············································································································· 45
Columns ·························································································································· 46
AP/APDBVersion ····················································································································· 46
XML structure ··················································································································· 46
Table description ··············································································································· 46
Columns ·························································································································· 47
AP/RadioDB ··························································································································· 47
XML structure ··················································································································· 47
Table description ··············································································································· 48
Columns ·························································································································· 48
AP/RegionDB ·························································································································· 51
XML structure ··················································································································· 51
Table description ··············································································································· 51
Columns ·························································································································· 51
AP/AntennaDB ························································································································ 52
XML structure ··················································································································· 52
Table description ··············································································································· 52
Columns ·························································································································· 52
AP/ChannelTypeMap ················································································································ 53
XML structure ··················································································································· 53
Table description ··············································································································· 53
Columns ·························································································································· 53
AP/PowerIndex ······················································································································· 56
XML structure ··················································································································· 56
Table description ··············································································································· 56
Columns ·························································································································· 57
AP/ChannelDB ························································································································ 58
XML structure ··················································································································· 58
Table description ··············································································································· 59
Columns ·························································································································· 59
AP/PowerDB ··························································································································· 61
XML structure ··················································································································· 61
Table description ··············································································································· 61
Columns ·························································································································· 62
AP/ChannelReport ··················································································································· 64
XML structure ··················································································································· 64
Table description ··············································································································· 65
Columns ·························································································································· 65
AP/NeighborAPReport ·············································································································· 66
XML structure ··················································································································· 66
Table description ··············································································································· 66
Columns ·························································································································· 67
AP/EdcaRadio ························································································································· 67
XML structure ··················································································································· 67
Table description ··············································································································· 68
Columns ·························································································································· 68
AP/RadioWmm ························································································································ 69
XML structure ··················································································································· 69
Table description ··············································································································· 69
Columns ·························································································································· 70
AP/APGroup ··························································································································· 70
XML structure ··················································································································· 70

2
 Table description ··············································································································· 71
Columns ·························································································································· 71
AP/APGroupMACRule ·············································································································· 72
XML structure ··················································································································· 73
Table description ··············································································································· 73
Columns ·························································································································· 73
AP/APGroupSerialIDRule ·········································································································· 73
XML structure ··················································································································· 73
Table description ··············································································································· 74
Columns ·························································································································· 74
AP/APGroupNameRule ············································································································· 74
XML structure ··················································································································· 74
Table description ··············································································································· 74
Columns ·························································································································· 75
AP/APGroupIPv4Rule ··············································································································· 75
XML structure ··················································································································· 75
Table description ··············································································································· 75
Columns ·························································································································· 75
AP/APGroupIPv6Rule ··············································································································· 76
XML structure ··················································································································· 76
Table description ··············································································································· 76
Columns ·························································································································· 76
AP/APGroupModel ··················································································································· 77
XML structure ··················································································································· 77
Table description ··············································································································· 77
Columns ·························································································································· 77
AP/APGroupRadio ··················································································································· 77
XML structure ··················································································································· 77
Table description ··············································································································· 78
Columns ·························································································································· 79
AP/APGroupRadio11n ·············································································································· 83
XML structure ··················································································································· 83
Table description ··············································································································· 84
Columns ·························································································································· 84
AP/APGroupRadio11ac ············································································································· 85
XML structure ··················································································································· 85
Table description ··············································································································· 86
Columns ·························································································································· 86
AP/APGroupPrvs ····················································································································· 87
XML structure ··················································································································· 87
Table description ··············································································································· 87
Columns ·························································································································· 88
AP/APGroupPrvsACIPv4 ··········································································································· 88
XML structure ··················································································································· 88
Table description ··············································································································· 88
Columns ·························································································································· 89
AP/APGroupPrvsACIPv6 ··········································································································· 89
XML structure ··················································································································· 89
Table description ··············································································································· 89
Columns ·························································································································· 90
AP/APListOfGroup ··················································································································· 90
XML structure ··················································································································· 90
Table description ··············································································································· 90
Columns ·························································································································· 90
AP/Location ···························································································································· 91
XML structure ··················································································································· 91
Table description ··············································································································· 91
Columns ·························································································································· 91
AP/APAuthentication ················································································································ 91
XML structure ··················································································································· 91
Table description ··············································································································· 92
Columns ·························································································································· 92

3
AP/HistorySummary ················································································································· 92
XML structure ··················································································································· 92
Table description ··············································································································· 93
Columns ·························································································································· 93
AP/AllAP ································································································································ 94
XML structure ··················································································································· 94
Table description ··············································································································· 94
Columns ·························································································································· 95
AP/LocalACDB ························································································································ 96
XML structure ··················································································································· 96
Table description ··············································································································· 96
Columns ·························································································································· 96
AP/LocalAC ···························································································································· 96
XML structure ··················································································································· 97
Table description ··············································································································· 97
Columns ·························································································································· 97
AP/ContainerTopology ·············································································································· 98
XML structure ··················································································································· 98
Table description ··············································································································· 99
Columns ·························································································································· 99
AP/Container ·························································································································· 99
XML structure ··················································································································· 99
Table description ············································································································· 100
Columns ························································································································ 100

4
AP
AP/APSummary
This table contains AP global statistics.

XML structure
<AP>
<APSummary>
<ManualApNum></ManualApNum>
<RunApNum></RunApNum>
<OfflineApNum></OfflineApNum>
<UnhealthyApNum></UnhealthyApNum>
<ApGroupNum></ApGroupNum>
<LocationNum></LocationNum>
<NorthIfOutPkt></NorthIfOutPkt>
<NorthIfOutByte></NorthIfOutByte>
<NorthIfInPkt></NorthIfInPkt>
<NorthIfInByte></NorthIfInByte>
<Is5gRadioNum></Is5gRadioNum>
<Is2gRadioNum></Is2gRadioNum>
<AccessModeNum></AccessModeNum>
<SensorModeNum></SensorModeNum>
<HybirdModeNum></HybirdModeNum>
<ChannelBusyLower10PctNum></ChannelBusy10PctNum>
<ChannelBusy10PctNum></ChannelBusy10PctNum>
<ChannelBusy20PctNum></ChannelBusy20PctNum>
<ChannelBusy30PctNum></ChannelBusy30PctNum>
<ChannelBusy40PctNum></ChannelBusy40PctNum>
<ChannelBusy50PctNum></ChannelBusy50PctNum>
<ChannelBusy60PctNum></ChannelBusy60PctNum>
<ChannelBusy70PctNum></ChannelBusy70PctNum>
<ChannelBusy80PctNum></ChannelBusy80PctNum>
<ChannelBusy90PctNum></ChannelBusy90PctNum>
<NoiseFloorLower105Num></NoiseFloorLower105Num>
<NoiseFloor100Num></NoiseFloor100Num>
<NoiseFloor95Num></NoiseFloor95Num>
<NoiseFloor90Num></NoiseFloor90Num>
<NoiseFloor85Num></NoiseFloor85Num>
<NoiseFloor80Num></NoiseFloor80Num>
<NoiseFloor75Num></NoiseFloor75Num>
<NoiseFloor70Num></NoiseFloor70Num>
<NoiseFloorUpper70Num></NoiseFloorUpper70Num>
<Dot11InterfLower10PctNum></Dot11InterfLower10PctNum>
<Dot11Interf10PctNum></Dot11Interf10PctNum>
<Dot11Interf20PctNum></Dot11Interf20PctNum>

1
 <Dot11Interf30PctNum></Dot11Interf30PctNum>
<Dot11Interf40PctNum></Dot11Interf40PctNum>
<Dot11Interf50PctNum></Dot11Interf50PctNum>
<Dot11Interf60PctNum></Dot11Interf60PctNum>
<Dot11Interf70PctNum></Dot11Interf70PctNum>
<Dot11Interf80PctNum></Dot11Interf80PctNum>
<Dot11Interf90PctNum></Dot11Interf90PctNum>
<NonDot11InterfLower10PctNum></NoneDot11InterfLower10PctNum>
<NonDot11Interf10PctNum></NonDot11Interf10PctNum>
<NonDot11Interf20PctNum></NonDot11Interf20PctNum>
<NonDot11Interf30PctNum></NonDot11Interf30PctNum>
<NonDot11Interf40PctNum></NonDot11Interf40PctNum>
<NonDot11Interf50PctNum></NonDot11Interf50PctNum>
<NonDot11Interf60PctNum></NonDot11Interf60PctNum>
<NonDot11Interf70PctNum></NonDot11Interf70PctNum>
<NonDot11Interf80PctNum></NonDot11Interf80PctNum>
<NonDot11Interf90PctNum></NonDot11Interf90PctNum>
<RunSPMNum></RunSPMNum>
<OfflineSPMNum></OfflineSPMNum>
<MaxRunApNum></MaxRunApNum>
<MaxPersistentApNum></MaxPersistentApNum> </APSummary>
</AP>

Table description
Item Description
Feature name AP
Table name APSummary
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Data type and
Column name Column type
description restrictions
Number of manual Unsigned integer.
ManualApNum N/A
APs Value range: 0 to 65535.

Number of running Unsigned integer.

RunApNum N/A
APs Value range: 0 to 65535.
Unsigned integer.
OfflineApNum Number of offline APs N/A
Value range: 0 to 65535.

Number of Unhealthy Unsigned integer.

UnhealthyApNum N/A
APs Value range: 0 to 65535.

2
 Column Data type and
Column name Column type
description restrictions
Unsigned integer.
ApGroupNum Number of AP groups N/A
Value range: 0 to 65535.
Unsigned integer.
LocationNum Number of locations N/A
Value range: 0 to 65535.
Packets count of Unsigned integer.
northbound interface
NorthIfOutPkt N/A Value range: 0 to
with outbound
direction. 4294967295.

Throughput statistics Unsigned integer.

of northbound
NorthIfOutByte N/A Value range: 0 to
interface with
outbound direction. 4294967295.

Packets count of Unsigned integer.

NorthIfInPkt northbound interface N/A Value range: 0 to
with inbound direction. 4294967295.
Throughput statistics Unsigned integer.
of northbound Value range: 0 to
NorthIfInByte N/A
interface with inbound 4294967295.
direction.
Unsigned integer.
Number of radios
Is5gRadioNum N/A Value range: 0 to
which is 5GHz.
4294967295.
Unsigned integer.
Number of radios
Is2.4gRadioNum N/A Value range: 0 to
which is 2.4GHz.
4294967295.
Unsigned integer.
Number of radios in
AccessModeNum N/A Value range: 0 to
access mode.
4294967295.
Unsigned integer.
Number of radios in
SensorModeNum N/A Value range: 0 to
sensor mode.
4294967295.
Unsigned integer.
Number of radios in
HybirdModeNum N/A Value range: 0 to
hybird mode.
4294967295.
Number of radios Unsigned integer.
ChannelBusyLower10PctNum which channel busy is N/A Value range: 0 to
lower than 10% 4294967295.
Number of radios Unsigned integer.
which channel busy is
ChannelBusy10PctNum N/A Value range: 0 to
between 10% and
20% 4294967295.

Number of radios Unsigned integer.

which channel busy is
ChannelBusy20PctNum N/A Value range: 0 to
between 20% and
30% 4294967295.

Number of radios Unsigned integer.

ChannelBusy30PctNum which channel busy is N/A Value range: 0 to
between 30% and 4294967295.

3
 Column Data type and
Column name Column type
description restrictions
40%
Number of radios Unsigned integer.
which channel busy is
ChannelBusy40PctNum N/A Value range: 0 to
between 40% and
50% 4294967295.

Number of radios Unsigned integer.

which channel busy is
ChannelBusy50PctNum N/A Value range: 0 to
between 50% and
60% 4294967295.

Number of radios Unsigned integer.

which channel busy is
ChannelBusy60PctNum N/A Value range: 0 to
between 60% and
70% 4294967295.

Number of radios Unsigned integer.

which channel busy is
ChannelBusy70PctNum N/A Value range: 0 to
between 70% and
80% 4294967295.

Number of radios Unsigned integer.

which channel busy is
ChannelBusy80PctNum N/A Value range: 0 to
between 80% and
90% 4294967295.

Number of radios Unsigned integer.

ChannelBusy90PctNum which channel busy is N/A Value range: 0 to
upper than 90% 4294967295.
Number of radios Unsigned integer.
NoiseFloorLower105Num which noise floor is N/A Value range: 0 to
lower than 105dbm 4294967295.
Number of radios Unsigned integer.
which noise floor is
NoiseFloor100Num N/A Value range: 0 to
between 100dbm and
105dbm 4294967295.

Number of radios Unsigned integer.

which noise floor is
NoiseFloor95Num N/A Value range: 0 to
between 95dbm and
100dbm 4294967295.

Number of radios Unsigned integer.

which noise floor is
NoiseFloor90Num N/A Value range: 0 to
between 90dbm and
95dbm 4294967295.

Number of radios Unsigned integer.

which noise floor is
NoiseFloor85Num N/A Value range: 0 to
between 85dbm and
90dbm 4294967295.

Number of radios Unsigned integer.

which noise floor is
NoiseFloor80Num N/A Value range: 0 to
between 80dbm and
85dbm 4294967295.

Number of radios Unsigned integer.

which noise floor is
NoiseFloor75Num N/A Value range: 0 to
between 75dbm and
80dbm 4294967295.

4
 Column Data type and
Column name Column type
description restrictions
Number of radios Unsigned integer.
which noise floor is
NoiseFloor70Num N/A Value range: 0 to
between 70dbm and
75dbm 4294967295.

Number of radios Unsigned integer.

NoiseFloorUpper70Num which noise floor is N/A Value range: 0 to
upper than 70dbm 4294967295.
Number of radios Unsigned integer.
which 802.11
Dot11InterfLower10PctNum N/A Value range: 0 to
interference is lower
than 10% 4294967295.

Number of radios
which 802.11 Unsigned integer.
Dot11Interf10PctNum interference is N/A Value range: 0 to
between 10% and 4294967295.
20%
Number of radios
which 802.11 Unsigned integer.
Dot11Interf20PctNum interference is N/A Value range: 0 to
between 20% and 4294967295.
30%
Number of radios
which 802.11 Unsigned integer.
Dot11Interf30PctNum interference is N/A Value range: 0 to
between 30% and 4294967295.
40%
Number of radios
which 802.11 Unsigned integer.
Dot11Interf40PctNum interference is N/A Value range: 0 to
between 40% and 4294967295.
50%
Number of radios
which 802.11 Unsigned integer.
Dot11Interf50PctNum interference is N/A Value range: 0 to
between 50% and 4294967295.
60%
Number of radios
which802.11 Unsigned integer.
Dot11Interf60PctNum interference is N/A Value range: 0 to
between 60% and 4294967295.
70%
Number of radios
which802.11 Unsigned integer.
Dot11Interf70PctNum interference is N/A Value range: 0 to
between 70% and 4294967295.
80%
Number of radios
which802.11 Unsigned integer.
Dot11Interf80PctNum interference is N/A Value range: 0 to
between 80% and 4294967295.
90%
Number of radios Unsigned integer.
Dot11Interf90PctNum which802.11 N/A
interference is upper Value range: 0 to

5
 Column Data type and
Column name Column type
description restrictions
than 90% 4294967295.
Number of radios Unsigned integer.
which non-802.11
NonDot11InterfLower10PctNum N/A Value range: 0 to
interference is lower
than 10% 4294967295.

Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf10PctNum interference is N/A Value range: 0 to
between 10% and 4294967295.
20%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf20PctNum interference is N/A Value range: 0 to
between 10% and 4294967295.
20%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf30PctNum interference is N/A Value range: 0 to
between 20% and 4294967295.
30%
NonDot11Interf40PctNum Number of radios Unsigned integer.
which non-802.11 Value range: 0 to
interference is N/A 4294967295.
between 30% and
40%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf50PctNum interference is N/A Value range: 0 to
between 50% and 4294967295.
60%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf60PctNum interference is N/A Value range: 0 to
between 60% and 4294967295.
70%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf70PctNum interference is N/A Value range: 0 to
between 70% and 4294967295.
80%
Number of radios
which non-802.11 Unsigned integer.
NonDot11Interf80PctNum interference is N/A Value range: 0 to
between 80% and 4294967295.
90%
Number of radios Unsigned integer.
which non-802.11
NonDot11Interf90PctNum N/A Value range: 0 to
interference is upper
than 90% 4294967295.

Number of running Unsigned integer.

RunSPMNum SPMs N/A
Value range: 0 to 65535.
Number of offline Unsigned integer.
OfflineSPMNum SPMs N/A
Value range: 0 to 65535.

6
 Column Data type and
Column name Column type
description restrictions
Max number of Unsigned integer.
MaxRunApNum running APs N/A
Value range: 0 to 65535.
Max number of Unsigned integer.
MaxPersistentApNum persistent APs N/A
Value range: 0 to 65535.

AP/GlobalCfg
This table contains the informations of global.

XML structure
<AP>
<GlobalCfg>
<AutoAp></AutoAp>
<AutoPersistent></AutoPersistent>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<TunnelEncryption></TunnelEncryption>
<MainAPName></MainAPName>
<Gps></Gps>
<LocalAC></LocalAC>
<CentralACIPv4></CentralACIPv4>
<CentralACIPv6></CentralACIPv6>
<ContralAddress></ContralAddress>
<ControlAddressIPv4></ControlAddressIPv4>
<ControlAddressIPv6></ControlAddressIPv6>
</GlobalCfg>
</AP>

Table description
Item Description
Feature name AP

7
 Item Description
Table name GlobalCfg
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Whether an AP Boolean:
can connect the • true—Support. N/A
AutoAp AC without N/A
creating a manual • false—Not support.
AP. Default value is false.

When an auto AP Boolean:

connects the AC , • true—Support. N/A
AutoPersist
whether convert N/A
ent
the AP to manual • false—Not support.
AP automatically. Default value is false.

Region code of Conform to ISO 3166

RegionCode N/A Unsigned short.
AP group. stantard.
Whether the Boolean:
region code of the • true—Support. N/A
RegionLock AC is locked. N/A
• false—Not support.
Default value is false.
AP connection Unsigned short.
Priority priority N/A N/A
Value range: 0 to 7.
Whether the AP in
this group will be Boolean:
forced to switch
Preempt N/A • true: Switch N/A
the backup tunnel
to active by • false: Not switch
priority.
The transmit Unsigned short.
EchoInterval interval of tunnel N/A Value range: 0, 5 to 255. N/A
echo messages.
Unit: seconds
The allowed
maximum number
of echo messges
which are not Unsigned short.
EchoCount N/A N/A
received. If the Value range: 1 to 20.
count is reached,
the tunnel will be
down.
The interval to Unsigned short.
RetransInter retransmit a N/A Value range: 1 to 30. N/A
val request message.
Unit: seconds

8
Column Column Column Data type and
Remarks
name description type restrictions
The allowed
maximum number
of retransmission Unsigned short.
RetransCou
attempts. If the N/A Value range: 1 to 20. N/A
nt
count is reached, Unit: seconds.
the tunnel will be
down.
The interval of AP
sending the Unsigned short.
StatisInterva
statistics N/A Value range: 0 to 240. N/A
l
informations to Unit: seconds.
AC.
Whether the AC
will upgrade AP’s Boolean:
FirmwareUp firmware
grade automatically if the
N/A • true: Enable N/A
software is • false: Disable
mismatch.
BackupACI The IPv4 backup String, dotted decimal
N/A Example: 1.1.1.1.
Pv4 AC address. notation.
BackupACI The IPv6 backup Hexadecimal string,
N/A Example: 1:1::1:1.
Pv6 AC address. colon-separated.
Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable

MainAPNam String, case-sensitive.

AP name. N/A Only for FatAP Type.
e Length: 1 to 64 characters.
Boolean:
Gps Gps. N/A • true—Support. Only for FatAP Type
• false—Not support.
Boolean:
Whether to enable
LocalAC N/A • true—Enable. Only for Local-ac Type
Local ac.
• false—Disable.

CentralACIP The IPv4 Central String, dotted decimal Example: 1.1.1.1.

N/A
v4 AC address. notation. Only for Local-ac Type

CentralACIP The IPv6 Central Hexadecimal string, Example: 1:1::1:1.

N/A
v6 AC address. colon-separated. Only for Local-ac Type

CAPWAP control Boolean:

ControlAddr
ess
address N/A • true—Enable. N/A
configuration. • false—Disable.
Specify an AC
ControlAddr String, dotted decimal
IPv4 address for N/A Example: 1.1.1.1.
essIPv4 notation.
AC rediscovery
Specify an AC
ControlAddr Hexadecimal string,
IPv4 address for N/A Example: 1:1::1:1.
essIPv6 colon-separated.
AC rediscovery

9
AP/ManualAP
This table contains information of manual AP.

XML structure
<AP>
<ManualAP>
<AP>
<Name></Name>
<Model></Model>
<CfgSerialID></CfgSerialID>
<CfgMacAddress></CfgMacAddress>
<RadioNum></RadioNum>
<Status></Status>
<GroupName></GroupName>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
<OfflineTime></OfflineTime>
<OfflineMoment></OfflineMoment>
<ControlAddress></ControlAddress>
<ControlAddressIPv4></ControlAddressIPv4>
<ControlAddressIPv6></ControlAddressIPv6>
<ProvisionAutoUpgrade></ProvisionAutoUpgrade>
<ProvisionAutoRecover></ProvisionAutoRecover>
<ModelType></ModelType>
<LedMode></LedMode>
</AP>
</ManualAP>
</AP>

10
Table description
Item Description
Feature name AP
Table name ManualAP
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name. Index N/A
Length: 1 to 64 characters.
String, case-insensitive.
Model AP model name. N/A N/A
Length: 1 to 63 characters.
String, uppercase.
Configured AP
CfgSerialID N/A Length: 1 to 127 N/A
serial ID.
characters.
Six groups of two
CfgMacAddr Configured AP Example:
N/A hexadecimal digits,
ess MAC address. 00-0c-af-e3-5d-c0.
hyphen-separated.

Number of the Unsigned short.

RadioNum N/A N/A
radio. Value range: 1 to 4.
Enumeration:
• 1—Online
AP associated
Status
status.
N/A • 2—Offline N/A
• 3—Image
downloading
The name of AP String, lowercase.
GroupName group which the N/A N/A
AP belongs to. Length: 1 to 31 characters.

Region code of Conform to ISO 3166

RegionCode N/A Unsigned short.
AP. stantard.

Whether the Boolean:

RegionLock region code of the N/A • true—Support. N/A
AP is locked. • false—Not support.

AP connection Unsigned short.

Priority N/A N/A
priority. Value range: 0 to 7.
Whether the AP
Boolean:
will be forced to
Preempt switch the backup N/A • true: Switch N/A
tunnel to active by
• false: Not switch
priority.

11
Column Column Column Data type and
Remarks
name description type restrictions
The transmit Unsigned short.
EchoInterval interval of tunnel N/A Value range: 0, 5 to 255. N/A
echo messages. Unit: seconds
The allowed
maximum number
of echo messges
which are not Unsigned short.
EchoCount N/A N/A
received. If the Value range: 1 to 20.
count is reached,
the tunnel will be
down.
The interval to Unsigned short.
RetransInter retransmit a N/A Value range: 1 to 30. N/A
val request message.
Unit: seconds.
The allowed
maximum number
of retransmission Unsigned short.
RetransCou
attempts. If the N/A Value range: 1 to 20. N/A
nt
count is reached, Unit: seconds.
the tunnel will be
down.
Unsigned short.
Value range: 0 to 240.
StatisInterva
RetransCount N/A Unit: seconds N/A
l
Default value is 50
seconds.
Whether the AC
will upgrade AP’s Boolean:
FirmwareUp firmware
grade automatically if the
N/A • true—Enable N/A
software is • false—Disable
mismatch.
BackupACI The IPv4 backup String, dotted decimal
N/A Example: 1.1.1.1.
Pv4 AC address. notation.
BackupACI The IPv6 backup Hexadecimal string,
N/A Example: 1:1::1:1.
Pv6 AC address. colon-separated.
Which location the String, lowercase.
LocationNa
AP group belongs N/A Length: 1 to 31 characters. N/A
me
to.

The description of String,

Description N/A N/A
AP. Length: 1 to 64 cahracters.
Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable
Unsigned integer.
The time since the Value range: 0 to
OfflineTime N/A N/A
AP online. 4294967295.
Unit: Second

12
 Column Column Column Data type and
Remarks
name description type restrictions
DateTime.
OfflineMom The time of the AP Example:
N/A Format:
ent offline in last time. 2014-05-07T09:35:07
YYYY-MM-DDTHH:MM:SS

CAPWAP control Boolean:

ControlAddr
ess
address N/A • true—Enable. N/A
configuration • false—Disable.
Specify an AC Example: 1.1.1.1.
ControlAddr String, dotted decimal
IPv4 address for N/A
essIPv4 notation.
AC rediscovery
Specify an AC
ControlAddr Hexadecimal string,
IPv4 address for N/A Example: 1:1::1:1.
essIPv6 colon-separated.
AC rediscovery

Whether to enable Boolean:

ProvisionAut
oUpgrade
provision N/A • true—Enable. N/A
auto-upgrade • false—Disable.

Whether to enable Boolean:

ProvisionAut
oRecover
provision N/A • true—Enable. N/A
auto-recover • false—Disable.
ModelType Model type N/A Enumeration: When the value is 3,
some commands can not
• 1—Normal.
be configurated.
• 2—WT.
• 3—WTU.
Enumeration:
• 0—Normal.
LedMode LED mode N/A • 1—Quiet. N/A
• 2—Awake.
• 3—Always-on.

AP/APRunningCfg
This table contains information of AP running configurations.

XML structure
<AP>
<APRunningCfg>
<AP>
<Name></Name>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>

13
 <RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
</AP>
</APRunningCfg>
</AP>

Table description
Item Description
Feature name AP
Table name APRunningCfg
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name. Index N/A
Length: 1 to 64 characters.
Region code of Conform to ISO 3166
RegionCode N/A Unsigned short.
AP. stantard.
Whether the Boolean:
RegionLock region code of the N/A • true—Support. N/A
AP is locked.
• false—Not support.

AP connection Unsigned short.

Priority N/A N/A
priority. Value range: 0 to 7.
Whether the AP
Boolean:
will be forced to
Preempt switch the backup N/A • true: Switch N/A
tunnel to active by
• false: Not switch
priority.
The transmit Unsigned short.
EchoInterval interval of tunnel N/A Value range: 0, 5 to 255. N/A
echo messages.
Unit: seconds

14
 Column Column Column Data type and
Remarks
name description type restrictions
The allowed
maximum number
of echo messges
which are not Unsigned short.
EchoCount N/A N/A
received. If the Value range: 1 to 20.
count is reached,
the tunnel will be
down.
The interval to Unsigned short.
RetransInter retransmit a N/A Value range: 1 to 30. N/A
val request message.
Unit: seconds.
The allowed
maximum number
of retransmission Unsigned short.
RetransCou
attempts. If the N/A Value range: 1 to 20. N/A
nt
count is reached, Unit: seconds.
the tunnel will be
down.
The interval of AP
sending the Unsigned short.
StatisInterva
statistics N/A Value range: 0 to 240. N/A
l
informations to Unit: seconds.
AC.
Whether the AC
will upgrade AP’s Boolean:
FirmwareUp firmware
grade automatically if the
N/A • true—Enable N/A
software is • false—Disable
mismatch.
BackupACI The IPv4 backup String, dotted decimal
N/A Example: 1.1.1.1.
Pv4 AC address. notation.
BackupACI The IPv6 backup Hexadecimal string,
N/A Example: 1:1::1:1.
Pv6 AC address. colon-separated.
Which location the String, lowercase.
LocationNa
AP group belongs N/A Length: 1 to 31 characters. N/A
me
to.

The description of String,

Description N/A N/A
AP. Length: 1 to 64 cahracters.
Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable

AP/RunAP
This table contains the information of the running AP.

XML structure
<AP>

15
 <RunAP>
<AP>
<Name></Name>
<Model></Model>
<SerialID></SerialID>
<Type></Type>
<MacAddress></MacAddress>
<RadioNum></RadioNum>
<Status></Status>
<Ipv4Address></Ipv4Address>
<Ipv6Address></Ipv6Address>
<PortNumber></PortNumber>
<GroupName></GroupName>
<OnlineTime></OnlineTime>
<HWVer><HWVer>
<SWVer><SWVer>
<BWVer><BWVer>
<TransCtrlPkt></TransCtrlPkt>
<RecvCtrlPkt></RecvCtrlPkt>
<TransDataPkt></TransDataPkt>
<RecvDataPkt></RecvDataPkt>
<EchoReqCnt></EchoReqCnt>
<EchoRespLossCnt></EchoRespLossCnt>
<DiscoveryType></DiscoveryType>
<ConfigFailCnt></ConfigFailCnt>
<LastFailReason></LastFailReason>
<LastRebootReason></LastRebootReason>
<TunnelDownReason></TunnelDownReason>
<ConnectionType></ConnectionType>
<PeerACIPv4Address><PeerACIPv4Address>
<PeerACIPv6Address><PeerACIPv6Address>
<LocationName></LocationName>
<AuthenticatedFlag></AuthenticatedFlag>
<LocalACName><LocalACName>
</AP>
</RunAP>
</AP>

Table description
Item Description
Feature name AP
Table name RunAP
Table type Multi-instance table
Row name AP
Restrictions None

16
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name. Index N/A
Length: 1 to 64 characters.
String, case-insensitive.
Model AP model name. N/A N/A
Length: 1 to 63 characters.
String, uppercase.
SerialID AP serial ID. N/A Length: 1 to 127 N/A
characters.
Enumeration:
Type AP type. N/A • 1—auto N/A
• 2—manual
N/A Six groups of two
Example:
MacAddress AP MAC address. hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.
Number of the Unsigned short.
RadioNum radio. N/A N/A
Value range: 1 to 4.
Enumeration:
AP associated • 1—Online
Status N/A N/A
status.
• 3—Image
downloading
Example: 1.1.1.1.
String, dotted decimal This column is
Ipv4Address AP IPv4 address. N/A
notation. unavailable when the AP
uses an IPv6 address.
Example: 1:1::1:1.
Hexadecimal string, This column is
Ipv6Address AP IPv6 address. N/A
colon-separated. unavailable when the AP
uses an IPv4 address.
Unsigned integer.
PortNumber AP port number. N/A N/A
Value range: 1 to 65535.
The name of AP String, lowercase.
GroupName group which the N/A Length: 1 to 31 characters. N/A
AP belongs to.
Unsigned integer.
AP online Value range: 0 to
OnlineTime N/A N/A
duration. 4294967295.
Unit: Second
Enumeration:
• 1—Ver.A
The version of AP • 2—Ver.B
HWVer N/A N/A
hardware. • 3—Ver.C
• 4—Ver.D
• 5—Ver.E

17
Column Column Column Data type and
Remarks
name description type restrictions
The version of AP String.
SWVer software. N/A N/A
Length: 1 to 31 characters.
The version of AP String.
BWVer bootrom. N/A N/A
Length: 1 to 31 characters.
Count of Unsigned integer.
TransCtrlPkt transmitted control N/A Value range: 0 to N/A
packets. 4294967295.
Unsigned integer.
Count of received
RecvCtrlPkt N/A Value range: 0 to N/A
control packets.
4294967295.
Count of Unsigned integer.
TransDataP transmitted data N/A Value range: 0 to N/A
kt packets. 4294967295.
Unsigned integer.
RecvDataPk Count of received
N/A Value range: 0 to N/A
t data packets.
4294967295.
Unsigned integer.
EchoReqCn Count of echo
N/A Value range: 0 to N/A
t request packets.
4294967295.
Unsigned integer.
EchoRespL Count of lost echo
N/A Value range: 0 to N/A
ossCnt response packets.
4294967295.
Enumeration:
• 1—Unknown
DiscoveryTy By which type the • 2—DHCP
N/A N/A
pe AP find the AC.
• 3—Static
Configuration
• 4—DNS
Unsigned integer.
ConfigFailC Count of failed
N/A Value range: 0 to N/A
nt Configuration.
4294967295.
The cause of
synchronizing String.
LastFailRea
configurations to N/A N/A
son Length: 1 to 31 characters.
the AP failed in
last time.
The cause of the String.
LastReboot
AP rebooting in N/A Length: 1 to 31 characters. N/A
Reason
last time.
The cause of the String.
TunnelDown
tunnel down in last N/A Length: 1 to 31 characters. N/A
Reason
time.
Enumeration:
Connection The connection
N/A • 1—Active N/A
Type type of tunnel.
• 2—Standby

18
 Column Column Column Data type and
Remarks
name description type restrictions
Example: 1.1.1.1.
The IPv4 address
PeerACIPv4 String, dotted decimal This column is
of peer AC that AP N/A
Address notation. unavailable when the AP
is connecting to.
uses an IPv6 address.
Example: 1:1::1:1.
The IPv6 address
PeerACIPv6 Hexadecimal string, This column is
of peer AC that AP N/A
Address colon-separated. unavailable when the AP
is connecting to.
uses an IPv4 address.
Which location the String, lowercase.
LocationNa
AP group belongs N/A Length: 1 to 31 characters. N/A
me
to.
Boolean:
Whether the When AP type is manual
Authenticate
dFlag
auto-ap is N/A • Enable AP, this column is
authenticated. invalid.
• Disable

LocalACNa String, case-sensitive.

Local-ac name. N/A N/A
me Length: 1 to 64 characters.

AP/APHistory
This table contains the information of the AP history.

XML structure
<AP>
<APHistory>
<AP>
<Name></Name>
<LatestIPV4Address></LatestIPV4Address>
<LatestIPV6Address></LatestIPV6Address>
<ConnectCnt></ConnectCnt>
</AP>
</APHistory>
</AP>

Table description
Item Description
Feature name AP
Table name APHistory
Table type Multi-instance table
Row name AP
Restrictions None

19
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name. Index N/A
Length: 1 to 64 characters.
Example: 1.1.1.1.
The latest IPv4
LatestIPV4A String, dotted decimal This column is
address that AP N/A
ddress notation. unavailable when the AP
used.
uses an IPv6 address.
Example: 1:1::1:1.
The latest IPv6
LatestIPV6A Hexadecimal string, This column is
address that AP N/A
ddress colon-separated. unavailable when the AP
used.
uses an IPv4 address.

The count that the Unsigned integer.

ConnectCnt AP connected the N/A Value range: 0 to N/A
AC. 4294967295.

AP/RadioOfManualAP
This table contains radio information of manual AP.

XML structure
<AP>
<RadioOfManualAP>
<Radio>
<ApName></ApName>
<RadioID></RadioID>
<Mode></Mode>
<SupportDot11B></SupportDot11B>
<SupportDot11A></SupportDot11A>
<SupportDot11G></SupportDot11G>
<SupportDot11GN></SupportDot11GN>
<SupportDot11AN></SupportDot11AN>
<SupportDot11GAC></SupportDot11GAC>
<SupportDot11AC></SupportDot11AC>
<Bandwidth></Bandwidth>
<Spectrum></Spectrum>
<Status></Status>
<RateMulticast></RateMulticast>
<RateMandatory></RateMandatory>
<RateSupported></RateSupported>
<RateDisabled></RateDisabled>
<Preamble></Preamble>
<BeaconInterval></BeaconInterval>
<PowerLock></PowerLock>

20
 <ChannelAutoLock></ChannelAutoLock>
<Distance></Distance>
<MaxRxDuration></MaxRxDuration>
<FragmentThreshold></FragmentThreshold>
<LongRetryThreshold></LongRetryThreshold>
<ProtectionThreshold></ProtectionThreshold>
<ShortRetryThreshold></ShortRetryThreshold>
<CfgChannel></CfgChannel>
<CfgMaxPower></CfgMaxPower>
<ProtectionMode></ProtectionMode>
<ValidChannelNum></ValidChannelNum>
<ValidChannelList></ValidChannelList>
</Radio>
</RadioOfManualAP>
</AP>

Table description
Item Description
Feature name AP
Table name RadioOfManualAP
Table type Multi-instance table
Row name Radio
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode. N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Whether a radio Boolean:
SupportDot1 supports 802.11b
1B
N/A • true—Support. N/A
radio mode
• false—Not support.

21
Column Column Column Data type and
Remarks
name description type restrictions
Whether a radio Boolean:
SupportDot1 supports 802.11a
1A
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports 802.11g
1G
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports
1GN 802.11n(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AN 802.11n(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1GAC 802.11ac(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AC 802.11ac(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth. N/A N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M
Enumeration:
• 1—Support both
Supported radio 5GHz and 2.4GHz
Spectrum N/A N/A
spectrum. • 2—Support 5GHz only
• 3—Support 2.4GHz
only
Enumeration:
• 0—Disable
Status Radio status. N/A N/A
• 1—Enable
• 2—Inherit

22
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
The value can have
• 7—12Mbps multi-selections.
RateMultica
Multicast. N/A • 8—18Mbps List of enumeration,
st separated by comma
• 9—24Mbps
Example: 1, 2.
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
• 13—auto
If this column is not
configured, the multicast
rate will be calculated
automatically.
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
The value can have
• 5—9Mbps multi-selections.
RateMandat
Mandatory rate. N/A • 6—11Mbps List of enumeration,
ory separated by comma
• 7—12Mbps
Example: 1, 2.
• 8—18Mbps
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps

23
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateSupport
Supported rate. N/A • 6—11Mbps rate uses.
ed List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateDisable
Disabled rate. N/A • 6—11Mbps rate uses.
d List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Boolean:
• true—Short. N/A
Preamble Preamble. N/A • false—Long.
The column is only for
2.4GHz radio mode.

Unsigned short.
BeaconInter Beacon Interval The value range is
N/A N/A
val time. 32~8191.
Unit: TU. 1TU = 1024ms
Enumeration:
• 0—Disable
PowerLock Lock the power. N/A N/A
• 1—Enable
• 2—Inherit
Unsigned short.
The distance that
Distance N/A The value range is 1~40. N/A
Radio can cover.
Unit: km(kilometre).

24
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
Max Reveived
MaxRxDurat The value range is
frame duration N/A N/A
ion 500~250000.
time.
Unit: ms(millisecond).
Unsigned short.
The value range is
FragmentTh Fragment
N/A 256~2346.And the value N/A
reshold threshold.
must be an even number.
Unit: byte.
Unsigned short.
LongRetryT Long retry
N/A The value range is 1~15. N/A
hreshold threshold.
Unit: null.
Unsigned short.
ProtectionT ProtectionThresho
N/A The value range is 0~2346. N/A
hreshold ld.
Unit: byte.
Unsigned short.
ShortRetryT ShortRetryThresh
N/A The value range is 1~15. N/A
hreshold old.
Unit: null.
When the value is 15, the
radio automatically
selects an optimal
The value range conforms channel, and then locks
to the channel.
Configured AP/ChannelDB/Supported
CfgChannel N/A When the AC detects
channel number. ChannelList” column.
any radar signals on its
And 15 –auto lock、 channel, it immediately
16-auto unlock. selects another channel
(even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
Value range: 1 to
CfgMaxPow Configured
N/A “AP/PowerDB/ValidMaxPo N/A
er maximum power.
wer”.
Unit: dBm
Enumeration:
ProtectionM
ode
Protection mode. N/A • 1—Rts/Cts. N/A
• 2—Cts To Self

ValidChann Number of the Unsigned integer.

N/A N/A
elNum valid channels Value range: 0 to 32.
Number string.
It is a comma-separated list
ValidChann a list of the valid of valid channels. Example:
N/A
elList channels. The string must not end 1,2,3,4,5,6,7,8,9,10,11
with a comma or hyphen,
or include any whitespace

25
AP/RadioRunningCfg
This table contains radio information of radio running configurations.

XML structure
<AP>
<RadioRunningCfg>
<Radio>
<ApName></ApName>
<RadioID></RadioID>
<Mode></Mode>
<SupportDot11B></SupportDot11B>
<SupportDot11A></SupportDot11A>
<SupportDot11G></ SupportDot11G>
<SupportDot11GN></SupportDot11GN>
<SupportDot11AN></SupportDot11AN>
<SupportDot11GAC></SupportDot11GAC>
<SupportDot11AC></SupportDot11AC>
<Bandwidth></Bandwidth>
<Spectrum></Spectrum>
<Status></Status>
<RateMulticast></RateMulticast>
<RateMandatory></RateMandatory>
<RateSupported></RateSupported>
<RateDisabled></RateDisabled>
<Preamble></Preamble>
<BeaconInterval></BeaconInterval>
<PowerLock></PowerLock>
<Distance></Distance>
<MaxRxDuration></MaxRxDuration>
<FragmentThreshold></FragmentThreshold>
<LongRetryThreshold></LongRetryThreshold>
<ProtectionThreshold></ProtectionThreshold>
<ShortRetryThreshold></ShortRetryThreshold>
<CfgChannel></CfgChannel>
<CfgMaxPower></CfgMaxPower>
</Radio>
</RadioRunningCfg>
</AP>

Table description
Item Description
Feature name AP
Table name RadioRunningCfg

26
 Item Description
Table type Multi-instance table
Row name Radio
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode. N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Whether a radio Boolean:
SupportDot1 supports 802.11b
1B
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports 802.11a
1A
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports 802.11g
1G
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports
1GN 802.11n(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AN 802.11n(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1GAC 802.11ac(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AC 802.11ac(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

27
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth. N/A N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M
Enumeration:
• 1—Support both
Supported radio 5GHz and 2.4GHz
Spectrum N/A N/A
spectrum. • 2—Support 5GHz only
• 3—Support 2.4GHz
only
Enumeration:
Status Radio status. N/A • Disable N/A
• Enable
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps The value can have
multi-selections.
RateMultica • 6—11Mbps
Multicast rate. N/A List of enumeration,
st • 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
• 13—auto

28
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
The value can have
• 5—9Mbps multi-selections.
RateMandat
Mandatory rate. N/A • 6—11Mbps List of enumeration,
ory separated by comma
• 7—12Mbps
Example: 1, 2.
• 8—18Mbps
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateSupport
Supported rate. N/A • 6—11Mbps rate uses.
ed List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps The value can have
multi-selections, exclude
• 5—9Mbps the one which multicast
RateDisable
Disabled rate. N/A • 6—11Mbps rate uses.
d List of enumeration,
• 7—12Mbps separated by comma
• 8—18Mbps Example: 1, 2.
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps

29
Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
• true—Short. N/A
Preamble Preamble. N/A • false—Long.
The column is only for
2.4GHz radio mode.

Unsigned short.
BeaconInter Beacon Interval The value range is
N/A N/A
val time. 32~8191.
Unit: TU. 1TU = 1024ms
Enumeration:
PowerLock Lock the power. N/A • Disable N/A
• Enable
Lo Boolean: When
ck • true—ChanneAutoLoc the value
th k. is true,
e the radio
ch • false—ChanneAuto automati
an UnLock. cally
ne The default selects
l value is true. an
optimal
channel,
and then
locks the
channel.
When the AC
detects any
radar signals
on its
channel, it
immediately
selects
another
channel (even
if the channel
auto lock is
true) and
locks the new
channel.
Unsigned short.
The distance that
Distance N/A The value range is 1~40. N/A
Radio can cover.
Unit: km(kilometre).
Unsigned integer.
Max Reveived The value range is
MaxRxDurat
frame duration N/A 500~250000. N/A
ion
time.
Unit: ms(millisecond).
Unsigned short.
The value range is
FragmentTh Fragment
N/A 256~2346. And the value N/A
reshold threshold.
must be an even number.
Unit: byte.

30
 Column Column Column Data type and
Remarks
name description type restrictions
Unsigned short.
LongRetryT LongRetryThresh
N/A The value range is 1~15. N/A
hreshold old.
Unit: null.
Unsigned short.
ProtectionT ProtectionThresho
N/A The value range is 0~2346. N/A
hreshold ld.
Unit: byte.
Unsigned short.
ShortRetryT ShortRetryThresh
N/A The value range is 1~15. N/A
hreshold old.
Unit: null.
When the value is 15, the
radio automatically
selects an optimal
The value range conforms channel, and then locks
to the channel.
Configured AP/ChannelDB/Supported
CfgChannel N/A When the AC detects
channel number. ChannelList” column.
any radar signals on its
And 15 –auto lock、 channel, it immediately
16-auto unlock. selects another channel
(even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
Value range: 1 to
CfgMaxPow Configured
N/A “AP/PowerDB/ValidMaxPo N/A
er maximum power.
wer”.
Unit: dBm

AP/Radio11n
This table contains radio 802.11n information.

XML structure
<AP>
<Radio11n>
<Dot11n>
<ApName></ApName>
<RadioID></RadioID>
<MCSMulticast></MCSMulticast>
<MCSMandatory></MCSMandatory>
<MCSSupported></MCSSupported>
<Ampdu></Ampdu>
<Amsdu></Amsdu>
<ShortGI></ShortGI>
<Stbc></Stbc>
<Ldpc></Ldpc>
<Mimo></Mimo>

31
 <Greenap></Greenap>
<SmartAntenna></SmartAntenna>
<SmartAntennaPolicy></SmartAntennaPolicy>
<Protection></Protection>
<Client11nOnly></Client11nOnly>
<BandwidthAutoswitch></ BandwidthAutoswitch >
</Dot11n>
</Radio11n>
</AP>

Table description
Item Description
Feature name AP
Table name Radio11n
Table type Multi-instance table
Row name Dot11n
Restrictions The table is only for 802.11n and 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Unsigned short.
The MCSMulticast must
MCSMultica The index for Value range: 0 to 76, and
N/A be smaller than or equal
st multicast MCS. 255.
to the MCSMandatory.
Default value is 255.
Unsigned short. The MCSMandatory
Value range: 0 to 76, and must be smaller than or
The maximum 255. equal to the
MCSMandat
index for N/A MCSSupported, and the
ory Default value is 255.
mandatory MCS. MCSMandatory must be
greater than or equal to
the MCSMulticast.
Unsigned short. The MCSSupported
The maximum must be greater than or
MCSSuppor Value range: 0 to 76, and
index for N/A equal to the
ted 255.
supported MCS. MCSMandatory.
Default value is 255.

32
Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
Ampdu A-mpdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Amsdu A-msdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
ShortGI Short GI function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Stbc STBC function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Ldpc LDPC function. N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 1: 1X1
Mimo Mimo. N/A • 2: 2X2 N/A
• 3: 3X3
• 4: 4X4
Boolean:
Greenap Green ap function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
SmartAnten Smart antenna
na function.
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
Effective only when
SmartAnten Smart antenna • 1: Auto
N/A SmartAntenna is
naPolicy policy. • 2: High-availability enabled.
• 3: High-throughput

802.11n Boolean:
Protection protection N/A • true—Enable. N/A
function. • false—Disable.
Boolean:
Client11nOn Client dot11n only
N/A • true—Enable. N/A
ly function.
• false—Disable.
Boolean:
• true—Enable. N/A
BandwidthA
Bandwidth • false—Disable.
autoswitch N/A
utoswitch The column is only for
function.
2.4GHz radio mode, and
AP/RadioOfManualAP/Ban
dwidth must be 2..

33
AP/Radio11ac
This table contains radio 802.11ac information.

XML structure
<AP>
<Radio11ac>
<Dot11ac>
<ApName></ApName>
<RadioID></RadioID>
<VHTNSSMulticast></VHTNSSMulticast>
<VHTMCSMulticast></VHTMCSMulticast>
<VHTNSSMandatory></VHTNSSMandatory>
<VHTNSSSupported></VHTNSSSupported>
<Client11acOnly></Client11acOnly>
</Dot11ac>
</Radio11ac>
</AP>

Table description
Item Description
Feature name AP
Table name Radio11ac
Table type Multi-instance table
Row name Dot11ac
Restrictions The table is only for 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Unsigned short. The VHTNSSMulticast
The NSS for
VHTNSSMu Value range: 0 to 8. must be smaller than or
multicast N/A
lticast equal to the
VHT-MCS. Default value is 0. VHTNSSMandatory.

34
 Column Column Column Data type and
Remarks
name description type restrictions
The index for Unsigned short.
VHTMCSMu
multicast N/A Value range: 0 to 9, 255. N/A
lticast
VHT-MCS. Default value is 255.
The VHTNSSMandatory
must be smaller than or
The maximum Unsigned short. equal to the
VHTNSSMa NSS for VHTNSSSupported, and
N/A Value range: 0 to 8.
ndatory mandatory the VHTNSSMandatory
VHT-MCS. Default value is 0. must be greater than or
equal to the
VHTNSSMulticast.
Unsigned short. The VHTNSSSupported
The maximum
VHTNSSSu Value range: 0 to 8. must be greater than or
NSS for supported N/A
pported equal to the
VHT-MCS. Default value is 0. VHTNSSMandatory.
Boolean:
Client11acO Client dot11ac
N/A • true—Enable. N/A
nly only function.
• false—Disable.

AP/RadioRunningCfg11n
This table contains radio 802.11n information of radio running configurations.

XML structure
<AP>
<RadioRunningCfg11n>
<Dot11n>
<ApName></ApName>
<RadioID></RadioID>
<MCSMulticast></MCSMulticast>
<MCSMandatory></MCSMandatory>
<MCSSupported></MCSSupported>
<Ampdu></Ampdu>
<Amsdu></Amsdu>
<ShortGI></ShortGI>
<Stbc></Stbc>
<Ldpc></Ldpc>
<Mimo></Mimo>
<Greenap></Greenap>
<SmartAntenna></SmartAntenna>
<SmartAntennaPolicy></SmartAntennaPolicy>
<Protection></Protection>
<Client11nOnly></Client11nOnly>
<BandwidthAutoswitch></BandwidthAutoswitch >
</Dot11n>
</RadioRunningCfg11n>

35
 </AP>

Table description
Item Description
Feature name AP
Table name RadioRunningCfg11n
Table type Multi-instance table
Row name Dot11n
Restrictions The table is only for 802.11n and 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Unsigned short. The MCSMulticast must
MCSMultica The index for be smaller than or equal
N/A Value range: 0 to 76, and
st multicast MCS. to the MCSMandatory.
255.
The MCSMandatory
must be smaller than or
The maximum Unsigned short. equal to the
MCSMandat
index for N/A Value range: 0 to 76, and MCSSupported, and the
ory
mandatory MCS. 255. MCSMandatory must be
greater than or equal to
the MCSMulticast.

Unsigned short. The MCSSupported

The maximum
MCSSuppor must be greater than or
index for N/A Value range: 0 to 76, and
ted equal to the
supported MCS. 255. MCSMandatory.
Boolean:
Ampdu A-mpdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Amsdu A-msdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
ShortGI Short GI function. N/A • true—Enable. N/A
• false—Disable.

36
 Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
Stbc STBC function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Ldpc LDPC function. N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 1: 1X1
Mimo MIMO. N/A • 2: 2X2 N/A
• 3: 3X3
• 4: 4X4
Boolean:
Greenap Green ap function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
SmartAnten Smart antenna
na function.
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
Effective only when
SmartAnten Smart antenna • 1: Auto
N/A SmartAntenna is
naPolicy policy. • 2: High-availability enabled.
• 3: High-throughput
802.11n Boolean:
Protection protection N/A • true—Enable. N/A
function.
• false—Disable.
Boolean:
Client11nOn Client dot11n only
ly function.
N/A • true—Enable. N/A
• false—Disable.
Boolean:
• true—Enable. N/A
BandwidthA
Bandwidth • false—Disable.
autoswitch N/A
utoswitch The column is only for
function.
2.4GHz radio mode, and
AP/ RadioRunningCfg/
Bandwidth must be 2..

AP/RadioRunningCfg11ac
This table contains radio 802.11ac information of radio running configurations.

XML structure
<AP>
<RadioRunningCfg11ac>
<Dot11ac>

37
 <ApName></ApName>
<RadioID></RadioID>
<VHTNSSMulticast></VHTNSSMulticast>
<VHTMCSMulticast></VHTMCSMulticast>
<VHTNSSMandatory></VHTNSSMandatory>
<VHTNSSSupported></VHTNSSSupported>
<Client11acOnly></Client11acOnly>
</Dot11ac>
</RadioRunningCfg11ac>
</AP>

Table description
Item Description
Feature name AP
Table name RadioRunningCfg11ac
Table type Multi-instance table
Row name Dot11ac
Restrictions The table is only for 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
The VHTNSSMulticast
The NSS for Unsigned short.
VHTNSSMu must be smaller than or
multicast N/A
lticast Value range: 0 to 8. equal to the
VHT-MCS.
VHTNSSMandatory.
The index for Unsigned short.
VHTMCSMu
multicast N/A N/A
lticast Value range: 0 to 9, 255.
VHT-MCS.
The VHTNSSMandatory
must be smaller than or
The maximum equal to the
VHTNSSMa NSS for Unsigned short. VHTNSSSupported, and
N/A
ndatory mandatory Value range: 0 to 8. the VHTNSSMandatory
VHT-MCS. must be greater than or
equal to the
VHTNSSMulticast.

38
 Column Column Column Data type and
Remarks
name description type restrictions
The VHTNSSSupported
The maximum Unsigned short.
VHTNSSSu must be greater than or
NSS for supported N/A
pported Value range: 0 to 8. equal to the
VHT-MCS.
VHTNSSMandatory.
Boolean:
Client11acO Client dot11ac
N/A • true—Enable. N/A
nly only function.
• false—Disable.

AP/RadioOfRunAP
This table contains radio information of running AP.

XML structure
<AP>
<RadioOfRunAP>
<Radio>
<ApName></ApName>
<RadioID></RadioID>
<Mode></Mode>
<Bandwidth></Bandwidth>
<Status></Status>
<Channel></Channel>
<SecondaryOffSet></SecondaryOffSet>
<MaxPower></MaxPower>
<BasicBSSID></BasicBSSID>
<TxPower></TxPower>
<NoiseFloor></NoiseFloor>
<ChannelBusy></ChannelBusy>
</Radio>
</RadioOfRunAP>
</AP>

Table description
Item Description
Feature name AP
Table name RadioOfRunAP
Table type Multi-instance table
Row name Radio
Restrictions None

39
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode. N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth. N/A N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M
Enumeration:
Status Radio status. N/A • enable N/A
• disable
Unsigned short.
The value range is related
Channel Channel number. N/A to AP model, radio mode, N/A
antenna type and region
code.
Enumeration:
SecondaryO Secondary • 0: None
N/A N/A
ffSet channel offset. • 1: Above
• 2: Below
Unsigned short.
The value range is related
to AP model, radio mode,
MaxPower Maximum power. N/A N/A
antenna type, channel
number and region code.
Unit: dBm
Six groups of two
Example:
BasicBSSID Basic BSSID. N/A hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.

40
 Column Column Column Data type and
Remarks
name description type restrictions
TxPower Tx power. N/A Unsigned short. N/A
String, Length: 1 to 7
NoiseFloor Noise floor. N/A N/A
characters.
ChannelBus Channel usage.
N/A Unsigned short. N/A
y

AP/PrvsOfManualAP
This table contains provision information of manual AP.

XML structure
<AP>
<PrvsOfManualAP>
<Prvs>
<ApName></ApName>
<ACHostName></ACHostName>
<ACIPv4></ACIPv4>
<ACIPv6></ACIPv6>
<DnsDomain></DnsDomain>
<DnsServerIPv4></DnsServerIPv4>
<DnsServerIPv6></DnsServerIPv6>
<GatewayIPv4></GatewayIPv4>
<GatewayIPv6></GatewayIPv6>
<IPv4Address></IPv4Address>
<IPv6Address></IPv6Address>
<Dot1xSupplAnonyIdent></Dot1xSupplAnonyIdent>
<Dot1xSupplEapMethod></Dot1xSupplEapMethod>
<Dot1xSupplEnable></Dot1xSupplEnable>
<Dot1xSupplPasswdCiper></Dot1xSupplPasswdCiper>
<Dot1xSupplPasswdSimple></Dot1xSupplPasswdSimple>
<Dot1xSupplUsername></Dot1xSupplUsername>
</Prvs>
</PrvsOfManualAP>
</AP>

Table description
Item Description
Feature name AP
Table name PrvsOfManualAP
Table type Multi-instance table
Row name Prvs

41
 Item Description
Restrictions None
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
String.
ACHostNam Specify an AC by
N/A Length: 1 to 253 N/A
e its hostname.
characters.
List of string, dotted
Specify an AC by Example: 1.1.1.1,
ACIPv4 N/A decimal notation,
its IPv4 address. 1.1.1.2.
Separated by comma.
List of hexadecimal string,
Specify an AC by Example:
ACIPv6 N/A colon-separated,
its IPv6 address. 1:1::1:1,1:1::1:2.
Separated by comma.
Specify the String.
DnsDomain domain name N/A N/A
suffix. Length: 1 to 253.

Specify a DNS
DnsServerI String, dotted decimal
server by its IPv4 N/A Example: 1.1.1.1.
Pv4 notation.
address.
Specify a DNS
DnsServerI Hexadecimal string,
server by its IPv6 N/A Example: 1:1::1:1.
Pv6 colon-separated.
address.
Specify a gateway
GatewayIPv String, dotted decimal
by its IPv4 N/A Example: 1.1.1.1.
4 notation.
address.
Specify a gateway
GatewayIPv Hexadecimal string,
by its IPv6 N/A Example: 1:1::1:1.
6 colon-separated.
address
Specify an IP
address that the
IPv4Addres String, dotted decimal
AP uses to N/A Example: 1.1.1.1.
s notation.
establish a
CAPWAP tunnel.
Specify an IPv6
address that the
IPv6Addres Hexadecimal string,
AP uses to N/A Example: 1:1::1:1.
s colon-separated.
establish a
CAPWAP tunnel.
Specify an String.
Dot1xSuppl anonymous
N/A Length: 1 to 253 N/A
AnonyIdent identifier for the
supplicant. characters.

42
 Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—md5
Specify an EAP • 2—peap-gtc
Dot1xSuppl
authentication N/A N/A
EapMethod
method. • 3—peap-mschapv2
• 4—ttls-gtc
• 5—ttls-mschapv2
Boolean:
Dot1xSuppl Enable the 802.1X
Enable supplicant feature.
N/A • true—Enable. N/A
• false—Disable.
Specify a String.
Dot1xSuppl
ciphertext
PasswdCipe N/A Length: 1 to 201 N/A
password for the
r characters.
802.1X supplicant.
Dot1xSuppl Specify a plaintext String.
PasswdSim password for the N/A Length: 1 to 127 N/A
ple 802.1X supplicant. characters.
Specify a String.
Dot1xSuppl username for the N/A Length: 1 to 253 N/A
Username 802.1X supplicant. characters.

AP/PrvsOfManualAPACIPv4
This table contains provision information of manual AP of IPv4 address.

XML structure
<AP>
<PrvsOfManualAPACIPv4>
<Prvs>
<ApName></ApName>
<ACIPv4></ACIPv4>
</Prvs>
</PrvsOfManualAPACIPv4>
</AP>

Table description
Item Description
Feature name AP
Table name PrvsOfManualAPACIPv4
Table type Multi-instance table
Row name Prvs
Restrictions None

43
 Item Description
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Specify an AC by String, dotted decimal
ACIPv4 N/A Example: 1.1.1.1.
its IPv4 address. notation.

AP/PrvsOfManualAPACIPv6
This table contains provision information of manual AP of IPv6 address.

XML structure
<AP>
<PrvsOfManualAPACIPv6>
<Prvs>
<ApName></ApName>
<ACIPv6></ACIPv6>
</Prvs>
</PrvsOfManualAPACIPv6>
</AP>

Table description
Item Description
Feature name AP
Table name PrvsOfManualAPACIPv6
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

44
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name. Index N/A
Length: 1 to 64 characters.
Example: 1:1::1:1.
Specify an AC by Hexadecimal string, This column is available
ACIPv6 N/A
its IPv6 address. colon-separated. when the SrcAny column
is false.

AP/APDB
This table contains AP model information.

XML structure
<AP>
<APDB>
<Model>
<ModelName></ModelName>
<RadioNum></RadioNum>
<DefaultRegionCode></DefaultRegionCode>
<StartPoePort></StartPoePort>
<EndPoePort></EndPoePort>
<ModelType></ModelType>
</Model>
</APDB>
</AP>

Table description
Item Description
Feature name AP
Table name APDB
Table type Multi-instance table
Row name Model
Restrictions None

45
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-insensitive.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.
Radio’s number of Unsigned short.
RadioNum AP model N/A N/A
Value range: 1 to 4.
DefaultRegi Default region Conform to ISO 3166
N/A Unsigned short.
onCode code of AP model. stantard.
StartPoePor
Start PoE port. N/A Unsigned char. N/A
t
EndPoePort End PoE port. N/A Unsigned char. N/A
Enumeration:
When the value is 3,
• 1—Normal
ModelType Model type. N/A some command can not
• 2—WT
be configurated.
• 3—WTU

AP/APDBVersion
This table contains apdb version of AP model.

XML structure
<AP>
<APDBVersion>
<Model>
<ModelName></ModelName>
<HardwareVersion></HardwareVersion>
<SoftwareVersion></SoftwareVersion>
</Model>
</APDBVersion>
</AP>

Table description
Item Description
Feature name AP
Table name APDBVersion
Table type Multi-instance table
Row name Model
Restrictions None

46
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, uppercase. Refer to
ModelName AP model name. Index
Length: 1 to 63 characters. APDB/ModelName.

Enumeration:
• 1—Ver.A
• 2—Ver.B
HardwareVe The version of
Index • 3—Ver.C N/A
rsion Hardware.
• 4—Ver.D
• 5—Ver.E
• 6—Ver.F
SoftwareVer The version of String
sion Software. N/A N/A
Length:1 to 31.

AP/RadioDB
This table contains radio information of AP model.

XML structure
<AP>
<RadioDB>
<Radio>
<ModelName></ModelName>
<RadioID></RadioID>
<DefaultRadioMode></DefaultRadioMode>
<SupportDot11B></SupportDot11B>
<SupportDot11A></SupportDot11A>
<SupportDot11G></SupportDot11G>
<SupportDot11GN></SupportDot11GN>
<SupportDot11AN></SupportDot11AN>
<SupportDot11GAC></SupportDot11GAC>
<SupportDot11AC></SupportDot11AC>
<Spectrum></Spectrum>
<DefaultAntennaType></DefaultAntennaType>
<Aifsn></Aifsn>
<Ecwmin></Ecwmin>
<Ecwmax></Ecwmax>
<TxOpLimit></TxOpLimit>
<SupportBandwidth></SupportBandwidth>
<SupportMCS></SupportMCS>
<SupportVHTMCS></SupportVHTMCS>
<ShortGI20M></ShortGI20M>
<ShortGI40M></ShortGI40M>

47
 <ShortGI80M></ShortGI80M>
<ShortGI160M></ShortGI160M>
<SUBeamformer></SUBeamformer>
<MUBeamformer></MUBeamformer>
<Ldpc></Ldpc>
<TxStbc></TxStbc>
<RxStbc></RxStbc>
<VHTLdpc></VHTLdpc>
<VHTTxStbc></VHTTxStbc>
<VHTRxStbc></VHTRxStbc>
</Radio>
</RadioDB>
</AP>

Table description
Item Description
Feature name AP
Table name RadioDB
Table type Multi-instance table
Row name Radio
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, uppercase.
ModelName AP model name. Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID. Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
DefaultRadi Default radio • 3—802.11g
N/A N/A
oMode mode. • 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
Whether a radio Boolean:
SupportDot1 supports 802.11b
1B
N/A • true—Support. N/A
radio mode
• false—Not support.

48
Column Column Column Data type and
Remarks
name description type restrictions
Whether a radio Boolean:
SupportDot1
1A
supports 802.11a N/A • true—Support. N/A
radio mode. • false—Not support.

Whether a radio Boolean:

SupportDot1
1G
supports 802.11g N/A • true—Support. N/A
radio mode. • false—Not support.
Whether a radio Boolean:
SupportDot1 supports
1GN 802.11n(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AN 802.11n(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1GAC 802.11ac(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AC 802.11ac(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Enumeration:
• 1—Support both
Supported radio 5GHz and 2.4GHz
Spectrum N/A N/A
spectrum. • 2—Support 5GHz only
• 3—Support 2.4GHz
only
DefaultAnte Default antenna String, case-insensitive.
nnaType type of radio. N/A N/A
Length: 1 to 80 characters.
ArbitrationInter Unsigned integer. Value
Aifsn Frame Spacing N/A range is 1 to 15, and is N/A
Number restricted by chipset.
Unsigned integer. Value
Exponent form of
Ecwmin N/A range is 0 to 10, and is N/A
CWmin
restricted by chipset.
Unsigned integer. Value
Exponent form of
Ecwmax N/A range is 1 to 10, and is N/A
CWmax
restricted by chipset.
Unsigned integer. Value
Transmission range is 0 to 32767 and is
TxOpLimit N/A N/A
oppurtunity limit restricted by chipset. Unit is
millisecond.

49
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—20M
• 2—40M
Supported • 3—80M
SupportBan
channel N/A N/A
dwidth
bandwidth • 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M

SupportMC Unsigned short.

Supported MCS N/A N/A
S Value range: 0 to 76.

SupportVHT Supported Unsigned short.

N/A N/A
MCS VHT-MCS Value range: 1 to 8.
Boolean:
Supported short
ShortGI20M
GI for 20MHz
N/A • true—Support. N/A
• false—Not support.
Boolean:
Supported short
ShortGI40M
GI for 40MHz
N/A • true—Support. N/A
• false—Not support.
Boolean:
Supported short
ShortGI80M
GI for 80MHz
N/A • true—Support. N/A
• false—Not support.
Boolean:
ShortGI160 Supported short
M GI for 160MHz
N/A • true—Support. N/A
• false—Not support.
Boolean:
SUBeamfor Supported
mer SU-Beamformer
N/A • true—Support. N/A
• false—Not support.
Boolean:
MUBeamfor Supported
mer MU-Beamformer
N/A • true—Support. N/A
• false—Not support.
Boolean:
Ldpc Supported ldpc N/A • true—Support. N/A
• false—Not support.
Boolean:
TxStbc Supported TxStbc N/A • true—Support. N/A
• false—Not support.
Boolean:
RxStbc Supported RxStbc N/A • true—Support. N/A
• false—Not support.
Boolean:
Supported VHT
VHTLdpc
ldpc
N/A • true—Support. N/A
• false—Not support.

50
 Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
Supported VHT
VHTTxStbc
TxStbc
N/A • true—Support. N/A
• false—Not support.
Boolean:
Supported VHT
VHTRxStbc
RxStbc
N/A • true—Support. N/A
• false—Not support.

AP/RegionDB
This table contains valid region list of AP models.

XML structure
<AP>
<RegionDB>
<Region>
<ModelName></ModelName>
<RegionCode></RegionCode>
<SupportedRadioList></SupportedRadioList>
</Region>
</RegionDB>
</AP>

Table description
Item Description
Feature name AP
Table name RegionDB
Table type Multi-instance table
Row name Region
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Region code of Conform to ISO 3166
RegionCode N/A Unsigned short.
AP. stantard.

51
 Column Column Column Data type and
Remarks
name description type restrictions
Number string.
It is a comma-separated list
Supported radio Example:
SupportedR of supported radio IDs.
list of current N/A
adioList The string must not end 1,2
region.
with a comma or hyphen,
or include any whitespace

AP/AntennaDB
This table contains valid antenna types of AP models.

XML structure
<AP>
<AntennaDB>
<Antenna>
<ModelName></ModelName>
<RadioID></RadioID>
<AntennaType></AntennaType>
</Antenna>
</AntennaDB>
</AP>

Table description
Item Description
Feature name AP
Table name AntennaDB
Table type Multi-instance table
Row name Antenna
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.

AntennaTyp Antenna type of String, case-insensitive.

Index N/A
e radio Length: 1 to 80 characters.

52
AP/ChannelTypeMap
This table contains channel type of radios.

XML structure
<AP>
<ChannelTypeMap>
<ChannelMap>
<RadioMode></RadioMode>
<Bandwidth></Bandwidth>
<Channel></Channel>
<ChannelType></ChannelType>
</ChannelMap>
</ChannelTypeMap>
</AP>

Table description
Item Description
Feature name AP
Table name ChannelTypeMap
Table type Multi-instance table
Row name ChannelMap
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
RadioMode Radio mode Index N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)

53
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth Index N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M
Conform to IEEE 802.11
protocol , ISO 3166
Legal channel
Channel Index Unsigned short. stantard and the related
number.
national and regional
laws and regulations.

54
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—802.11b
• 2—802.11g
• 3—802.11n(2.4GHz)
in 20M mode
• 4—802.11n(2.4GHz)
in 40M mode
• 5—802.11gac(2.4GHz
) in 20M mode
• 6—802.11gac(2.4GHz
) in 40M mode
• 7—802.11a(36 to 64)
• 8—802.11a(100 to
144)
• 9—802.11a(149 to
165)
• 10—802.11n(5GHz)
(36 to 64) in 20M
mode
• 11—802.11n(5GHz)
(100 to 144) in 20M
mode
• 12—802.11n(5GHz)
(149 to 165) in 20M
mode
Type of spectrum, • 13—802.11n(5GHz)
ChannelTyp (36 to 64) in 40M
bandwidth and N/A N/A
e mode
channel range.
• 14—802.11n(5GHz)
(100 to 144) in 40M
mode
• 15—802.11n(5GHz)
(149 to 165) in 40M
mode
• 16—802.11ac (36 to
64) in 20M mode
• 17—802. 11ac (100 to
144) in 20M mode
• 18—802. 11ac (149 to
165) in 20M mode
• 19—802.11ac (36 to
64) in 40M mode
• 20—802. 11ac (100 to
144) in 40M mode
• 21—802. 11ac (149 to
165) in 40M mode
• 22—802.11ac (36 to
64) in 80M mode
• 23—802. 11ac (100 to
144) in 80M mode
• 24—802. 11ac (149 to
165) in 80M mode
• 25—802.11ac (36 to
64) in 160M mode

55
 Column Column Column Data type and
Remarks
name description type restrictions
• 26—802. 11ac (100 to
144) in 160M mode
• 27—802. 11ac (149 to
165) in 160M mode
• 28—802. 11ac (36 to
64) in 8080M mode
• 29—802. 11ac (100 to
144) in 8080M mode
• 30—802. 11ac (149 to
165) in 8080M mode

AP/PowerIndex
This table contains valid power index of AP models.

XML structure
<AP>
<PowerIndex>
<Index>
<ModelName></ModelName>
<RadioID></RadioID>
<RadioMode></RadioMode>
<AntennaType></AntennaType>
<RegionCode></RegionCode>
<ChannelType></ChannelType>
<PowerIndex></PowerIndex>
<PowerSubIndex></PowerSubIndex>
</Index>
</PowerIndex>
</AP>

Table description
Item Description
Feature name AP
Table name PowerIndex
Table type Multi-instance table
Row name Index
Restrictions None

56
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
RadioMode Radio mode Index N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)
AntennaTyp Antenna type of String, case-insensitive.
e radio. Index N/A
Length: 1 to 80 characters.
Unsigned short. Refer to
Region code of
RegionCode Index AP/RegionDB/RegionCo
AP.
de.
Enumeration:
• 1—802.11b
• 2—802.11g
• 3—802.11n(2.4GHz)
in 20M mode
• 4—802.11n(2.4GHz)
in 40M mode
• 5—802.11gac in 20M
mode
• 6—802.11gac in 40M
mode
• 7—802.11a(36 to 64)
• 8—802.11a(100 to
Type of spectrum, 144) Refer to AP/
ChannelTyp
e
bandwidth and Index • 9—802.11a(149 to ChannelTypeMap/Chann
channel range. 165) elType.
• 10—802.11n(5GHz)
(36 to 64) in 20M
mode
• 11—802.11n(5GHz)
(100 to 144) in 20M
mode
• 12—802.11n(5GHz)
(149 to 165) in 20M
mode
• 13—802.11n(5GHz)
(36 to 64) in 40M
mode
• 14—802.11n(5GHz)
(100 to 144) in 40M

57
 Column Column Column Data type and
Remarks
name description type restrictions
mode
• 15—802.11n(5GHz)
(149 to 165) in 40M
mode
• 16—802.11ac (36 to
64) in 20M mode
• 17—802. 11ac (100 to
144) in 20M mode
• 18—802. 11ac (149 to
165) in 20M mode
• 19—802.11ac (36 to
64) in 40M mode
• 20—802. 11ac (100 to
144) in 40M mode
• 21—802. 11ac (149 to
165) in 40M mode
• 22—802.11ac (36 to
64) in 80M mode
• 23—802. 11ac (100 to
144) in 80M mode
• 24—802. 11ac (149 to
165) in 80M mode
• 25—802.11ac (36 to
64) in 160M mode
• 26—802. 11ac (100 to
144) in 160M mode
• 27—802. 11ac (149 to
165) in 160M mode
• 28—802. 11ac (36 to
64) in 8080M mode
• 29—802. 11ac (100 to
144) in 8080M mode
• 30—802. 11ac (149 to
165) in 8080M mode
Enumeration:
The index value of
PowerIndex
power table
N/A • 1—System script N/A
• 2—Userscript
The sub-index
PowerSubIn
value of power N/A Unsigned short. N/A
dex
table

AP/ChannelDB
This table contains valid channel list of AP models.

XML structure
<AP>
<ChannelDB>
<Channel>
<PowerIndex></PowerIndex>

58
 <ChannelType></ChannelType>
<PowerSubIndex></PowerSubIndex>
<SupportedChannelList></SupportedChannelList>
</Channel>
</ChannelDB>
</AP>

Table description
Item Description
Feature name AP
Table name ChannelDB
Table type Multi-instance table
Row name Channel
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration: Refer to
The index value of AP/PowerIndex/PowerIn
PowerIndex
power table
Index • 1—System script
dex
• 2—Userscript

59
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—802.11b
• 2—802.11g
• 3—802.11n(2.4GHz)
in 20M mode
• 4—802.11n(2.4GHz)
in 40M mode
• 5—802.11gac in 20M
mode
• 6—802.11gac in 40M
mode
• 7—802.11a(36 to 64)
• 8—802.11a(100 to
144)
• 9—802.11a(149 to
165)
• 10—802.11n(5GHz)
(36 to 64) in 20M
mode
• 11—802.11n(5GHz)
(100 to 144) in 20M
mode
• 12—802.11n(5GHz)
(149 to 165) in 20M
mode
Type of spectrum, • 13—802.11n(5GHz) Refer to AP/
ChannelTyp (36 to 64) in 40M
bandwidth and Index ChannelTypeMap/Chann
e mode
channel range. elType.
• 14—802.11n(5GHz)
(100 to 144) in 40M
mode
• 15—802.11n(5GHz)
(149 to 165) in 40M
mode
• 16—802.11ac (36 to
64) in 20M mode
• 17—802. 11ac (100 to
144) in 20M mode
• 18—802. 11ac (149 to
165) in 20M mode
• 19—802.11ac (36 to
64) in 40M mode
• 20—802. 11ac (100 to
144) in 40M mode
• 21—802. 11ac (149 to
165) in 40M mode
• 22—802.11ac (36 to
64) in 80M mode
• 23—802. 11ac (100 to
144) in 80M mode
• 24—802. 11ac (149 to
165) in 80M mode
• 25—802.11ac (36 to
64) in 160M mode

60
 Column Column Column Data type and
Remarks
name description type restrictions
• 26—802. 11ac (100 to
144) in 160M mode
• 27—802. 11ac (149 to
165) in 160M mode
• 28—802. 11ac (36 to
64) in 8080M mode
• 29—802. 11ac (100 to
144) in 8080M mode
• 30—802. 11ac (149 to
165) in 8080M mode
The sub-index Refer to
PowerSubIn
value of power Index Unsigned short. AP/PowerIndex/PowerS
dex
table ubIndex
Number string.
It is a comma-separated list
Supported Example:
SupportedC of supported channels.
channel list of N/A
hannelList The string must not end 1,2,3
current model.
with a comma or hyphen,
or include any whitespace

AP/PowerDB
This table contains valid power values of AP models.

XML structure
<AP>
<PowerDB>
<Power>
<PowerIndex></PowerIndex>
<ChannelType></ChannelType>
<PowerSubIndex></PowerSubIndex>
<Channel></Channel>
<ValidMaxPower></ValidMaxPower>
</Power>
</PowerDB>
</AP>

Table description
Item Description
Feature name AP
Table name PowerDB
Table type Multi-instance table
Row name Power
Restrictions None

61
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration: Refer to
The index value of
PowerIndex
power table
Index • 1—System script AP/PowerIndex/PowerIn
• 2—User script dex

62
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—802.11b
• 2—802.11g
• 3—802.11n(2.4GHz)
in 20M mode
• 4—802.11n(2.4GHz)
in 40M mode
• 5—802.11gac in 20M
mode
• 6—802.11gac in 40M
mode
• 7—802.11a(36 to 64)
• 8—802.11a(100 to
144)
• 9—802.11a(149 to
165)
• 10—802.11n(5GHz)
(36 to 64) in 20M
mode
• 11—802.11n(5GHz)
(100 to 144) in 20M
mode
• 12—802.11n(5GHz)
(149 to 165) in 20M
mode
Type of spectrum, • 13—802.11n(5GHz) Refer to AP/
ChannelTyp (36 to 64) in 40M
bandwidth and Index ChannelTypeMap/Chann
e mode
channel range. elType.
• 14—802.11n(5GHz)
(100 to 144) in 40M
mode
• 15—802.11n(5GHz)
(149 to 165) in 40M
mode
• 16—802.11ac (36 to
64) in 20M mode
• 17—802. 11ac (100 to
144) in 20M mode
• 18—802. 11ac (149 to
165) in 20M mode
• 19—802.11ac (36 to
64) in 40M mode
• 20—802. 11ac (100 to
144) in 40M mode
• 21—802. 11ac (149 to
165) in 40M mode
• 22—802.11ac (36 to
64) in 80M mode
• 23—802. 11ac (100 to
144) in 80M mode
• 24—802. 11ac (149 to
165) in 80M mode
• 25—802.11ac (36 to
64) in 160M mode

63
 Column Column Column Data type and
Remarks
name description type restrictions
• 26—802. 11ac (100 to
144) in 160M mode
• 27—802. 11ac (149 to
165) in 160M mode
• 28—802. 11ac (36 to
64) in 8080M mode
• 29—802. 11ac (100 to
144) in 8080M mode
• 30—802. 11ac (149 to
165) in 8080M mode
The sub-index Refer to
PowerSubIn
value of power Index Unsigned short. AP/PowerIndex/PowerS
dex
table ubIndex
Refer to
Legal channel
Channel Index Unsigned short. AP/ChannelDB/Supporte
number.
dChannelList.
Legal maximum Unsigned short. Conform to IEEE 802.11
power. The upper The value range is related protocol , ISO 3166
ValidMaxPo limit of stantard and the related
N/A to AP model, radio mode,
wer configurable national and regional
antenna type, channel
maximum power. number and region code. laws and regulations.

AP/ChannelReport
This table contains the fileds which carry the channel reports of the Ap.

XML structure
<AP>
<ChannelReport>
<Channel>
<ApName></ApName>
<RadioID></RadioID>
<Channel></Channel>
<NeighborCount></NeighborCount>
<Load></Load>
<Utilization></Utilization>
<Interference></Interference>
<PacketErr></PacketErr>
<Retry></Retry>
<RadarStatus><RadarStatus>
</Channel>
</ChannelReport>
</AP>

64
Table description
Item Description
Feature name AP
Table name ChannelReport
Table type Multi-instance table
Row name Channel
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
Refer to
Legal channel
Channel Index Unsigned short. AP/ChannelDB/Supporte
number.
dChannelList.
Neighbour
NeighborCo
number of the N/A Unsigned integer. N/A
unt
legal channels.
Percentage of the
time for
transmitting all Unsigned integer.
packets on the
Load N/A Value range: 0 to 100. N/A
channel to the
total time for Unit: %.
scanning the
channel.
Percentage of the
time for
transmitting Unsigned integer.
Utilization packets of the N/A Value range: 0 to 100. N/A
BSS to the total Unit: %.
time for scanning
the channel.
Percentage of the
time for
transmitting Unsigned integer.
Interference packets of other N/A Value range: 0 to 100. N/A
BSSs to the total Unit: %.
time for scanning
the channel.

Packet error rate Unsigned integer.

PacketErr of the legal N/A Value range: 0 to 100. N/A
channel. Unit: %.

65
 Column Column Column Data type and
Remarks
name description type restrictions
Retransmission Unsigned integer.
Retry rate of the legal N/A Value range: 0 to 100. N/A
channel. Unit: %.
Boolean:
Radar detection • true—Radar is N/A
RadarStatus status at the legal N/A detected.
channel. • false—Radar is not
detected.

AP/NeighborAPReport
This table contains the fileds which carry the information of the Ap’s current neighbors.

XML structure
<AP>
<NeighborAPReport>
<Neighbor>
<ApName></ApName>
<RadioID></RadioID>
<MacAddress></MacAddress>
<Channel></Channel>
<Interference></Interference>
<SignalStrength></SignalStrength>
<NeighborType></NeighborType>
</Neighbor>
</NeighborAPReport>
</AP>

Table description
Item Description
Feature name AP
Table name NeighborAPReport
Table type Multi-instance table
Row name Neighbor
Restrictions None

66
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
ApName AP name Index N/A
Length: 1 to 64 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
If the neighbor is
unmanaged AP, this
column is MAC address;
Six groups of two or if the neighbor is
MacAddress MAC address Index hexadecimal digits, managed AP, it is basic
hyphen-separated. BSSID.
Example:
00-0c-af-e3-5d-c0.
Unsigned short.
Channel number
where the The value range is related
Channel N/A to AP model, radio mode, N/A
neighbor is
discovered. antenna type and country
code.
Percentage of the
time for
transmitting Unsigned integer.
packets of the
Interference N/A Value range: 0 to 100. N/A
neighbor to the
total time for Unit: %.
scanning the
channel.
An indication of the total
channel power (signal,
noise, and interference)
SignalStren Strength of signal Unsigned integer. of a received frame
N/A
gth received. Unit: dBm. measured on the
channel and at the
antenna connector used
to receive the frame.

Boolean:
Management N/A
NeighborTy • true—Managed
status of the N/A
pe neighbor.
neighbor.
• false—UnManaged
neighbor.

AP/EdcaRadio
This table contains radio EDCA information.

XML structure
<AP>
<EdcaRadio>

67
 <EdcaPara>
<ApName></ApName>
<RadioID></RadioID>
<AccessCategory></AccessCategory>
<Noack></Noack>
<CfgAifsn></CfgAifsn>
<CfgEcwmin></CfgEcwmin>
<CfgEcwmax></CfgEcwmax>
<CfgTxOpLimit></CfgTxOpLimit>
</EdcaPara>
</EdcaRadio>
</AP>

Table description
Item Description
Feature name AP
Table name EdcaRadio
Table type Multi-instance table
Row name EdcaPara
Restrictions None
Support for row creation and deletion No

Columns
Column Column
Column description Data type and restrictions Remarks
name type
String, case-sensitive. N/A.
ApName AP name. Index
Length:1to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
A label for the common set of
enhanced distributed channel Enumeration:
access
• 0—BK.
parameters that are used by
AccessCategory
a WMM STA to conten d for
Index • 1—BE. N/A
the channel in order to • 2—VI.
transmit MSDUs with • 3—VO.
certain priorities..
Whehter acknowledgement is Boolean:
Noack required. N/A • true—Not required. N/A
• false—Required.
ArbitrationInter Frame The value range conforms to
CfgAifsn N/A N/A
Spacing Number. “AP/RadiolDB/Aifsn” column.

68
 Column Column
Column description Data type and restrictions Remarks
name type
The value range conforms to
CfgEcwmin Exponent form of CWmin. N/A “AP/RadiolDB/Ecwmin” N/A
column.
The value range conforms to
CfgEcwmax Exponent form of CWmax. N/A “AP/RadiolDB/Ecwmax” N/A
column.
The value range conforms to
Transmission oppurtunity
CfgTxOpLimit N/A “AP/RadiolDB/TxOpLimit” N/A
limit.
column.

AP/RadioWmm
This table contains radio WMM information.

XML structure
<AP>
<RadioWmm>
<Wmm>
<ApName></ApName>
<RadioID></RadioID>
<Status></Status>
</Wmm>
</RadioWmm>
</AP>

Table description
Item Description
Feature name AP
Table name RadioWmm
Table type Multi-instance table
Row name Wmm
Restrictions None
Support for row creation
No
and deletion

69
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive. N/A.
ApName AP name. Index
Length: 1 to 64 characters.
Unsigned char.
RadioID Radio identifier. Index N/A
Value range: 1 to 31.
Boolean:
WMM status of
Status
radio.
N/A • true—Enable. N/A
• false—Disable.

AP/APGroup
This table contains information of AP groups.

XML structure
<AP>
<APGroup>
<Group>
<Name></Name>
<RuleNum></RuleNum>
<ModelNum></ModelNum>
<APNum></APNum>
<RegionCode></RegionCode>
<RegionLock></RegionLock>
<Priority></Priority>
<Preempt></Preempt>
<EchoInterval></EchoInterval>
<EchoCount></EchoCount>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<StatisInterval></StatisInterval>
<FirmwareUpgrade></FirmwareUpgrade>
<BackupACIPv4></BackupACIPv4>
<BackupACIPv6></BackupACIPv6>
<LocationName></LocationName>
<Description></Description>
<TunnelEncryption></TunnelEncryption>
<ProvisionAutoUpgrade></ProvisionAutoUpgrade>
<ProvisionAutoRecover></ProvisionAutoRecover>
<LedMode></LedMode>
</Group>
</APGroup>
</AP>

70
Table description
Item Description
Feature name AP
Table name APGroup
Table type Multi-instance table
Row name Group
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
Name AP group name Index N/A
Length: 1 to 31 characters.

AP group Number of rules in Unsigned short.

the AP group N/A N/A
name Value range: 0 to 5.
Number of models Unsigned short.
ModelNum in the AP group N/A N/A
Value range: 0 to 65535.
Number of APs in Unsigned short.
APNum the AP group N/A N/A
Value range: 0 to 65535.
Region code of Conform to ISO 3166
RegionCode N/A Unsigned short.
AP group. stantard.
Whether the Boolean:
region code of the • true—Support.
RegionLock N/A N/A
AP group is
locked. • false—Not support.

AP connection Unsigned short.

Priority priority N/A N/A
Value range: 0 to 7.
Whether the AP in
this group will be Boolean:
forced to switch
Preempt N/A • true: Switch N/A
the backup tunnel
to active by • false: Not switch.
priority.
The transmit Unsigned short.
EchoInterval interval of tunnel N/A Value range: 0, 5 to 255. N/A
echo messages.
Unit: seconds
The allowed
maximum number
of echo messges
which are not Unsigned short.
EchoCount N/A N/A
received. If the Value range: 1 to 20.
count is reached,
the tunnel will be
down.

71
 Column Column Column Data type and
Remarks
name description type restrictions
The interval to Unsigned short.
RetransInter
retransmit a N/A Value range: 1 to 30. N/A
val
request message. Unit: seconds
The allowed
maximum number
of retransmission Unsigned short.
RetransCou
attempts. If the N/A Value range: 1 to 20. N/A
nt
count is reached, Unit: seconds
the tunnel will be
down.
The interval of AP
sending the Unsigned short.
StatisInterva
statistics N/A Value range: 0 to 240. N/A
l
informations to Unit: seconds
AC.
Whether the AC
will upgrade AP’s Boolean:
FirmwareUp firmware
grade automatically if the
N/A • true—Enable N/A
software is • false—Disable
mismatch.
BackupACI The IPv4 backup String, dotted decimal
N/A Example: 1.1.1.1.
Pv4 AC address. notation.
BackupACI The IPv6 backup Hexadecimal string,
N/A Example: 1:1::1:1.
Pv6 AC address. colon-separated.
Which location the String, lowercase.
LocationNa
AP group belongs N/A N/A
me Length: 1 to 31 characters.
to.

The description of String,

Description N/A N/A
APGroup. Length: 1 to 64 cahracters
Boolean:
TunnelEncry Whether to enable
ption tunnel encryption.
N/A • true—Enable N/A
• false—Disable
Whether to enable Boolean:
ProvisionAut provision
oUpgrade
N/A • true—Enable. N/A
auto-upgrade
• false—Disable.
Whether to enable Boolean:
ProvisionAut provision
oRecover
N/A • true—Enable. N/A
auto-recover
• false—Disable.
Enumeration:
• 0—Normal
LedMode LED mode N/A • 1—Quiet N/A
• 2—Awake
• 3—Always-on

AP/APGroupMACRule
This table contains information of AP groups’ rules of MAC address.

72
XML structure
<AP>
<APGroupMACRule>
<Rule>
<GroupName></GroupName>
<MacAddress></MacAddress>
</Rule>
</APGroupMACRule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupMACRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
Six groups of two
Example:
MacAddress AP MAC address Index hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.

AP/APGroupSerialIDRule
This table contains information of AP groups’ rules of serial ID.

XML structure
<AP>
<APGroupSerialIDRule>
<Rule>
<GroupName></GroupName>
<SerialID></SerialID>
<Rule>
</APGroupSerialIDRule>
</AP>

73
Table description
Item Description
Feature name AP
Table name APGroupSerialIDRule
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, uppercase.
SerialID AP serial ID Index Length: 1 to 127 N/A
characters.

AP/APGroupNameRule
This table contains information of AP groups’ rules of AP name.

XML structure
<AP>
<APGroupNameRule>
<Rule>
<GroupName></GroupName>
<APName></APName>
<Rule>
</APGroupNameRule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupNameRule
Table type Multi-instance table
Row name Rule
Restrictions None

74
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-sensitive.
APName AP name Index N/A
Length: 1 to 64 characters.

AP/APGroupIPv4Rule
This table contains information of AP groups’ rules of IPv4 address range.

XML structure
<AP>
<APGroupIPv4Rule>
<Rule>
<GroupName></GroupName>
<IPv4Addr></IPv4Addr>
<IPv4Wildcard></IPv4Wildcard>
<Rule>
</APGroupIPv4Rule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupIPv4Rule
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
IPv4 address of String, dotted decimal
IPv4Addr Index Example: 1.1.1.1.
AP. notation.

75
 Column Column Column Data type and
Remarks
name description type restrictions
Wildcard mask for
IPv4Wildcar String, dotted decimal
the IPv4 address Index Example: 255.255.255.0.
d notation.
of AP.

AP/APGroupIPv6Rule
This table contains information of AP groups’ rules of IPv6 address range.

XML structure
<AP>
<APGroupIPv6Rule>
<Rule>
<GroupName></GroupName>
<IPv6Addr></IPv6Addr>
<IPv6Wildcard></IPv6Wildcard>
<Rule>
</APGroupIPv6Rule>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupIPv6Rule
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
Example: 1:1::1:1.
Source IPv6 Hexadecimal string, This column is available
IPv6Addr Index
address. colon-separated. when the SrcAny column
is false.
Length of the Unsigned integer. This column is available
IPv6Wildcar
source IPv6 Index when the SrcAny column
d Value range: 1 to 128.
address prefix. is false.

76
AP/APGroupModel
This table contains information of AP group models.

XML structure
<AP>
<APGroupModel>
<Model>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioNum></RadioNum>
</Model>
</APGroupModel>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupModel
Table type Multi-instance table
Row name Model
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.

Number of the Unsigned short.

RadioNum N/A N/A
radio Value range: 1 to 4.

AP/APGroupRadio
This table contains information of AP group radios.

XML structure
<AP>
<APGroupRadio>

77
 <Radio>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<Mode></Mode>
<SupportDot11B></SupportDot11B>
<SupportDot11A></SupportDot11A>
<SupportDot11G></ SupportDot11G>
<SupportDot11GN></SupportDot11GN>
<SupportDot11AN></SupportDot11AN>
<SupportDot11AC></SupportDot11AC>
<Bandwidth></Bandwidth>
<Spectrum></Spectrum>
<Status></Status>
<RateMulticast></RateMulticast>
<RateMandatory></RateMandatory>
<RateSupported></RateSupported>
<RateDisabled></RateDisabled>
<Preamble></Preamble>
<BeaconInterval></BeaconInterval>
<PowerLock></PowerLock>
<Distance></Distance>
<MaxRxDuration></MaxRxDuration>
<FragmentThreshold></FragmentThreshold>
<LongRetryThreshold></LongRetryThreshold>
<ProtectionThreshold></ProtectionThreshold>
<ShortRetryThreshold></ShortRetryThreshold>
<CfgChannel></CfgChannel>
<CfgMaxPower></CfgMaxPower>
</Radio>
</APGroupRadio>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupRadio
Table type Multi-instance table
Row name Radio
Restrictions None

78
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
Enumeration:
• 1—802.11b
• 2—802.11a
• 3—802.11g
Mode Radio mode N/A N/A
• 4—802.11n(2.4GHz)
• 5—802.11n(5GHz)
• 6—802.11ac(2.4GHz)
• 7—802.11ac(5GHz)

Whether a radio Boolean:

SupportDot1
1B
supports 802.11b N/A • true—Support. N/A
radio mode • false—Not support.
Whether a radio Boolean:
SupportDot1 supports 802.11a
1A
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports 802.11g
1G
N/A • true—Support. N/A
radio mode
• false—Not support.
Whether a radio Boolean:
SupportDot1 supports
1GN 802.11n(2.4GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AN 802.11n(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Whether a radio Boolean:

SupportDot1 supports
1AC 802.11ac(5GHz)
N/A • true—Support. N/A
radio mode • false—Not support.

Enumeration:
• 1—20M
• 2—40M
• 3—80M
Bandwidth Radio bandwidth N/A N/A
• 4—160M
• 5—80M + 80M
• 17—5M
• 18—10M

79
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—Support both
Supported radio 5GHz and 2.4GHz
Spectrum N/A N/A
spectrum • 2—Support 5GHz only
• 3—Support 2.4GHz
only
Enumeration:
• 0—Disable
Status Radio status N/A N/A
• 1—Enable
• 2—Inherit
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps
• 8—18Mbps
RateMultica • 9—24Mbps
Multicast rate N/A N/A
st • 10—36Mbps
• 11—48Mbps
• 12—54Mbps
• 13—auto
The value range conforms
to
“AP/RadioOfManualAP/Cfg
RateMandatory” column. If
this column is not
configured, the multicast
rate will be calculated
automatically.

80
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps
• 8—18Mbps
RateMandat
Mandatory rate N/A • 9—24Mbps The value can have
ory multi-selections.
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps
Default value:
A. 1, 2Mbps(802.11b).
B. 6, 12,
24Mbps(802.11a/802.1
1an)
C. 1, 2, 5.5,
11Mbps(802.11g/802.1
1gn)
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
• 6—11Mbps
• 7—12Mbps
• 8—18Mbps The value can have
RateSupport
Supported rate N/A • 9—24Mbps multi-selections, exclude
ed the one which multicast
• 10—36Mbps
rate uses.
• 11—48Mbps
• 12—54Mbps
Default value:
A. 5.5, 11Mbps(802.11b)
B. 9, 18, 24, 36, 48,
54Mbps(802.11a/802.1
1an)
C. 6, 9, 12, 18, 24, 36,
54Mbps(802.11g/802.1
1gn)

81
Column Column Column Data type and
Remarks
name description type restrictions
Enumeration:
• 1—1Mbps
• 2—2Mbps
• 3—5.5Mbps
• 4—6Mbps
• 5—9Mbps
The value can have
RateDisable • 6—11Mbps multi-selections, exclude
Disabled rate N/A
d • 7—12Mbps the one which multicast
rate uses.
• 8—18Mbps
• 9—24Mbps
• 10—36Mbps
• 11—48Mbps
• 12—54Mbps

Boolean:
• true—Short. N/A
Preamble Preamble N/A • false—Long.
The column is only for
2.4GHz radio mode.

Unsigned short.
BeaconInter Beacon Interval The value range is
N/A N/A
val time 32~8191.
Unit: TU. 1TU = 1024ms
Boolean:
PowerLock Lock the power N/A • true—Enable. N/A
• false—Disable.
Unsigned short.
The distance that
Distance N/A The value range is 1~40. N/A
Radio can cover
Unit: km(kilometre).
Unsigned integer.
Max Reveived The value range is
MaxRxDurat
frame duration N/A 500~250000. N/A
ion
time
Unit: ms.
Unsigned short.
The value range is
FragmentTh Fragment
N/A 256~2346. And the value N/A
reshold threshold
must be an even number.
Unit: byte.
Unsigned short.
LongRetryT Long retry
N/A The value range is 1~15. N/A
hreshold threshold
Unit: null.
Unsigned short.
ProtectionT Protection
N/A The value range is 0~2346. N/A
hreshold threshold
Unit: byte.

82
 Column Column Column Data type and
Remarks
name description type restrictions
Unsigned short.
ShortRetryT Short retry
N/A The value range is 1~15. N/A
hreshold threshold
Unit: null.
When the value is 15, the
radio automatically
selects an optimal
The value range conforms channel, and then locks
to the channel.
Configured AP/ChannelDB/Supported
CfgChannel N/A When the AC detects
channel number ChannelList” column.
any radar signals on its
And 15 –auto lock、 channel, it immediately
16-auto unlock. selects another channel
(even if the channel auto
lock is true) and locks the
new channel.
Unsigned short.
Value range: 1 to
CfgMaxPow Configured
N/A “AP/PowerDB/ValidMaxPo N/A
er maximum power
wer”.
Unit: dBm

AP/APGroupRadio11n
This table contains 802.11n information of AP group radios.

XML structure
<AP>
<APGroupRadio11n>
<Radio11n>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<MCSMulticast></MCSMulticast>
<MCSMandatory></MCSMandatory>
<MCSSupported></MCSSupported>
<Ampdu></Ampdu>
<Amsdu></Amsdu>
<ShortGI></ShortGI>
<Stbc></Stbc>
<Ldpc></Ldpc>
<Mimo></Mimo>
<Greenap></Greenap>
<SmartAntenna></SmartAntenna>
<SmartAntennaPolicy></SmartAntennaPolicy>
<Protection></Protection>
<Client11nOnly></Client11nOnly>
<BandwidthAutoswitch></ BandwidthAutoswitch >

83
 </Radio11n>
</APGroupRadio11n>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupRadio11n
Table type Multi-instance table
Row name Radio11n
Restrictions The table is only for 802.11n and 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
Unsigned short.
The MCSMulticast must
MCSMultica The index for Value range: 0 to 76, and
N/A be smaller than or equal
st multicast MCS. 255. to the MCSMandatory.
Default value is 255.
The MCSMandatory
Unsigned short. must be smaller than or
The maximum equal to the
MCSMandat Value range: 0 to 76, and
index for N/A MCSSupported, and the
ory 255.
mandatory MCS. MCSMandatory must be
Default value is 255. greater than or equal to
the MCSMulticast.
Unsigned short. The MCSSupported
The maximum
MCSSuppor Value range: 0 to 76, and must be greater than or
index for N/A
ted 255. equal to the
supported MCS.
Default value is 76. MCSMandatory.

Boolean:
Ampdu A-mpdu function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Amsdu A-msdu function. N/A • true—Enable. N/A
• false—Disable.

84
 Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
ShortGI Short GI function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Stbc STBC function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
Ldpc LDPC function. N/A • true—Enable. N/A
• false—Disable.
Enumeration:
• 1: 1X1
Mimo MIMO. N/A • 2: 2X2 N/A
• 3: 3X3
• 4: 4X4
Boolean:
Greenap Green ap function. N/A • true—Enable. N/A
• false—Disable.
Boolean:
SmartAnten Smart antenna
na function
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
Effective only when
SmartAnten Smart antenna • 1: Auto
N/A SmartAntenna is
naPolicy policy • 2: High-availability enabled.
• 3: High-throughput
802.11n Boolean:
Protection protection N/A • true—Enable. N/A
function.
• false—Disable.
Boolean:
Client11nOn Client dot11n only
ly function.
N/A • true—Enable. N/A
• false—Disable.
Boolean:
• true—Enable. N/A
BandwidthA
Bandwidth • false—Disable.
autoswitch N/A
utoswitch The column is only for
function
2.4GHz radio mode, and
AP/APGroupRadio/Bandwi
dth must be 2.

AP/APGroupRadio11ac
This table contains 802.11ac information of AP group radios.

XML structure
<AP>

85
 <APGroupRadio11ac>
<Radio11ac>
<GroupName></GroupName>
<ModelName></ModelName>
<RadioID></RadioID>
<VHTNSSMulticast></VHTNSSMulticast>
<VHTMCSMulticast></VHTMCSMulticast>
<VHTNSSMandatory></VHTNSSMandatory>
<VHTNSSSupported></VHTNSSSupported>
<Client11acOnly></Client11acOnly>
</Radio11ac>
</APGroupRadio11ac>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupRadio11ac
Table type Multi-instance table
Row name Radio11ac
Restrictions The table is only for 802.11ac radio mode.
Support for row creation
No
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-insensitive.
ModelName AP model name Index N/A
Length: 1 to 63 characters.
Unsigned short.
RadioID Radio ID Index N/A
Value range: 1 to 31.
The VHTNSSMulticast
The NSS for Unsigned short.
VHTNSSMu must be smaller than or
multicast N/A
lticast Value range: 0 to 8. equal to the
VHT-MCS.
VHTNSSMandatory.
The index for Unsigned short.
VHTMCSMu
multicast N/A Value range: 0 to 9, 255. N/A
lticast
VHT-MCS.

86
 Column Column Column Data type and
Remarks
name description type restrictions
The VHTNSSMandatory
must be smaller than or
The maximum equal to the
VHTNSSMa NSS for Unsigned short. VHTNSSSupported, and
N/A
ndatory mandatory Value range: 0 to 8. the VHTNSSMandatory
VHT-MCS. must be greater than or
equal to the
VHTNSSMulticast.
The VHTNSSSupported
The maximum Unsigned short.
VHTNSSSu must be greater than or
NSS for supported N/A
pported Value range: 0 to 8. equal to the
VHT-MCS.
VHTNSSMandatory.
Boolean:
Client11acO Client dot11ac
nly only function.
N/A • true—Enable. N/A
• false—Disable.

AP/APGroupPrvs
This table contains provision information of AP Group.

XML structure
<AP>
<APGroupPrvs>
<Prvs>
<GroupName></GroupName>
<ACHostName></ACHostName>
<ACIPv4></ACIPv4>
<ACIPv6></ACIPv6>
<DnsDomain></DnsDomain>
<DnsServerIPv4></DnsServerIPv4>
<DnsServerIPv6></DnsServerIPv6>
</Prvs>
</APGroupPrvs>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvs
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
No
and deletion

87
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String.
ACHostNam Specify an AC by
N/A Length: 1 to 253 N/A
e its hostname.
characters.
List of string, dotted
Specify an AC by Example: 1.1.1.1,
ACIPv4 N/A decimal notation,
its IPv4 address. 1.1.1.2.
Separated by comma.
List of hexadecimal string,
Specify an AC by Example:
ACIPv6 N/A colon-separated,
its IPv6 address. 1:1::1:1,1:1::1:2.
Separated by comma.
Specify the String.
DnsDomain domain name N/A N/A
suffix. Length: 1 to 253.

Specify a DNS
DnsServerI String, dotted decimal
server by its IPv4 N/A Example: 1.1.1.1.
Pv4 notation.
address.
Specify a DNS
DnsServerI Hexadecimal string,
server by its IPv6 N/A Example: 1:1::1:1.
Pv6 colon-separated.
address.

AP/APGroupPrvsACIPv4
This table contains provision information of AP Group of IPv4 address.

XML structure
<AP>
<APGroupPrvsACIPv4>
<Prvs>
<GroupName></GroupName>
<ACIPv4></ACIPv4>
</Prvs>
</APGroupPrvsACIPv4>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvsACIPv4
Table type Multi-instance table

88
 Item Description
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, dotted decimal
GroupName AP group name Index Example: 1.1.1.1.
notation.
List of string, dotted
Specify an AC by Example: 1.1.1.1,
ACIPv4 N/A decimal notation,
its IPv4 address. 1.1.1.2.
Separated by comma.

AP/APGroupPrvsACIPv6
This table contains provision information of AP group of IPv6 address.

XML structure
<AP>
<APGroupPrvsACIPv6>
<Prvs>
<GroupName></GroupName>
<ACIPv6></ACIPv6>
</Prvs>
</APGroupPrvsACIPv6>
</AP>

Table description
Item Description
Feature name AP
Table name APGroupPrvsACIPv6
Table type Multi-instance table
Row name Prvs
Restrictions None
Support for row creation
Yes
and deletion

89
Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
Example: 1:1::1:1.
Specify an AC by Hexadecimal This column is available
ACIPv6 N/A
its IPv6 address. string, colon-separated. when the SrcAny column
is false.

AP/APListOfGroup
This table contains the AP list of AP groups.

XML structure
<AP>
<APListOfGroup>
<AP>
<GroupName></GroupName>
<ApName></ApName>
</AP>
</APListOfGroup>
</AP>

Table description
Item Description
Feature name AP
Table name APListOfGroup
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, lowercase.
GroupName AP group name Index N/A
Length: 1 to 31 characters.
String, case-sensitive.
ApName AP name Index N/A
Length: 1 to 64 characters.

90
AP/Location
This table contains the informations of locations.

XML structure
<AP>
<Location>
<Location>
<LocationName></LocationName>
</Location>
</Location>
<AP>

Table description
Item Description
Feature name AP
Table name Location
Table type Multi-instance table
Row name Location
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
LocationNa String, lowercase.
Location name Index N/A
me Length: 1 to 31 characters.

AP/APAuthentication
This table contains the informations of AP authentication.

XML structure
<AP>
<APAuthentication>
<Status></Status>
<Method></Method>
<PermitUnauth></PermitUnauth>
<AuthDomain></AuthDomain>
<AclNumber></AclNumber>
<AclName></AclName>
</APAuthentication>

91
 </AP>

Table description
Item Description
Feature name AP
Table name APAuthentication
Table type Single-instance table
Row name N/A
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Boolean:
The status of AP
Status
authentication.
N/A • true—Enable. N/A
• false—Disable.
Enumeration:
The authentication
Method
method
N/A • 1—MAC address. N/A
• 2—Serial ID.
Whether the Boolean:
PermitUnaut un-authenticated • true—Allowed.
N/A N/A
h AP is allowed to
join the AC. • false—Not allowed.

The ISP domain of String, case-insensitive.

AuthDomain remote AP N/A N/A
authentication. Length: 1 to 24 characters.

The ACL number Unsigned short. This column is

AclNumber of local AP N/A unavailable when the AC
authentication. Value range: 200 to 299. uses an ACL name.
This column is
The ACL name of unavailable when the AC
String, case-sensitive.
AclName local AP N/A uses an ACL number.
authentication. Length: 1 to 64 characters.
The ACL name should
not be “all”.

AP/HistorySummary
This table contains information of history summary.

XML structure
<AP>
<HistorySummary>
<Record>
<Date></Date>

92
 <Time></Time>
<ManualApNum></ManualApNum>
<RunApNum></RunApNum>
<OfflineApNum></OfflineApNum>
<UnhealthyApNum></UnhealthyApNum>
<ApGroupNum></ApGroupNum>
<LocationNum></LocationNum>
<NorthIfOutPkt></NorthIfOutPkt>
<NorthIfOutByte></NorthIfOutByte>
<NorthIfInPkt></NorthIfInPkt>
<NorthIfInByte></NorthIfInByte>
</Record>
</HistorySummary>
</AP>

Table description
Item Description
Feature name AP
Table name HistorySummary
Table type Multi-instance table
Row name Record
Restrictions None

Columns
Column Column Column Data type and Remarks
name description type restrictions
Format: YYYY-MM-DD.
The date of the
Date Index Value range: 1970-01-01 to N/A
record,
2100-12-31.
Format: hh:mm.
The time of the
Time Index Value range: 00:00 to N/A
record.
23:59.
ManualApN Number of manual Unsigned integer.
um APs N/A N/A
Value range: 0 to 65535.
Number of running Unsigned integer.
Index APs N/A N/A
Value range: 0 to 65535.
OfflineApNu Number of offline Unsigned integer.
m APs N/A N/A
Value range: 0 to 65535.
UnhealthyA Number of Unsigned integer.
pNum Unhealthy APs N/A N/A
Value range: 0 to 65535.
ApGroupNu Number of AP Unsigned integer.
m groups N/A N/A
Value range: 0 to 65535.

93
 LocationNu Number of Unsigned integer.
m locations N/A N/A
Value range: 0 to 65535.
Packets count of
northbound Unsigned integer.
NorthIfOutP
interface with N/A Value range: 0 to N/A
kt
outbound 4294967295.
direction.
Throughput
statistics of Unsigned integer.
NorthIfOutB northbound
N/A Value range: 0 to N/A
yte interface with
outbound 4294967295.
direction.
Packets count of Unsigned integer.
northbound
NorthIfInPkt N/A Value range: 0 to N/A
interface with
inbound direction. 4294967295.

Throughput
statistics of Unsigned integer.
NorthIfInByt
northbound N/A Value range: 0 to N/A
e
interface with 4294967295.
inbound direction.

AP/AllAP
This table contains the information of all APs.

XML structure
<AP>
<AllAP>
<AP>
<LocationName></LocationName>
<Name></Name>
<Type></Type>
<Status></Status>
<GroupName></GroupName>
<SerialID></SerialID>
<MacAddress></MacAddress>
<Ipv4Address></Ipv4Address>
<Ipv6Address></Ipv6Address>
<OnlineTime></OnlineTime> </AP>
</AllAP>
</AP>

Table description
Item Description
Feature name AP

94
 Item Description
Table name AllAP
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
LocationNa Which location the String, lowercase.
Index N/A
me AP belongs to. Length: 1 to 31 characters.
String, case-sensitive.
Name AP name Index N/A
Length: 1 to 64 characters.
Enumeration:
• 1—Online
AP associated
Status N/A • 2—Offline N/A
status
• 3—Image
downloading
Enumeration:
Type AP type N/A • 1—auto N/A
• 2—manual
The name of AP String, lowercase.
GroupName group which the N/A N/A
AP belongs to. Length: 1 to 31 characters.

String, uppercase.
SerialID AP serial ID. N/A Length: 1 to 127 N/A
characters.
N/A Six groups of two
Example:
MacAddress AP MAC address. hexadecimal digits,
00-0c-af-e3-5d-c0.
hyphen-separated.
Example: 1.1.1.1.
String, dotted decimal This column is
Ipv4Address AP IPv4 address. N/A
notation. unavailable when the AP
uses an IPv6 address.
Example: 1:1::1:1.
Hexadecimal string, This column is
Ipv6Address AP IPv6 address. N/A
colon-separated. unavailable when the AP
uses an IPv4 address.
Unsigned integer.
AP online Value range: 0 to
OnlineTime N/A N/A
duration. 4294967295.
Unit: Second

95
AP/LocalACDB
This table contains local-ac model information.

XML structure
<AP>
<LocalACDB>
<Model>
<ModelName></ModelName>
<HardwareVersion></HardwareVersion>
<SoftwareVersion></SoftwareVersion>
</Model>
</LocalACDB>
</AP>

Table description
Item Description
Feature name AP
Table name LocalACDB
Table type Multi-instance table
Row name Model
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Local-ac model String, case-insensitive.
ModelName name Index N/A
Length: 1 to 63 characters.
Enumeration:
• 1—Ver.A
• 2—Ver.B
HardwareVe The version of
Index • 3—Ver.C N/A
rsion Hardware.
• 4—Ver.D
• 5—Ver.E
• 6—Ver.F
SoftwareVer The version of String
sion Software. N/A N/A
Length:1 to 31.

AP/LocalAC
This table contains information of local-ac.

96
XML structure
<AP>
<LocalAC>
<AC>
<Name></Name>
<Model></Model>
<CfgSerialID></CfgSerialID>
<Status></Status>
<EchoInterval></EchoInterval>
<RetransInterval></RetransInterval>
<RetransCount></RetransCount>
<FirmwareUpgrade></FirmwareUpgrade>
<Ipv4Address></Ipv4Address>
<Ipv6Address></Ipv6Address>
</AC>
</LocalAC>
</AP>

Table description
Item Description
Feature name AP
Table name LocalAC
Table type Multi-instance table
Row name AC
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name Local-ac name Index N/A
Length: 1 to 64 characters.
Local-ac model String, case-insensitive.
Model name N/A N/A
Length: 1 to 63 characters.
Configured String, uppercase.
CfgSerialID Local-ac serial ID N/A N/A
Length: 1 to 63 characters.
Enumeration:
Local-ac • 1—Online
Status N/A N/A
associated status • 2—Offline
• 3—Image downloading

97
 Column Column Column Data type and
Remarks
name description type restrictions
The transmit Unsigned short.
EchoInterval interval of tunnel N/A Value range: 0, 5 to 255. N/A
echo messages. Unit: seconds

The interval to Unsigned short.

RetransInter
retransmit a N/A Value range: 3 to 8 N/A
val
request message. Unit: seconds
The allowed
maximum number
of retransmission Unsigned short.
RetransCou
attempts. If the N/A Value range: 2 to 5. N/A
nt
count is reached, Unit: seconds
the tunnel will be
down.
Whether the AC
will upgrade AP’s Boolean:
FirmwareUp firmware
grade automatically if the
N/A • true—Enable. N/A
software is • false—Disable.
mismatch.
Example: 1.1.1.1.
Local AC IPv4 String, dotted decimal This column is
Ipv4Address N/A
address notation. unavailable when the AC
uses an IPv6 address.
Example: 1:1::1:1.
Local AC IPv6 Hexadecimal string, This column is
Ipv6Address N/A unavailable when the
address colon-separated.
ACuses an IPv4
address.

AP/ContainerTopology
This table contains information about all PoE ports on the container and units (such as WAP and
WTU) connected to the container (such as SPM and WT).

XML structure
<AP>
<ContainerTopology>
<Container>
<ContainerName></ContainerName>
<PoePort></PoePort>
<PoeStatus></PoeStatus>
<UnitName></UnitName>
</Container>
</ContainerTopology>
</AP>

98
Table description
Item Description
Feature name AP
Table name ContainerTopology
Table type Multi-instance table
Row name Container
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ContainerNa String, case-sensitive.
me Container name Index N/A
Length: 1 to 64 characters.
Port on the
PoePort Index Unsigned short. See AP/APDB/.
container
Boolean:
PoeStatus PoE port status N/A • true—Enable. N/A
• false—Disable.
String, case-sensitive.
UnitName Unit name N/A N/A
Length: 1 to 64 characters.

AP/Container
This table contains information about containers.

XML structure
<AP>
<Container>
<AP>
<Name></Name>
<Model></Model>
<CfgMacAddress></CfgMacAddress>
<APNum></APNum>
<Status></Status>
<Ipv4Address></Ipv4Address>
<Ipv6Address></Ipv6Address>
<OnlineTime></OnlineTime>
<LastDownReason></LastDownReason>
<LastRebootReason></LastRebootReason>
<OfflineMoment></OfflineMoment>
</AP>

99
 </Container>
</AP>

Table description
Item Description
Feature name AP
Table name Container
Table type Multi-instance table
Row name AP
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
String, case-sensitive.
Name AP name Index N/A
Length: 1 to 64 characters.
String, case-insensitive.
Model AP model name N/A N/A
Length: 1 to 63 characters.
Six groups of two
CfgMacAddr Configured AP Example:
N/A hexadecimal digits,
ess MAC address 00-0c-af-e3-5d-c0.
hyphen-separated.
Number of APs Unsigned integer.
APNum connected to the N/A Value range: 0 to 65535. N/A
container
Enumeration:
AP association • 1—Online.
Status N/A N/A
status • 2—Image
downloading.
Example: 1.1.1.1.
String, dotted decimal This column is
Ipv4Address AP IPv4 address N/A
notation. unavailable when the AP
uses an IPv6 address.
Example: 1:1::1:1.
Hexadecimal string, This column is
Ipv6Address AP IPv6 address N/A
colon-separated. unavailable when the AP
uses an IPv4 address.
Unsigned integer.
Time since the AP Value range: 0 to
OnlineTime N/A N/A
came online. 4294967295.
Unit: Second
Cause of the String.
LastDownR
tunnel down the N/A N/A
eason Length: 1 to 31 characters.
last time.

100
Column Column Column Data type and
Remarks
name description type restrictions
Cause of the AP String.
LastReboot
rebooting in last N/A Length: 1 to 31 characters. N/A
Reason
time.
DateTime.
OfflineMom The time of the AP Example:
N/A Format:
ent offline in last time. 2014-05-07T09:35:07
YYYY-MM-DDTHH:MM:SS

101
Contents
AppProfile·······················································································1
AppProfile/Profiles ····················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
AppProfile
AppProfile/Profiles
This table contains application profile information.

XML structure
<AppProfile>
<Profiles>
<Profile>
<ProfileName></ProfileName>
</Profile>
</Profiles>
</AppProfile>

Table description
Item Description
Feature name AppProfile
Table name Profiles
Table type Multi-instance table
Row name Profile
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String: case-insensitive.
Name of the
Length: 1 to 100 characters.
ProfileName application Index N/A
profile Only numbers, letters, and
underscores (_) are allowed.

1
Contents
AppProfile·······················································································1
AppProfile/Profiles ····················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1

i
AppProfile
AppProfile/Profiles
This table contains application profile information.

XML structure
<AppProfile>
<Profiles>
<Profile>
<ProfileName></ProfileName>
</Profile>
</Profiles>
</AppProfile>

Table description
Item Description
Feature name AppProfile
Table name Profiles
Table type Multi-instance table
Row name Profile
Restrictions None

Columns
Column Column Column
Data type and restrictions Remarks
name description type
String: case-insensitive.
Name of the
Length: 1 to 100 characters.
ProfileName application Index N/A
profile Only numbers, letters, and
underscores (_) are allowed.

1
Contents
AppProxy ·······················································································1
AppProxy/MoveBeforeRules········································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AppProxy/ImportCertificates ········································································································· 1
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AppProxy/DeleteCertificates ········································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 3
Columns ···························································································································· 3
AppProxy/CommitWhiteLists ········································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4

i
AppProxy
AppProxy/MoveBeforeRules
This table is used to move a rule to before another rule.

XML structure
<AppProxy>
<MoveBeforeRules>
<Rule>
<ID></ID>
<DestID></DestID>
</Rule>
</MoveBeforeRules>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name MoveBeforeRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ID of the rule to Unsigned integer.
ID N/A N/A
be moved Value range: 1 to 65535
ID of the
Unsigned integer. When the value is
reference rule
DestID N/A 65536, the rule is
before which the Value range: 1 to 65536 placed after all rules.
rule is placed

AppProxy/ImportCertificates
This table is used to import the certificate for SSL server in SSL decryption.

1
XML structure
<AppProxy>
<ImportCertificates>
<ImportCertificate>
<FileName></FileName>
<Trust></Trust>
<Password></Password>
</ImportCertificate>
</ImportCertificates>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name ImportCertificates
Table type Multi-instance table
Row name ImportCertificate
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
File name of the String, case-insensitive.
FileName Index N/A
certificate Length: 1 to 255 characters.
Enumeration:
Credibility of the • 0—untrust.
Trust N/A N/A
certificate • 1—trust.
• 2—untrust and trust.

Password of the String, case-insensitive.

Password N/A N/A
certificate Length: 1 to 31 characters.

AppProxy/DeleteCertificates
This table is used to delete the imported certificate.

XML structure
<AppProxy>
<DeleteCertificates>
<FileName></FileName>
</DeleteCertificates>

2
 </AppProxy>

Table description
Item Description
Feature name AppProxy
Table name DeleteCertificates
Table type Single-instance table
Row name None
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
File name of the String, case-insensitive.
FileName Index. N/A
certificate Length: 1 to 255 characters.

AppProxy/CommitWhiteLists
This table contains information about committing SSL whitelist.

XML structure
<AppProxy>
<CommitWhiteLists>
<Commit></Commit>
</CommitWhiteLists>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name CommitWhiteLists
Table type Single-instance table
Row name None
Restrictions None

3
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Action of
Commit committing SSL N/A This column must be empty. N/A
whitelist

4
Contents
AppProxy ·······················································································1
AppProxy/PolicyRules ················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 1
Columns ···························································································································· 1
AppProxy/RuleSrcAddrs ·············································································································· 2
XML structure ····················································································································· 2
Table description ················································································································· 2
Columns ···························································································································· 2
AppProxy/RuleDestAddrs ············································································································ 3
XML structure ····················································································································· 3
Table description ················································································································· 3
Columns ···························································································································· 4
AppProxy/RuleSrcSecZones ········································································································ 4
XML structure ····················································································································· 4
Table description ················································································································· 4
Columns ···························································································································· 5
AppProxy/RuleDestSecZones······································································································· 5
XML structure ····················································································································· 5
Table description ················································································································· 5
Columns ···························································································································· 6
AppProxy/RuleUsers ·················································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7
AppProxy/RuleUserGrps ············································································································· 7
XML structure ····················································································································· 7
Table description ················································································································· 8
Columns ···························································································································· 8
AppProxy/RuleServGrps·············································································································· 8
XML structure ····················································································································· 8
Table description ················································································································· 9
Columns ···························································································································· 9
AppProxy/WhiteListHostNames ···································································································· 9
XML structure ····················································································································· 9
Table description ··············································································································· 10
Columns ·························································································································· 10
AppProxy/WhiteListPredefine ····································································································· 10
XML structure ··················································································································· 10
Table description ··············································································································· 10
Columns ·························································································································· 11
AppProxy/WhiteListPredefineChromeHsts ····················································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 11
Columns ·························································································································· 12
AppProxy/TrustCertificate ·········································································································· 12
XML structure ··················································································································· 12
Table description ··············································································································· 12
Columns ·························································································································· 12

i
AppProxy
AppProxy/PolicyRules
This table contains proxy rule information.

XML structure
<AppProxy>
<PolicyRules>
<Rule>
<ID></ID>
<RuleName></RuleName>
<Action></Action>
<Enable></Enable>
</Rule>
</PolicyRules>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name PolicyRules
Table type Multi-instance table
Row name Rule
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
When creating a rule, if the
ID is set to 0, the device will
Unsigned integer.
ID Rule ID Index automatically assign an ID.
Value range: 0 to 65536.
The value 65536 is
reserved for default rule.
The value cannot be
“default”.
String, case-insensitive.
RuleName Rule name N/A When operating the default
Length: 1 to 63 characters.
rule, this column cannot be
specified.
Action Action for the N/A Enumeration: N/A

1
 Column Column Column Data type and
Remarks
name description type restrictions
rule • 1—No proxy.
• 2—SSL decrypt.
• 3—TCP proxy.
Enumeration: When operating the default
Enabling status
Enable
of the rule
N/A • 0—Disabled. rule, this column cannot be
• 1—Enabled. set to 0.

AppProxy/RuleSrcAddrs
This table contains source address object group information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleSrcAddrs>
<SrcAddr>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
</SrcAddr>
</RuleSrcAddrs>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleSrcAddrs
Table type Multi-instance table
Row name SrcAddr
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

2
 Column Column Column Data type and
Remarks
name description type restrictions
Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.

Data Members include:

NameList Object group list N/A
structure • NameItem
Name of the String, case-insensitive.
NameItem source address N/A The value cannot be “any”.
object group Length: 0 to 31 characters.

AppProxy/RuleDestAddrs
This table contains destination address object group information for an existing app-proxy policy
rule.

XML structure
<AppProxy>
<RuleDestAddrs>
<DestAddr>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
</DestAddr>
</RuleDestAddrs>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleDestAddrs
Table type Multi-instance table
Row name DestAddr
Restrictions None
Support for row creation and deletion Yes

3
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.

Data Members include:

NameList Object group list N/A
structure • NameItem
Name of the
destination String, case-insensitive.
NameItem N/A The value cannot be “any”.
address object Length: 0 to 31 characters.
group

AppProxy/RuleSrcSecZones
This table contains source security zone information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleSrcSecZones>
<SrcSecZone>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
</SrcSecZone>
</RuleSrcSecZones>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleSrcSecZones
Table type Multi-instance table
Row name SrcSecZone
Restrictions None
Support for row creation and deletion Yes

4
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.

Data Members include:

NameList Zone list N/A
structure • NameItem
Name of the String, case-insensitive. The value cannot be
NameItem source security N/A
Length: 0 to 31 characters. “any”.
zone

AppProxy/RuleDestSecZones
This table contains destination security zone information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleDestSecZones>
<DestSecZone>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>
<NameItem></NameItem>
</NameList>
<DestSecZone>
</RuleDestSecZones>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleDestSecZones
Table type Multi-instance table
Row name DestSecZone
Restrictions None
Support for row creation and deletion Yes

5
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.

Data Members include:

ZoneList Zone list N/A
structure • NameItem
Name of the String, case-insensitive. The value cannot be
NameItem destination N/A
Length: 0 to 31 characters. “any”.
security zone

AppProxy/RuleUsers
This table contains user information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleUsers>
<User>
<ID></ID>
<IsIncrement></IsIncrement>
<UserList>
<UserName></UserName>
<DomainName></DomainName>
</UserList>
</User>
</RuleUsers>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleUsers
Table type Multi-instance table
Row name User
Restrictions None
Support for row creation and deletion Yes

6
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.
Members include:
Data
UserList User list
structure • UserName N/A
• DomainName
The user name cannot
String, case-sensitive. be a, al, or all, and it
UserName Name of the user N/A cannot contain any of the
Length: 1 to 55 characters. following characters: \ | / :
* ? < > @.
The domain name
cannot contain any of the
following characters: \ |
String, case-sensitive. / ?: * ? < > @, and it
Name of the
DomainName N/A cannot be d, de, def,
domain Length: 0 to 255 characters. defa, defau, defaul,
default, i, if, if-, if-u, if-un,
if-unk, if-unkn, if-unkno,
if-unknow, or if-unknown.

AppProxy/RuleUserGrps
This table contains user group information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleUserGrps>
<UserGrp>
<ID></ID>
<IsIncrement></IsIncrement>
<UserGrpList>
<UserGrpName></UserGrpName>
<DomainName></DomainName>
</UserGrpList>
</UserGrp>
</RuleUserGrps>
</AppProxy>

7
Table description
Item Description
Feature name AppProxy
Table name RuleUserGrps
Table type Multi-instance table
Row name UserGrp
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.
Members include:
Data
UserGrpList User group list
structure • UserGrpName N/A
• DomainName

UserGrpNam Name of the String, case-insensitive.

N/A N/A
e user group Length: 1 to 200 characters.
The domain name cannot
contain any of the following
characters: \ | / ?: * ? < > @,
DomainNam Name of the String, case-sensitive. and it cannot be d, de, def,
N/A
e domain Length: 0 to 255 characters. defa, defau, defaul, default,
i, if, if-, if-u, if-un, if-unk,
if-unkn, if-unkno, if-unknow,
or if-unknown.

AppProxy/RuleServGrps
This table contains service object group information for an existing app-proxy policy rule.

XML structure
<AppProxy>
<RuleServGrps>
<ServGrp>
<ID></ID>
<IsIncrement></IsIncrement>
<NameList>

8
 <NameItem></NameItem>
</NameList>
</ServGrp>
</RuleServGrps>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name RuleServGrps
Table type Multi-instance table
Row name ServGrp
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer.
ID Rule ID Index N/A
Value range: 1 to 65535

Whether to Boolean:
IsIncrement increment the N/A • true—Yes. N/A
data • false—No.

Service group Data Members include:

NameList N/A
list structure • NameItem
Name of the String, case-insensitive.
NameItem service object N/A The value cannot be “any”.
group Length: 0 to 31 characters.

AppProxy/WhiteListHostNames
This table contains information of user-defined host name whitelist.

XML structure
<AppProxy>
<WhiteListHostNames>
<HostName>
<Name></Name>
</HostName>
</WhiteListHostNames>
</AppProxy>

9
Table description
Item Description
Feature name AppProxy
Table name WhiteListHostNames
Table type Multi-instance table
Row name HostName
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Colum Data type and
Remarks
name description n type restrictions
String, case-insensitive. The host name may contain
Name Host name Index
Length: 1 to 63 characters. space.

AppProxy/WhiteListPredefine
This table contains information of pre-defined host name whitelist.

XML structure
<AppProxy>
<WhiteListPredefine>
<HostName>
<Type></Type>
<Name></Name>
<Enable></Enable>
</HostName>
</WhiteListPredefine>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name WhiteListPredefine
Table type Multi-instance table
Row name HostName
Restrictions None

10
 Item Description
Support for row creation and deletion No

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Whether the host Enumeration:
name belongs to
Type
the pre-define
Index • 1—Not in chrome-HSTS. N/A
chrome-HSTS list • 2—in chrome-HSTS.

String, case-insensitive. The host name may

Name Host name Index
Length: 1 to 63 characters. contain spaces.

Enumeration:
Enabling status of
Enable
the host name
N/A • 0—Disable. N/A
• 1—Enable.

AppProxy/WhiteListPredefineChromeHsts
This table contains the state information of chrome-HSTS in pre-defined host name whitelist.

XML structure
<AppProxy>
<WhiteListPredefineChromeHsts>
<Enable></Enable>
</WhiteListPredefineChromeHsts>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name WhiteListPredefineChromeHsts
Table type Single-instance table
Row name None
Restrictions None
Support for row creation and deletion No

11
Columns
Column Column Column Data type and
Remarks
name description type restrictions
Enabling status Boolean:
of host names in
Enable
chrome-HSTS
N/A • true—Enabled N/A
whitelist • false—Disabled

AppProxy/TrustCertificate
This table contains credibility information of certificates.

XML structure
<AppProxy>
<TrustCertificates>
<TrustCertificate>
<FileName></FileName>
<Trust></Trust>
</TrustCertificate>
</TrustCertificates>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name TrustCertificates
Table type Multi-instance table
Row name TrustCertificate
Restrictions None
Support for row creation and deletion Yes

Columns
Column Column Column
Data type and restrictions Remarks
name description type
File name of the String, case-insensitive.
FileName Index N/A
certificate Length: 1 to 63 characters
Enumeration:
Credibility type of • 0—untrust.
Trust N/A N/A
the certificate • 1—trust.
• 2—trust&untrust.

12
13
Contents
AppProxy ·······················································································1
AppProxy/GetRules ···················································································································· 1
XML structure ····················································································································· 1
Table description ················································································································· 2
Columns ···························································································································· 2
AppProxy/QueryRules················································································································· 3
XML structure ····················································································································· 3
Table description ················································································································· 4
Columns ···························································································································· 4
AppProxy/RuleSrcAddrs ·············································································································· 6
XML structure ····················································································································· 6
Table description ················································································································· 6
Columns ···························································································································· 7
AppProxy/RuleDestAddrs ············································································································ 7
XML structure ····················································································································· 7
Table description ················································································································· 7
Columns ···························································································································· 8
AppProxy/RuleSrcSecZones ········································································································ 8
XML structure ····················································································································· 8
Table description ················································································································· 8
Columns ···························································································································· 9
AppProxy/RuleDestSecZones······································································································· 9
XML structure ····················································································································· 9
Table description ················································································································· 9
Columns ·························································································································· 10
AppProxy/RuleUsers ················································································································ 10
XML structure ··················································································································· 10
Table description ··············································································································· 10
Columns ·························································································································· 11
AppProxy/RuleUserGrps ··········································································································· 11
XML structure ··················································································································· 11
Table description ··············································································································· 12
Columns ·························································································································· 12
AppProxy/RuleServGrps············································································································ 12
XML structure ··················································································································· 12
Table description ··············································································································· 13
Columns ·························································································································· 13
AppProxy/WhiteListHostNames ·································································································· 13
XML structure ··················································································································· 13
Table description ··············································································································· 14
Columns ·························································································································· 14
AppProxy/WhiteListPredefine ····································································································· 14
XML structure ··················································································································· 14
Table description ··············································································································· 14
Columns ·························································································································· 15
AppProxy/WhiteListPredefineChromeHsts ····················································································· 15
XML structure ··················································································································· 15
Table description ··············································································································· 15
Columns ·························································································································· 16
AppProxy/TrustCertificate ·········································································································· 16
XML structure ··················································································································· 16
Table description ··············································································································· 16
Columns ·························································································································· 16
AppProxy/Certificates ··············································································································· 17
XML structure ··················································································································· 17
Table description ··············································································································· 17
Columns ·························································································································· 17

i
AppProxy/Specifications ············································································································ 18
XML structure ··················································································································· 18
Table description ··············································································································· 18
Columns ·························································································································· 18

ii
AppProxy
AppProxy/GetRules
This table contains information about proxy rules.

XML structure
<AppProxy>
<GetRules>
<Rule>
<ID></ID>
<Name></Name>
<Action></Action>
<SrcZoneList>
<SrcZoneItem></SrcZoneItem>
</SrcZoneList>
<DestZoneList>
<DestZoneItem></DestZoneItem>
</DestZoneList>
<SrcAddrList>
<SrcAddrItem></SrcAddrItem>
</SrcAddrList>
<DestAddrList>
<DestAddrItem></DestAddrItem>
</DestAddrList>
<ServGrpList>
<ServGrpItem></ServGrpItem>
</ServGrpList>
<UserList>
<UserItem></UserItem>
<DomainItem></DomainItem>
</UserList>
<UserGrpList>
<UserGrpItem></UserGrpItem>
<DomainItem></DomainItem>
</UserGrpList>
<Enable></Enable>
<AllRulesCount></AllRulesCount>
</Rule>
</GetRules>
</AppProxy>

1
Table description
Item Description
Feature name AppProxy
Table name GetRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
Unsigned integer. The value 65536 is
ID Rule ID Index
Value range: 1 to 65536 reserved for default rule.

String, case-insensitive.
Name Rule name N/A N/A
Length: 1 to 63 characters.
Enumeration:
Action for the • 1—No proxy.
Action N/A N/A
rule • 2—SSL decrypt.
• 3—TCP proxy.

Data Members include:

SrcZoneList Source zone list N/A
structure • SrcZoneItem
Name of the String, case-insensitive.
SrcZoneItem source security N/A N/A
zone Length: 0 to 31 characters.

Destination zone Data Members include:

DestZoneList N/A
list structure • DestZoneItem
Name of the String, case-insensitive.
DestZoneItem destination N/A N/A
security zone Length: 0 to 31 characters.

Source address Data Members include:

SrcAddrList N/A
list structure • SrcAddrItem
Name of the String, case-insensitive.
SrcAddrItem source address N/A N/A
object group Length: 0 to 31 characters.

Destination Data Members include:

DestAddrList N/A
address list structure • DestAddrItem
Name of the
destination String, case-insensitive.
DestAddrItem N/A N/A
address object Length: 0 to 31 characters.
group

Data Members include:

ServGrpList Service group list N/A
structure • ServGrpItem
ServGrpItem Name of the N/A String, case-insensitive. N/A

2
 Column Column Column Data type and
Remarks
name description type restrictions
service object Length: 0 to 31 characters.
group
Members include:
Data
UserList User list
structure • UserItem N/A
• DomainItem
The user name cannot be
String, case-sensitive. a, al, or all, and it cannot
UserItem Name of the user N/A contain any of the
Length: 0 to 55 characters. following characters: \ | / :
* ? < > @.
The domain name cannot
contain any of the
following characters: \ |
String, case-insensitive. / ?: * ? < > @, and it
Name of the
DomainItem N/A cannot be d, de, def,
domain Length: 0 to 255 characters. defa, defau, defaul,
default, i, if, if-, if-u, if-un,
if-unk, if-unkn, if-unkno,
if-unknow, or if-unknown.
Members include:
Data
UserGrpList User group list
structure • UserGrpItem N/A
• DomainItem

Name of the user String, case-insensitive.

UserGrpItem N/A N/A
group Length: 0 to 200 characters.
The domain name cannot
contain any of the
following characters: \ |
String, case-insensitive. / ?: * ? < > @, and it
Name of the
DomainItem N/A cannot be d, de, def,
domain Length: 0 to 255 characters. defa, defau, defaul,
default, i, if, if-, if-u, if-un,
if-unk, if-unkn, if-unkno,
if-unknow, or if-unknown.
Enumeration:
Enabling status
Enable
of the rule
N/A • 0—Disabled. N/A
• 1—Enabled.
AllRulesCoun Total number of
N/A Unsigned integer.
t rules

AppProxy/QueryRules
This table contains information about proxy rules.

XML structure
<AppProxy>
<QueryRules>
<Rule>
<ID></ID>

3
 <Name></Name>
<Action></Action>
<SrcZoneList>
<SrcZoneItem></SrcZoneItem>
</SrcZoneList>
<DestZoneList>
<DestZoneItem></DestZoneItem>
</DestZoneList>
<SrcAddrList>
<SrcAddrItem></SrcAddrItem>
</SrcAddrList>
<DestAddrList>
<DestAddrItem></DestAddrItem>
</DestAddrList>
<ServGrpList>
<ServGrpItem></ServGrpItem>
</ServGrpList>
<UserList>
<UserItem></UserItem>
<DomainItem></DomainItem>
</UserList>
<UserGrpList>
<UserGrpItem></UserGrpItem>
<DomainItem></DomainItem>
</UserGrpList>
<Enable></Enable>
<AllRulesCount></AllRulesCount>
</Rule>
</QueryRules>
</AppProxy>

Table description
Item Description
Feature name AppProxy
Table name QueryRules
Table type Multi-instance table
Row name Rule
Restrictions None

Columns
Column Column Column Data type and
Remarks
name description type restrictions
ID Rule ID Index Unsigned integer. The value 65536 is
reserved for the default

4
Column Column Column Data type and
Remarks
name description type restrictions
Value range: 1 to 65536 rule.

String, case-insensitive.
Name Rule name N/A N/A
Length: 1 to 63 characters.
Enumeration:
Action for the • 1—No proxy.
Action N/A N/A
rule • 2—SSL decrypt.
• 3—TCP proxy.

Data Members include:

SrcZoneList Source zone list N/A
structure • SrcZoneItem
Name of the String, case-insensitive.
SrcZoneItem source security N/A N/A
zone Length: 0 to 31 characters.

Destination zone Data Members include:

DestZoneList N/A
list structure • DestZoneItem
Name of the String, case-insensitive.
DestZoneItem destination N/A N/A
security zone Length: 0 to 31 characters.

Source address Data Members include:

SrcAddrList N/A
list structure • SrcAddrItem
Name of the String, case-insensitive.
SrcAddrItem source address N/A N/A
object group Length: 0 to 31 characters.

Destination Data Members include:

DestAddrList N/A
address list structure • DestAddrItem
Name of the
destination String, case-insensitive.
DestAddrItem N/A N/A
address object Length: 0 to 31 characters.
group

Data Members include:

ServGrpList Service group list N/A
structure • ServGrpItem
Name of the String, case-insensitive.
ServGrpItem service object N/A N/A
group Length: 0 to 31 characters.

Members include:
Data
UserList User list
structure • UserItem N/A
• DomainItem
The user name cannot be
String, case-sensitive. a, al, or all, and it cannot
UserItem Name of the user N/A contain any of the
Length: 0 to 55 characters. following characters: \ | / :
* ? < > @.
The domain name cannot
contain any of the
Name of the String, case-insensitive. following characters: \ |
DomainItem N/A / ?: * ? < > @, and it
domain Length: 0 to 255 characters. cannot be d, de, def,
defa, defau, defaul,
default, i, if, if-, if-u, if-un,

5
 Column Column Column Data type and
Remarks
name description type restrictions
if-unk, if-unkn, if-unkno,
if-unknow, or if-unknown.
Members include:
Data
UserGrpList User group list
structure • UserGrpItem N/A
• DomainItem

Name of the user String, case-insensitive.

UserGrpItem N/A N/A
group Length: 0 to 200 characters.
The domain name cannot
contain any of the
following characters: \ |
String, case-insensitive. / ?: * ? < > @, and it
Name of the
DomainItem N/A cannot be d, de, def,
domain Length: 0 to 255 characters. defa, defau, defaul,
default, i, if, if-, if-u, if-un,
if-unk, if-unkn, if-unkno,