Command Line Reference
HQoS Configuration
27 min
hqos configuration hqos configuration show hqos profile {all|single show hqos profile {all|single hqos profile name } \[command] show hqos profile {all|single hqos profile name } \[purpose] view hqos configuration information \[view] system view \[notes] use this command to view all hqos information \[use cases] sonic# show hqos profile all show hqos user group profile {all|single show hqos user group profile {all|single hqos user group profile name |stats hqos user group profile name } \[command] show hqos user group profile {all|single hqos user group profile name |stats hqos user group profile name } \[purpose] view hqos user group configuration and real time traffic status \[view] system view \[notes] using this command to view all hqos user group information real time traffic status can be viewed when traffic exists within the user group \[use cases] sonic# show hqos user group profile all show hqos user profile {all|single show hqos user profile {all|single hqos user profile name |stats hqos user profile name } \[command] show hqos user profile {all|single hqos user profile name |stats hqos user profile name } \[purpose] view hqos user configuration and real time traffic status \[view] system view \[notes] using this command to view all hqos user information real time traffic status can be viewed when traffic exists within the user \[use cases] sonic# show hqos user profile all hqos enable hqos enable \[command] hqos enable \[purpose] globally enable the hqos function \[view] system configuration view \[use cases] sonic(config)# hqos enable hqos profile hqos profile name \[command] hqos profile name \[purpose] create hqos configuration \[parameter] parameter description name hqos configuration file name \[view] system configuration view \[use cases] sonic(config)# hqos profile test1 global rate global rate byte/s \[command] global rate byte/s \[purpose] configure global rate limiting \[parameter] parameter description byte/s rate limit speed, unit byte/s \[view] hqos profile configuration view \[use cases] sonic(config)# hqos profile test1 sonic(config hqos test1)# global rate 125000000 user group profile {fuzzymatch user group profile {fuzzymatch user group name |postmatch user group name |prematch user group name | user group name } {shaping pir byte/s pbs bytes } \[command] user group profile {fuzzymatch user group name |postmatch user group name |prematch user group name | user group name } {shaping pir byte/s pbs bytes } \[purpose] bind user group configuration in hqos setup, with independent rate limiting capability \[parameter] parameter description user group name user group name byte/s rate limit speed, unit byte/s \[view] hqos profile configuration view \[notes] custom user groups must be created prior to binding \[use cases] sonic(config)# hqos profile test1 sonic(config hqos test1)# user group profile test1 shaping pir 2000000 pbs 1000000 user profile {fuzzymatch user profile {fuzzymatch user name |postmatch user name |prematch user name | user name } {shaping pir byte/s pbs bytes } \[command] user profile {fuzzymatch user name |postmatch user name |prematch user name | user name } {shaping pir byte/s pbs bytes } \[purpose] bind a user configuration in the hqos setup, with independent rate limiting capability \[parameter] parameter description user name username byte/s rate limit speed, unit byte/s \[view] hqos profile configuration view \[notes] custom users must be created prior to binding \[use cases] sonic(config)# hqos profile test1 sonic(config hqos test1)# user profile test1 shaping pir 2000000 pbs 1000000 default group profile shaping pir default group profile shaping pir byte/s pbs bytes \[command] default group profile shaping pir byte/s pbs bytes \[purpose] configure independent rate limiting for the default user group within the hqos setup \[parameter] parameter description byte/s rate limit speed, unit byte/s \[view] hqos profile configuration view \[notes] when a user is not bound to a custom user group, that user belongs to the default user group \[use cases] sonic(config)# hqos profile test1 sonic(config hqos test1)# default group profile shaping pir 2000000 pbs 1000000 default user profile shaping pir default user profile shaping pir byte/s pbs bytes \[command] default user profile shaping pir byte/s pbs bytes \[purpose] configure independent rate limiting for the default user within the hqos setup \[parameter] parameter description byte/s rate limit speed, unit byte/s \[view] hqos profile configuration view \[notes] if a user is not bound to a custom user, they belong to the default user \[use cases] sonic(config)# hqos profile test1 sonic(config hqos test1)# default user profile shaping pir 2000000 pbs 1000000 hqos user group profile hqos user group profile name \[command] hqos user group profile name \[purpose] create a custom user group \[parameter] parameter description name custom user group name \[view] system configuration view \[use cases] sonic(config)# hqos user group profile test1 counter enable counter enable \[command] counter enable \[purpose] enable statistics \[view] hqos user group view \[use cases] sonic(config)# hqos user group profile test1 sonic(config group test1)# counter enable auto user by ip pool auto user by ip pool ip pool name \[command] auto user by ip pool ip pool name \[purpose] create custom users in batch based on ip pool \[parameter] parameter description ip pool name ip address pool name \[view] hqos user group view \[use cases] sonic(config)# hqos user group profile test1 sonic(config group test1)# auto user by ip pool test user profile {fuzzymatch user profile {fuzzymatch user name |postmatch user name |prematch user name | user name } {shaping pir byte/s pbs bytes } \[command] user profile {fuzzymatch user name |postmatch user name |prematch user name | user name } {shaping pir byte/s pbs bytes } \[purpose] bind a user configuration within the custom user group, with independent rate limiting capability \[parameter] parameter description user name username byte/s rate limit speed, unit byte/s \[view] custom user group configuration view \[notes] custom users must be created prior to binding \[use cases] sonic(config)# hqos user group profile test1 sonic(config group test1)# user profile test1 shaping pir 2000000 pbs 1000000 qos map bind dscp to tc qos map bind dscp to tc qos map name \[command] qos map bind dscp to tc qos map name \[purpose] bind a dscp based priority mapping relationship within the custom user group \[parameter] parameter description qos map name dscp priority mapping table \[view] custom user group configuration view \[notes] the dscp based priority mapping table must be created prior to binding \[use cases] sonic(config)# hqos user group profile test1 sonic(config group test1)# qos map bind dscp to tc dscp1 hqos user profile hqos user profile name \[command] hqos user profile name \[purpose] create a custom user \[parameter] parameter description name custom username \[view] system configuration view \[notes] the specific characteristics of a user can be configured via acl, and the set hqos user field is used within the acl to associate with a custom user \[use cases] sonic(config)# hqos user profile test1 tc queue tc queue sequence number mode strict|dwrr {shaping pir byte/s pbs bytes } \[command] tc queue sequence number mode strict|dwrr {shaping pir byte/s pbs bytes } \[purpose] configure the tc scheduling mode within the custom user, with independent rate limiting capability for the tc \[parameter] parameter description sequence number tc index 0–7 byte/s rate limit speed, unit byte/s \[view] custom user configuration view \[use cases] sonic(config)# hqos user profile test1 test1 sonic(config user test1)# tc queue 1 mode strict shaping pir 20000000 pbs 1000000 qos map bind dscp to tc qos map bind dscp to tc qos map name \[command] qos map bind dscp to tc qos map name \[purpose] bind a dscp based priority mapping relationship within the custom user \[parameter] parameter description qos map name dscp priority mapping table \[view] custom user configuration view \[notes] the dscp based priority mapping table must be created prior to binding \[use cases] sonic(config)# hqos user profile test1 sonic(config user test1)# qos map bind dscp to tc dscp1 hqos profile hqos profile name {shared|offload} \[command] hqos profile name {shared|offload} \[purpose] bind the hqos configuration file to the traffic egress interface \[parameter] parameter description name hqos configuration file name \[view] interface view \[notes] the mode parameter can be omitted during configuration; by default, it operates in normal mode, where each port functions independently in shared mode, all interfaces bound to this hqos configuration file share the rate limit specified in the configuration \[use cases] sonic(config)# interface ethernet 1 sonic(config if 1)# hqos profile test1
