- Table of Contents
-
- 11-Security Command Reference
- 00-Preface
- 01-AAA commands
- 02-Portal commands
- 03-User profile commands
- 04-Password control commands
- 05-Keychain commands
- 06-Public key management commands
- 07-PKI commands
- 08-IPsec commands
- 09-Group domain VPN commands
- 10-SSH commands
- 11-SSL commands
- 12-SSL VPN commands
- 13-ASPF commands
- 14-APR commands
- 15-Session management commands
- 16-Connection limit commands
- 17-Object group commands
- 18-Object policy commands
- 19-Attack detection and prevention commands
- 20-ARP attack protection commands
- 21-ND attack defense commands
- 22-uRPF commands
- 23-Crypto engine commands
- 24-FIPS commands
- 25-SMA commands
- Related Documents
-
Title | Size | Download |
---|---|---|
02-Portal commands | 448.50 KB |
Contents
display portal auth-error-record
display portal auth-fail-record
display portal captive-bypass statistics
display portal extend-auth-server
display portal packet statistics
display portal redirect statistics
display portal safe-redirect statistics
exclude-attribute (portal authentication server view)
ip (portal authentication server view)
ipv6 (portal authentication server view)
port (portal authentication server view)
portal { ipv4-max-user | ipv6-max-user }
portal auth-error-record enable
portal auth-error-record export
portal auth-fail-record enable
portal auth-fail-record export
portal authorization strict-checking
portal captive-bypass optimize delay
portal dual-stack traffic-separate enable
portal free-all except destination
portal ipv6 free-all except destination
portal safe-redirect forbidden-file
portal safe-redirect forbidden-url
portal safe-redirect user-agent
portal traffic-accounting disable
reset portal auth-error-record
reset portal captive-bypass statistics
reset portal packet statistics
reset portal redirect statistics
reset portal safe-redirect statistics
server-detect (portal authentication server view)
server-detect (portal Web server view)
server-type (portal authentication server view/portal Web server view)
Portal commands
app-id
Use app-id to specify the APP ID for QQ authentication.
Use undo app-id to restore the default.
Syntax
app-id app-id
undo app-id
Default
An APP ID for QQ authentication exists.
Views
QQ authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
app-id: Specifies the APP ID for QQ authentication.
Usage guidelines
To use QQ authentication for portal users, you must go to the Tencent Open Platform (http://connect.qq.com/intro/login) to finish the following tasks:
1. Register as a developer by using a valid QQ account.
2. Apply the access to the platform for your website. The website is the webpage to which users are redirected after passing QQ authentication.
You will obtain the APP ID and APP key from the Tencent Open Platform after your application succeeds.
After a portal user passes QQ authentication, the QQ authentication server sends the authorization code of the user to the portal Web server. After the portal Web server receives the authorization code, it sends the authorization code of the user, the APP ID, and the APP key to the QQ authentication server for verification. If the information is verified as correct, the device determines that the user passes QQ authentication.
Examples
# Specify 101235509 as the APP ID for QQ authentication.
<Sysname> system-view
[Sysname] portal extend-auth-server qq
[Sysname-portal-extend-auth-server-qq] app-id 101235509
Related commands
display portal extend-auth-server
app-key
Use app-key to specify the APP key for QQ authentication.
Use undo app-key to restore the default.
Syntax
app-key { cipher | simple } app-key
undo app-key
Default
An APP key for QQ authentication exists.
Views
QQ authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
cipher: Specifies the APP key in encrypted form.
simple: Specifies the APP key in plaintext form.
app-key: Specifies the APP key string. Its plaintext form is a case-sensitive string of 1 to 64 characters. Its encrypted form is a case-sensitive string of 1 to 117 characters.
Usage guidelines
To use QQ authentication for portal users, you must go to the Tencent Open Platform (http://connect.qq.com/intro/login) to finish the following tasks:
1. Register as a developer by using a valid QQ account.
2. Apply the access to the platform for your website. The website is the webpage to which users are redirected after passing QQ authentication.
You will obtain the APP ID and APP key from the Tencent Open Platform after your application succeeds.
After a portal user passes QQ authentication, the QQ authentication server sends the authorization code of the user to the portal Web server. After the portal Web server receives the authorization code, it sends the authorization code of the user, the APP ID, and the APP key to the QQ authentication server for verification. If the information is verified as correct, the device determines that the user passes QQ authentication.
Examples
# Specify 8a5428e6afdc3e2a2843087fe73f1507 in plaintext form as the APP key for QQ authentication.
<Sysname> system-view
[Sysname] portal extend-auth-server qq
[Sysname-portal-extend-auth-server-qq] app-key simple 8a5428e6afdc3e2a2843087fe73f1507
Related commands
display portal extend-auth-server
auth-url
Use auth-url to specify the URL of the QQ authentication server.
Use undo auth-url to delete the URL of the QQ authentication server.
Syntax
auth-url url-string
undo auth-url
Default
The URL of QQ authentication server is https://graph.qq.com.
Views
QQ authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
url-string: Specifies the URL of the QQ authentication server, a case-sensitive string of 1 to 256 characters. Make sure that you specify the actual URL of the QQ authentication server.
Examples
# Specify http://oauth.qq.com as the URL of the QQ authentication server.
<Sysname> system-view
[Sysname] portal extend-auth-server qq
[Sysname-portal-extend-auth-server-qq] auth-url http://oauth.qq.com
Related commands
display portal extend-auth-server
captive-bypass enable
Use captive-bypass enable to enable the captive-bypass feature.
Use undo captive-bypass enable to disable the captive-bypass feature.
Syntax
captive-bypass [ android | ios [ optimize ] ] enable
undo captive-bypass [ android | ios [ optimize ] ] enable
Default
The captive-bypass feature is disabled. The device automatically pushes the portal authentication page to the iOS devices and some Android devices when they are connected to the network.
Views
Portal Web server view
Predefined user roles
network-admin
mdc-admin
Parameters
android: Enables the captive-bypass feature for Android users.
ios: Enables the captive-bypass feature for iOS users.
optimize: Enables the optimized captive-bypass feature.
Usage guidelines
With the captive-bypass feature enabled, the device does not automatically push the portal authentication page to iOS devices and some Android devices when they are connected to the network. The device pushes the portal authentication page only when the user accesses the Internet by using a browser.
The optimized captive-bypass feature applies only to iOS mobile devices. The device automatically pushes the portal authentication page to iOS mobile devices when they are connected to the network. Users can press the home button to return to the desktop without triggering portal authentication, and the Wi-Fi connection is not disabled.
You can repeat this command to enable the captive-bypass feature for both Android and iOS users.
If you do not specify any parameters, this command enables the captive-bypass feature for both Android and iOS users.
Examples
# Enable the captive-bypass feature.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] captive-bypass enable
# Enable the optimized captive-bypass feature for iOS users.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] captive-bypass ios optimize enable
# Enable the captive-bypass feature for Android users.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] captive-bypass android enable
Related commands
display portal captive-bypass statistics
display portal web-server
default-logon-page
Use default-logon-page to specify the default authentication page file for the local portal Web server.
Use undo default-logon-page to restore the default.
Syntax
default-logon-page file-name
undo default-logon-page
Default
A default authentication page file is specified for the local portal Web server.
Views
Local portal Web server view
Predefined user roles
network-admin
mdc-admin
Parameters
file-name: Specifies the default authentication page file by the file name (without the file storage directory). The file name is a case-sensitive string of 1 to 91 characters. Valid characters are letters, digits, dots (.) and underscores (_).
Usage guidelines
You must edit the default authentication pages, compress them to a .zip file, and then upload the file to the root directory of the storage medium of the device.
After you use the default-logon-page command to specify the file, the device decompresses the file to get the authentication pages. The device then sets them as the default authentication pages for local portal authentication.
Examples
# Specify file pagefile1.zip as the default authentication page file for local portal authentication.
<Sysname> system-view
[Sysname] portal local-web-server http
[Sysname-portal-local-websvr-http] default-logon-page pagefile1.zip
Related commands
portal local-web-server
display portal
Use display portal to display portal configuration and portal running state.
Syntax
display portal interface interface-type interface-number
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
interface-type interface-number: Specifies an interface by its type and number.
Examples
# Display portal configuration and portal running state on GigabitEthernet 1/1/1.
<Sysname> display portal interface gigabitethernet 1/1/1
Portal information of GigabitEthernet1/1/1
NAS-ID profile: aaa
Authorization : Strict checking
ACL : Enabled
User profile : Disabled
Dual stack : Disabled
Dual traffic-separate: Disabled
IPv4:
Portal status: Enabled
Authentication type: Layer3
Portal Web server: wbs(active)
Secondary portal Web server: wbs sec
Authentication domain: my-domain
Pre-auth domain: abc
Extend-auth domain: abc
User-dhcp-only: Enabled
Pre-auth IP pool: ab
Max portal users: Not configured
Bas-ip: Not configured
User detection: Type: ICMP Interval: 300s Attempts: 5 Idle time: 180s
Portal temp-pass: Enabled Period: 30s
Action for server detection:
Server type Server name Action
Web server wbs fail-permit
Portal server pts fail-permit
Layer3 source network:
IP address Mask
1.1.1.1 255.255.0.0
Destination authentication subnet:
IP address Mask
2.2.2.2 255.255.255.0
IPv6:
Portal status: enabled
Authentication type: Layer3
Portal Web server: wbsv6(active)
Secondary portal Web server: Not configured
Authentication domain: my-domain
Pre-auth domain: abc
Extend-auth domain: Not configured
User-dhcp-only: Enabled
Pre-auth IP pool: ab
Max portal users: Not configured
Bas-ipv6:Not configured
User detection: Type: ICMPv6 Interval: 300s Attempts: 5 Idle time: 180s
Portal temp-pass: Disabled
Action for server detection:
Server type Server name Action
Web server wbsv6 fail-permit
Portal server ptsv6 fail-permit
Layer3 source network:
IP address Prefix length
11::5 64
Destination authentication subnet:
IP address Prefix length
Table 1 Command output
Field |
Description |
Portal information of interface |
Portal configuration on the interface. |
NAS-ID profile |
NAS-ID profile on the interface. |
Authorization |
Authorization information type: · ACL · User profile |
Strict checking |
Whether strict checking is enabled on portal authorization information. |
Dual stack |
Status of the portal dual-stack feature on the interface: · Disabled. · Enabled. |
Dual traffic-separate |
Status of separate IPv4 and IPv6 traffic statistics for dual-stack portal users on the interface: · Disabled. · Enabled. |
IPv4 |
IPv4 portal configuration. |
IPv6 |
IPv6 portal configuration. |
Portal status |
Portal authentication status on the interface: · Disabled—Portal authentication is disabled. · Enabled—Portal authentication is enabled. · Authorized—The portal authentication server or portal Web server is unreachable. The interface allows users to have network access without authentication. |
Authentication type |
Type of authentication enabled on the interface: · Direct—Direct authentication. · Redhcp—Re-DHCP authentication. · Layer3—Cross-subnet authentication. |
Portal Web server |
Name of the primary portal Web server specified on the interface. This field displays the (active) flag next to the server name if the server is being used. |
Secondary portal Web server |
Name of the backup portal Web server specified on the interface. This field displays the (active) flag next to the server name if the server is being used. |
Authentication domain |
Mandatory authentication domain on the interface. |
Pre-auth domain |
Preauthentication domain for portal users on the interface. |
Extend-auth domain |
Authentication domain configured for third-party authentication on an interface. |
User-dhcp-only |
Status of the user-dhcp-only feature: · Enabled—Only users with IP addresses obtained through DHCP can perform portal authentication. · Disabled—Both users with IP addresses obtained through DHCP and users with static IP addresses can pass authentication to get online. |
Pre-auth ip-pool |
Name of the IP address pool specified for portal users before authentication. |
Max portal users |
Maximum number of portal users allowed on an interface. |
Bas-ip |
BAS-IP attribute of the portal packets sent to the portal authentication server. |
Bas-ipv6 |
BAS-IPv6 attribute of the portal packets sent to the portal authentication server. |
User detection |
Configuration for online detection of portal users on the interface, including detection method (ARP, ICMP, ND, or ICMPv6), detection interval, maximum number of detection attempts, and user idle time. |
Portal temp-pass |
Status of the temporary pass feature: · Enabled—The temporary pass feature is enabled. · Disabled—The temporary pass feature is disabled. · Period—Temporary pass period during which a user can access the Internet temporarily. This field is displayed only if the temporary pass feature is enabled. |
Action for server detection |
Portal server detection configuration on the interface: · Server type—Type of the server. Portal server represents the portal authentication server, and Web server represents the portal Web server. · Server name—Name of the server. · Action—Action triggered by the result of server detection. This field displays fail-permit when the portal fail-permit feature is enabled. |
Layer3 source subnet |
Information of the portal authentication source subnet. |
Destination authentication subnet |
Information of the portal authentication destination subnet. |
IP address |
IP address of the portal authentication subnet. |
Mask |
Subnet mask of the portal authentication subnet. |
Prefix length |
Prefix length of the IPv6 portal authentication subnet address. |
display portal auth-error-record
Use display portal auth-error-record to display portal authentication error records.
Syntax
display portal auth-error-record { all | ipv4 ipv4-address | ipv6 ipv6-address | start-time start-date start-time end-time end-date end-time }
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
all: Specifies all portal authentication error records.
ipv4 ipv4-address: Specifies the IPv4 address of a portal user.
ipv6 ipv6-address: Specifies the IPv6 address of a portal user.
start-time start-date start-time end-time end-date end-time: Specifies a time range. The start date and end date must be in the format of MM/DD/YYYY or YYYY/MM/DD. The value range for MM is 1 to 12. The value range for DD varies with the specified month. The value range for YYYY is 1970 to 2100. The start time and end time must be in the format of hh:mm. The value range for the start time and end time is 00:00 to 23:59.
Examples
# Display all portal authentication error records.
<Sysname> display portal auth-error-record all
Total authentication error records: 2
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.188
Auth error time : 2016-03-04 16:49:07
Auth error reason : The maximum number of users already reached.
User MAC : 0016-ecb7-a235
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.10
Auth error time : 2016-03-04 16:51:07
Auth error reason : The maximum number of users already reached.
# Display portal authentication error records for the portal user whose IPv4 address is 192.168.0.188.
<Sysname> display portal auth-error-record ip 192.168.0.188
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.188
Auth error time : 2016-03-04 16:49:07
Auth error reason : The maximum number of users already reached.
# Display portal authentication error records for the portal user whose IPv6 address is 2000::2.
<Sysname> display portal auth-error-record ipv6 2000::2
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 2000::2
Auth error time : 2016-03-04 16:49:07
Auth error reason : The maximum number of users already reached.
# Display portal authentication error records with the error time in the range of 2016/3/4 14:20 to 2016/3/4 14:23.
<Sysname> display portal auth-error-record start-time 2016/3/4 14:20 end-time 2016/3/4 14:23
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.188
Auth error time : 2016-03-04 14:22:25
Auth error reason : The maximum number of users already reached.
Table 2 Command output
Field |
Description |
Total authentication error records |
Total number of portal authentication error records. |
User MAC |
MAC address of the portal user. |
Interface |
Access interface of the portal user. |
User IP address |
IP address of the portal user. |
Auth error time |
Time when the portal user encountered an authentication error, in the format of YYYY-MM-DD hh:mm:ss. |
Auth error reason |
Reason of the authentication error: · The maximum number of users already reached. · Failed to obtain user physical information. · Failed to receive the packet because packet length is 0. · Packet source unknown. Server IP:X.X.X.X, VRF index:0. · Packet validity check failed because packet length and version don't match. · Packet type invalid. · Packet validity check failed due to invalid authenticator. · Memory insufficient. · Portal is disabled on the interface. · The maximum number of users on the interface already reached. · Failed to get the access token of the cloud user. · Failed to get the user information of the cloud user. · Failed to get the access token of the QQ user. · Failed to get the openID of the QQ user. · Failed to get the user information of the QQ user. · Email authentication failed. |
Related commands
portal auth-error-record enable
reset auth-error-record
display portal auth-fail-record
Use display portal auth-fail-record to display portal authentication failure records.
Syntax
display portal auth-fail-record { all | ipv4 ipv4-address | ipv6 ipv6-address | start-time start-date start-time end-time end-date end-time | username username }
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
all: Specifies all portal authentication failure records.
ipv4 ipv4-address: Specifies the IPv4 address of a portal user.
ipv6 ipv6-address: Specifies the IPv6 address of a portal user.
start-time start-date start-time end-time end-date end-time: Specifies a time range. The start date and end date must be in the format of MM/DD/YYYY or YYYY/MM/DD. The value range for MM is 1 to 12. The value range for DD varies with the specified month. The value range for YYYY is 1970 to 2100. The start time and end time must be in the format of hh:mm. The value range for the start time and end time is 00:00 to 23:59.
username username: Specifies the username of a portal user, a case-sensitive string of 1 to 253 characters. The username cannot contain the domain name.
Examples
# Display all portal authentication failure records.
<Sysname> display portal auth-fail-record all
Total authentication fail records: 2
User name : test@abc
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.188
Auth failure time : 2016-03-04 16:49:07
Auth failure reason : Authorization information does not exist.
User name : coco
User MAC : 0016-ecb7-a235
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.10
Auth failure time : 2016-03-04 16:50:07
Auth failure reason : Authorization information does not exist.
# Display portal authentication failure records for the portal user whose IPv4 address is 192.168.0.8.
<Sysname> display portal auth-fail-record ip 192.168.0.188
User name : test@abc
User MAC : 0016-ecb7-a879
Interface : WLAN-BSS0/1
User IP address : 192.168.0.188
Auth failure time : 2016-03-04 16:49:07
Auth failure reason : Authorization information does not exist.
# Display portal authentication failure records for the portal user whose IPv6 address is 2000::2.
<Sysname> display portal auth-fail-record ipv6 2000::2
User name : test@abc
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 2000::2
Auth failure time : 2016-03-04 16:49:07
Auth failure reason : Authorization information does not exist.
# Display portal authentication failure records for the portal user whose username is chap1.
<Sysname> display portal auth-fail-record username chap1
User name : chap1
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.188
Auth failure time : 2016-03-04 16:49:07
Auth failure reason : Authorization information does not exist.
# Display portal authentication failure records with the failure time in the range of 2016/3/4 14:20 to 2016/3/4 14:23.
<Sysname> display portal auth-fail-record start-time 2016/3/4 14:20 end-time 2016/3/4 14:23
User name : chap1
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.188
Auth failure time : 2016-03-04 14:22:25
Auth failure reason : Authorization information does not exist.
Table 3 Command output
Field |
Description |
Total authentication fail records |
Total number of portal authentication failure records. |
User name |
Username of the portal user. |
User MAC |
MAC address of the portal user. |
Interface |
Access interface of the portal user. |
User IP address |
IP address of the portal user. |
Auth failure time |
Time when the portal user failed authentication, in the format of YYYY/MM/DD hh:mm:ss. |
Auth failure reason |
Reason why the user failed portal authentication. |
Related commands
portal auth-fail-record enable
reset portal auth-fail-record
display portal captive-bypass statistics
Use display portal captive-bypass statistics to display packet statistics for portal captive-bypass.
Syntax
In standalone mode:
display portal captive-bypass statistics [ slot slot-number ]
In IRF mode:
display portal captive-bypass statistics [ chassis chassis-number slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
slot slot-number: Specifies the slot number of the device, which is fixed at 0. Alternatively, you can execute the command without specifying this option. The command execution results are the same. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies an IRF member device. The chassis-number argument represents the member ID of the IRF member device. The slot-number argument represents the slot number of the device, which is fixed at 0. If you do not specify an IRF member device, this command displays portal captive-bypass packet statistics for all member devices. (In IRF mode.)
Examples
# (In standalone mode.) Display portal captive-bypass packets on the specified slot.
<Sysname> display portal captive-bypass statistics slot 1
Slot 1:
User type Packets
iOS 1
Android 0
Table 4 Command output
Field |
Description |
User type |
Type of users: · iOS. · Android. |
Packets |
Number of portal captive-bypass packets sent to the users. |
Related commands
captive-bypass enable
display portal extend-auth-server
Use display portal extend-auth-server to display information about third-party authentication servers.
Syntax
display portal extend-auth-server { all | qq | mail }
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
all: Specifies all third-party authentication servers.
qq: Specifies the QQ authentication server.
mail: Specifies the email authentication server.
Examples
# Display information about all third-party authentication servers.
<Sysname> display portal extend-auth-server all
Portal extend-auth-server: qq
Authentication URL : http://graph.qq.com
APP ID : 101235509
APP key : ******
Redirect URL : http://h3crd-lvzhou3.chinacloudapp.cn/portal/qqlogin.html
Portal extend-auth-server: mail
Mail protocol : POP3
Mail domain name : @qq.com
Table 5 Command output
Field |
Description |
Portal extend-auth-server |
Type of the third-party authentication server. |
Authentication URL |
URL of the QQ authentication server. |
APP ID |
APP ID for QQ authentication. |
APP key |
APP key for QQ authentication. |
Redirect URL |
Redirection URL for QQ authentication success. |
Mail protocol |
Protocols of the email authentication service. |
Mail domain name |
Email domain name of the email authentication service. |
Related commands
portal extend-auth-server
display portal logout-record
Use display portal logout-record to display portal user offline records.
Syntax
display portal logout-record { all | ipv4 ipv4-address | ipv6 ipv6-address | start-time start-date start-time end-time end-date end-time | username username }
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
all: Specifies all portal user offline records.
ipv4 ipv4-address: Specifies the IPv4 address of a portal user.
ipv6 ipv6-address: Specifies the IPv6 address of a portal user.
start-time start-date start-time end-time end-date end-time: Specifies a time range. The start date and end date must be in the format of MM/DD/YYYY or YYYY/MM/DD. The value range for MM is 1 to 12. The value range for DD varies with the specified month. The value range for YYYY is 1970 to 2100. The start time and end time must be in the format of hh:mm. The value range for the start time and end time is 00:00 to 23:59.
username username: Specifies the username of a portal user, a case-sensitive string of 1 to 253 characters. The username cannot contain the domain name.
Examples
# Display all portal user offline records.
<Sysname> display portal logout-record all
Total logout records: 2
User name : test@abc
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.8
User login time : 2016-03-04 14:20:19
User logout time : 2016-03-04 14:22:05
Logout reason : Admin Reset
User name : coco
User MAC : 0016-ecb7-a235
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.10
User login time : 2016-03-04 14:10:15
User offline time : 2016-03-04 14:22:05
Offline reason : Admin Reset
# Display offline records for the portal user whose IP address is 192.168.0.8.
<Sysname> display portal logout-record ip 192.168.0.8
User name : test@abc
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.8
User login time : 2016-03-04 14:26:12
User logout time : 2016-03-04 14:27:35
Logout reason : Admin Reset
# Display offline records for the portal user whose username is chap1.
<Sysname> display portal logout-record username chap1
User name : chap1
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.8
User login time : 2016-03-04 17:20:19
User logout time : 2016-03-04 17:22:05
Logout reason : Admin Reset
# Display portal user offline records with the logout time in the range of 2016/3/4 14:20 to 2016/3/4 14:23.
<Sysname> display portal logout-record start-time 2016/3/4 14:20 end-time 2016/3/4 14:23
User name : test@abc
User MAC : 0016-ecb7-a879
Interface : GigabitEthernet1/1/1
User IP address : 192.168.0.8
User login time : 2016-03-04 14:20:19
User logout time : 2016-03-04 14:22:05
Logout reason : Admin Reset
Table 6 Command output
Field |
Description |
Total logout records |
Total number of portal user offline records. |
User name |
Username of the portal user. |
User MAC |
MAC address of the portal user. |
Interface |
Access interface of the portal user. |
User IP address |
IP address of the portal user. |
User login time |
Time when the portal user came online, in the format of YYYY-MM-DD hh:mm:ss. |
User logout time |
Time when the portal user went offline, in the format of YYYY-MM-DD hh:mm:ss. |
Logout reason |
Reason why the portal user went offline: · User Request. · Carrier Lost. · Service Lost. · Admin Reset. · NAS Request. · Idle Timeout. · Port Suspended. · Port Error. · Admin Reboot. · Session Timeout. · User Error. · Service Unavailable. · NAS Error. · Other Errors. |
Related commands
portal logout-record enable
reset portal logout-record
display portal packet statistics
Use display portal packet statistics to display packet statistics for portal authentication servers.
Syntax
display portal packet statistics [ extend-auth-server { cloud | mail | qq | wechat } | server server-name ] *
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
extend-auth-server: Specifies a third-party authentication server.
cloud: Specifies the lvzhou cloud authentication server.
mail: Specifies the email authentication server.
qq: Specifies the QQ authentication server.
wechat: Specifies the WeChat authentication server.
server server-name: Specifies a portal authentication server by its name, a case-sensitive string of 1 to 32 characters.
Usage guidelines
If you do not specify any parameters, this command displays packet statistics for all third-party authentication servers, portal authentication servers.
Examples
# Display packet statistics for portal authentication server pts.
<Sysname> display portal packet statistics server pts
Portal server : pts
Invalid packets: 0
Pkt-Type Total Drops Errors
REQ_CHALLENGE 3 0 0
ACK_CHALLENGE 3 0 0
REQ_AUTH 3 0 0
ACK_AUTH 3 0 0
REQ_LOGOUT 1 0 0
ACK_LOGOUT 1 0 0
AFF_ACK_AUTH 3 0 0
NTF_LOGOUT 1 0 0
REQ_INFO 6 0 0
ACK_INFO 6 0 0
NTF_USERDISCOVER 0 0 0
NTF_USERIPCHANGE 0 0 0
AFF_NTF_USERIPCHAN 0 0 0
ACK_NTF_LOGOUT 1 0 0
NTF_HEARTBEAT 0 0 0
NTF_USER_HEARTBEAT 2 0 0
ACK_NTF_USER_HEARTBEAT 0 0 0
NTF_CHALLENGE 0 0 0
NTF_USER_NOTIFY 0 0 0
AFF_NTF_USER_NOTIFY 0 0 0
# Display packet statistics for the lvzhou cloud authentication server.
<Sysname> display portal packet statistics extend-auth-server cloud
Extend-auth server: cloud
Update interval: 60s
Pkt-Type Success Error Timeout Conn-failure
REQ_ACCESSTOKEN 1 0 0 0
REQ_USERINFO 1 0 0 0
RESP_ACCESSTOKEN 1 0 0 0
RESP_USERINFO 1 0 0 0
POST_ONLINEDATA 0 0 0 0
RESP_ONLINEDATA 0 0 0 0
POST_OFFLINEUSER 1 0 0 0
AUTHENTICATION 0 1 0 0
Table 7 Command output
Field |
Description |
Portal server |
Name of the portal authentication server. |
Invalid packets |
Number of invalid packets. |
Pkt-Type |
Packet type. |
Total |
Total number of packets. |
Drops |
Number of dropped packets. |
Errors |
Number of packets that carry error information. |
REQ_CHALLENGE |
Challenge request packet the portal authentication server sent to the access device. |
ACK_CHALLENGE |
Challenge acknowledgment packet the access device sent to the portal authentication server. |
REQ_AUTH |
Authentication request packet the portal authentication server sent to the access device. |
ACK_AUTH |
Authentication acknowledgment packet the access device sent to the portal authentication server. |
REQ_LOGOUT |
Logout request packet the portal authentication server sent to the access device. |
ACK_LOGOUT |
Logout acknowledgment packet the access device sent to the portal authentication server. |
AFF_ACK_AUTH |
Affirmation packet the portal authentication server sent to the access device after receiving an authentication acknowledgment packet. |
NTF_LOGOUT |
Forced logout notification packet the access device sent to the portal authentication server. |
REQ_INFO |
Information request packet. |
ACK_INFO |
Information acknowledgment packet. |
NTF_USERDISCOVER |
User discovery notification packet the portal authentication server sent to the access device. |
NTF_USERIPCHANGE |
User IP change notification packet the access device sent to the portal authentication server. |
AFF_NTF_USERIPCHAN |
User IP change success notification packet the portal authentication server sent to the access device. |
ACK_NTF_LOGOUT |
Forced logout acknowledgment packet the portal authentication server sent to the access device. |
NTF_HEARTBEAT |
Server heartbeat packet the portal authentication server periodically sent to the access device. |
NTF_USER_HEARTBEAT |
User synchronization packet the portal authentication server sent to the access device. |
ACK_NTF_USER_HEARTBEAT |
User synchronization acknowledgment packet the access device sent to the portal authentication server. |
NTF_CHALLENGE |
Challenge request packet the access device sent to the portal authentication server. |
NTF_USER_NOTIFY |
User information notification packet the access device sent to the portal authentication server. |
AFF_NTF_USER_NOTIFY |
NTF_USER_NOTIFY acknowledgment packet the portal authentication server sent to the access device. |
Extend-auth server |
Type of the third-party authentication server: · qq—QQ authentication server. · mail—Email authentication server. · wechat—WeChat authentication server. · cloud—Lvzhou cloud authentication server. |
Update interval |
Interval at which the device sends online user information to the lvzhou cloud server, in seconds. This field is displayed if the third-party authentication server is the lvzhou cloud authentication server. |
Success |
Number of packets that have been successfully sent or received. |
Timeout |
Number of packets that timed out of establishing a connection to the third-party authentication server. |
Conn-failure |
Number of packets that failed to establish a connection to the third-party authentication server. |
Deny |
Number of packets denied access to the third-party authentication server. This field is displayed if the third-party authentication server is the email authentication server. |
REQ_ACCESSTOKEN |
Access token request packet the access device sent to the third-party authentication server. This field is displayed if the third-party authentication server is QQ, lvzhou cloud, or WeChat authentication server. |
REQ_OPENID |
Open ID request packet the access device sent to the third-party authentication server. This field is displayed if the third-party authentication server is the QQ authentication server. |
REQ_USERINFO |
User information request packet the access device sent to the third-party authentication server. This field is displayed if the third-party authentication server is the QQ, lvzhou cloud, or WeChat authentication server. |
RESP_ACCESSTOKEN |
Access token response packet the access device received from the third-party authentication server. This field is displayed if the third-party authentication server is the QQ, lvzhou cloud, or WeChat authentication server. |
RESP_OPNEID |
Open ID response packet the access device received from the third-party authentication server. This field is displayed if the third-party authentication server is the QQ authentication server. |
RESP_USERINFO |
User information response packet the access device received from the third-party authentication server. This field is displayed if the third-party authentication server is the QQ, lvzhou cloud, or WeChat authentication server. |
REQ_POP3 |
POP3 authentication request packet the access device sent to the third-party authentication server. This field is displayed if the third-party authentication server is the email authentication server. |
REQ_IMAP |
IMAP authentication request packet the access device sent to the third-party authentication server. This field is displayed if the third-party authentication server is the email authentication server. |
POST_ONLINEDATA |
Cloud user information request packet the access device sent to the third-party authentication server. This field is displayed if the third-party authentication server is the lvzhou cloud authentication server. |
RESP_ONLINEDATA |
Cloud user information response packet the access device received from the third-party authentication server. This field is displayed if the third-party authentication server is the lvzhou cloud authentication server. |
POST_OFFLINEUSER |
Cloud user offline packet the access device sent to the third-party authentication server. This field is displayed if the third-party authentication server is the lvzhou cloud or WeChat authentication server. |
AUTHENTICATION |
Result of third-party authentication. |
Related commands
reset portal packet statistics
display portal redirect statistics
Use display portal redirect statistics to display portal redirect packet statistics.
Syntax
In standalone mode:
display portal redirect statistics [ slot slot-number ]
In IRF mode:
display portal redirect statistics [ chassis chassis-number slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
slot slot-number: Specifies the slot number of the device, which is fixed at 0. Alternatively, you can execute the command without specifying this option. The command execution results are the same. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies an IRF member device. The chassis-number argument represents the member ID of the IRF member device. The slot-number argument represents the slot number of the device, which is fixed at 0. If you do not specify an IRF member device, this command displays portal redirect packet statistics for all member devices. (In IRF mode.)
Examples
# (In standalone mode.) Display portal redirect packet statistics on the specified slot.
<Sysname> display portal redirect statistics slot 1
Slot 1:
HttpReq: 3
HttpResp: 3
HttpsReq: 6
HttpsResp: 6
Table 8 Command output
Field |
Description |
HttpReq |
Total number of HTTP redirect requests. |
HttpResp |
Total number of HTTP redirect responses. |
HttpsReq |
Total number of HTTPS redirect requests. |
HttpsResp |
Total number of HTTPS redirect responses. |
Related commands
reset portal redirect statistics
display portal rule
Use display portal rule to display portal packet filtering rules.
Syntax
In standalone mode:
display portal rule { all | dynamic | static } interface interface-type interface-number [ slot slot-number ]
In IRF mode:
display portal rule { all | dynamic | static } interface interface-type interface-number [ chassis chassis-number slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
all: Displays all portal packet filtering rules, including dynamic and static portal packet filtering rules.
dynamic: Displays dynamic portal packet filtering rules, which are generated after users pass portal authentication. These rules allow packets with specific source IP addresses to pass the interface.
static: Displays static portal packet filtering rules, which are generated after portal authentication is enabled. The interface filters packets by these rules when portal authentication is enabled.
interface interface-type interface-number: Specifies an interface by its type and number.
slot slot-number: Specifies the slot number of the device, which is fixed at 0. Alternatively, you can execute the command without specifying this option. The command execution results are the same. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies an IRF member device. The chassis-number argument represents the member ID of the IRF member device. The slot-number argument represents the slot number of the device, which is fixed at 0. If you do not specify an IRF member device, this command displays portal filtering rules for all member devices. (In IRF mode.)
Examples
# (In standalone mode.) Display all portal packet filtering rules on GigabitEthernet 1/1/1 for the specified slot.
<Sysname> display portal rule all interface gigabitethernet 1/1/1 slot 1
Slot 1:
IPv4 portal rules on GigabitEthernet1/1/1:
Rule 1
Type : Static
Action : Permit
Protocol : Any
Status : Active
Source:
IP : 0.0.0.0
Mask : 0.0.0.0
Port : Any
MAC : 0000-0000-0000
Interface : GigabitEthernet1/1/1
VLAN : Any
Destination:
IP : 192.168.0.111
Mask : 255.255.255.255
Port : Any
Rule 2
Type : Dynamic
Action : Permit
Status : Active
Source:
IP : 2.2.2.2
MAC : 000d-88f8-0eab
Interface : GigabitEthernet1/1/1
VLAN : Any
Author ACL:
Number : 3001
Rule 3
Type : Static
Action : Redirect
Status : Active
Source:
IP : 0.0.0.0
Mask : 0.0.0.0
Interface : GigabitEthernet1/1/1
VLAN : Any
Protocol : TCP
Destination:
IP : 0.0.0.0
Mask : 0.0.0.0
Port : 80
Rule 4:
Type : Static
Action : Deny
Status : Active
Source:
IP : 0.0.0.0
Mask : 0.0.0.0
Interface : GigabitEthernet1/1/1
VLAN : Any
Destination:
IP : 0.0.0.0
Mask : 0.0.0.0
IPv6 portal rules on GigabitEthernet1/1/1:
Rule 1
Type : Static
Action : Permit
Protocol : Any
Status : Active
Source:
IP : ::
Prefix length : 0
Port : Any
MAC : 0000-0000-0000
Interface : GigabitEthernet1/1/1
VLAN : Any
Destination:
IP : 3000::1
Prefix length : 64
Port : Any
Rule 2
Type : Dynamic
Action : Permit
Status : Active
Source:
IP : 3000::1
MAC : 0015-e9a6-7cfe
Interface : GigabitEthernet1/1/1
VLAN : Any
Author ACL:
Number : 3001
Rule 3
Type : Static
Action : Redirect
Status : Active
Source:
IP : ::
Prefix length : 0
Interface : GigabitEthernet1/1/1
VLAN : Any
Protocol : TCP
Destination:
IP : ::
Prefix length : 0
Port : 80
Rule 4:
Type : Static
Action : Deny
Status : Active
Source:
IP : ::
Prefix length : 0
Interface : GigabitEthernet1/1/1
VLAN : Any
Destination:
IP : ::
Prefix length : 0
Rule 5:
Type : Static
Action : Match pre-auth ACL
Status : Active
Source:
Interface : GigabitEthernet1/1/1
Pre-auth ACL:
Number : 3002
Table 9 Command output
Field |
Description |
Rule |
Number of the portal rule. IPv4 portal packet filtering rules and IPv6 portal packet filtering rules are numbered separately. |
Type |
Type of the portal packet filtering rule: · Static—Static portal rule. · Dynamic—Dynamic portal rule. |
Action |
Action triggered by the portal packet filtering rule: · Permit—The interface allows packets to pass. · Redirect—The interface redirects packets. · Deny—The interface forbids packets to pass. · Match pre-auth ACL—The interface matches packets against the authorized ACL rules in the preauthentication domain. |
Protocol |
Transport layer protocol permitted by the portal packet filtering rule: · Any—Permits any transport layer protocol. · TCP—Permits TCP. · UDP—Permits UDP. |
Status |
Status of the portal packet filtering rule: · Active—The portal rule is effective. · Unactuated—The portal rule is not activated. |
Source |
Source information of the portal packet filtering rule. |
IP |
Source IP address. |
Mask |
Subnet mask of the source IPv4 address. |
Prefix length |
Prefix length of the source IPv6 address. |
Port |
Source transport layer port number. |
MAC |
Source MAC address. |
Interface |
Layer 2 or Layer 3 interface on which the portal rule is implemented. |
VLAN |
Source VLAN ID. |
Protocol |
Transport layer protocol of the portal redirect rule. |
Destination |
Destination information of the portal packet filtering rule. |
IP |
Destination IP address. |
Port |
Destination transport layer port number. |
Mask |
Subnet mask of the destination IPv4 address. |
Prefix length |
Prefix length of the destination IPv6 address. |
Author ACL |
Authorized ACL assigned to authenticated portal users. This field is displayed only for a dynamic portal packet filtering rule. |
Pre-auth ACL |
Authorized ACL assigned to preauthentication portal users. This field is displayed only for the Match pre-auth ACL action. |
Number |
Number of the authorized ACL. This field displays N/A if the AAA server does not assign an ACL. |
display portal safe-redirect statistics
Use display portal safe-redirect statistics to display portal safe-redirect packet statistics.
Syntax
In standalone mode:
display portal safe-redirect statistics [ slot slot-number ]
In IRF mode:
display portal safe-redirect statistics [ chassis chassis-number slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
slot slot-number: Specifies the slot number of the device, which is fixed at 0. Alternatively, you can execute the command without specifying this option. The command execution results are the same. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies an IRF member device. The chassis-number argument represents the member ID of the IRF member device. The slot-number argument represents the slot number of the device, which is fixed at 0. If you do not specify an IRF member device, this command displays portal safe-redirect packet statistics for all member devices. (In IRF mode.)
Examples
# (In standalone mode.) Display portal safe-redirect packet statistics on the specified slot.
<Sysname> display portal safe-redirect statistics slot 1
Slot 1:
Redirect statistics:
Success: 7
Failure: 8
Total : 15
Method statistics:
Get : 11
Post : 1
Others : 3
User agent statistics:
Safari: 3
Chrome: 2
Forbidden User URL statistics:
www.qq.com: 4
Forbidden filename extension statistics:
.jpg: 0
# (In IRF mode.) Display portal safe-redirect packet statistics on chassis 1 slot 0.
<Sysname> display portal safe-redirect statistics chassis 1 slot 0
Slot 0 in chassis 1:
Redirect statistics:
Success: 3
Failure: 5
Total : 8
Method statistics:
Get : 11
Post : 3
Others : 7
User agent statistics:
Safari: 3
Chrome: 2
Forbidden User URL statistics:
http://www.abc.com: 0
Forbidden filename extension statistics:
.jpg: 1
Table 10 Command output
Field |
Description |
Success |
Number of packets redirected successfully. |
Failure |
Number of packets failed redirection. |
Total |
Total number of packets. |
Method statistics |
Statistics of HTTP request methods. |
Get |
|
Post |
Number of packets with the POST request method. |
Other |
Number of packets with other request methods. |
User agent statistics |
Browser types (in HTTP User Agent) allowed by portal safe-redirect, and packet statistics for the browsers. |
Forbidden User URL statistics |
URLs forbidden by portal safe-redirect, and statistics for packets dropped by forbidden URL filtering. |
Forbidden filename extension statistics |
Filename extensions forbidden by portal safe-redirect, and statistics for packets dropped by forbidden filename extension filtering. |
Related commands
reset portal safe-redirect statistics
display portal server
Use display portal server to display information about portal authentication servers.
display portal server [ server-name ]
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
server-name: Specifies a portal authentication server by its name, a case-sensitive string of 1 to 32 characters.
Usage guidelines
If you do not specify the server-name argument, this command displays information about all portal authentication servers.
Examples
# Display information about portal authentication server pts.
<Sysname> display portal server pts
Portal server: pts
Type : IMC
IP : 192.168.0.111
VPN instance : vpn1
Port : 50100
Server detection : Timeout 60s Action: log, trap
User synchronization : Timeout 200s
Status : Up
Exclude-attribute : Not configured
Logout notification : Retry 3 interval 5s
Table 11 Command output
Field |
Description |
Type |
Portal authentication server type: · CMCC—CMCC server. · IMC—IMC server. |
Portal server |
Name of the portal authentication server. |
IP |
IP address of the portal authentication server. |
VPN instance |
MPLS L3VPN where the portal authentication server resides. |
Port |
Listening port on the portal authentication server. |
Server detection |
Parameters for portal authentication server detection: · Detection timeout in seconds. · Actions (log and trap) triggered by the reachability status change of the portal authentication server. |
User synchronization |
User idle timeout in seconds for portal user synchronization. |
Status |
Reachability status of the portal authentication server: · Up—This value indicates one of the following conditions: ¡ Portal authentication server detection is disabled. ¡ Portal authentication server detection is enabled and the server is reachable. · Down—Portal authentication server detection is enabled and the server is unreachable. |
Exclude-attribute |
Attributes that are not carried in portal protocol packets sent to the portal authentication server. |
Logout-notification |
Maximum number of times and the interval (in seconds) for retransmitting a logout notification packet. |
Related commands
portal enable
portal server
server-detect (portal authentication server view)
user-sync
display portal user
Use display portal user to display information about portal users.
Syntax
display portal user { all | auth-type { cloud | email | local | normal | qq | wechat } | interface interface-type interface-number | ip ipv4-address | ipv6 ipv6-address | mac mac-address | pre-auth [ interface interface-type interface-number | ip ipv4-address | ipv6 ipv6-address ] | username username } [ brief | verbose ]
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
all: Displays information about all portal users.
auth-type: Specifies an authentication type.
cloud: Specifies the cloud authentication (a cloud portal authentication server performs portal authentication on portal users).
email: Specifies the email authentication.
local: Specifies the local authentication (a local portal authentication server performs portal authentication on portal users).
normal: Specifies the normal authentication (a remote portal authentication server performs portal authentication on portal users).
qq: Specifies QQ authentication.
wechat: Specifies WeChat authentication.
interface interface-type interface-number: Displays information about portal users on the specified interface.
ip ipv4-address: Specifies the IPv4 address of a portal user.
ipv6 ipv6-address: Specifies the IPv6 address of a portal user.
mac mac-address: Specifies the MAC address of a portal user, in the format of H-H-H.
username username: Specifies the username of a portal user, a case-sensitive string of 1 to 253 characters. The username cannot contain the domain name.
pre-auth: Displays information about preauthentication portal users. A preauthentication user is a user who is authorized with the authorization attributes in a preauthentication domain before portal authentication. If you do not specify the pre-auth keyword, this command displays information about authenticated portal users.
brief: Displays brief information about portal users.
verbose: Displays detailed information about portal users.
Usage guidelines
If you specify neither the brief nor the verbose keyword, this command displays portal authentication-related information for portal users.
Examples
# Display information about all portal users.
<Sysname> display portal user all
Total portal users: 2
Username: abc
Portal server: pts
State: Online
VPN instance: N/A
MAC IP VLAN Interface
000d-88f8-0eab 2.2.2.2 -- GigabitEthernet1/1/1
Authorization information:
DHCP IP pool: N/A
User profile: abc (active)
ACL number: N/A
Inbound CAR: N/A
Outbound CAR: N/A
Username: def
Portal server: pts
VPN instance: vpn1
MAC IP VLAN Interface
000d-88f8-0eac 3.3.3.3 -- GigabitEthernet1/1/2
Authorization information:
DHCP IP pool: N/A
User profile: N/A
ACL number: 3000
Inbound CAR: CIR 3072 bps PIR 3072 bps
Outbound CAR: CIR 3072 bps PIR 3072 bps
# Display information about portal users whose authentication type is normal portal authentication.
<Sysname> display portal user auth-type normal
Total normal users: 1
Username: abc
Portal server: pts
State: Online
VPN instance: N/A
MAC IP VLAN Interface
000d-88f8-0eab 2.2.2.2 -- GigabitEthernet1/1/1
Authorization information:
DHCP IP pool: N/A
User profile: abc (active)
ACL number: N/A
Inbound CAR: N/A
Outbound CAR: N/A
# Display information about the portal user whose MAC address is 000d-88f8-0eab.
<Sysname> display portal user mac 000d-88f8-0eab
Username: abc
Portal server: pts
State: Online
VPN instance: N/A
MAC IP VLAN Interface
000d-88f8-0eab 2.2.2.2 -- GigabitEthernet1/1/1
Authorization information:
DHCP IP pool: N/A
User profile: abc (active)
ACL number: N/A
Inbound CAR: N/A
Outbound CAR: N/A
# Display information about the portal user whose username is abc.
<Sysname> display portal user username abc
Username: abc
Portal server: pts
State: Online
VPN instance: N/A
MAC IP VLAN Interface
000d-88f8-0eab 2.2.2.2 -- GigabitEthernet1/1/1
Authorization information:
DHCP IP pool: N/A
User profile: abc (active)
ACL number: N/A
Inbound CAR: N/A
Outbound CAR: N/A
Table 12 Command output
Field |
Description |
Total portal users |
Total number of portal users. |
Total normal users |
Total number of portal users whose authentication type is normal authentication. |
Total local users |
Total number of portal users whose authentication type is local authentication. |
Total email users |
Total number of portal users whose authentication type is email authentication. |
Total cloud users |
Total number of portal users whose authentication type is cloud authentication. |
Total QQ users |
Total number of portal users whose authentication type is QQ authentication. |
Total WeChat users |
Total number of portal users whose authentication type is WeChat authentication. |
Username |
Name of the user. |
Portal server |
Name of the portal authentication server. |
State |
Current state of the portal user: · Initialized—The user is initialized and ready for authentication. · Authenticating—The user is being authenticated. · Waiting SetRule—Deploying portal rules to the user. · Authorizing—The user is being authorized. · Online—The user is online. · Waiting Traffic—Waiting for traffic from the user. · Stop Accounting—Stopping accounting for the user. · Done—The user is offline. |
VPN instance |
MPLS L3VPN the portal user belongs to. If the portal user is on a public network, this field displays N/A. |
MAC |
MAC address of the portal user. |
IP |
IP address of the portal user. |
VLAN |
VLAN where the portal user resides. |
Interface |
Access interface of the portal user. |
Authorization information |
Authorization information for the portal user. |
DHCP IP pool |
Name of the authorized IP address pool. If no IP address pool is authorized for the portal user, this field displays N/A. |
User profile |
Authorized user profile: · N/A—The AAA server authorizes no user profile. · active—The AAA server has authorized the user profile successfully. · inactive—The AAA server failed to authorize the user profile or the user profile does not exist on the device. |
ACL number |
Authorized ACL: · N/A—The AAA server authorizes no ACL. · active—The AAA server has authorized the ACL successfully. · inactive—The AAA server failed to authorize the ACL or the ACL does not exist on the device. |
Inbound CAR |
Authorized inbound CAR: · CIR—Committed information rate in bps. · PIR—Peak information rate in bps. If no inbound CAR is authorized, this field displays N/A. |
Outbound CAR |
Authorized outbound CAR: · CIR—Committed information rate in bps. · PIR—Peak information rate in bps. If no outbound CAR is authorized, this field displays N/A. |
# Display detailed information about the portal user with IP address 50.50.50.3.
<Sysname> display portal user ip 50.50.50.3 verbose
Basic:
Current IP address: 50.50.50.3
Original IP address: 30.30.30.2
Username: user1@hrss
User ID: 0x28000002
Access interface: eth3/2/2
Service-VLAN/Customer-VLAN: -/-
MAC address: 0000-0000-0001
Authentication type: Normal
Domain: hrss
VPN instance: 123
Status: Online
Portal server: test
Vendor: Apple
Portal authentication method: Direct
AAA:
Realtime accounting interval: 60s, retry times: 3
Idle-cut: 180 sec, 10240 bytes
Session duration: 500 sec, remaining: 300 sec
Remaining traffic: 10240000 bytes
Login time: 2014-01-19 2:42:3 UTC
DHCP IP pool: abc
ACL&QoS&Multicast:
Inbound CAR: CIR 64000bps PIR 640000bps
Outbound CAR: CIR 64000bps PIR 640000bps
ACL number: 3000 (inactive)
User profile: portal (active)
Max multicast addresses: 4
Multicast address list: 1.2.3.1, 1.34.33.1, 3.123.123.3, 4.5.6.7
2.2.2.2, 3.3.3.3, 4.4.4.4
Traffic statistic:
Uplink packets/bytes: 7/546
Downlink packets/bytes: 0/0
Dual-stack traffic statistics:
IPv4 address: 50.50.50.3
Uplink packets/bytes: 3/200
Downlink packets/bytes: 0/0
IPv6 address: 2001::2
Uplink packets/bytes: 4/346
Downlink packets/bytes: 0/0
Table 13 Command output
Field |
Description |
Current IP address |
IP address of the portal user after passing authentication. |
Original IP address |
IP address of the portal user during authentication. |
Username |
Name of the portal user. |
User ID |
Portal user ID. |
Access interface |
Access interface of the portal user. |
Service-VLAN/Customer-VLAN |
Public VLAN/Private VLAN to which the portal user belongs. If no VLAN is configured for the portal user, this field displays -/-. |
MAC address |
MAC address of the portal user. |
Authentication type |
Type of portal authentication: · Normal—Normal authentication. · Local—Local authentication. · Email—Email authentication. · Cloud—Cloud authentication. · QQ—QQ authentication. · WeChat—WeChat authentication. |
Domain |
ISP domain name for portal authentication. |
VPN instance |
MPLS L3VPN to which the portal user belongs. If the portal user is on a public network, this field displays N/A. |
Status |
Status of the portal user: · Authenticating—The user is being authenticated. · Authorizing—The user is being authorized. · Waiting SetRule—Deploying portal rules to the user. · Online—The user is online. · Waiting Traffic—Waiting for traffic from the user. · Stop Accounting—Stopping accounting for the user. · Done—The user is offline. |
Portal server |
Name of the portal server. |
Vendor |
Vendor name of the endpoint. |
Portal authentication method |
Portal authentication method on the access interface: · Direct—Direct authentication. · Re-Dhcp—Re-DHCP authentication. · Layer3—Cross-subnet authentication. |
AAA |
AAA information about the portal user. |
Realtime accounting interval |
Interval for sending real-time accounting updates, and the maximum number of accounting attempts. If the real-time accounting is not authorized, this field displays N/A. |
Idle-cut |
Idle timeout period and the minimum traffic threshold. If idle-cut is not authorized, this field displays N/A. |
Session duration |
Session duration and the remaining session time. If the session duration is not authorized, this field displays N/A. |
Remaining traffic |
Remaining traffic for the portal user. If the remaining traffic is not authorized, this field displays N/A. |
Login time |
Time when the user logged in. The field uses the device time format, for example, 2023-1-19 2:42:30 UTC. |
DHCP IP pool |
Authorized DHCP IP address pool. If no DHCP IP address pool is authorized for the portal user, this field displays N/A. |
Inbound CAR |
Authorized inbound CAR: · CIR—Committed information rate in bps. · PIR—Peak information rate in bps. If no inbound CAR is authorized, this field displays N/A. |
Outbound CAR |
Authorized outbound CAR: · CIR—Committed information rate in bps. · PIR—Peak information rate in bps. If no outbound CAR is authorized, this field displays N/A. |
ACL number |
Authorized ACL: · N/A—The AAA server authorizes no ACL. · active—The AAA server has authorized the ACL successfully. · inactive—The AAA server failed to authorize the ACL or the ACL does not exist on the device. |
User profile |
Authorized user profile: · N/A—The AAA server authorizes no user profile. · active—The AAA server has authorized the user profile successfully. · inactive—The AAA server failed to authorize the user profile or the user profile does not exist on the device. |
Max multicast addresses |
Maximum number of multicast groups the portal user can join. |
Multicast address list |
Multicast group list the portal user can join. If no multicast group is authorized, this field displays N/A. |
Traffic statistic |
Traffic statistics for the portal user. |
Uplink packets/bytes |
Packet and byte statistics of the upstream traffic. |
Downlink packets/bytes |
Packet and byte statistics of the downstream traffic. |
Dual-stack traffic statistic |
IPv4 and IPv6 traffic statistics for the dual-stack user. |
IPv4 address |
IPv4 address of the portal user. |
IPv6 address |
IPv6 address of the portal user. |
Uplink packets/bytes |
Packet and byte statistics of the upstream traffic. |
Downlink packets/bytes |
Packet and byte statistics of the downstream traffic. |
# Display brief information about all portal users.
<Sysname> display portal user all brief
IP address MAC address Online duration Username
2.2.2.2 000d-88f8-0eab 1:53:7 abc
3.3.3.3 000d-88f8-0eac 1:53:7 def
Table 14 Command output
Field |
Description |
IP address |
IP address of the portal user. |
MAC address |
MAC address of the portal user. |
Online duration |
Online duration of the portal user, in hh:ss:mm. |
Username |
Username of the portal user. |
Related commands
portal enable
display portal user count
Use display portal user count to display the number of portal users.
Syntax
display portal user count
Views
Any view
Predefined user roles
network-admin
mdc-admin
Examples
# Display the number of portal users.
<Sysname> display portal user count
Total number of users: 1
Related commands
portal enable
portal delete-user
display portal web-server
Use display portal web-server to display information about portal Web servers.
Syntax
display portal web-server [ server-name ]
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
server-name: Specifies a portal Web server by its name, a case-sensitive string of 1 to 32 characters.
Usage guidelines
If you do not specify the server-name argument, this command displays information about all portal Web servers.
Examples
# Display information about portal Web server wbs.
<Sysname> display portal web-server wbs
Portal Web server: wbs
Type : IMC
URL : http://www.test.com/portal
URL parameters : userurl=http://www.test.com/welcome
userip=source-address
VPN instance : Not configured
Server detection : Interval: 120s Attempts: 5 Action: log, trap
IPv4 status : Up
IPv6 status : Up
Captive-bypass : Enabled
If-match : original-url: http://2.2.2.2, redirect-url: http://192.168.56.2
original-url: http://1.1.1.1, temp-pass redirect-url:
http://192.168.1.1
Table 15 Command output
Field |
Description |
Type |
Portal Web server type: · CMCC—CMCC server. · IMC—IMC server. |
Portal Web server |
Name of the portal Web server. |
URL |
URL of the portal Web server. |
URL parameters |
URL parameters for the portal Web server. |
VPN instance |
Name of the MPLS L3VPN where the portal Web server resides. |
Server detection |
Parameters for portal Web server detection: · Detection interval in seconds. · Maximum number of detection attempts. · Actions (log and trap) triggered by the reachability status change of the portal Web server. |
IPv4/IPv6 status |
Current state of the portal Web server: · Up—This value indicates one of the following conditions: ¡ Portal Web server detection is disabled. ¡ Portal Web server detection is enabled and the server is reachable. · Down—Portal Web server detection is enabled and the server is unreachable. |
Captive-bypass |
Status of the captive-bypass feature: · Disabled—Captive-bypass is disabled. · Enabled—Captive-bypass is enabled. · Optimize Enabled—Optimized captive-bypass is enabled. |
If-match |
Match rules configured for URL redirection and temporary pass. |
Related commands
portal enable
portal web-server
server-detect (portal Web server view)
display web-redirect rule
Use display web-redirect rule to display information about Web redirect rules.
Syntax
In standalone mode:
display web-redirect rule { interface interface-type interface-number [ slot slot-number ] }
display web-redirect rule { interface interface-type interface-number [ chassis chassis-number slot slot-number ] }
Views
Any view
Predefined user roles
network-admin
network-operator
mdc-admin
mdc-operator
Parameters
interface interface-type interface-number: Specifies an interface by its type and number.
slot slot-number: Specifies the slot number of the device, which is fixed at 0. Alternatively, you can execute the command without specifying this option. The command execution results are the same. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies an IRF member device. The chassis-number argument represents the member ID of the IRF member device. The slot-number argument represents the slot number of the device, which is fixed at 0. If you do not specify an IRF member device, this command displays Web redirect rules for the master device. (In IRF mode.)
Examples
# Display all Web redirect rules on GigabitEthernet 1/1/1.
<Sysname> display web-redirect rule interface gigabitethernet 1/1/1
IPv4 web-redirect rules on GigabitEthernet1/1/1:
Rule 1:
Type : Dynamic
Action : Permit
Status : Active
Source:
IP : 192.168.2.114
VLAN : Any
Rule 2:
Type : Static
Action : Redirect
Status : Active
Source:
VLAN : Any
Protocol : TCP
Destination:
Port : 80
IPv6 web-redirect rules on GigabitEthernet1/1/1:
Rule 1:
Type : Static
Action : Redirect
Status : Active
Source:
VLAN : Any
Protocol : TCP
Destination:
Port : 80
Table 16 Command output
Field |
Description |
Rule |
Number of the Web redirect rule. |
Type |
Type of the Web redirect rule: · Static—Static Web redirect rule, generated when the Web redirect feature takes effect. · Dynamic—Dynamic Web redirect rule, generated when a user visits a redirect webpage. |
Action |
Action in the Web redirect rule: · Permit—Allows packets to pass. · Redirect—Redirects the packets. |
Status |
Status of the Web redirect rule: · Active—The Web redirect rule is effective. · Inactive—The Web redirect rule is not effective. |
Source |
Source information in the Web redirect rule. |
IP |
Source IP address. |
Mask |
Subnet mask of the source IPv4 address. |
Prefix length |
Prefix length of the source IPv6 address. |
VLAN |
Source VLAN. If not specified, this field displays Any. |
Protocol |
Transport layer protocol in the Web redirect rule: · Any—No transport layer protocol is limited. · TCP—Transmission Control Protocol. |
Destination |
Destination information in the Web redirect rule. |
Port |
Destination transport layer port number. The default port number is 80. |
exclude-attribute (portal authentication server view)
Use exclude-attribute to exclude an attribute from portal protocol packets.
Use undo exclude-attribute to not exclude an attribute from portal protocol packets.
Syntax
exclude-attribute number { ack-auth | ack-logout | ntf-logout }
undo exclude-attribute number { ack-auth | ack-logout | ntf-logout }
Default
No attributes are excluded from portal protocol packets.
Views
Portal authentication server view
Predefined user roles
network-admin
Parameters
number: Specifies an attribute by its number in the range of 1 to 255.
ack-auth: Excludes the attribute from ACK_AUTH packets.
ack-logout: Excludes the attribute from ACK_LOGOUT packets.
ntf-logout: Excludes the attribute from NTF_LOGOUT packets.
Usage guidelines
Support of the portal authentication server for portal protocol attributes varies by the server type. If the device sends the portal authentication server a packet that contains an attribute unsupported by the server, the device and the server cannot communicate.
To address this issue, you can configure this command to exclude the unsupported attributes from specific portal protocol packets sent to the portal authentication server.
You can specify multiple excluded attributes. For an excluded attribute, you can specify multiple types of portal protocol packets (ack-auth, ntf-logout, and ack-logout).
Table 17 describes all attributes of the portal protocol.
Name |
Number |
Description |
UserName |
1 |
Name of the user to be authenticated. |
PassWord |
2 |
User password in plaintext form. |
Challenge |
3 |
Random challenge for CHAP authentication. |
ChapPassWord |
4 |
CHAP password encrypted by MD5. |
TextInfo |
5 |
The device uses this attribute to transparently transport prompt information of a RADIUS server or packet error information to the portal authentication server. The attribute value can be any string excluding the end character '\0'. This attribute can exist in any packet from the device to the portal server. A packet can contain multiple TextInfo attributes. As a best practice, carry only one TextInfo attribute in a packet. |
UpLinkFlux |
6 |
Uplink (output) traffic of the user, an 8-byte unsigned integer, in KB. |
DownLinkFlux |
7 |
Downlink (input) traffic of the user, an 8-byte unsigned integer, in KB. |
Port |
8 |
Port information, a string excluding the end character '\0'. |
IP-Config |
9 |
This attribute has different meanings in different types of packets. · The device uses this attribute in ACK _AUTH (Type=0x04) packets to notify the portal server that the user requires re-DHCP. · The device uses this attribute in ACK_LOGOUT (Type=0x06) and NTF_LOGOUT (Type=0x08) packets to indicate that the current user IP address must be released. The portal server must notify the user to release the public IP address through DHCP. The device will reallocate a private IP address to the user. |
BAS-IP |
10 |
IP address of the access device. For re-DHCP portal authentication, the value of this attribute is the public IP address of the access device. |
Session-ID |
11 |
Identification of a portal user. Generally, the value of this attribute is the MAC address of the portal user. |
Delay-Time |
12 |
Delay time for sending a packet. This attributes exists in NTF_LOGOUT (Type=0x08) packets. |
User-List |
13 |
List of IP addresses of an IPv4 portal user. |
EAP-Message |
14 |
An EAP attribute that needs to be transported transparently. This attribute is applicable to EAP TLS authentication. Multiple EAP-Message attributes can exist in a portal authentication packet. |
User-Notify |
15 |
Value of the hw_User_Notify attribute in a RADIUS accounting response. This attribute needs to be transported transparently. |
BAS-IPv6 |
100 |
IPv6 address of the access device. |
UserIPv6-List |
101 |
List of IPv6 addresses of an IPv6 portal user. |
Examples
# Exclude the UpLinkFlux attribute (number 6) from portal ACK_AUTH packets.
<Sysname> system-view
[Sysname] portal server pts
[Sysname-portal-server-pts] exclude-attribute 6 ack-auth
Related commands
display portal server
if-match
Use if-match to configure a match rule for URL redirection.
Use undo if-match to delete a URL redirection match rule.
Syntax
if-match { original-url url-string redirect-url url-string [ url-param-encryption { aes | des } key { cipher | simple } string ] | user-agent string redirect-url url-string }
undo if-match { original-url url-string | user-agent user-agent }
Default
No URL redirection match rules exist.
Views
Portal Web server view
Predefined user roles
network-admin
mdc-admin
Parameters
original-url url-string: Specifies a URL string to match the URL in HTTP or HTTPS requests of a portal user. The specified URL must be a complete URL starting with http:// or https://, a case-sensitive string of 1 to 256 characters.
redirect-url url-string: Specifies the URL to which the user is redirected. The specified URL must be a complete URL starting with http:// or https://, a case-sensitive string of 1 to 256 characters.
url-param-encryption: Specifies an encryption algorithm to encrypt the parameters carried in the redirection URL. If you do not specify an encryption algorithm, the parameters carried in the redirection URL are not encrypted.
aes: Specifies the AES algorithm.
des: Specifies the DES algorithm.
key: Specifies a key for encryption.
cipher: Specifies a key in encrypted form.
simple: Specifies a key in plaintext form. For security purposes, the key specified in plaintext form will be stored in encrypted form.
string: Specifies the case-sensitive key string. The string length varies by the selected encryption method:
· If des cipher is specified, the string length is 41 characters.
· If des simple is specified, the string length is 8 characters.
· If aes cipher is specified, the string length is 1 to 73 characters.
· If aes simple is specified, the string length is 1 to 31 characters.
user-agent user-agent: Specifies a user agent string to match the User-Agent string in HTTP/HTTPS requests. The user agent string is a case-sensitive string of 1 to 255 characters. The User-Agent string in HTTP or HTTPS requests includes information about hardware manufacturer, operating system, browser, and search engine.
Usage guidelines
A URL redirection match rule matches HTTP or HTTPS requests by user-requested URL or User-Agent information, and redirects the matching HTTP or HTTPS requests to the specified redirection URL.
For a user to successfully access a redirection URL, configure a portal-free rule to allow HTTP or HTTPS requests destined for the redirection URL to pass. For information about configuring portal-free rules, see the portal free-rule command.
For a portal Web server, you can configure the url command and the if-match command for URL redirection. The url command redirects all HTTP or HTTPS requests from unauthenticated users to the portal Web server for authentication. The if-match command allows for flexible URL redirection by redirecting specific HTTP or HTTPS requests to specific redirection URLs. If both commands are executed, the if-match command takes priority to perform URL redirection.
If you configure encryption for parameters in the redirection URL, you must add an encryption prompt field after the redirection URL address. For example, to redirect HTTP requests to URL 10.1.1.1 with encrypted URL parameters, specify the redirection URL as http://10.1.1.1?yyyy=. The value of yyyy depends on the portal Web server configuration. For more information, see the portal Web server configuration guide.
Examples
# Configure a match rule to redirect HTTP requests destined for the URL http://www.abc.com.cn to the URL http://192.168.0.1.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] if-match original-url http://www.abc.com.cn redirect-url http://192.168.0.1
# Configure a match rule to redirect HTTP requests that carry the user agent string 5.0(WindowsNT6.1)AppleWebKit/537.36(KHTML,likeGecko)Chrome/36.0.1985.125Safari/537.36 to the URL http://192.168.0.1.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] if-match user-agent 5.0(WindowsNT6.1)AppleWebKit/537.36(KHTML,likeGecko)Chrome/36.0.1985.125Safari/537.36 redirect-url http://192.168.0.1
Related commands
display portal web-server
portal free-rule
url
url-parameter
if-match temp-pass
Use if-match temp-pass to configure a match rule for temporary pass.
Use undo if-match temp-pass to restore the default.
Syntax
if-match { original-url url-string | user-agent user-agent } * temp-pass [ redirect-url url-string | original ]
undo if-match { original-url url-string | user-agent user-agent } * temp-pass
Default
No match rules for temporary pass are configured.
Views
Portal Web server view
Predefined user roles
network-admin
mdc-admin
Parameters
original-url url-string: Specifies a URL string to match the URL in HTTP or HTTPS requests of portal users. The specified URL must be a complete URL starting with http:// or https://, a case-sensitive string of 1 to 256 characters.
user-agent user-agent: Specifies a user agent string to match the User-Agent string in HTTP/HTTPS requests. The user agent string is a case-sensitive string of 1 to 255 characters. The User-Agent string in HTTP or HTTPS requests includes information about hardware manufacturer, operating system, browser, and search engine.
redirect-url url-string: Redirects the matching Web requests to the specified URL. The specified URL must be a complete URL starting with http:// or https://, a case-sensitive string of 1 to 256 characters.
original: Redirects the matching Web requests to the originally requested URLs.
Usage guidelines
A match rule for temporary pass matches Web requests by URL or User-Agent information. Only the matching Web requests are temporarily permitted to pass.
A permitted request can be redirected to the specified redirection URL or to the originally requested URL, depending on the redirection action in the match rule. If you do not configure a redirection action (by using the redirect-url url-string option or the original keyword), the device permits the matching requests to pass without redirection.
For the match rules to take effect, make sure the portal temporary pass feature is enabled.
If you configure the same match criteria but different redirection actions in two match rules, the new configuration overwrites the existing one.
Examples
# Configure a temporary pass rule to temporarily allow user packets that access the URL http://www.abc.com.cn to pass.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] if-match original-url http://www.abc.com.cn temp-pass
# Configure a temporary pass rule to temporarily allow user packets that access the URL http://www.abc.com.cn to pass and then redirect the packets to the originally requested URL.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] if-match original-url http://www.abc.com.cn temp-pass original
# Configure a temporary pass rule to allow user packets that contain user agent information 5.0(WindowsNT6.1)AppleWebKit/537.36(KHTML,likeGecko)Chrome/36.0.1985.125Safari/537.36 to pass and then redirect the packets to the URL http://192.168.0.1.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] if-match user-agent 5.0(WindowsNT6.1)AppleWebKit/537.36(KHTML,likeGecko)Chrome/36.0.1985.125Safari/537.36 temp-pass redirect-url http://192.168.0.1
# Configure a temporary pass rule. This rule allows user packets that access the URL http://www.abc.com.cn and contain user agent information 5.0(WindowsNT6.1)AppleWebKit/537.36(KHTML,likeGecko)Chrome/36.0.1985.125Safari/537.36 to pass and then redirects the packets to the URL http://192.168.0.1.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] if-match original-url http://www.123.com.cn user-agent 5.0(WindowsNT6.1)AppleWebKit/537.36(KHTML,likeGecko)Chrome/36.0.1985.125Safari/537.36 temp-pass redirect-url http://192.168.0.1
Related commands
display portal web-server
portal free-rule
portal temp-pass enable
url
url-parameter
ip (portal authentication server view)
Use ip to specify the IP address of an IPv4 portal authentication server.
Use undo ip to restore the default.
Syntax
ip ipv4-address [ vpn-instance vpn-instance-name ] [ key { cipher | simple } string ]
undo ip
Default
The IP address of the IPv4 portal authentication server is not specified.
Views
Portal authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv4-address: Specifies the IP address of the IPv4 portal authentication server.
vpn-instance vpn-instance-name: Specifies the MPLS L3VPN where the portal authentication server resides by the VPN instance name, a case-sensitive string of 1 to 31 characters. If the portal authentication server is on the public network, do not specify this option.
key: Specifies a shared key for communication with the portal authentication server. Portal packets exchanged between the access device and the portal authentication server carry an authenticator that is generated with the shared key. The receiver uses the authenticator to check the correctness of the received portal packets.
cipher: Specifies a key in encrypted form.
simple: Specifies a key in plaintext form. For security purposes, the key specified in plaintext form will be stored in encrypted form.
string: Specifies the key. Its plaintext form is a case-sensitive string of 1 to 64 characters. Its encrypted form is a case-sensitive string of 1 to 117 characters.
Usage guidelines
A portal authentication server has only one IPv4 address. Therefore, in portal authentication server view, only one IPv4 address exists. If you execute this command multiple times, the most recent configuration takes effect.
Do not configure the same IPv4 address and MPLS L3VPN for different portal authentication servers.
Examples
# Configure the IP address of the IPv4 portal authentication server pts as 192.168.0.111 and the plaintext key as portal.
<Sysname> system-view
[Sysname] portal server pts
[Sysname-portal-server-pts] ip 192.168.0.111 key simple portal
Related commands
display portal server
portal server
ipv6 (portal authentication server view)
Use ipv6 to specify the IP address of an IPv6 portal authentication server.
Use undo ipv6 to restore the default.
Syntax
ipv6 ipv6-address [ vpn-instance ipv6-vpn-instance-name ] [ key { cipher | simple } string ]
undo ipv6
Default
The IP address of the IPv6 portal authentication server is not specified.
Views
Portal authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6-address: Specifies the IP address of the IPv6 portal authentication server.
vpn-instance ipv6-vpn-instance-name: Specifies the MPLS L3VPN where the portal authentication server resides by the VPN instance name, a case-sensitive string of 1 to 31 characters. If the portal authentication server is on the public network, do not specify this option.
key: Specifies a shared key for communication with the portal authentication server. Portal packets exchanged between the access device and the portal authentication server carry an authenticator that is generated with the shared key. The receiver uses the authenticator to check the correctness of the received portal packets.
cipher: Specifies a key in encrypted form.
simple: Specifies a key in plaintext form. For security purposes, the key in plaintext form will be stored in encrypted form.
string: Specifies the key. Its plaintext form is a case-sensitive string of 1 to 64 characters. Its encrypted form is a case-sensitive string of 1 to 117 characters.
Usage guidelines
A portal authentication server has only one IPv6 address. Therefore in portal authentication server view, only one IPv6 address exists. If you execute this command multiple times, the most recent configuration takes effect.
Do not configure the same IPv6 address and MPLS L3VPN for different portal authentication servers.
Examples
# Configure the IP address of the IPv6 portal authentication server pts as 2000::1 and the plaintext key as portal.
<Sysname> system-view
[Sysname] portal server pts
[Sysname-portal-server-pts] ipv6 2000::1 key simple portal
Related commands
display portal server
portal server
logout-notify
Use logout-notify to set the maximum number of times and the interval for retransmitting a logout notification packet.
Use undo logout-notify to restore the default.
Syntax
logout-notify retry retries interval interval
undo logout-notify
Default
The device does not retransmit a logout notification packet.
Views
Portal authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
retry retries: Specifies the maximum number of retries, in the range of 1 to 5.
interval interval: Specifies the retry interval, in the range of 1 to 10 seconds.
Usage guidelines
A logout notification packet is a UDP packet that the device sends to the portal authentication server for forcibly logging out a portal user. To increase the delivery reliability, you can set the maximum number of times and the interval for retransmitting a logout notification packet.
After the device sends a logout notification packet for logging out a portal user, it waits for a response from the portal authentication server. If the device receives a response within the specified period of time (maximum number of retries × retry interval), it logs out and deletes the user immediately. If the device does not receive a response within the period of time, the device logs out and deletes the user when the period of time elapses.
Examples
# Set the maximum number of times to 3 and the interval to 5 seconds for retransmitting a logout notification packet,
<Sysname> system-view
[Sysname] portal server pt
[Sysname-portal-server-pt] logout-notify retry 3 interval 5
Related commands
display portal server
mail-domain-name
Use mail-domain-name to specify an email domain name for email authentication.
Use undo mail-address to remove an email domain name for email authentication.
Syntax
mail-domain-name string
undo mail-domain-name [ string ]
Default
No email domain names are specified for email authentication.
Views
Email authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
string: Specifies an email domain name for email authentication, a case-sensitive string of 1 to 255 characters, in the format of @XXX.XXX. The undo form of this command removes all email domain names for email authentication if you do not specify an email domain name.
Usage guidelines
After you configure this command, the device performs email authentication only on portal users that use the specified email domain names.
You can specify a maximum of 16 email domain names for email authentication.
Examples
# Specify @qq.com and @sina.com email domain names for email authentication.
<Sysname> system-view
[Sysname] portal extend-auth-server mail
[Sysname-portal-extend-auth-server-mail] mail-domain-name @qq.com
[Sysname-portal-extend-auth-server-mail] mail-domain-name @Sina.com
Related commands
display portal extend-auth-server
mail-protocol
Use mail-protocol to specify protocols for email authentication.
Use undo mail-protocol to restore the default.
Syntax
mail-protocol { imap | pop3 } *
undo mail-protocol
Default
No protocols are specified for email authentication.
Views
Email authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
imap: Specifies the Internet Message Access Protocol (IMAP).
pop3: Specifies the Post Office Protocol 3 (POP3).
Usage guidelines
This command specifies email protocols that the device uses to interact with the email server to perform authentication and authorization on portal users who uses email authentication.
Examples
# Specify POP3 as the protocol for email authentication.
<Sysname> system-view
[Sysname] portal extend-auth-server mail
[Sysname-portal-extend-auth-server-mail] mail-protocol pop3
Related commands
display portal extend-auth-server
port (portal authentication server view)
Use port to set the destination UDP port number used by the device to send unsolicited portal packets to the portal authentication server.
Use undo port to restore the default.
Syntax
port port-number
undo port
Default
The device uses 50100 as the destination UDP port number for unsolicited portal packets.
Views
Portal authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
port-number: Specifies a destination UDP port number the device uses to send unsolicited portal packets to the portal authentication server. The value range for this argument is 1 to 65534.
Usage guidelines
The specified port must be the port that listens to portal packets on the portal authentication server.
Examples
# Set the destination UDP port number to 50000 for the device to send unsolicited portal packets to the portal authentication server pts.
<Sysname> system-view
[Sysname] portal server pts
[Sysname-portal-server-pts] port 50000
Related commands
portal server
portal { bas-ip | bas-ipv6 }
Use portal { bas-ip | bas-ipv6 } to configure the BAS-IP or BAS-IPv6 attribute carried in the portal packets sent to the portal authentication server.
Use undo portal { bas-ip | bas-ipv6 } to delete the BAS-IP or BAS-IPv6 attribute setting.
Syntax
portal { bas-ip ipv4-address | bas-ipv6 ipv6-address }
undo portal { bas-ip | bas-ipv6 }
Default
The BAS-IP attribute of an IPv4 portal reply packet sent to the portal authentication server is the source IPv4 address of the packet. The BAS-IPv6 attribute of an IPv6 portal reply packet sent to the portal authentication server is the source IPv6 address of the packet.
The BAS-IP attribute of an IPv4 portal notification packet sent to the portal authentication server is the IPv4 address of the packet's output interface. The BAS-IPv6 attribute of an IPv6 portal notification packet sent to the portal authentication server is the IPv6 address of the packet's output interface.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
bas-ip ipv4-address: Specifies BAS-IP for portal packets sent to the portal authentication server. The ipv4-address argument must be the IPv4 address of an interface on the device. It cannot be 0.0.0.0, 1.1.1.1, a class D address, a class E address, or a loopback address.
bas-ip6 ipv6-address: Specifies BAS-IPv6 for portal packets sent to the portal authentication server. The ipv6-address argument must be the IPv6 address of an interface on the device. It cannot be a multicast address, an all 0 address, or a link-local address.
Usage guidelines
If the device runs Portal 2.0, unsolicited portal packets (such as a logout notification packet) sent to the portal authentication server must carry the BAS-IP attribute. If the device runs Portal 3.0, unsolicited portal packets sent to the portal authentication server must carry the BAS-IP or BAS-IPv6 attribute.
After this command takes effect, the source IP address for unsolicited notification portal packets the device sends to the portal authentication server is the configured BAS-IP or BAS-IPv6. If the BAS-IP or BAS-IPv6 attribute is not configured, the source IP address of the packets is the IP address of the packet output interface.
You must configure the BAS-IP or BAS-IPv6 attribute on a portal authentication-enabled interface if the following conditions are met:
· The portal authentication server is an H3C IMC server or the portal authentication mode on the interface is re-DHCP.
· The portal device IP address specified on the portal authentication server is not the IP address of the portal packet output interface.
Examples
# On GigabitEthernet 1/1/1, configure the BAS-IP attribute as 2.2.2.2 for portal packets sent to the portal authentication server.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal bas-ip 2.2.2.2
Related commands
display portal
portal { ipv4-max-user | ipv6-max-user }
Use portal { ipv4-max-user | ipv6-max-user } to set the maximum number of portal users allowed on an interface.
Use undo portal { ipv4-max-user | ipv6-max-user } to restore the default.
Syntax
portal { ipv4-max-user | ipv6-max-user } max-number
undo portal { ipv4-max-user | ipv6-max-user }
Default
The maximum number of portal users allowed on an interface is not limited.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
max-number: Specifies the maximum number of portal users allowed on an interface, in the range of 1 to 4294967295.
Usage guidelines
If the specified maximum number is smaller than the number of current online portal users on the interface, the limit can be set successfully. The limit does not impact the online portal users. However, the device does not allow new portal users to log in from the interface until the number drops down below the limit.
Make sure the maximum combined number of IPv4 and IPv6 portal users specified on all interfaces does not exceed the system-allowed maximum number. Otherwise, the exceeding portal users will not be able to log in to the device.
Examples
# Set the maximum number of IPv4 portal users to 100 on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal ipv4-max-user 100
Related commands
display portal user
portal max-user
portal apply web-server
Use portal [ ipv6 ] apply web-server to specify a portal Web server. The device redirects the HTTP or HTTPS requests sent by unauthenticated portal users to the portal Web server.
Use undo portal [ ipv6 ] apply web-server to delete a portal Web server.
Syntax
portal [ ipv6 ] apply web-server server-name [ secondary ]
undo portal [ ipv6 ] apply web-server [ server-name ]
Default
No portal Web servers are specified.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6: Specifies an IPv6 portal Web server. If the server is an IPv4 portal Web server, do not specify this keyword.
secondary: Specifies the backup portal Web server. If you do not specify this keyword, the specified server is the primary portal Web server.
server-name: Specifies a portal Web server to be specified on the interface by its name, a case-sensitive string of 1 to 32 characters. The name must already exist. If you do not specify a server name in the undo form of this command, all portal Web servers on the interface are removed.
Usage guidelines
IPv4 and IPv6 portal authentication can both be enabled on an interface. You can specify both a primary portal Web server and a backup portal Web server after enabling each type (IPv4 or IPv6) of portal authentication.
The device first uses the primary portal Web server for portal authentication. When the primary portal Web server is unreachable but the backup portal Web server is reachable, the device uses the backup portal Web server. When the primary portal Web server becomes reachable, the device switches back to the primary portal Web server for portal authentication.
To automatically switch between the primary portal Web server and the backup portal Web server, configure portal Web server detection on both servers.
Examples
# Specify portal Web server wbs as the backup portal Web server on GigabitEthernet 1/1/1 for portal authentication.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal apply web-server wbs secondary
Related commands
display portal
portal fail-permit server
portal web-server
server-detect (portal Web server view)
portal auth-error-record enable
Use portal auth-error-record enable to enable portal authentication error recording.
Use undo portal auth-error-record enable to disable portal authentication error recording.
Syntax
portal auth-error-record enable
undo portal auth-error-record enable
Default
Portal authentication error recording is disabled.
Views
System view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
This feature enables the device to save all portal authentication error records and to periodically send the records to the lvzhou cloud server or other servers.
Examples
# Enable portal authentication error recording.
<Sysname> system-view
[Sysname] portal auth-error-record enable
Related commands
display portal auth-error-record
portal auth-error-record export
Use portal auth-error-record export to export portal authentication error records to a path.
Syntax
portal auth-error-record export url url-string [ start-time start-date start-time end-time end-date end-time ]
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
url url-string: Specifies the URL to which portal authentication error records are exported. The URL is a case-insensitive string of 1 to 255 characters.
start-time start-date start-time end-time end-date end-time: Specifies a time range. The start date and end date must be in the format of MM/DD/YYYY or YYYY/MM/DD. The value range for MM is 1 to 12. The value range for DD varies with the specified month. The value range for YYYY is 1970 to 2100. The start time and end time must be in the format of hh:mm. The value range for the start time and end time is 00:00 to 23:59.
Usage guidelines
The device supports FTP, TFTP, and HTTP file transfer methods. Table 18 describes the valid URL format for each method.
Protocol |
URL format |
Remarks |
FTP |
ftp://username[:password]@server-address[:port-number]/file-path Example: ftp://a:[email protected]/authfail/ |
The username and password must be the same as those on the server. If the server authenticates only the username, no password is required. |
TFTP |
tftp://server-address[:port-number]/file-path Example: tftp://1.1.1.1/ autherror/ |
N/A |
HTTP |
http://username[:password]@server-address[:port-number]/file-path Example: http://1.1.1.1/autherror/ |
The username and password must be the same as those on the server. If the server authenticates only the username, no password is required. |
If the server address is an IPv6 address, bracket the IPv6 address to distinguish the IPv6 address from the port number. For example, if the server address is 2001::1 and the port number is 21, the URL is ftp://test:test@[2001::1]:21/test/.
Examples
# Export all portal authentication error records to path tftp://1.1.1.1/record/autherror/.
<Sysname> system-view
[Sysname] portal auth-error-record export tftp://1.1.1.1/record/autherror/
# Export portal authentication error records in the time range from 2016/3/4 14:20 to 2016/3/4 15:00 to path tftp://1.1.1.1/record/autherror/.
<Sysname> system-view
[Sysname] portal auth-error-record export tftp://1.1.1.1/record/autherror/ start-time 2016/3/4 14:20 end-time 2016/3/4 15:00
Related commands
display portal auth-error-record
portal auth-error-record enable
reset portal auth-error-record
portal auth-error-record max
Use portal auth-error-record max to set the maximum number of portal authentication error records.
Use undo portal auth-error-record max to restore the default.
Syntax
portal auth-error-record max number
undo portal auth-error-record max
Default
The maximum number of portal authentication error records is 32000.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
number: Specifies the maximum number of portal authentication error records, in the range of 1 to 4294967295.
Usage guidelines
When the maximum number of portal authentication error records is reached, a new record overwrites the oldest one.
Examples
# Set the maximum number of portal authentication error records to 50.
<Sysname> system-view
[Sysname] portal auth-error-record max 50
Related commands
display portal auth-error-record
portal auth-fail-record enable
Use portal auth-fail-record enable to enable portal authentication failure recording.
Use undo portal auth-fail-record enable to disable portal authentication failure recording.
Syntax
portal auth-fail-record enable
undo portal auth-fail-record enable
Default
Portal authentication failure recording is disabled.
Views
System view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
This feature enables the device to save portal authentication failure records and to periodically send the records to the lvzhou cloud server or other servers.
Examples
# Enable portal authentication failure recording.
<Sysname> system-view
[Sysname] portal auth-fail-record enable
Related commands
display portal auth-fail-record
portal auth-fail-record export
Use portal auth-fail-record export to export portal authentication failure records to a path.
Syntax
portal auth-fail-record export url url-string [ start-time start-date start-time end-time end-date end-time ]
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
url url-string: Specifies the URL to which portal authentication failure records are exported. The URL is a case-insensitive string of 1 to 255 characters.
start-time start-date start-time end-time end-date end-time: Specifies a time range. The start date and end date must be in the format of MM/DD/YYYY or YYYY/MM/DD. The value range for MM is 1 to 12. The value range for DD varies with the specified month. The value range for YYYY is 1970 to 2100. The start time and end time must be in the format of hh:mm. The value range for the start time and end time is 00:00 to 23:59.
Usage guidelines
The device supports FTP, TFTP, and HTTP file transfer methods. Table 19 describes the valid URL format for each method.
Protocol |
URL format |
Remarks |
FTP |
ftp://username[:password]@server-address[:port-number]/file-path Example: ftp://a:[email protected]/authfail/ |
The username and password must be the same as those on the server. If the server authenticates only the username, no password is required. |
TFTP |
tftp://server-address[:port-number]/file-path Example: tftp://1.1.1.1/ autherror/ |
N/A |
HTTP |
http://username[:password]@server-address[:port-number]/file-path Example: http://1.1.1.1/autherror/ |
The username and password must be the same as those on the server. If the server authenticates only the username, no password is required. |
If the server address is an IPv6 address, bracket the IPv6 address to distinguish the IPv6 address from the port number. For example, if the server address is 2001::1 and the port number is 21, the URL is ftp://test:test@[2001::1]:21/test/.
Examples
# Export all portal authentication failure records to path tftp://1.1.1.1/record/authfail/.
<Sysname> system-view
[Sysname] portal auth-fail-record export url tftp://1.1.1.1/record/authfail/
# Export portal authentication failure records in the time range from 2016/3/4 14:20 to 2016/3/4 15:00 to path tftp://1.1.1.1/record/authfail/.
<Sysname> system-view
[Sysname] portal auth-fail-record export tftp://1.1.1.1/record/authfail/ start-time 2016/3/4 14:20 end-time 2016/3/4 15:00
Related commands
display portal auth-fail-record
portal auth-fail-record enable
reset portal auth-fail-record
portal auth-fail-record max
Use portal auth-fail-record max to set the maximum number of portal authentication failure records.
Use undo portal auth-fail-record max to restore the default.
Syntax
portal auth-fail-record max number
undo portal auth-fail-record max
Default
The maximum number of portal authentication failure records is 32000.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
number: Specifies the maximum number of portal authentication failure records, in the range of 1 to 4294967295.
Usage guidelines
When the maximum number of portal authentication failure records is reached, a new record overwrites the oldest one.
Examples
# Set the maximum number of portal authentication failure records to 50.
<Sysname> system-view
[Sysname] portal auth-fail-record max 50
Related commands
display portal auth-fail-record
portal authorization strict-checking
Use portal authorization strict-checking to enable strict checking on portal authorization information.
Use undo portal authorization strict-checking to disable strict checking on portal authorization information.
Syntax
portal authorization { acl | user-profile } strict-checking
undo portal authorization { acl | user-profile } strict-checking
Default
Strict checking mode on portal authentication information is disabled. If an authorized ACL or user profile does not exist on the device or the ACL or user profile fails to be deployed, the user will not be logged out.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
acl: Enables strict checking on authorized ACLs.
user-profile: Enables strict checking on authorized user profiles.
Usage guidelines
You can enable strict checking on authorized ACLs, authorized user profiles, or both. If you enable both strict ACL checking and user profile checking, the user will be logged out if either checking fails.
An ACL/user profile checking fails when the authorized ACL/user profile does not exist on the device or the ACL/user profile fails to be deployed.
Examples
# Enable strict checking on authorized ACLs on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname–GigabitEthernet1/1/1] portal authorization acl strict-checking
Related commands
display portal
portal captive-bypass optimize delay
Use portal captive-bypass optimize delay to set the captive-bypass detection timeout time.
Use undo portal captive-bypass optimize delay to restore the default.
Syntax
portal captive-bypass optimize delay seconds
undo portal captive-bypass optimize delay
Default
The captive-bypass detection timeout time is 6 seconds.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
seconds: Specifies the captive-bypass detection timeout time, in the range of 6 to 60 seconds.
Usage guidelines
This command applies only to iOS mobile clients.
When an iOS client is connected to a network, it automatically sends a server reachability detection packet to determine whether the Apple server is reachable. If the server is reachable, the Wi-Fi connection displays connected. If the server is not reachable, the Wi-Fi connection is terminated.
When the network condition is poor, the device cannot detect a server reachability detection packet from an iOS mobile client within the captive-bypass detection timeout time. The client cannot receive a response for the server reachability detection packet, and therefore it determines the server to be unreachable and terminates the Wi-Fi connection. To avoid Wi-Fi disconnections caused by server reachability detection failure, set a longer captive-bypass detection timeout time when the network condition is poor.
Examples
# Set the captive-bypass detection timeout time to 20 seconds.
<Sysname> system-view
[Sysname] portal captive-bypass optimize delay 20
Related commands
captive-bypass enable
portal delete-user
Use portal delete-user to log out online portal users.
Syntax
portal delete-user { ipv4-address | all | auth-type { cloud | email | local | normal | qq | wechat } | interface interface-type interface-number | ipv6 ipv6-address | mac mac-address | username username }
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv4-address: Specifies the IP address of an IPv4 online portal user.
all: Specifies IPv4 and IPv6 online portal users on all interfaces.
auth-type: Specifies an authentication type.
cloud: Specifies the cloud authentication.
email: Specifies the email authentication.
local: Specifies the local authentication.
normal: Specifies the normal authentication.
qq: Specifies the QQ authentication.
wechat: Specifies the WeChat authentication.
interface interface-type interface-number: Specifies an interface by its type and number. If you specify this option, this command logs out all IPv4 and IPv6 online portal users on the interface.
ipv6 ipv6-address: Specifies the IP address of an IPv6 online portal user.
mac mac-address: Specifies the MAC address of an online portal user, in the format of H-H-H.
username username: Specifies the username of an online portal user, a case-sensitive string of 1 to 253 characters. The username cannot contain the domain name.
Examples
# Log out the online portal user whose IP address is 1.1.1.1.
<Sysname> system-view
[Sysname] portal delete-user 1.1.1.1
# Log out the online portal user whose MAC address is 000d-88f8-0eab.
<Sysname> system-view
[Sysname] portal delete-user mac 000d-88f8-0eab
# Log out all online portal users whose authentication type is email authentication.
<Sysname> system-view
[Sysname] portal delete-user auth-type email
# Log out the online portal user whose username is abc.
<Sysname> system-view
[Sysname] portal delete-user username abc
Related commands
display portal user
portal device-id
Use portal device-id to specify the device ID.
Use undo portal device-id to restore the default.
Syntax
portal device-id device-id
undo portal device-id
Default
A device is not configured with a device ID.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
device-id: Specifies a device ID for the device, a case-sensitive string of 1 to 63 characters.
Usage guidelines
The portal authentication server uses device IDs to identify the device that sends protocol packets to the portal server.
Make sure the configured device ID is different than any other access devices communicating with the same portal authentication server.
Examples
# Set the device ID of the device to 0002.0010.100.00.
<Sysname> system-view
[Sysname] portal device-id 0002.0010.100.00
portal domain
Use portal [ ipv6 ] domain to configure a portal authentication domain on an interface. All portal users accessing through the interface must use the authentication domain.
Use undo portal [ ipv6 ] domain to delete the configured portal authentication domain.
Syntax
portal [ ipv6 ] domain domain-name
undo portal [ ipv6 ] domain
Default
No portal authentication domain is configured on an interface.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6: Specifies an authentication domain for IPv6 portal users. Do not specify this keyword for IPv4 portal users.
domain-name: Specifies an ISP authentication domain by its name, a case-insensitive string of 1 to 255 characters.
Usage guidelines
You can specify both an IPv4 portal authentication domain and an IPv6 portal authentication domain on an interface.
Do not specify the ipv6 keyword for IPv4 portal users.
Examples
# Configure the authentication domain for IPv4 portal users as my-domain on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname–GigabitEthernet1/1/1] portal domain my-domain
Related commands
display portal
portal dual-stack enable
Use portal dual-stack enable to enable the portal dual-stack feature.
Use undo portal dual-stack enable to disable the portal dual-stack feature.
Syntax
portal dual-stack enable
undo portal dual-stack enable
Default
The portal dual-stack feature is disabled.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
The portal dual-stack feature enables portal users to access both IPv4 and IPv6 networks after passing one type (IPv4 or IPv6) of portal authentication.
Only direct portal authentication supports this feature.
Examples
# Enable the portal dual-stack feature on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal dual-stack enable
Related commands
portal dual-stack traffic-separate enable
portal dual-stack traffic-separate enable
Use portal dual-stack traffic-separate enable to enable separate IPv4 and IPv6 traffic statistics for dual-stack portal users.
Use undo portal dual-stack traffic-separate enable to disable separate IPv4 and IPv6 traffic statistics for dual-stack portal users.
Syntax
portal dual-stack traffic-separate enable
undo portal dual-stack traffic-separate enable
Default
Separate IPv4 and IPv6 traffic statistics is disabled for dual-stack portal users. The device collects IPv4 and IPv6 traffic statistics collectively.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
This feature enables the device to separately collect IPv4 traffic statistics and IPv6 traffic statistics for a dual-stack portal user. Then, the AAA server can separately perform accounting on IPv4 traffic and IPv6 traffic of the user.
For this feature to take effect, you must enable the portal dual-stack feature.
This command has a higher priority over the accounting dual-stack command in ISP domain view.
Examples
# Enable separate IPv4 and IPv6 traffic statistics for dual-stack portal users on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal dual-stack traffic-separate enable
Related commands
portal dual-stack enable
portal enable
Use portal [ ipv6 ] enable to enable portal authentication.
Use undo portal [ ipv6 ] enable to disable portal authentication.
Syntax
portal enable method { direct | layer3 | redhcp }
portal ipv6 enable method { direct | layer3 }
undo portal [ ipv6 ] enable
Default
Portal authentication is disabled.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6: Enables IPv6 portal authentication. Do not specify this keyword for IPv4 portal authentication.
method: Specifies an authentication mode:
· direct—Direct authentication.
· layer3—Cross-subnet authentication.
· redhcp—Re-DHCP authentication.
Usage guidelines
To modify the portal authentication mode, first execute the undo form of this command to disable portal authentication.
Make sure the device supports IPv6 ACL and IPv6 forwarding before you enable IPv6 portal authentication on the interface.
IPv6 portal authentication does not support the re-DHCP authentication mode.
Do not add a portal authentication-enabled Ethernet interface to an aggregation group. Otherwise, portal authentication cannot take effect on the interface.
You can enable both IPv4 and IPv6 portal authentication on an interface.
Do not enable portal authentication on both an interface.
Examples
# Enable direct IPv4 portal authentication on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal enable method direct
Related commands
display portal
portal extend-auth domain
Use portal extend-auth domain to specify the authentication domain for third-party authentication.
Use undo portal extend-auth domain to remove the authentication domain for third-party authentication.
Syntax
portal extend-auth domain domain-name
undo portal extend-auth domain
Default
No authentication domain is specified for third-party authentication.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
domain-name: Specifies an ISP domain by its name, a case-insensitive string of 1 to 255 characters.
Usage guidelines
The specified ISP domain takes effect only on IPv4 portal users that use third-party authentication.
Make sure the authentication, authorization, and accounting methods in the authentication domain are none.
Examples
# Specify authentication domain my-domain for third-party authentication on GigabitEthernet1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname–GigabitEthernet1/1/1] portal extend-auth domain my-domain
Related commands
display portal
portal extend-auth-server
Use portal extend-auth-server to create a third-party authentication server and enter its view, or enter the view of an existing third-party authentication server.
Use undo portal extend-auth-server to delete a third-party authentication server.
Syntax
portal extend-auth-server { qq | mail }
undo portal extend-auth-server { qq | mail }
Default
No third-party authentication servers exist.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
qq: Specifies the QQ authentication server.
mail: Specifies the email authentication server.
Usage guidelines
The device supports using the QQ or email authentication server as a third-party portal authentication server for portal authentication. A portal user can use a QQ or email account instead of a portal account to perform portal authentication. If the user passes third-party authentication, the third-party server notifies the third-party authentication success of the user to the device. Then, the device interacts with the local portal Web server to complete the remaining process of portal authentication.
Only direct portal authentication that uses a local portal Web portal server supports third-party authentication.
Examples
# Create a QQ authentication server and enter its view.
<Sysname> system-view
[Sysname] portal extend-auth-server qq
[Sysname-portal-extend-auth-server-qq]
# Create an email authentication server and enter its view.
<Sysname> system-view
[Sysname] portal extend-auth-server mail
[Sysname-portal-extend-auth-server-mail]
Related commands
display portal extend-auth-server
portal fail-permit server
Use portal [ ipv6 ] fail-permit server to enable the portal fail-permit feature for a portal authentication server.
Use undo portal [ ipv6 ] fail-permit server to disable the portal fail-permit feature for the portal authentication server.
Syntax
portal [ ipv6 ] fail-permit server server-name
undo portal [ ipv6 ] fail-permit server
Default
Portal fail-permit is disabled for the portal authentication server.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6: Specifies an IPv6 portal authentication server. Do not specify this keyword for an IPv4 portal authentication server.
server-name: Specifies a portal authentication server by its name, a case-sensitive string of 1 to 32 characters.
Usage guidelines
When portal fail-permit is enabled for a portal authentication server and portal Web servers on an interface, the interface disables portal authentication in either of the following conditions:
· Both the primary and backup portal Web servers are unreachable.
· The specified portal authentication server is unreachable.
Portal authentication resumes on the interface when the specified portal authentication server and a minimum of one portal Web server becomes reachable. After portal authentication resumes, users who failed portal authentication and unauthenticated portal users need to pass authentication to access network resources. Portal users who have passed authentication can continue accessing network resources.
If you execute this command multiple times, the most recent configuration takes effect.
Examples
# Enable portal fail-permit for portal authentication server pts1 on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal fail-permit server pts1
Related commands
display portal
portal fail-permit web-server
Use portal [ ipv6 ] fail-permit web-server to enable the portal fail-permit feature for portal Web servers.
Use undo portal [ ipv6 ] fail-permit web-server to disable the portal fail-permit feature for portal Web servers.
Syntax
portal [ ipv6 ] fail-permit web-server
undo portal [ ipv6] fail-permit web-server
Default
Portal fail-permit is disabled for portal Web servers.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6: Specifies IPv6 portal Web servers. To specify IPv4 portal Web servers, do not specify this keyword.
Usage guidelines
On an interface enabled with portal fail-permit for a portal authentication server and portal Web servers, portal authentication on the interface is disabled in either of the following conditions:
· All portal Web servers are unreachable.
· The specified portal authentication server is unreachable.
Portal authentication resumes on the interface when the specified portal authentication server and a minimum of one portal Web server becomes reachable. After portal authentication resumes, users who failed portal authentication and unauthenticated portal users need to pass authentication to access network resources. Portal users who have passed authentication can continue accessing network resources.
Examples
# Enable portal fail-permit for the portal Web servers on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal fail-permit web-server
Related commands
display portal
portal free-all except destination
Use portal free-all except destination to configure an IPv4 portal authentication destination subnet on an interface.
Use undo portal free-all except destination to delete the IPv4 portal authentication destination subnets on the interface.
Syntax
portal free-all except destination ipv4-network-address { mask-length | mask }
undo portal free-all except destination [ ipv4-network-address ]
Default
No IPv4 portal authentication destination subnet is configured on the interface. Portal users must pass portal authentication to access any subnet.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv4-network-address: Specifies an IPv4 portal authentication subnet address.
mask-length: Specifies the subnet mask length for the authentication subnet address, in the range of 0 to 32.
mask: Specifies the subnet mask in dotted decimal format.
Usage guidelines
Portal users on the interface are authenticated when accessing the specified authentication destination subnet (except IP addresses and subnets specified in portal-free rules). The users can access other subnets without portal authentication.
You can configure multiple authentication destination subnets.
If you do not specify the ipv4-network-address argument in the undo portal free-all except destination command, this commands deletes all IPv4 portal authentication destination subnets on the interface.
Re-DHCP authentication does not support authentication destination subnets.
If you configure both an authentication source subnet and an authentication destination subnet on an interface, only the authentication destination subnet takes effect.
Examples
# Configure an IPv4 portal authentication destination subnet of 11.11.11.0/24 on GigabitEthernet 1/1/1. Portal users need to pass authentication to access this subnet and can access other subnets without authentication.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname–GigabitEthernet1/1/1] portal free-all except destination 11.11.11.0 24
Related commands
display portal
portal free-rule
Use portal free-rule to configure an IP-based portal-free rule.
Use undo portal free-rule to delete portal-free rules.
Syntax
portal free-rule rule-number { destination ip { ip-address { mask-length | mask } | any } [ tcp tcp-port-number | udp udp-port-number ] | source ip { ip-address { mask-length | mask } | any } [ tcp tcp-port-number | udp udp-port-number ] } * [ interface interface-type interface-number ]
portal free-rule rule-number { destination ipv6 { ipv6-address prefix-length | any } [ tcp tcp-port-number | udp udp-port-number ] | source ipv6 { ipv6-address prefix-length | any } [ tcp tcp-port-number | udp udp-port-number ] } * [ interface interface-type interface-number ]
undo portal free-rule { rule-number | all }
Default
No IP-based portal-free rule is configured.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
rule-number: Specifies a portal-free rule number, in the range of 1 to 4294967295.
destination: Specifies the destination information.
source: Specifies the source information.
ip ip-address: Specifies an IPv4 address for the portal-free rule.
{ mask-length | mask }: Specifies the subnet mask of the IPv4 address. The value range for the mask-length argument is 0 to 32. The mask argument is in dotted decimal format.
ipv6 ipv6-address: Specifies an IPv6 address for the portal-free rule.
prefix-length: Specifies the prefix length of the IPv6 address, in the range of 0 to 128.
ip any: Represents any IPv4 address.
ipv6 any: Represents any IPv6 address.
tcp tcp-port-number: Specifies a TCP port number for the portal-free rule, in the range of 0 to 65535.
udp udp-port-number: Specifies a UDP port number for the portal-free rule, in the range of 0 to 65535.
all: Specifies all portal-free rules.
interface interface-type interface-number: Specifies a Layer 3 interface on which the portal-free rule takes effect.
Usage guidelines
You can specify both the source and destination keyword for a portal-free rule. If you specify only one keyword, the other keyword does not act as a filtering criterion.
If you specify both a source port number and a destination port number for a portal-free rule, the two port numbers must belong to the same transport layer protocol.
If you do not specify a Layer 3 interface, the portal-free rule takes effect on all portal-enabled interfaces.
You cannot configure two portal-free rules with the same filtering criteria.
Examples
# Configure an IPv4-based portal-free rule:
· Set the rule number to 1.
· Specify the source IP address as 10.10.10.1/24, the destination IP address as 20.20.20.1, the destination TCP port number as 23.
· Specify the interface as GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] portal free-rule 1 destination ip 20.20.20.1 32 tcp 23 source ip 10.10.10.1 24 interface gigabitethernet 1/1/1
With this rule, users in subnet 10.10.10.1/24 do not need to pass portal authentication through GigabitEthernet 1/1/1 when they access services provided on TCP port 23 of host 20.20.20.1.
# Configure an IPv6-based portal-free rule:
· Set the rule number to 2.
· Specify the source IP address as 2000::1/64, the destination IP address as 2001::1, the destination TCP port number as 23.
· Specify the interface as GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] portal free-rule 2 destination ipv6 2001::1 128 tcp 23 source ip 2000::1 64 interface gigabitethernet 1/1/1
With this rule, users in subnet 2000::1/64 do not need to pass portal authentication through GigabitEthernet 1/1/1 when they access services provided on TCP port 23 of host 2001::1.
Related commands
display portal rule
portal free-rule description
Use portal free-rule description to configure a description for a portal-free rule.
Use undo portal free-rule description to delete the description of a portal-free rule.
Syntax
portal free-rule rule-number description text
undo portal free-rule rule-number description
Default
No description is configured for a portal-free rule.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
rule-number: Specifies a portal-free rule by its rule number, in the range of 1 to 4294967295.
text: Specifies the description, a case-sensitive string of 1 to 255 characters.
Examples
# Configure a description of This is IT department for portal-free rule 2.
<Sysname> system-view
[Sysname] portal free-rule 2 description This is IT department
portal free-rule destination
Use portal free-rule destination to configure a destination-based portal-free rule.
Use undo portal free-rule to delete portal-free rules.
Syntax
portal free-rule rule-number destination host-name
undo portal free-rule { rule-number | all }
Default
No destination-based portal-free rule is configured.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
rule-number: Specifies a portal-free rule number, in the range of 1 to 4294967295.
destination: Specifies the destination host.
host-name: Specifies the destination host by its name, a case-insensitive string of 1 to 253 characters. Valid characters are letters, digits, hyphens (-), underscores (_), dots (.), and asterisks (*). The host name string cannot be ip and ipv6.
all: Specifies all portal-free rules.
Usage guidelines
You can configure a host name in one of the following ways:
· For exact match—Specify a complete host name. For example, if you configure the host name as abc.com.cn in the portal-free rule, only packets that contain the host name abc.com.cn match the rule. Packets that carry any other host names (such as dfabc.com.cn) do not match the rule.
· For fuzzy match—Specify a host name by placing the asterisk (*) wildcard character at the beginning or end of the host name string. For example, if you configure the host name as *abc.com.cn, abc*, or *abc*, packets that carry the host name ending with abc.com.cn, starting with abc, or including abc match the rule.
The asterisk (*) wildcard character represents any characters. The device treats multiple consecutive asterisks as one.
The configured host name cannot contain only asterisks (*).
You cannot configure two destination-based portal-free rules with the same destination information. Otherwise the system prompts you that the same rule already exists.
Examples
# Configure a destination-based portal-free rule: specify the rule number as 4 and host name as www.h3c.com. This rule allows the portal user who sends the HTTP/HTTPS request that carries the host name www.h3c.com to access network resources without authentication.
<Sysname> system-view
[Sysname] portal free-rule 4 destination www.h3c.com
Related commands
display portal rule
portal free-rule source
Use portal free-rule source to configure a source-based portal-free rule. The filtering criteria include source MAC address, source interface, and source VLAN.
Use undo portal free-rule to delete a specific or all portal-free rules.
Syntax
portal free-rule rule-number source { interface interface-type interface-number | mac mac-address | object-group object-group-name | vlan vlan-id } *
undo portal free-rule { rule-number | all }
Default
No source-based portal-free rules exist.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
rule-number: Specifies a portal-free rule number, in the range of 1 to 4294967295.
interface interface-type interface-number: Specifies a source interface by its type and number for the portal-free rule.
mac mac-address: Specifies a source MAC address for the portal-free rule, in the form of H-H-H.
object-group object-group-name: Specifies a source object group by its name, a case-insensitive string of 1 to 31 characters. You must specify an existing object group. Only IPv4 and IPv6 address object groups are available.
vlan vlan-id: Specifies a source VLAN ID for the portal-free rule. This option takes effect only on portal users that access the network through VLAN interfaces.
all: Specifies all portal-free rules.
Usage guidelines
If you specify both the source VLAN and the source Layer 2 interface, the interface must be in the VLAN.
Examples
# Configure a source-based portal-free rule: specify the rule number as 3, source MAC address as 1-1-1, and source VLAN ID as 10. This rule allows the portal user whose source MAC address is 1-1-1 from VLAN 10 to access network resources without authentication.
<Sysname> system-view
[Sysname] portal free-rule 3 source mac 1-1-1 vlan 10
Related commands
display portal rule
portal ipv6 free-all except destination
Use portal ipv6 free-all except destination to configure an IPv6 portal authentication destination subnet on an interface.
Use undo portal ipv6 free-all except destination to delete IPv6 portal authentication destination subnets on the interface.
Syntax
portal ipv6 free-all except destination ipv6-network-address prefix-length
undo portal ipv6 free-all except destination [ ipv6-network-address ]
Default
No IPv6 portal authentication destination subnet is configured on the interface. Portal users must pass portal authentication to access any IPv6 subnet.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6-network-address: Specifies an IPv6 portal authentication destination subnet.
prefix-length: Specifies the prefix length of the IPv6 subnet, in the range of 0 to 128.
Usage guidelines
Portal users on the interface are authenticated when accessing the specified authentication destination subnet (except IP addresses and subnets specified in portal-free rules). The users can access other subnets without portal authentication.
You can configure multiple authentication destination subnets.
If you do not specify the ipv6-network-address argument in the undo portal ipv6 free-all except destination command, this command deletes all IPv6 portal authentication destination subnets on the interface.
Re-DHCP authentication does not support authentication destination subnets.
If you configure both an authentication source subnet and an authentication destination subnet on an interface, only the authentication destination subnet takes effect.
Examples
# Configure an IPv6 portal authentication destination subnet of 1::2/16 on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname–GigabitEthernet1/1/1] portal ipv6 free-all except destination 1::2 16
Related commands
display portal
portal ipv6 layer3 source
Use portal ipv6 layer3 source to configure an IPv6 portal authentication source subnet on an interface.
Use undo portal ipv6 layer3 source to delete IPv6 portal authentication source subnets on an interface.
Syntax
portal ipv6 layer3 source ipv6-network-address prefix-length
undo portal ipv6 layer3 source [ ipv6-network-address ]
Default
No IPv6 portal authentication source subnet is configured on the interface. Portal users from any IPv6 subnet must pass portal authentication.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6-network-address: Specifies an IPv6 portal authentication source subnet address.
prefix-length: Specifies the prefix length of the IPv6 address, in the range of 0 to 128.
Usage guidelines
With IPv6 authentication source subnets configured, only packets from IPv6 users on the authentication source subnets can trigger portal authentication. If an unauthenticated IPv6 user is not on any authentication source subnet, the access device discards all the user's packets that do not match any portal-free rule.
If you do not specify the ipv6-network-address argument in the undo portal ipv6 layer3 source command, this command deletes all IPv6 portal authentication source subnets on the interface.
Only cross-subnet authentication supports authentication source subnets.
If you configure both an authentication source subnet and an authentication destination subnet on an interface, only the authentication destination subnet takes effect.
Examples
# Configure an IPv6 portal authentication source subnet of 1::1/16 on GigabitEthernet 1/1/1. Only portal users from subnet 1::1/16 trigger portal authentication.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname–GigabitEthernet1/1/1] portal ipv6 layer3 source 1::1 16
Related commands
display portal
portal ipv6 free-all except destination
portal ipv6 user-detect
Use portal ipv6 user-detect to enable online detection of IPv6 portal users.
Use undo portal user-detect to disable online detection of IPv6 portal users.
Syntax
portal ipv6 user-detect type { icmpv6 | nd } [ retry retries ] [ interval interval ] [ idle time ]
undo portal ipv6 user-detect
Default
Online detection of IPv6 portal users is disabled.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
type: Specifies the detection type.
· icmpv6—ICMPv6 detection.
· nd—ND detection.
retry retries: Sets the maximum number of detection attempts, in the range of 1 to 10. The default value is 3.
interval interval: Sets a detection interval in the range of 1 to 1200 seconds. The default interval is 3 seconds.
idle time: Sets the user idle timeout in the range of 60 to 3600 seconds. The default idle timeout is 180 seconds. When the timeout expires, online detection of portal users is started.
Usage guidelines
If the device receives no packets from a portal user within the idle time, the device detects the user's online status as follows:
· ICMPv6 detection—Sends ICMPv6 requests to the user at configurable intervals to detect the user status.
¡ If the device receives a reply within the maximum number of detection attempts, it considers that the user is online and stops sending detection packets. Then the device resets the idle timer and repeats the detection process when the timer expires.
¡ If the device receives no reply after the maximum number of detection attempts, the device logs out the user.
· ND detection—Sends ND requests to the user and detects the ND entry status of the user at configurable intervals.
¡ If the ND entry of the user is refreshed within the maximum number of detection attempts, the device considers that the user is online and stops detecting the user's ND entry. Then the device resets the idle timer and repeats the detection process when the timer expires.
¡ If the ND entry of the user is not refreshed after the maximum number of detection attempts, the device logs out the user.
Direct authentication and re-DHCP authentication support both ND detection and ICMPv6 detection. Cross-subnet authentication only supports ICMPv6 detection.
If firewall policies on the access device filter out ICMPv6 packets, ICMPv6 detection might fail and result in the logout of portal users. Make sure the access device does not block ICMPv6 packets before you enable ICMPv6 detection on an interface.
Examples
# Enable online detection of IPv6 portal users on GigabitEthernet 1/1/1. Configure the detection type as ICMPv6, the maximum number of detection attempts as 5, the detection interval as 10 seconds, and the user idle timeout as 300 seconds.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname–GigabitEthernet1/1/1] portal ipv6 user-detect type icmpv6 retry 5 interval 10 idle 300
Related commands
display portal
portal layer3 source
Use portal layer3 source to configure an IPv4 portal authentication source subnet.
Use undo portal layer3 source to delete IPv4 portal authentication source subnets.
Syntax
portal layer3 source ipv4-network-address { mask-length | mask }
undo portal layer3 source [ ipv4-network-address ]
Default
No IPv4 portal authentication source subnet is configured. Portal users from any IPv4 subnet must pass portal authentication.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv4-network-address: Specifies an IPv4 portal authentication source subnet address.
mask-length: Specifies the subnet mask length of the IPv4 address, in the range of 0 to 32.
mask: Specifies the subnet mask in dotted decimal format.
Usage guidelines
With IPv4 authentication source subnets configured, only packets from IPv4 users on the authentication source subnets can trigger portal authentication. If an unauthenticated IPv4 user is not on any authentication source subnet, the access device discards all the user's packets that do not match any portal-free rule.
If you do not specify the ipv4-network-address argument in the undo portal layer3 source command, this command deletes all IPv4 portal authentication source subnets on the interface.
Only cross-subnet authentication supports authentication source subnets.
If you configure both an authentication source subnet and an authentication destination subnet on an interface, only the authentication destination subnet takes effect.
Examples
# Configure an IPv4 portal authentication source subnet of 10.10.10.0/24 on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname–GigabitEthernet1/1/1] portal layer3 source 10.10.10.0 24
Related commands
display portal
portal free-all except destination
portal local-web-server
Use portal local-web-server to create a local portal Web server and enter its view, or enter the view of an existing local portal Web server.
Use undo portal local-web-server to delete the local portal Web server.
Syntax
portal local-web-server { http | https [ ssl-server-policy policy-name ] }
undo portal local-web-server { http | https }
Default
No local portal Web servers exist.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
http: Configures the local portal Web server to use HTTP to exchange authentication information with clients.
https: Configures the local portal Web server to use HTTPS to exchange authentication information with clients.
ssl-server-policy policy-name: Specifies an existing SSL server policy for HTTPS. The policy name is a case-insensitive string of 1 to 31 characters. If you do not specify this option, HTTPS is associated with the SSL server policy that uses the self-signed certificate. That SSL server policy supports all cipher suites.
Usage guidelines
After a local portal Web server is configured on the access device, the access device also acts as the portal Web server and the portal authentication server. No external portal Web server and portal authentication server are needed.
For an interface to use the local portal Web server, the URL of the portal Web server specified for the interface must meet the following requirements:
· The IP address in the URL must be a local IP address on the device.
· The URL must be ended with /portal/. For example: http://1.1.1.1/portal/.
You cannot delete an SSL server policy by using the undo ssl server-policy command when the policy is associated with HTTPS.
To specify a new SSL server policy for HTTPS, first execute the undo form of this command to delete the existing local portal Web server.
Examples
# Configure a local portal Web server. Use HTTP to exchange authentication information with clients.
<Sysname> system-view
[Sysname] portal local-web-server http
[Sysname-portal-local-websvr-http] quit
# Configure a local portal Web server. Use HTTPS to exchange authentication information with clients, and specify the SSL server policy policy1 for HTTPS.
<Sysname> system-view
[Sysname] portal local-web-server https ssl-server-policy policy1
[Sysname-portal-local-websvr-https] quit
# Change the SSL server policy to policy2.
[Sysname] undo portal local-web-server https
[Sysname] portal local-web-server https ssl-server-policy policy2
[Sysname-portal-local-websvr-https] quit
Related commands
default-logon-page
portal local-web-server
ssl server-policy
portal logout-record enable
Use portal logout-record enable to enable portal user offline recording.
Use undo portal logout-record enable to disable portal user offline recording.
Syntax
portal logout-record enable
undo portal logout-record enable
Default
Portal user offline recording is disabled.
Views
System view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
This feature enables the device to save all portal user offline records and to periodically send the records to the lvzhou cloud server or other servers.
Examples
# Enable portal user offline recording.
<Sysname> system-view
[Sysname] portal logout-record enable
Related commands
display portal safe-redirect statistics
display portal logout-record
portal logout-record export
Use portal logout-record export to export portal user offline records to a path.
Syntax
portal logout-record export url url-string [ start-time start-date start-time end-time end-date end-time ]
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
url url-string: Specifies the URL to which portal user offline records are exported. The URL is a case-insensitive string of 1 to 255 characters.
start-time start-date start-time end-time end-date end-time: Specifies a time range. The start date and end date must be in the format of MM/DD/YYYY or YYYY/MM/DD. The value range for MM is 1 to 12. The value range for DD varies with the specified month. The value range for YYYY is 1970 to 2100. The start time and end time must be in the format of hh:mm. The value range for the start time and end time is 00:00 to 23:59.
Usage guidelines
The device supports FTP, TFTP, and HTTP file transfer methods. Table 20 describes the valid URL format for each method.
Protocol |
URL format |
Remarks |
FTP |
ftp://username[:password]@server-address[:port-number]/file-path Example: ftp://a:[email protected]/authfail/ |
The username and password must be the same as those on the server. If the server authenticates only the username, no password is required. |
TFTP |
tftp://server-address[:port-number]/file-path Example: tftp://1.1.1.1/ autherror/ |
N/A |
HTTP |
http://username[:password]@server-address[:port-number]/file-path Example: http://1.1.1.1/autherror/ |
The username and password must be the same as those on the server. If the server authenticates only the username, no password is required. |
If the server address is an IPv6 address, bracket the IPv6 address to distinguish the IPv6 address from the port number. For example, if the server address is 2001::1 and the port number is 21, the URL is ftp://test:test@[2001::1]:21/test/.
Examples
# Export all portal user offline records to path tftp://1.1.1.1/record/logout/.
<Sysname> system-view
[Sysname] portal logout-record export url tftp://1.1.1.1/record/logout/
# Export portal user offline records in the time rang of 2016/3/4 14:20 to 2016/3/4 15:00 to path tftp://1.1.1.1/record/logout/.
<Sysname> system-view
[Sysname] portal logout-record export tftp://1.1.1.1/record/logout/ start-time 2016/3/4 14:20 end-time 2016/3/4 15:00
Related commands
display portal logout-record
portal logout-record enable
reset portal logout-record
portal logout-record max
Use portal logout-record max to set the maximum number of portal user offline records.
Use undo portal logout-record max to restore the default.
Syntax
portal logout-record max number
undo portal logout-record max
Default
The maximum number of portal user offline records is 32000.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
number: Specifies the maximum number of portal user offline records, in the range of 1 to 4294967295.
Usage guidelines
When the maximum number of portal user offline records is reached, a new record overwrites the oldest one.
Examples
# Set the maximum number of portal user offline records to 50.
<Sysname> system-view
[Sysname] portal logout-record max 50
Related commands
display portal logout-record
portal max-user
Use portal max-user to set the maximum number of total portal users allowed in the system.
Use undo portal max-user to restore the default.
Syntax
portal max-user max-number
undo portal max-user
Default
The total number of portal users allowed in the system is not limited.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
max-number: Specifies the maximum number of total portal users in the system. The value range for this argument is 1 to 4294967295.
Usage guidelines
If you configure the maximum total number smaller than the number of current online portal users on the device, this command still takes effect. The online users are not affected by this command, but the system forbids new portal users to log in.
This command sets the maximum number of online IPv4 and IPv6 portal users in all.
Make sure the maximum combined number of IPv4 and IPv6 portal users specified on all interfaces does not exceed the system-allowed maximum number. Otherwise, the exceeding portal users will not be able to log in to the device.
Examples
# Set the maximum number of online portal users allowed in the system to 100.
<Sysname> system-view
[Sysname] portal max-user 100
Related commands
display portal user
portal { ipv4-max-user | ipv6-max-user }
portal nas-id profile
Use portal nas-id-profile to specify a NAS-ID profile for an interface.
Use undo portal nas-id-profile to restore the default.
Syntax
portal nas-id-profile profile-name
undo portal nas-id-profile
Default
No NAS-ID profile is specified for an interface.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
profile-name: Specifies the name of a NAS-ID profile, a case-insensitive string of 1 to 31 characters.
Usage guidelines
A NAS-ID profile defines the binding relationship between VLANs and NAS-IDs. To configure a NAS-ID profile, use the aaa nas-id profile command.
If an interface is specified with a NAS-ID profile, the interface prefers to use the bindings defined in the profile.
If no NAS-ID profile is specified for an interface or no matching binding is found in the specified profile, the device uses the device name as the interface NAS-ID.
Examples
# Specify the NAS-ID profile aaa for GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname–GigabitEthernet1/1/1] portal nas-id-profile aaa
Related commands
aaa nas-id profile
portal nas-port-id format
Use portal nas-port-id format to specify the NAS-Port-Id attribute format.
Use undo portal nas-port-id format to restore the default.
Syntax
portal nas-port-id format { 1 | 2 | 3 | 4 }
undo portal nas-port-id format
Default
The format for the NAS-Port-Id attribute is format 2.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
1: Uses format 1 for the NAS-Port-Id attribute.
2: Uses format 2 for the NAS-Port-Id attribute.
3: Uses format 3 for the NAS-Port-Id attribute.
4: Uses format 4 for the NAS-Port-Id attribute.
Usage guidelines
The NAS-Port-Id format supported by RADIUS servers varies by vendor. Use this command to specify the format of the NAS-Port-Id attribute in the RADIUS packets sent for portal users to the RADIUS server. The device then automatically constructs a value for the NAS-Port-Id attribute in the specified format to meet the RADIUS server requirements.
Format 1 contains three space-separated strings: interface-type port-location access-node-id. Spaces are not allowed within a string.
· The interface-type string specifies the interface type of the NAS port. Available options include::
¡ eth—Common Ethernet interface.
¡ trunk—Ethernet trunk interface.
¡ 0—The interface type information will be reported by the access node to the BRAS.
· The port-location string represents the location of the access line on the BRAS. Its format is NAS_slot/NAS_subslot/NAS_port:XPI.XCI.
Field |
Description |
NAS_slot |
Slot number of the BRAS, in the range of 0 to 31. |
NAS_subslot |
Subslot number of the BRAS, in the range of 0 to 31. |
NAS_Port |
Port number of the BRAS, in the range of 0 to 63. |
XPI.XCI |
For Ethernet interfaces or Ethernet trunk interfaces: · XPI is PVLAN in the range of 0 to 4095. This field is set to 4096 if there is no PVLAN. · XCI is CVLAN in the range of 0 to 4095. This field is set to 4096 if the user is not assigned to a VLAN as in the situation where the end user device is directly connected to a BRAS port. |
For the access node to report its access line information to the BRAS, all fields will be set to 0s except for the XPI and XCI fields.
· The access-node-id string specifies the attributes the of BRAS. Its format is AccessNodeIdentifier/ANI_rack/ANI_frame/ANI_slot/ANI_subslot/ANI_port:ANI_XPI.ANI_XCI, in which the :ANI_XPI.ANI_XCI portion is optional.
AccessNodeIdentifier |
Identifier description of the access node, a string not longer than 50 characters without spaces. |
ANI_rack |
Rack number of the access node, in the range of 0 to 15. |
ANI_frame |
Frame number of the access node, in the range of 0 to 31. |
ANI_slot |
Slot number of the access node, in the range of 0 to 127. |
ANI_subslot |
Subslot number of the access node, in the range of 0 to 31. |
ANI_port |
Port number of the access node, in the range of 0 to 255. |
ANI_XPI.ANI_XCI |
Optional. This field is mainly used to carry CPE-side service information, identifying the further service type requirement. For example, use this field to identify specific services in a multi-PVC scenario. For Ethernet interfaces or Ethernet trunk interfaces: · ANI_XPI is PVLAN in the range of 0 to 4095. This field is set to 4096 if there is no PVLAN. · ANI_XCI is CVLAN in the range of 0 to 4095. This field is set to 4096 if the user is not assigned to a VLAN as in the situation where the end user device is directly connected to a BRAS port. |
If the device does not have rack, frame, or subslot information, 0 is padded in the corresponding field.
· Examples of format 1:
NAS-Port-Id |
Description |
eth 31/31/7:1234.2345 0/0/0/0/0/0 |
The subscriber interface type is an Ethernet interface. The slot number is 31, the subslot number is 31, the port number is 7, the PVLAN is 1234, and the CVLAN is 2345. |
eth 31/31/7:4096.2345 0/0/0/0/0/0 |
The subscriber interface type is an Ethernet interface. The slot number is 31, the subslot number is 31, the port number is 7, the VLAN is 2345. |
eth 31/31/7:4096.2345 guangzhou001/1/31/63/31/127 |
The subscriber interface type is Ethernet. The slot number is 31, the subslot number is 31, the port number is 7, and the VLAN ID is 2345. The access node identifier of the DSLAM is guangzhou001, the rack number is 1, the frame number is 31, the slot number is 31, and the port number is 127. |
Format 2 is SlotID/00/IfNO/VlanID.
· SlotID—Slot number, a string of 2 characters.
· IFNO—Slot number, a string of 3 characters.
· VlanID—VLAN ID, a string of 9 characters.
Format 3 is SlotID/00/IfNO/VlanID/DHCP option.
· SlotID—Slot number, a string of 2 characters.
· IFNO—Interface number, a string of 3 characters.
· VlanID—VLAN ID, a string of 9 characters.
· DHCP option—DHCP option 82 is appended for IPv4 users and DHCP option 1 is appended for IPv6.
Format 4 is slot=**;subslot=**;port=**;vlanid=**;vlanid2=**;
· For non-VLAN interfaces, the slot=**;subslot=**;port=**;vlanid=0; format is used.
· For interfaces that terminate only the outermost VLAN tag, the slot=**;subslot=**;port=**;vlanid=**; format is used.
Examples
# Set the format of the NAS-Port-Id attribute to format 1.
<Sysname> system-view
[Sysname] portal nas-port-id format 1
portal outbound-filter enable
Use portal [ ipv6 ] outbound-filter enable to enable outgoing packets filtering on a portal-enabled interface.
Use undo portal [ ipv6 ] outbound-filter enable to disable outgoing packets filtering on a portal-enabled interface.
Syntax
portal [ ipv6 ] outbound-filter enable
undo portal [ ipv6 ] outbound-filter enable
Default
Outgoing packets filtering is disabled. A portal-enabled interface can send any packets.
Views
Interface view
Predefined user roles
network-admin
Parameters
ipv6: Specifies outgoing IPv6 packets. If you do not specify this keyword, the command is for outgoing IPv4 packets.
Usage guidelines
When you enable this feature on a portal-enabled interface, the device permits the interface to send the following packets:
· Packets whose destination IP addresses are IP addresses of authenticated portal users.
· Packets that match portal-free rules.
Other outgoing packets on the interface are dropped.
Examples
# Enable outgoing packets filtering on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal outbound-filter enable
portal packet log enable
Use portal packet log enable to enable logging for portal protocol packets.
Use undo portal packet log enable to disable logging for portal protocol packets.
Syntax
portal packet log enable
undo portal packet log enable
Default
Portal protocol packet logging is disabled.
Views
System view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
This feature logs information about portal protocol packets, including the username, IP address, authentication type and packet type. For portal log messages to be sent correctly, you must also configure the information center on the device. For more information about information center configuration, see Network Management and Monitoring Configuration Guide.
Examples
# Enable logging for portal protocol packets.
<Sysname> system-view
[Sysname] portal packet log enable
Related commands
portal redirect log enable
portal user log enable
portal pre-auth domain
Use portal [ ipv6 ] pre-auth domain to specify a preauthentication domain for portal users.
Use undo portal [ ipv6 ] pre-auth domain to restore the default.
Syntax
portal [ ipv6 ] pre-auth domain domain-name
undo portal [ ipv6 ] pre-auth domain
Default
No preauthentication domain is specified for portal users.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6: Specifies IPv6 portal users. Do not specify this keyword for IPv4 portal users.
domain-name: Specifies an existing ISP domain by its name, a case-insensitive string of 1 to 255 characters. The string cannot contain the following characters: slashes (/), backslashes (\), vertical bars (|), quotation marks ("), colons (:), asterisks (*), question marks (?), left angle brackets (<), right angle brackets (>), and at signs (@).
Usage guidelines
After you configure a preauthentication domain on a portal-enabled interface, the device authorizes users on the interface as follows:
1. After an unauthenticated user obtains an IP address, the user is assigned with authorization attributes configured for the preauthentication domain.
The authorization attributes in a preauthentication domain include ACL, user profile, and CAR.
An unauthenticated user who is authorized with the authorization attributes in a preauthentication domain is called a preauthentication user.
2. After the user passes portal authentication, the user is assigned with new authorization attributes from the AAA server.
3. After the user goes offline, the user is reassigned with the authorization attributes in the preauthentication domain.
The preauthentication domain takes effect only on portal users with IP addresses assigned by DHCP or DHCPv6.
Make sure you specify an existing ISP domain as a preauthentication domain. If the specified ISP domain does not exist, the device might operate incorrectly.
You must delete a preauthentication domain (by using the undo portal [ ipv6 ] pre-auth domain command) and reconfigure it in the following situations:
· You create the ISP domain after specifying it as the preauthentication domain.
· You delete the specified ISP domain and then re-create it.
If you change the preauthentication domain on an interface, the interface uses the new preauthentication domain for both new and existing preauthentication users.
If authorization attributes in the preauthentication domain are modified, the modified attributes take effect only on new preauthentication users. Existing preauthentication users use the original authorization attributes.
If the ACL in the preauthentication domain does not exist or the ACL has no rules, the device does not control user access. Users can access any network resources without passing portal authentication.
Follow these guidelines when you configure a preauthentication ACL rule:
· Do not specify a source address. If you specify a source address, users cannot trigger portal authentication.
· Do not set the destination address to any. If you set the destination address to any, all packets will be permitted to pass and therefore users can access any resources before portal authentication.
Examples
# Create the preauthentication domain abc for GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal pre-auth domain abc
Related commands
display portal
portal pre-auth ip-pool
Use portal pre-auth ip-pool to specify a preauthentication IP address pool for portal users.
Use undo portal pre-auth ip-pool to restore the default.
Syntax
portal [ ipv6 ] pre-auth ip-pool pool-name
undo portal [ ipv6 ] pre-auth ip-pool
Default
No preauthentication IP address pool is specified for portal users.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6: Specifies IPv6 portal users. Do not specify this keyword for IPv4 portal users.
pool-name: Specifies an IP address pool by its name, a case-insensitive string of 1 to 63 characters.
Usage guidelines
You must use this command to specify a preauthentication IP address pool on a portal-enabled interface in the following situation:
· Portal users access the network through a subinterface of the portal-enabled interface.
· The subinterface does not have an IP address.
· Portal users need to obtain IP addresses through DHCP.
DHCP assigns an IP address from the specified IP address pool to a user. Then, the user can use this IP address to perform portal authentication.
The specified IP address pool takes effect when the following requirements are met:
· The direct portal authentication mode is used on the interface.
· The specified IP address pool must have existed and been correctly configured.
Examples
# Create the IPv4 address pool abc for GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal pre-auth ip-pool abc
Related commands
dhcp server ip-pool (Layer 3—IP Services Command Reference)
display portal
ipv6 dhcp pool (Layer 3—IP Services Command Reference)
portal redirect log enable
Use portal redirect log enable to enable logging for portal redirect.
Use undo portal redirect log enable to disable logging for portal redirect.
Syntax
portal redirect log enable
undo portal redirect log enable
Default
Portal redirect logging is disabled.
Views
System view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
This feature logs information about portal redirect packets, including the user IP address, MAC address, BAS IP, and Web server IP address. For portal log messages to be sent correctly, you must also configure the information center on the device. For more information about information center configuration, see Network Management and Monitoring Configuration Guide.
Examples
# Enable logging for portal redirect.
<Sysname> system-view
[Sysname] portal redirect log enable
Related commands
portal packet log enable
portal user log enable
portal refresh enable
Use portal refresh { arp | nd } enable to enable ARP or ND entry conversion for portal clients.
Use undo portal refresh { arp | nd } enable to disable ARP or ND entry conversion for portal clients.
Syntax
portal refresh { arp | nd } enable
undo portal refresh { arp | nd } enable
Default
ARP or ND entry conversion is enabled for portal clients.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
arp: Specifies the ARP entries.
nd: Specifies the ND entries.
Usage guidelines
After you enable this feature:
· ARP or ND entries for portal users who pass authentication after this feature is enabled are converted to Rule ARP or ND entries. Rule ARP or ND entries will not be aged.
· ARP or ND entries for portal users who pass authentication before this feature is enabled will be aged when their respective aging timers expire.
After you disable this feature:
· ARP or ND entries for portal users who pass authentication after this feature is disabled will be aged when their respective aging timers expire.
· Rule ARP or ND entries created for portal users before this feature is disabled are still Rule ARP or ND entries.
Examples
# Disable ARP entry conversion for portal clients.
<Sysname> system-view
[Sysname] undo portal refresh arp enable
portal roaming enable
Use portal roaming enable to enable portal roaming.
Use undo portal roaming enable to disable portal roaming.
Syntax
portal roaming enable
undo portal roaming enable
Default
Portal roaming is disabled.
Views
System view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
Portal roaming applies only to portal users that log in from VLAN interfaces.
This command cannot be executed when online users or preauthentication portal users are present on the device.
If portal roaming is enabled, an online portal user can access network resources from any Layer 2 port in its local VLAN. If portal roaming is disabled, the portal user can access network resources only from the Layer 2 port on which it passes authentication.
Examples
# Enable portal roaming.
<Sysname> system-view
[Sysname] portal roaming enable
portal safe-redirect enable
Use portal safe-redirect enable to enable the portal safe-redirect feature.
Use undo portal safe-redirect enable to restore the default.
Syntax
portal safe-redirect enable
undo portal safe-redirect enable
Default
The portal safe-redirect feature is disabled.
Views
System view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
Portal redirects all HTTP requests except HTTP requests that match portal-free rules to the portal Web server, which might overload the server.
Portal safe-redirect filters HTTP requests by HTTP request method, browser type (in HTTP User Agent), and destination URL, and redirects only the permitted HTTP requests.
As a best practice to avoid server overload and improve security, enable portal safe-redirect on the device.
Examples
# Enable the portal safe-redirect feature.
<Sysname> system-view
[Sysname] portal safe-redirect enable
Related commands
portal safe-redirect forbidden-url
portal safe-redirect method
portal safe-redirect user-agent
portal safe-redirect forbidden-file
Use portal safe-redirect forbidden-file to configure a filename extension forbidden by portal safe-redirect. If the URL of an HTTP request includes the specified filename extension, the device does not redirect the HTTP request.
Use undo portal safe-redirect forbidden-file to delete a portal safe-redirect forbidden filename extension.
Syntax
portal safe-redirect forbidden-file filename-extension
undo portal safe-redirect forbidden-file filename-extension
Default
No forbidden filename extensions are configured. The device redirects HTTP requests regardless of the filename extension in the URL.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
filename-extension: Specifies a filename extension forbidden by portal safe-redirect, a case sensitive string of 1 to 16 characters.
Usage guidelines
You can configure multiple portal safe-redirect forbidden filename extensions.
Before you execute this command, make sure the portal safe-redirect feature is enabled.
Examples
# Specify .jpg as a portal safe-redirect forbidden filename extension.
<Sysname> system-view
[Sysname] portal safe-redirect forbidden-file .jpg
Related commands
portal safe-redirect enable
portal safe-redirect forbidden-url
Use portal safe-redirect forbidden-url to configure a URL forbidden by portal safe-redirect.
Use undo portal safe-redirect forbidden-url to delete a portal safe-redirect forbidden URL.
Syntax
portal safe-redirect forbidden-url user-url-string
undo portal safe-redirect forbidden-url user-url-string
Default
No forbidden URLs are configured. The device can redirect HTTP requests with any URLs.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
user-url-string: Specifies a URL forbidden by portal safe-redirect, a case sensitive string of 1 to 256 characters.
Usage guidelines
You can execute this command multiple times to configure multiple portal safe-redirect forbidden URLs. The device does not redirect HTTP requests destined for the specified URLs to the portal Web server.
Before you execute this command, make sure the portal safe-redirect feature is enabled.
Examples
# Specify http://www.abc.com as a portal safe-redirect forbidden URL.
<Sysname> system-view
[Sysname] portal safe-redirect forbidden-url http://www.abc.com
Related commands
portal safe-redirect enable
portal safe-redirect method
Use portal safe-redirect method to specify HTTP request methods permitted by portal safe-redirect.
Use undo portal safe-redirect method to delete HTTP request methods permitted by portal safe-redirect.
Syntax
portal safe-redirect method { get | post }*
undo portal safe-redirect method { get | post }*
Default
After portal safe-redirect is enabled, the device redirects only HTTP requests with the GET method.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
get: Specifies the GET request method.
post: Specifies the POST request method.
Usage guidelines
After you specify HTTP request methods for portal safe-redirect, the device redirects only the HTTP requests with the specified methods to the portal Web server.
Before you execute this command, make sure the portal safe-redirect feature is enabled.
If you configure this command multiple times, the most recent configuration takes effect.
Examples
# Specify the GET request method for portal safe-redirect.
<Sysname> system-view
[Sysname] portal safe-redirect method get
Related commands
portal safe-redirect enable
portal safe-redirect user-agent
Use portal safe-redirect user-agent to specify a browser type for portal safe-redirect.
Use undo portal safe-redirect user-agent to delete a browser type for portal safe-redirect.
Syntax
portal safe-redirect user-agent user-agent-string
undo portal safe-redirect user-agent user-agent-string
Default
After portal safe-redirect is enabled, the device redirects the HTTP packets matching any browser types in Table 21.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
user-agent-string: Specifies a browser type in HTTP User Agent, a case-sensitive string of 1 to 255 characters. You can specify the browser types as shown in Table 21.
Table 21 Browser type and description
Browser type |
Description |
Safari |
Apple browser |
Chrome |
Google browser |
Firefox |
Firefox browser |
UC |
UC browser |
QQBrowser |
QQ browser |
LBBROWSER |
Cheetah browser |
TaoBrowser |
Taobao browser |
Maxthon |
Maxthon browser |
BIDUBrowser |
Baidu browser |
MSIE 10.0 |
Microsoft IE 10.0 browser |
MSIE 9.0 |
Microsoft IE 9.0 browser |
MSIE 8.0 |
Microsoft IE 8.0 browser |
MSIE 7.0 |
Microsoft IE 7.0 browser |
MSIE 6.0 |
Microsoft IE 6.0 browser |
MetaSr |
Sogou browser |
Usage guidelines
You can execute this command for multiple times to specify multiple browser types. The device redirects an HTTP request only when its User-Agent string contains a specified browser type.
Before you execute this command, make sure the portal safe-redirect feature is enabled.
Examples
# Specify browser types Chrome and Safari for portal safe-redirect.
<Sysname> system-view
[Sysname] portal safe-redirect user-agent Chrome
[Sysname] portal safe-redirect user-agent Safari
Related commands
portal safe-redirect enable
portal server
Use portal server to create a portal authentication server and enter its view, or enter the view of an existing portal authentication server.
Use undo portal server to delete the specified portal authentication server.
Syntax
portal server server-name
undo portal server server-name
Default
No portal authentication servers exist.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
server-name: Specifies a portal authentication server by its name, a case-sensitive string of 1 to 32 characters.
Usage guidelines
In portal authentication server view, you can configure the following parameters and features for the portal authentication server:
· IP address of the server.
· Destination UDP port number used by the device to send unsolicited portal packets to the portal authentication server.
· MPLS L3VPN where the portal authentication server resides.
· Pre-shared key for communication between the access device and the server.
· Server detection feature.
You can configure multiple portal authentication servers for an access device.
Examples
# Create the portal authentication server pts and enter its view.
<Sysname> system-view
[Sysname] portal server pts
[Sysname-portal-server-pts]
Related commands
display portal server
portal temp-pass enable
Use portal temp-pass enable to enable portal temporary pass and set the temporary pass period.
Use undo portal temp-pass enable to disable portal temporary pass.
Syntax
portal temp-pass [ period period-value ] enable
undo portal temp-pass enable
Default
Portal temporary pass is disabled.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
period period-value: Specifies the temporary pass period. The value range for the period-value argument is 10 to 3600 seconds, and the default is 30 seconds.
Usage guidelines
Typically, a portal user cannot access the network before passing portal authentication. This feature allows a user to access the Internet temporarily if the user uses a WeChat account to perform portal authentication. During the temporary pass period, the user provides WeChat authentication information to the WeChat server for the server to interact with the access device to finish portal authentication.
Examples
# On GigabitEthernet1/1/1, enable portal temporary pass and set the temporary pass period to 25 seconds.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal temp-pass period 25 enable
Related commands
display portal
portal traffic-accounting disable
Use portal traffic-accounting disable to disable traffic accounting for portal users.
Use undo portal traffic-accounting disable to restore the default.
Syntax
portal traffic-accounting disable
undo portal traffic-accounting disable
Default
Traffic accounting for portal users is enabled.
Views
System view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
The accounting server might perform time-based or traffic-based accounting, or it might not perform accounting. If the accounting server does not perform traffic-based accounting, disable traffic accounting for portal users on the device. The device will provide quick accounting for portal users, and the traffic statistics will be imprecise. If the accounting server performs traffic-based accounting, enable traffic accounting for portal users. The device will provide precise traffic statistics for portal users.
Examples
# Disable traffic accounting for portal users.
<Sysname> system-view
[Sysname] portal traffic-accounting disable
portal user-detect
Use portal user-detect to enable online detection of IPv4 portal users.
Use undo portal user-detect to disable online detection of IPv4 portal users.
Syntax
portal user-detect type { arp | icmp } [ retry retries ] [ interval interval ] [ idle time ]
undo portal user-detect
Default
Online detection of IPv4 portal users is disabled.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
type: Specifies the detection type.
· arp—ARP detection.
· icmp—ICMP detection.
retry retries: Sets the maximum number of detection attempts, in the range of 1 to 10. The default value is 3.
interval interval: Sets a detection interval in the range of 1 to 1200 seconds. The default interval is 3 seconds.
idle time: Sets a user idle timeout in the range of 60 to 3600 seconds. The default idle timeout is 180 seconds. When the timeout expires, online detection of IPv4 portal users is started.
Usage guidelines
If the device receives no packets from a portal user within the configured idle time, the device detects the user's online status as follows:
· ICMP detection—Sends ICMP requests to the user at configurable intervals to detect the user status.
¡ If the device receives a reply within the maximum number of detection attempts, it considers that the user is online and stops sending detection packets. Then the device resets the idle timer and repeats the detection process when the timer expires.
¡ If the device receives no reply after the maximum number of detection attempts, the device logs out the user.
· ARP detection—Sends ARP requests to the user and detects the ARP entry status of the user at configurable intervals.
¡ If the ARP entry of the user is refreshed within the maximum number of detection attempts, the device considers that the user is online and stops detecting the user's ARP entry. Then the device resets the idle timer and repeats the detection process when the timer expires.
¡ If the ARP entry of the user is not refreshed after the maximum number of detection attempts, the device logs out the user.
Direct authentication and re-DHCP authentication support both ARP detection and ICMP detection. Cross-subnet authentication only supports ICMP detection.
If firewall policies on the access device filter out ICMP packets, ICMP detection might fail and result in the logout of portal users. Make sure the access device does not block ICMP packets before you enable ICMP detection on an interface.
Examples
# Enable online detection of IPv4 portal users on GigabitEthernet 1/1/1. Configure the detection type as ICMP, the maximum number of detection attempts as 5, the detection interval as 10 seconds, and the user idle timeout as 300 seconds.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname–GigabitEthernet1/1/1] portal user-detect type icmp retry 5 interval 10 idle 300
Related commands
display portal
portal user-dhcp-only
Use portal user-dhcp-only to enable portal authentication only for users with IP addresses obtained through DHCP.
Use undo portal user-dhcp-only to disable portal authentication only for users with IP addresses obtained through DHCP.
Syntax
portal [ ipv6 ] user-dhcp-only
undo portal [ ipv6 ] user-dhcp-only
Default
Both users with IP addresses obtained through DHCP and users with static IP addresses can pass portal authentication to get online.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6: Specifies IPv6 portal users. Do not specify this keyword for IPv4 portal users.
Usage guidelines
With this feature enabled, users with static IP addresses cannot pass portal authentication to get online.
Examples
# Enable portal authentication only for users with IP addresses obtained through DHCP on GigabitEthernet 1/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] portal user-dhcp-only
Related commands
display portal
portal user log enable
Use portal user log enable to enable logging for portal user logins and logouts.
Use undo portal user log enable to disable logging for portal user logins and logouts.
Syntax
portal user log enable
undo portal user log enable
Default
Portal user login and logout logging is disabled.
Views
System view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
This feature logs information about portal user login and logout events, including the username, IP address, user's MAC address, interface name, VLAN, and reason for login failure. For portal log messages to be sent correctly, you must also configure the information center on the device. For more information about information center configuration, see Network Management and Monitoring Configuration Guide.
Examples
# Enable logging for portal user logins and logouts.
<Sysname> system-view
[Sysname] portal user log enable
Related commands
portal packet log enable
portal redirect log enable
portal web-server
Use portal web-server to create a portal Web server and enter its view, or enter the view of an existing portal Web server.
Use undo portal web-server to delete a portal Web server.
Syntax
portal web-server server-name
undo portal web-server server-name
Default
No portal Web servers exist.
Views
System view
Predefined user roles
network-admin
mdc-admin
Parameters
server-name: Specifies a portal Web server by its name, a case-sensitive string of 1 to 32 characters.
Usage guidelines
The portal Web server pushes portal authentication pages to portal users during authentication. The access device redirects HTTP requests of unauthenticated portal users to the portal Web server. In portal Web server view, you can configure the URL and URL parameters for the portal Web server and the portal Web server detection feature.
Examples
# Create the portal Web server wbs and enter its view.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs]
Related commands
display portal web-server
portal apply web-server
redirect-url
Use redirect-url to specify the redirection URL for QQ authentication success.
Use undo redirect-url to restore the default.
Syntax
redirect-url url-string
undo redirect-url
Default
The redirection URL for QQ authentication success is http://lvzhou.h3c.com/portal/qqlogin.html.
Views
QQ authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
url-string: Specifies the redirection URL for QQ authentication success, a case-sensitive string of 1 to 256 characters.
Usage guidelines
After a portal user passes QQ authentication, the user is redirected to the specified webpage to complete portal authentication.
You must enable DNS proxy and specify the IP address of an interface on the device as the DNS server.
Examples
# Specify http://www.abc.com/portal/qqlogin.html as the redirection URL for QQ authentication success.
<Sysname> system-view
[Sysname] portal extend-auth-server qq
[Sysname-portal-extend-auth-server-qq] redirect-url http://www.abc.com/portal/qqlogin.html
Related commands
display portal extend-auth-server
reset portal auth-error-record
Use reset portal auth-error-record to clear portal authentication error records.
Syntax
reset portal auth-error-record { all | ipv4 ipv4-address | ipv6 ipv6-address | start-time start-date start-time end-time end-date end-time }
Views
User view
Predefined user roles
network-admin
mdc-admin
Parameters
all: Specifies all portal authentication error records.
ipv4 ipv4-address: Specifies the IPv4 address of a portal user.
ipv6 ipv6-address: Specifies the IPv6 address of a portal user.
start-time start-date start-time end-time end-date end-time: Specifies a time range. The start date and end date must be in the format of MM/DD/YYYY or YYYY/MM/DD. The value range for MM is 1 to 12. The value range for DD varies with the specified month. The value range for YYYY is 1970 to 2100. The start time and end time must be in the format of hh:mm. The value range for the start time and end time is 00:00 to 23:59.
Examples
# Clear all portal authentication error records.
<Sysname> reset portal auth-error-record all
# Clear portal authentication error records of the portal user whose IPv4 address is 11.1.0.1.
<Sysname> reset portal auth-error-record ipv4 11.1.0.1
# Clear portal authentication error records of the portal user whose IPv6 address is 2000::2.
<Sysname> reset portal auth-error-record ipv6 2000::2
# Clear portal authentication error records with the error time in the range of 2016/3/4 14:20 to 2016/3/4 16:23.
<Sysname> reset portal auth-error-record start-time 2016/3/4 14:20 end-time 2016/3/4 16:23
Related commands
display portal auth-error-record
reset portal auth-fail-record
Use reset portal auth-fail-record to clear portal authentication failure records.
Syntax
reset portal auth-fail-record { all | ipv4 ipv4-address | ipv6 ipv6-address | start-time start-date start-time end-time end-date end-time | username username }
Views
User view
Predefined user roles
network-admin
mdc-admin
Parameters
all: Specifies all portal authentication failure records.
ipv4 ipv4-address: Specifies the IPv4 address of a portal user.
ipv6 ipv6-address: Specifies the IPv6 address of a portal user.
start-time start-date start-time end-time end-date end-time: Specifies a time range. The start date and end date must be in the format of MM/DD/YYYY or YYYY/MM/DD. The value range for MM is 1 to 12. The value range for DD varies with the specified month. The value range for YYYY is 1970 to 2100. The start time and end time must be in the format of hh:mm. The value range for the start time and end time is 00:00 to 23:59.
username username: Specifies the username of a portal user, a case-sensitive string of 1 to 253 characters. The username cannot contain the domain name.
Examples
# Clear all portal authentication failure records.
<Sysname> reset portal auth-fail-record all
# Clear portal authentication failure records of the portal user whose IPv4 address is 11.1.0.1.
<Sysname> reset portal auth-fail-record ipv4 11.1.0.1
# Clear portal authentication failure records of the portal user whose IPv6 address is 2000::2.
<Sysname> reset portal auth-fail-record ipv6 2000::2
# Clear portal authentication failure records of the portal user whose username is abc.
<Sysname> reset portal auth-fail-record username abc
# Clear portal authentication failure records with the failure time in the range of 2016/3/4 14:20 to 2016/3/4 16:23.
<Sysname> reset portal auth-fail-record start-time 2016/3/4 14:20 end-time 2016/3/4 16:23
Related commands
display portal auth-fail-record
reset portal captive-bypass statistics
Use reset portal captive-bypass statistics to clear portal captive-bypass packet statistics.
Syntax
In standalone mode:
reset portal captive-bypass statistics [ slot slot-number ]
In IRF mode:
reset portal captive-bypass statistics [ chassis chassis-number slot slot-number ]
Views
User view
Predefined user roles
network-admin
mdc-admin
Parameters
slot slot-number: Specifies the slot number of the device, which is fixed at 0. Alternatively, you can execute the command without specifying this option. The command execution results are the same. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies an IRF member device. The chassis-number argument represents the member ID of the IRF member device. The slot-number argument represents the slot number of the device, which is fixed at 0. If you do not specify an IRF member device, this command clears portal captive-bypass packet statistics for all member devices. (In IRF mode.)
Examples
# (In standalone mode.) Clear portal captive-bypass packet statistics on the specified slot.
<Sysname> reset portal captive-bypass statistics slot 0
Related commands
display portal captive-bypass statistics
reset portal logout-record
Use reset portal logout-record to clear portal user offline records.
Syntax
reset portal logout-record { all | ipv4 ipv4-address | ipv6 ipv6-address | start-time start-date start-time end-time end-date end-time | username username }
Views
User view
Predefined user roles
network-admin
mdc-admin
Parameters
all: Specifies all portal user offline records.
ipv4 ipv4-address: Specifies the IPv4 address of a portal user.
ipv6 ipv6-address: Specifies the IPv6 address of a portal user.
start-time start-date start-time end-time end-date end-time: Specifies a time range. The start date and end date must be in the format of MM/DD/YYYY or YYYY/MM/DD. The value range for MM is 1 to 12. The value range for DD varies with the specified month. The value range for YYYY is 1970 to 2100. The start time and end time must be in the format of hh:mm. The value range for the start time and end time is 00:00 to 23:59.
username username: Specifies the username of a portal user, a case-sensitive string of 1 to 253 characters. The username cannot contain the domain name.
Examples
# Clear all portal user offline records.
<Sysname> reset portal logout-record all
# Clear offline records of the portal user whose IPv4 address is 11.1.0.1.
<Sysname> reset portal logout-record ipv4 11.1.0.1
# Clear offline records of the portal user whose IPv6 address is 2000::2.
<Sysname> reset portal logout-record ipv6 2000::2
# Clear offline records of the portal user whose username is abc.
<Sysname> reset portal logout-record username abc
# Clear portal user offline records with the logout time in the range of 2016/3/4 14:20 to 2016/3/4 16:23.
<Sysname> reset portal logout-record start-time 2016/3/4 14:20 end-time 2016/3/4 16:23
Related commands
display portal logout-record
reset portal packet statistics
Use reset portal packet statistics to clear packet statistics for portal authentication servers.
Syntax
reset portal packet statistics [ extend-auth-server { cloud | mail | qq | wechat } | server server-name ]
Views
User view
Predefined user roles
network-admin
mdc-admin
Parameters
extend-auth-server: Specifies a third-party authentication server by its type.
cloud: Specifies the lvzhou cloud authentication server.
mail: Specifies the email authentication server.
qq: Specifies the QQ authentication server.
wechat: Specifies the WeChat authentication server.
server server-name: Specifies a normal portal authentication server by its name, a case-sensitive string of 1 to 32 characters and third-party authentication servers.
Usage guidelines
If you do not specify any parameters, this command clears packet statistics for all portal authentication servers.
Examples
# Clear packet statistics for portal authentication server pts.
<Sysname> reset portal packet statistics server pts
# Clear packet statistics for the lvzhou cloud authentication server.
<Sysname> reset portal packet statistics extend-auth-server cloud
Related commands
display portal packet statistics
reset portal redirect statistics
Use reset portal redirect statistics to reset portal redirect packet statistics.
Syntax
In standalone mode:
reset portal redirect statistics [ slot slot-number ]
In IRF mode:
reset portal redirect statistics [ chassis chassis-number slot slot-number ]
Views
User view
Predefined user roles
network-admin
mdc-admin
Parameters
slot slot-number: Specifies the slot number of the device, which is fixed at 0. Alternatively, you can execute the command without specifying this option. The command execution results are the same. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies an IRF member device. The chassis-number argument represents the member ID of the IRF member device. The slot-number argument represents the slot number of the device, which is fixed at 0. If you do not specify an IRF member device, this command clears portal redirect packet statistics for all member devices. (In IRF mode.)
Examples
# (In standalone mode.) Clear redirect packet statistics on the specified slot.
<Sysname> reset portal redirect statistics slot 0
Related commands
display portal safe-redirect statistics
reset portal safe-redirect statistics
Use reset portal safe-redirect statistics to clear portal safe-redirect packet statistics.
Syntax
In standalone mode:
reset portal safe-redirect statistics [ slot slot-number ]
In IRF mode:
reset portal safe-redirect statistics [ chassis chassis-number slot slot-number ]
Views
User view
Predefined user roles
network-admin
mdc-admin
Parameters
slot slot-number: Specifies the slot number of the device, which is fixed at 0. Alternatively, you can execute the command without specifying this option. The command execution results are the same. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies an IRF member device. The chassis-number argument represents the member ID of the IRF member device. The slot-number argument represents the slot number of the device, which is fixed at 0. If you do not specify an IRF member device, this command clears portal safe-redirect packet statistics for all member devices. (In IRF mode.)
Examples
# (In standalone mode.) Clear portal safe-redirect packet statistics on the specified slot.
<Sysname> reset portal safe-redirect statistics slot 0
Related commands
display portal safe-redirect statistics
server-detect (portal authentication server view)
Use server-detect to enable portal authentication server detection. After server detection is enabled for a portal authentication server, the device periodically detects portal packets from the server to identify its reachability status.
Use undo server-detect to disable portal authentication server detection.
Syntax
server-detect [ timeout timeout ] { log | trap } *
undo server-detect
Default
Portal authentication server detection is disabled.
Views
Portal authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
timeout timeout: Specifies the detection timeout in the range of 10 to 3600 seconds. The default is 60 seconds.
{ log | trap } *: Specifies the action to be taken after the device detects reachability status change of the portal authentication server. You can select one of the following options or both:
· log—When reachability status of the portal authentication server changes, the device sends a log message. The log message contains the name, the original state, and the current state of the portal authentication server.
· trap—When reachability status of the portal authentication server changes, the device sends a trap message to the NMS. The trap message contains the name and the current state of the portal authentication server.
Usage guidelines
The portal authentication server detection feature takes effect only when the device has a portal-enabled interface.
To test server reachability by detecting heartbeat packets, you must enable the server heartbeat feature on the portal authentication server. Only the IMC portal authentication server supports sending heartbeat packets.
The detection timeout configured on the device must be greater than the server heartbeat interval configured on the portal authentication server.
If the device receives portal packets from the portal authentication server before the detection timeout expires and verifies the correctness of the packets, the device considers the portal authentication server is reachable. Otherwise, the device considers the portal authentication server is unreachable.
Examples
# Enable server detection for the portal authentication server pts:
· Set the detection timeout to 600 seconds.
· Configure the device to send a log message and a trap message if the server reachability status changes.
<Sysname> system-view
[Sysname] portal server pts
[Sysname-portal-server-pts] server-detect timeout 600 log trap
Related commands
portal server
server-detect (portal Web server view)
Use server-detect to enable portal Web server detection.
Use undo server-detect to disable portal Web server detection.
Syntax
server-detect [ interval interval ] [ retry retries ] { log | trap } *
undo server-detect
Default
Portal Web server detection is disabled.
Views
Portal Web server view
Predefined user roles
network-admin
mdc-admin
Parameters
interval interval: Specifies a detection interval in the range of 1 to 1200 seconds. The default is 5 seconds.
retry retries: Specifies the maximum number of consecutive detection failures, in the range of 1 to 10. The default is 3. If the number of consecutive failed detections reaches this threshold, the device considers the server as unreachable.
{ log | trap } *: Specifies the action to be taken after the device detects reachability status change of the portal Web server. You can select one of the following options or both:
· log—When reachability status of the portal Web server changes, the device sends a log message. The log message contains the name, the original state, and the current state of the portal Web server.
· trap—When reachability status of the portal Web server changes, the device sends a trap message to the NMS. The trap message contains the name and the current state of the portal Web server.
Usage guidelines
The access device performs server detection independently. No configuration on the portal Web server is required for the detection.
The portal Web server detection feature takes effect only when the URL of the portal Web server is specified and the device has a portal-enabled interface.
Examples
# Enable server detection for the portal Web server wbs:
· Set the detection interval to 600 seconds.
· Set the maximum number of consecutive detection failures to 2.
· Configure the device to send a log message and a trap massage after server reachability status changes.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] server-detect interval 600 retry 2 log trap
Related commands
portal web-server
server-register
Use server-register to configure the device to periodically send register packets to the portal authentication server.
Use undo server-register to restore the default.
Syntax
server-register [ interval interval-value ]
undo server-register
Default
The device does not send register packets to a portal authentication server.
Views
Portal authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
interval interval-value: Specifies the interval at which the device sends register packets to the portal authentication server, in seconds. The value range for the interval argument is 1 to 3600, and the default value is 600.
Usage guidelines
This feature is typically used in scenarios where a NAT device exists between a portal authentication server and a large number of access devices.
Before this feature is used, you must configure a static NAT mapping for each access device on the NAT device, causing much workload. After this feature is enabled on an access device, the access device automatically sends a register packet to the portal authentication server. When the server receives the register packet, it records register information for the access device, including the device name, and the IP address and port number after NAT. The register information is used for subsequent authentication information exchanges between the server and the access device. The access device updates its register information on the server by sending register packets at regular intervals.
Only CMCC portal authentication servers support this feature.
Examples
# Configure the device to send register packets to portal authentication server pts at the interval of 120 seconds.
<Sysname> system-view
[Sysname] portal server pts
[Sysname-portal-server-pts] server-register interval 120
Related commands
server-type (portal authentication server view/portal Web server view)
server-type (portal authentication server view/portal Web server view)
Use server-type to specify the type of a portal authentication server or portal Web server.
Use undo server-type to restore the default.
Syntax
server-type { cmcc | imc | oauth }
undo server-type
Default
The type of the portal authentication server and portal Web server is IMC.
Views
Portal authentication server view
Portal Web server view
Predefined user roles
network-admin
mdc-admin
Parameters
cmcc: Specifies the portal server type as CMCC.
imc: Specifies the portal server type as IMC.
oauth: Specifies the portal server type as Lvzhou. This keyword is supported only in portal Web server view.
Usage guidelines
Specify the portal server type on the device with the server type the device actually uses.
Examples
# Specify the type of the portal authentication server as cmcc.
<Sysname> system-view
[Sysname] portal server pts
[Sysname-portal-server-pts] server-type cmcc
# Specify the type of the portal Web server as cmcc.
<Sysname> system-view
[Sysname] web-server pts
[Sysname-portal-websvr-pts] server-type cmcc
Related commands
display portal server
tcp-port
Use tcp-port to configure a listening TCP port for the local portal Web server.
Use undo tcp-port to restore the default.
Syntax
tcp-port port-number
undo tcp-port
Default
The listening TCP port number for HTTP is 80 and that for HTTPS is 443.
Views
Local portal Web server view
Predefined user roles
network-admin
mdc-admin
Parameters
port-number: Specifies the listening TCP port number in the range of 1 to 65535.
Usage guidelines
To use the local portal Web server, make sure the port number in the portal Web server URL and the port number configured in this command are the same.
For successful local portal authentication, follow these guidelines:
· Do not configure the listening TCP port number for a local portal Web server as the port number used by a known protocol. For example, do not specify port numbers 21 and 23, which are used by FTP and Telnet, respectively.
· Do not configure the HTTP listening port number as the default HTTPS listening port number 443.
· Do not configure the HTTPS listening port number as the default HTTP listening port number 80.
· Do not configure the same listening port number for HTTP and HTTPS.
Examples
# Set the HTTP service listening port number to 2331 for the local portal Web server.
<Sysname> system-view
[Sysname] portal local-web-server http
[Sysname-portal-local-websvr-http] tcp-port 2331
Related commands
portal local-web-server
url
Use url to specify a URL for a portal Web server.
Use undo url to restore the default.
Syntax
url url-string
undo url
Default
No URL is specified for a portal Web server.
Views
Portal Web server view
Predefined user roles
network-admin
mdc-admin
Parameters
url-string: Specifies a URL for the portal Web server, a case-sensitive string of 1 to 256 characters.
Usage guidelines
This command specifies a URL that can be accessed through standard HTTP or HTTPS. The URL should start with http:// or https://. If the URL you specify does not start with http:// or https://, the system considers the URL begins with http:// by default.
Examples
# Configure the URL for the portal Web server wbs as http://www.test.com/portal.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] url http://www.test.com/portal
Related commands
display portal web-server
url-parameter
Use url-parameter to configure the parameters carried in the URL of a portal Web server. The access device redirects a portal user by sending the URL with the parameters to the user.
Use undo url-parameter to delete the parameters carried in the URL of the portal Web server.
Syntax
url-parameter param-name { nas-id | nas-port-id | original-url | source-address | source-mac [ format section { 1 | 3 | 6 } { lowercase | uppercase } ] [ encryption { aes | des } key { cipher | simple } string ] | value expression | vlan }
undo url-parameter param-name
Default
No URL parameters are configured for a portal Web server.
Views
Portal Web server view
Predefined user roles
network-admin
mdc-admin
Parameters
param-name: Specifies a URL parameter name, a case-sensitive string of 1 to 32 characters. Content of the parameter is determined by the following keyword you specify.
nas-id: Specifies the NAS-ID.
nas-port-id: Specifies the NAS-Port-Id.
original-url: Specifies the URL of the original webpage that a portal user visits.
source-address: Specifies the user IP address.
source-mac: Specifies the user MAC address.
format: Specifies the format of the MAC address.
section: Specifies the number of sections that a MAC address contains.
1: Specifies the one-section format XXXXXXXXXXXX.
3: Specifies the three-section format XXXX-XXXX-XXXX.
6: Specifies the six-section format XX-XX-XX-XX-XX-XX.
lowercase: Specifies the letters in a MAC address to be in lower case.
uppercase: Specifies the letters in a MAC address to be in upper case.
encryption: Specifies the encryption algorithm to encrypt the MAC address of the user.
aes: Specifies the AES algorithm.
des: Specifies the DES algorithm.
key: Specifies a key for encryption.
cipher: Specifies a key in encrypted form.
simple: Specifies a key in plaintext form. For security purposes, the key specified in plaintext form will be stored in encrypted form.
string: Specifies the case-sensitive key string. The string length varies by the selected encryption method:
· If des cipher is specified, the string length is 41 characters.
· If des simple is specified, the string length is 8 characters.
· If aes cipher is specified, the string length is 1 to 73 characters.
· If aes simple is specified, the string length is 1 to 31 characters.
value expression: Specifies a custom case-sensitive string of 1 to 256 characters.
vlan: Specifies the user VLAN ID.
Usage guidelines
You can configure multiple URL parameters.
If you execute this command multiple times to configure the same URL parameter, the most recent configuration takes effect.
After you configure the URL parameters, the access device sends the portal Web server URL with these parameters to portal users. For example, assume that the URL of a portal Web server is http://www.test.com/portal, and you execute the url-parameter userip source-address and url-parameter userurl value http://www.abc.com/welcome commands. Then, the access device sends to the user whose IP address is 1.1.1.1 the URL http://www.test.com/portal?userip=1.1.1.1&userurl=http://www.abc.com/welcome.
When you configure the param-name argument in this command, you must use the URL parameter name supported by the actual portal server. Different portal server types support different URL parameter names.
For example, the IMC server supports parameter names userurl, userip, and usermac for the keywords original-url, source-address, and source-mac, respectively. To carry the user IP information in the portal Web server URL, you must configure the parameter name as userip and specify the source-address keyword.
If you specify the encryption algorithm for a parameter, the redirection URL carries the encrypted value for the parameter. Execute the url-parameter usermac source-mac encryption des key simple 12345678 command. Then the access device sends to the user with MAC address 1111-1111-1111 the URL http://www.test.com/portal?usermac=xxxxxxxxx&userip=1.1.1.1&userurl= http://www.test.com/welcome, where xxxxxxxxx represents the encrypted user MAC address.
Examples
# Configure URL parameters userip and userurl for portal Web server wbs. Configure the value of the userip parameter as source-address (the IP addresses of users) and that of the userurl parameter as http://www.abc.com/welcome.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] url-parameter userip source-address
[Sysname-portal-websvr-wbs] url-parameter userurl value http://www.abc.com/welcome
# Configure URL parameter usermac for portal Web server wbs. Configure the value of the usermac parameter as source-mac (the MAC addresses of users) and specify DES to encrypt the MAC addresses.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] url-parameter usermac source-mac encryption des key simple 12345678
# Configure URL parameter uservlan for portal Web server wbs. Configure the value of the uservlan parameter as the vlan (the VLAN IDs of users.)
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] url-parameter uservlan vlan
Related commands
display portal web-server
url
user-password modify enable
Use user-password modify enable to enable local portal user password modification.
Use undo user-password modify enable to disable local portal user password modification.
Syntax
user-password modify enable
undo user-password modify enable
Default
Local portal user password modification is disabled.
Views
Local portal Web server view
Predefined user roles
network-admin
mdc-admin
Usage guidelines
This feature enables the local portal Web server to display the password modification button on the portal authentication page. Local portal users can change their passwords through this button.
Examples
# In local portal Web server view, enable local portal user password modification.
<Sysname> system-view
[Sysname] portal local-web-server http
[Sysname-portal-local-websvr-http] user-password modify enable
Related commands
portal local-web-server
user-sync
Use user-sync to enable portal user synchronization for a portal authentication server. After this feature is enabled, the device replies to and periodically detects the synchronization packets from the portal authentication server. In this way, information about online portal users on the device and on the portal authentication server remains consistent.
Use undo user-sync to disable portal user synchronization for a portal authentication server.
Syntax
user-sync timeout timeout
undo user-sync
Default
Portal user synchronization is disabled for a portal authentication server.
Views
Portal authentication server view
Predefined user roles
network-admin
mdc-admin
Parameters
timeout timeout: Sets a detection timeout for synchronization packets, in the range of 60 to 18000 seconds. The default is 1200 seconds.
Usage guidelines
Portal user synchronization requires that the portal authentication server support the portal user heartbeat feature. Now, only the IMC portal authentication server supports portal user heartbeat. To implement portal user synchronization, you need to configure the user heartbeat feature on the portal authentication server. Make sure the user heartbeat interval configured on the portal authentication server is not greater than the synchronization detection timeout configured on the access device.
Deleting a portal authentication server on the device also deletes the user synchronization configuration for the server.
If you execute this command multiple times, the most recent configuration takes effect.
For information of the users considered as nonexistent on the portal authentication server, the device deletes the information after the configured detection timeout expires.
If the user information from the portal authentication server does not exist on the device, the device encapsulates IP addresses of the users in user heartbeat reply packets to the server. The portal authentication server then deletes the users.
Examples
# Enable portal user synchronization for the portal authentication server pts and set the detection timeout to 600 seconds. If a use has not appeared in the synchronization packets sent by the portal authentication server for 600 seconds, the access device logs out the user.
<Sysname> system-view
[Sysname] portal server pts
[Sysname-portal-server-pts] user-sync timeout 600
Related commands
portal server
vpn-instance
Use vpn-instance to specify the MPLS L3VPN where a portal Web server resides.
Use undo vpn-instance to restore the default.
Syntax
vpn-instance vpn-instance-name
undo vpn-instance
Default
A portal Web server is on the public network.
Views
Portal Web server view
Predefined user roles
network-admin
mdc-admin
Parameters
vpn-instance-name: Specifies the name of the MPLS L3VPN where the portal Web server resides, a case-sensitive string of 1 to 31 characters.
Usage guidelines
A portal Web server belongs to only one MPLS L3VPN.
Examples
# Configure the MPLS L3VPN for the portal Web server wbs as abc.
<Sysname> system-view
[Sysname] portal web-server wbs
[Sysname-portal-websvr-wbs] vpn-instance abc
web-redirect url
Use web-redirect url to enable the Web redirect feature.
Use undo web-redirect url to disable the Web redirect feature.
Syntax
web-redirect [ ipv6 ] url url-string [ interval interval ]
undo web-redirect [ ipv6 ]
Default
The Web redirect feature is disabled.
Views
Interface view
Predefined user roles
network-admin
mdc-admin
Parameters
ipv6: Specifies the IPv6 Web redirect feature. Do not specify this keyword for the IPv4 Web redirect feature.
url url-string: Specifies the URL to which the user is redirected. The URL is required to be complete and begins with http:// or https://, a string of 1 to 256 characters.
interval interval: Specifies the time interval at which the user is redirected to the specified URL. It is in the range of 60 to 86400 seconds. The default interval is 86400 seconds.
Usage guidelines
This feature redirects a user on an interface to the specified URL before the user can access an external network through a Web browser. After the specified interval, the user is redirected to the specified URL again.
To push different advertisement pages to different users, you can carry parameters in the redirect URL (by using the url url-string option) as needed. The following parameters are available:
· userip=%c—IP address of the user.
· usermac=%m—MAC address of the user.
· nasid=%n—NAS identifier of the device.
· originalurl=%o—Original URL that the user enters in the browser.
Make sure the arrangement of the parameters conforms to the format of http://XXXX/index.html?userip=%c&usermac=%m&nasid=%n&originalurl=%o.
On Etherchannel interfaces, both Web redirect and portal authentication can be enabled at the same time. On non-Etherchannel of interfaces, Web redirect does not work when both Web redirect and portal authentication are enabled.
The Web redirect feature takes effect only on HTTP packets that use the default port number 80.
Examples
# Configure IPv4 Web redirect on GigabitEthernet 1/1/1. Set the redirect URL to http://192.0.0.1/index.html?userip=%c&usermac=%m&nasid=%n&originalurl=%o and the interval to 3600 seconds
<Sysname> system-view
[Sysname] interface gigabitethernet 1/1/1
[Sysname-GigabitEthernet1/1/1] web-redirect url http://192.0.0.1/index.html?userip=%c&usermac=%m&nasid=%n&originalurl=%o interval 3600
Related commands
display web-redirect rule