ltm profile mr-ratelimit
ltm profile mr-ratelimit(1) BIG-IP TMSH Manual ltm profile mr-ratelimit(1)
NAME
mr-ratelimit - Configures a Rate limit profile.
MODULE
ltm profile
SYNTAX
Configure the mr-ratelimit component within the ltm profile module using the syntax shown in the following sections.
CREATE/MODIFY
create mr-ratelimit [name]
modify mr-ratelimit [name]
options:
defaults-from [ [name] | none]
description [string]
ingress-msg-rate-threshold-per-conn [integer]
ingress-byte-rate-threshold-per-conn [integer]
action-ingress {
limit-50 {
priority-1 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-2 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-3 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-4 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
}
limit-75 {
priority-1 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-2 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-3 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-4 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
}
limit-90 {
priority-1 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-2 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-3 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-4 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
}
limit-100 {
priority-1 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-2 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-3 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-4 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
}
}
action-egress {
limit-50 {
priority-1 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-2 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-3 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-4 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
}
limit-75 {
priority-1 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-2 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-3 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-4 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
}
limit-90 {
priority-1 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-2 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-3 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-4 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
}
limit-100 {
priority-1 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-2 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-3 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
priority-4 [none | delay-25 | delay-50 | delay-100 | return-25 | return-50 | return-100 | drop-25 | drop-50 | drop-100]
}
}
edit mr-ratelimit [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list mr-ratelimit
list mr-ratelimit [ [ [name] | [glob] | [regex] ] ... ]
show running-config mr-ratelimit
show running-config mr-ratelimit [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show mr-ratelimit
show mr-ratelimit [ [ [name] | [glob] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
DELETE
delete mr-ratelimit [name]
DESCRIPTION
You can use the mr-ratelimit component to manage a Rate limit profile.
EXAMPLES
create mr-ratelimit my_ratelimit_profile defaults-from mr-ratelimit
Creates a Rate limit profile named my_ratelimit_profile using the system defaults.
create mr-ratelimit my_ratelimit_profile ingress-msg-rate-threshold-per-conn 1000 action-ingress { limit-50 { priority-1
none priority-2 delay-25 priority-3 return-25 priority-4 drop-25 } }
Creates a Rate limit profile named my_ratelimit_profile with message ingress traffic threshold configured to 1000 msgs/sec
and ingress actions when traffic rate hits 50% of threshold. The action for priority-1 messages is none, for priority-2
delay 25% of messages, for prioirty-3 return 25% of messages and for priority-4 drop 25% of messages.
mv mr-ratelimit /Common/my_ratelimit_profile to-folder /Common/my_folder
Moves a custom mr-ratelimit profile named my_ratelimit_profile to a folder named my_folder, where my_folder has already
been created and exists within /Common.
OPTIONS
ingress-msg-rate-threshold-per-conn
The maximum threshold number of messages any particular ingress connection can handle. When a particular limit
(50%,75%,90%,100%) of this threshold is reached then appropriate action is invoked.
ingress-byte-rate-threshold-per-conn
The maximum threshold bytes of message data any particular ingress connection can handle. When a particular limit
(50%,75%,90%,100%) of this threshold is reached then appropriate action is invoked.
egress-msg-rate-threshold-per-conn
The maximum threshold number of messages any particular egress connection can handle. When a particular limit
(50%,75%,90%,100%) of this threshold is reached then appropriate action is invoked.
egress-byte-rate-threshold-per-conn
The maximum threshold bytes of message data any particular egress connection can handle. When a particular limit
(50%,75%,90%,100%) of this threshold is reached then appropriate action is invoked.
action-ingress
Defines the actions for the ingress connectin when a particular limit (50%,75%,90%,100%) of configured threshold is
reached.
action-egress
Defines the actions for the egress connectin when a particular limit (50%,75%,90%,100%) of configured threshold is
reached.
limit-50
Defines the action that would be exercised on the message when the traffic rate reaches/crosses the 50% of configured
threshold. User configures the action for each of the 4 priority messages.
limit-75
Defines the action that would be exercised on the message when the traffic rate reaches/crosses the 75% of configured
threshold. User configures the action for each of the 4 priority messages.
limit-90
Defines the action that would be exercised on the message when the traffic rate reaches/crosses the 90% of configured
threshold. User configures the action for each of the 4 priority messages.
limit-100
Defines the action that would be exercised on the message when the traffic rate reaches/crosses the 100% of configured
threshold. User configures the action for each of the 4 priority messages.
prioity-1
Defines the action that would be exercised on the message configured as priority 1 - Highest prioirty
prioity-2
Defines the action that would be exercised on the message configured as priority 2
prioity-3
Defines the action that would be exercised on the message configured as priority 3
prioity-4
Defines the action that would be exercised on the message configured as priority 4
SEE ALSO
create, delete, edit, glob, list, ltm virtual, modify, mv, regex, reset-stats, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2010, 2012-2014, 2016-2017. All rights reserved.
BIG-IP 2020-06-29 ltm profile mr-ratelimit(1)