- Table of Contents
- Related Documents
-
Title | Size | Download |
---|---|---|
08-User profile commands | 73.91 KB |
User profile commands
This feature is supported only when the device is operating in standard mode. For information about system operating modes, see device management in Fundamentals Configuration Guide.
Only CSPEX (except CSPEX-1104-E) cards support user profiles.
Only CSPEX cards (except CSPEX-1204) support session group profiles and user group profiles and support applying a user profile to an interface.
display user-group-profile
Use display user-group-profile to display configuration and online user information for user group profiles.
Syntax
In standalone mode:
display user-group-profile [ name profile-name ] [ slot slot-number ]
In IRF mode:
display user-group-profile [ name profile-name ] [ chassis chassis-number slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
name profile-name: Specifies a user group profile by its name, a case-sensitive string of 1 to 31 characters. If you do not specify this option, the command displays configuration and online user information for all user group profiles.
slot slot-number: Specifies a card by its slot number. If you do not specify this option, the command displays user group profile configuration and online user information on all cards. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies a card on 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 card. If you do not specify this option, the command displays user group profile configuration and online user information for all cards. (In IRF mode.)
Examples
# Display configuration and online user information for all user group profiles.
User Group Profile: g1
Direction: Outbound
General Traffic Shaping:
If-match any:
CIR 1000 (kbps), CBS 62500 (Bytes), EBS 0 (Bytes)
slot 4:
User spirent:
User ID: 0x2811177c
Authentication type: PPP
Network attributes:
Interface : Bas-interface0
VPN : N/A
User spirent:
User ID: 0x2811177b
Authentication type: PPP
Network attributes:
Interface : Bas-interface0
VPN : N/A
For information about the command output, see Table 1.
display user-profile
Use display user-profile to display configuration and online user information for user profiles.
Syntax
In standalone mode:
display user-profile [ session-group ] [ name profile-name ] [ slot slot-number ]
In IRF mode:
display user-profile [ session-group ] [ name profile-name ] [ chassis chassis-number slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
session-group: Specifies a session group profile.
name profile-name: Specifies a user profile by its name, a case-sensitive string of 1 to 31 characters. Valid characters include English letters, digits, underscores (_), minus signs (–), and dots (.). The name can start with an English letter or digit, and cannot contain only digits. The name must be unique globally. If you do not specify this option, the command displays configuration and online user information for all user profiles.
slot slot-number: Specifies a card by its slot number. If you do not specify this option, the command displays user profile configuration and online user information on all cards. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies a card on 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 card. If you do not specify this option, the command displays user profile configuration and online user information for all cards. (In IRF mode.)
Examples
# Display configuration and online user information for user profile aaa.
<Sysname> display user-profile name aaa
User Profile: aaa
Direction: Inbound
Committed Access Rate:
CIR 32 (kbps), CBS 2048 (Bytes), EBS 0 (Bytes), PIR 888 (kbps)
Policy: p1
Direction: Outbound
Committed Access Rate:
CIR 32 (kbps), CBS 2048 (Bytes), EBS 0 (Bytes), PIR 888 (kbps)
Policy: p2
User queue:
CIR 32 (kbps), CBS 2048 (Bytes), EBS 0 (Bytes), PIR 888 (kbps)
Queue length: 1024 (Packets)
QMProfile: qm1
User group profile: ug1
Connection-limit amount: 1000
Connection-limit rate: 100
User user_1:
Authentication type: Portal
Network attributes:
Interface : GigabitEthernet3/1/3
IP address : 172.16.187.16
VPN : N/A
Service VLAN : 100
# Display configuration and online user information for all session group profiles.
<Sysname> display user-profile session-group
Session Group Profile: aaa
Direction: Outbound
Committed Access Rate:
CIR 32 (kbps), CBS 2048 (Bytes), EBS 0 (Bytes), PIR 888 (kbps)
QMProfile: a
User user_1:
Authentication type: Portal
Network attributes:
Interface : GigabitEthernet3/1/3
IP address : 172.16.187.16
VPN : N/A
Service VLAN : 100
Session Group Profile: bbb
Direction: Outbound
Committed Access Rate:
CIR 512 (kbps), CBS 1024 (Bytes), EBS 0 (Bytes), PIR 888 (kbps)
QMProfile: a
User user_2:
Authentication type: Portal
Network attributes:
Interface : GigabitEthernet3/1/2
IP address : 172.16.187.166
VPN : N/A
Service VLAN : 100
Field |
Description |
User Profile |
User profile name. |
Inbound |
Policy applied to incoming traffic. |
Outbound |
Policy applied to outgoing traffic. |
Session Group Profile |
Session group profile name. |
CIR |
Committed information rate, in kbps. |
CBS |
Committed burst size, in bytes. |
EBS |
Excess burst size, in bytes. |
PIR |
Peak information rate, in kbps. |
Connection-limit amount |
Maximum number of user connections set by the connection limits. |
Connection-limit rate |
Maximum connection establishment rate set by the connection limits. |
Policy |
Policy name. |
Queue length |
Maximum number of packets allowed in a queue. |
QMProfile |
Queue scheduling profile. |
User group profile |
User group profile name. |
User user_1 |
Username of a user account with which a user profile or session group profile is associated. |
Authentication type |
Authentication type: · Portal—Portal authentication. · PPP—PPP authentication. · IPoE—IPoE authentication. |
Network attributes |
Online user information. |
Failed action list |
Actions that failed to be applied to the user. |
display user-profile interface
Use display user-profile interface to display the configuration and statistics for user profiles applied to interfaces.
Syntax
In standalone mode:
display user-profile interface [ interface-type interface-number ] [ slot slot-number ]
In IRF mode:
display user-profile interface [ interface-type interface-number ] [ chassis chassis-number slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
interface-type interface-number: Specifies an interface by its type and number. If you do not specify an interface, this command displays the configuration and statistics for user profiles applied to all interfaces.
slot slot-number: Specifies a card by its slot number. If you do not specify this option, the command displays the configuration of user profiles applied to interfaces and the statistics for applied user profiles on the active MPU. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies a card on 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 card. If you do not specify this option, the command displays the configuration of user profiles applied to interfaces and the statistics for applied user profiles on the global active MPU. (In IRF mode.)
Examples
# Display the configuration and statistics for user profiles applied to all interfaces.
<Sysname> display user-profile interface
Interface: GigabitEthernet3/1/1
User Profile: u1
Direction: Inbound
Committed Access Rate(active):
CIR 112 (kbps), CBS 5120 (Bytes), EBS 0 (Bytes)
Green action : pass
Yellow action : pass
Red action : discard
Green packets : 0 (Packets) 0 (Bytes)
Yellow packets: 0 (Packets) 0 (Bytes)
Red packets : 0 (Packets) 0 (Bytes)
Policy(inactive): p
User queue(inactive):
CIR 30000 (kbps), CBS 1875000 (Bytes), EBS 0 (Bytes), PIR 40000 (kbps)
Direction: Outbound
Committed Access Rate(active):
CIR 112 (kbps), CBS 5120 (Bytes), EBS 0 (Bytes)
Green action : pass
Yellow action : pass
Red action : discard
Green packets : 0 (Packets) 0 (Bytes)
Yellow packets: 0 (Packets) 0 (Bytes)
Red packets : 0 (Packets) 0 (Bytes)
Policy(inactive): p
User queue(inactive):
CIR 3000 (kbps), CBS 187500 (Bytes), EBS 0 (Bytes), PIR 3000 (kbps)
Queue length: 3000 (Packets)
QMProfile: a
User group profile: g
Qos Weight(inactive): 4
Queue Name(inactive): af3
Connection-limit amount(inactive): 3000
Connection-limit rate(inactive): 500
IGMP access policy:
3000
MLD access policy:
3000
Authentication-free rule:
acl 3000
# Display the configuration and statistics for the user profile applied to GigabitEthernet 3/1/1.
<Sysname> display user-profile interface gigabitethernet 3/1/1
Interface: GigabitEthernet3/1/1
User Profile: test
Direction: Inbound
Committed Access Rate(active):
CIR 112 (kbps), CBS 5120 (Bytes), EBS 0 (Bytes)
Green action : pass
Yellow action : pass
Red action : discard
Green packets : 0 (Packets) 0 (Bytes)
Yellow packets: 0 (Packets) 0 (Bytes)
Red packets : 0 (Packets) 0 (Bytes)
Policy(inactive): p
User queue(inactive):
CIR 30000 (kbps), CBS 1875000 (Bytes), EBS 0 (Bytes), PIR 40000 (kbps)
Direction: Outbound
Committed Access Rate(active):
CIR 112 (kbps), CBS 5120 (Bytes), EBS 0 (Bytes)
Green action : pass
Yellow action : pass
Red action : discard
Green packets : 0 (Packets) 0 (Bytes)
Yellow packets: 0 (Packets) 0 (Bytes)
Red packets : 0 (Packets) 0 (Bytes)
Policy(inactive): p
User queue(inactive):
CIR 3000 (kbps), CBS 187500 (Bytes), EBS 0 (Bytes), PIR 3000 (kbps)
Queue length: 3000 (Packets)
QMProfile: a
User group profile: g
Qos Weight(inactive): 4
Queue Name(inactive): af3
Connection-limit amount(inactive): 3000
Connection-limit rate(inactive): 500
IGMP access policy:
3000
MLD access policy:
3000
Authentication-free rule:
acl 3000
# Display the configuration of the user profile applied to Route-Aggregation 1 and the statistics for the user profile on the card in slot 2.
<Sysname> display user-profile interface route-aggregation 1 slot 2
Interface: Route-Aggregation 1
User Profile: u2
Direction: Inbound
Committed Access Rate(inactive):
CIR 128 (kbps), CBS 8000 (Bytes), EBS 0 (Bytes)
Green action : pass
Yellow action : pass
Red action : discard
Green packets : 0 (Packets) 0 (Bytes)
Yellow packets: 0 (Packets) 0 (Bytes)
Red packets : 0 (Packets) 0 (Bytes)
Policy(inactive): p
User queue(inactive):
CIR 30000 (kbps), CBS 1875000 (Bytes), EBS 0 (Bytes), PIR 40000 (kbps)
Direction: Outbound
Committed Access Rate(inactive):
CIR 128 (kbps), CBS 8000 (Bytes), EBS 0 (Bytes)
Green action : pass
Yellow action : pass
Red action : discard
Green packets : 0 (Packets) 0 (Bytes)
Yellow packets: 0 (Packets) 0 (Bytes)
Red packets : 0 (Packets) 0 (Bytes)
Policy(inactive): p
User queue(inactive):
CIR 3000 (kbps), CBS 187500 (Bytes), EBS 0 (Bytes), PIR 3000 (kbps)
Queue length: 3000 (Packets)
QMProfile: a
User group profile: g
Qos Weight(inactive): 4
Queue Name(inactive): af3
Connection-limit amount(inactive): 3000
Connection-limit rate(inactive): 500
IGMP access policy:
3000
MLD access policy:
3000
Authentication-free rule:
acl 3000
Table 2 Command output
Field |
Description |
Direction |
Direction of CAR parameters in the user profile: Inbound or Outbound. |
active |
Indicates a configuration item is successfully issued and has taken effect. |
inactive |
Indicates a configuration item fails to be issued and has not taken effect. |
CIR |
Committed information rate, in kbps. |
CBS |
Committed burst size, in bytes. |
EBS |
Excess burst size, in bytes. |
PIR |
Peak information rate, in kbps. |
Green action : pass |
The action on green packets is pass. |
Yellow action : pass |
The action on yellow packets is pass. |
Red action : discard |
The action on red packets is discard. |
Green packets |
Statistics on green packets in packets and bytes. |
Yellow packets |
Statistics on yellow packets in packets and bytes. |
Red packets |
Statistics on red packets in packets and bytes. |
QoS Weight |
Scheduling weight for the outbound direction. |
Queue Name |
Name of the queue specified for a session. |
Connection-limit amount |
Maximum number of user connections set by the connection limits. |
Connection-limit rate |
Maximum connection establishment rate set by the connection limits. |
Igmp access-policy |
Access policy for IGMP users. |
mld access-policy |
Access policy for MLD users. |
Policy |
Policy name. |
QMProfile |
Queue scheduling profile. |
Queue length |
Maximum number of packets allowed in a user queue. |
Related commands
qos apply user-profile
reset user-profile interface
qos apply user-profile
Use qos apply user-profile to apply a user profile to an interface.
Use undo qos apply user-profile to remove a user profile from an interface.
Syntax
qos apply user-profile profile-name
undo qos apply user-profile
Default
No user profile is applied to an interface.
Views
Layer 3 Ethernet interface view
Layer 3 Ethernet subinterface view
Layer 3 aggregate interface view
Layer 3 aggregate subinterface view
Predefined user roles
network-admin
Parameters
profile-name: Specifies a user profile by its name, a case-sensitive string of 1 to 31 characters. Valid characters include English letters, digits, underscores (_), hyphens (-), and dots (.). The name can start with an English letter or digit, and cannot contain only digits.
Examples
# Apply user profile u1 to GigabitEthernet 3/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 3/1/1
[Sysname-GigabitEthernet3/1/1] qos apply user-profile u1
Related commands
display user-profile interface
reset user-profile interface
user-profile
qos queue
Use qos queue to specify a queue for session packets that use the user profile.
Use undo qos queue to restore the default.
Syntax
qos queue { queue-id | queue-name }
undo qos queue
Default
No queue for session packets is specified for a user profile.
Views
User profile view
Predefined user roles
network-admin
Parameters
queue { queue-id | queue-name }: Specifies a queue by its ID or name. The value range for the queue-id argument is 0 to 7. The following matrix shows the mapping between queue IDs and queue names:
Queue ID |
Queue name |
0 |
be |
1 |
af1 |
2 |
af2 |
3 |
af3 |
4 |
af4 |
5 |
ef |
6 |
cs6 |
7 |
cs7 |
Usage guidelines
Session packets are scheduled based on the scheduling priority of the specified queue.
Only CSPEX cards (except CSPEX-1204) support this command.
Examples
# Specify queue 7 for session packets that use user profile user.
<Sysname> system-view
[Sysname] user-profile user
[Sysname-user-profile-user] qos queue 7
qos session-group identify
Use qos session-group identify to identify a session group on an interface.
Use undo qos session-group identify to restore the default.
Syntax
qos session-group identify { customer-vlan | service-vlan | customer-service-vlan }
undo qos session-group identify
Default
No session group is identified on the interface.
Views
Interface view
Predefined user roles
network-admin
Parameters
customer-vlan: Identifies a session group by CVLAN. A CVLAN is used by a customer on the private network.
service-vlan: Identifies a session group by SVLAN. An SVLAN is used by a service provider to transmit VLAN tagged traffic for customers.
customer-service-vlan: Identifies a session group by CVLAN and SVLAN.
Usage guidelines
To configure a session group profile, you must first use the command.
Examples
# Configure GigabitEthernet 3/1/1 to identify a session group by an SVLAN.
<Sysname> system-view
[Sysname] interface gigabitethernet 3/1/1
[Sysname-GigabitEthernet3/1/1] qos session-group identify service-vlan
qos user-queue
Use qos user-queue to configure queue scheduling parameters for user queues.
Use undo qos user-queue to restore the default.
Syntax
qos user-queue { cir committed-information-rate [ cbs committed-burst-size [ ebs excess-burst-size ] ] [ queue-length queue-length ] | qmprofile qmprofile-name | user-group-profile user-group-profile-name } * outbound
qos user-queue { cir committed-information-rate [ cbs committed-burst-size ] pir peak-information-rate [ ebs excess-burst-size ] [ queue-length queue-length ] | qmprofile qmprofile-name | user-group-profile user-group-profile-name } * outbound
undo qos user-queue outbound
Default
No queue scheduling parameters are configured for user queues.
Views
User profile view
Predefined user roles
network-admin
Parameters
cir committed-information-rate: Specifies the CIR in the range of 300 to 100000000 kbps.
cbs committed-burst-size: Specifies the CBS in the range of 4096 to 133169152 bytes.
ebs excess-burst-size: Specifies the EBS in the range of 0 to 256000000 bytes.
pir peak-information-rate: Specifies the PIR in the range of 300 to 100000000 kbps. The PIR cannot be smaller than the CIR.
queue-length queue-length: Specifies the maximum number of packets allowed in the queue, in the range of 1 to 12582912.
qmprofile qmprofile-name: Specifies a queue scheduling profile by its name. The specified queue scheduling profile must already exist.
user-group-profile profile-name: Specifies a user group profile by its name. The specified user group profile must already exist.
outbound: Applies the queue scheduling parameters to the outbound direction (traffic received by online users).
Usage guidelines
You can use this command to configure rate limit settings, specify a queue scheduling profile, and associate the user profile with a user group profile.
Only CSPEX cards (except CSPEX-1204) support this command.
If the user profile has been authorized, you can modify the parameters in the queue scheduling profile or user group profile associated with the user profile. However, to add, modify, or delete any rate limit parameters, first execute the undo qos user-queue command to remove the configuration.
To delete a queue scheduling profile or user group profile that has been associated with a user profile, first execute the undo qos user-queue command to remove the association setting.
For the same online user, you cannot both associate a user group profile and authorize a session group profile.
Examples
# In user profile u1, set the CIR to 512 kbps and the queue length to 2048. Use queue scheduling profile qm1, and associate the user profile with user group profile g1.
<Sysname> system-view
[Sysname] user-profile u1
[Sysname-user-profile-u1] qos user-queue cir 512 queue-length 2048 qmprofile qm1 user-group-profile g1 outbound
Related commands
qos qmprofile (ACL and QoS Command Reference)
user-group-profile
qos weight outbound
Use qos weight outbound to set an outbound weight value for a user profile, user group profile, or session group profile.
Use undo qos weight outbound to restore the default.
Syntax
qos weight weight-value outbound
undo qos weight outbound
Default
No outbound weight value is set for a user profile or session group profile.
Views
User profile view
User group profile view
Session group profile view
Predefined user roles
network-admin
Parameters
weight-value: Specifies a weight value in the range of 1 to 15.
outbound: Applies the weight value to the outbound direction (traffic sent by the device to online users).
Usage guidelines
Users are allocated bandwidth resources based on the weight value.
Examples
# Set an outbound weight value of 3 for user profile abc.
<Sysname> system-view
[Sysname] user-profile abc
[Sysname-user-profile-abc] qos weight 3 outbound
# Set an outbound weight value of 3 for session group profile abc.
<Sysname> system-view
[Sysname] user-profile abc type session-group
[Sysname-session-group-profile-abc] qos weight 3 outbound
reset user-profile interface
Use reset user-profile interface to clear the statistics for user profiles applied to interfaces.
Syntax
reset user-profile interface [ interface-type interface-number ]
Views
User view
Predefined user roles
network-operator
Parameters
interface-type interface-number: Specifies an interface by its type and number. If you do not specify an interface, this command clears the statistics for user profiles applied to all interfaces.
Examples
# Clear the statistics for user profiles applied to all interfaces.
<Sysname> reset user-profile interface
# Clear the statistics for the user profile applied to GigabitEthernet 3/1/1.
<Sysname> reset user-profile interface gigabitethernet 3/1/1
Related commands
display user-profile interface
qos apply user-profile
user-group-profile
Use user-group-profile to create a user group profile and enter its view, or enter the view of an existing user group profile.
Use undo user-group-profile to delete a user group profile.
Syntax
user-group-profile profile-name
undo user-group-profile profile-name
Default
No user group profiles exist.
Views
System view
Predefined user roles
network-admin
Parameters
profile-name: Specifies a user group profile by its name, a case-sensitive string of 1 to 31 characters. Valid characters include English letters, digits, underscores (_), minus signs (–), and dots (.). The name can start with an English letter or digit, and cannot contain only digits. The name must be unique globally. The name cannot be the same as the name of an existing user profile or session group profile.
Examples
# Create user group profile a123 and enter the view of a123.
<Sysname> system-view
[Sysname] user-group-profile a123
[Sysname-user-group-profile-a123]
user-profile
Use user-profile to create a user profile and enter its view, or enter the view of an existing user profile.
Use undo user-profile to delete a user profile.
Syntax
user-profile profile-name [ type session-group ]
undo user-profile profile-name
Default
No user profiles exist.
Views
System view
Predefined user roles
network-admin
Parameters
profile-name: Specifies a user profile by its name, a case-sensitive string of 1 to 31 characters. Valid characters include English letters, digits, underscores (_), minus signs (–), and dots (.). The name can start with an English letter or digit, and cannot contain only digits. The name must be unique globally. The name cannot be the same as the name of an existing user group profile or session group profile.
type session-group: Specifies a session group profile.
Examples
# Create user profile a123 and enter the view of a123.
<Sysname> system-view
[Sysname] user-profile a123
# Create session group profile a123 and enter the view of a123.
<Sysname> system-view
[Sysname] user-profile a123 type session-group
[Sysname-session-group-profile-a123]