ltm profile http-compression
ltm profile http-compression(1BIG-IP TMSH Manualtm profile http-compression(1)
NAME
http-compression - Configures an HTTP Compression profile.
MODULE
ltm profile
SYNTAX
Configure the http-compression component within the ltm profile module
using the syntax shown in the following sections.
CREATE/MODIFY
create http-compression [name]
modify http-compression [name]
options:
allow-http-10 [disabled | enabled]
app-service [[string] | none]
browser-workarounds [disabled | enabled]
buffer-size [integer]
cpu-saver [disabled | enabled]
cpu-saver-high [integer]
cpu-saver-low [integer]
content-type-exclude
[add | delete | replace-all-with] {
[content type] ...
}
content-type-exclude none
content-type-include
[add | delete | replace-all-with] {
[content type] ...
}
content-type-include none
defaults-from [ [name] | none]
description [string]
gzip-level [integer]
gzip-memory-level [integer, in bytes]
gzip-window-size [integer]
keep-accept-encoding [disabled | enabled]
method-prefer [deflate | gzip]
min-size [integer]
selective [disabled | enabled]
uri-exclude
[add | delete | replace-all-with] {
[URI] ...
}
uri-exclude none
uri-include
[add | delete | replace-all-with] {
[URI] ...
}
uri-include none
vary-header [disabled | enabled]
edit http-compression [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
mv http-compression [ [[source-name] [destination-name]] | [[name] to-folder [folder-name]] | [[name...name] to-folder [folder-name]] ]
options:
to-folder
reset-stats http-compression
reset-stats http-compression [ [ [name] | [glob] | [regex] ] ... ]
DISPLAY
list http-compression
list http-compression [ [ [name] | [glob] | [regex] ] ... ]
show running-config http-compression
show running-config http-compression [ [ [name] | [glob] | [regex] ]
... ]
options:
all-properties
non-default-properties
one-line
partition
show http-compression
show http-compression [ [ [name] | [glob] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
global
DELETE
delete http-compression [name]
DESCRIPTION
You can use the http-compression component to create, modify, display,
or delete an HTTP Compression profile.
The BIG-IP(r) system installation includes the following default HTTP
Compression-type profiles:
o http-compression
o wan-optimized-compression
The default HTTP Compression profile contains values for properties
related to managing compression settings.
You can create a new HTTP Compression-type profile using an existing
profile as a parent profile, and then you can change the values of the
properties to suit your needs.
EXAMPLES
create http-compression my_hc_profile defaults-from http-compression
Creates a custom HTTP Compression profile named my_hc_profile that
inherits its settings from the system default HTTP Compression profile.
mv http-compression /Common/my_httpcompression_profile to-folder
/Common/my_folder
Moves a custom http-compression profile named
my_httpcompression_profile to a folder named my_folder, where my_folder
has already been created and exists within /Common.
OPTIONS
allow-http10
Enables or disables compression of HTTP/1.0 server responses. The
default value is disabled.
app-service
Specifies the name of the application service to which the profile
belongs. The default value is none. Note: If the strict-updates
option is enabled on the application service that owns the object,
you cannot modify or delete the profile. Only the application
service can modify or delete the profile.
browser-workarounds
Enables or disables compression of browser workarounds. The
default value is disabled. Enabling this options turns off
compression on server responses when any of the following
conditions are detected:
o If the client browser is Netscape Navigator(r) version 4.0x,
compression is turned off. Netscape advertises that the
browser can handle compression gracefully. In this case, F5
Networks disables compression entirely for that class of
browser.
o If the client browser is Netscape Navigator version 4.x (4.10
and later) and the server response Content-Type is not either
text/html or text/plain compression is turned off. This class
of Netscape browsers can handle plain text and HTML just
fine, but there are known issues with other types of content.
o If the client browser is Microsoft(r) Internet Explorer (any
version), the server response Content-Type is either text/css
or application/x-javascript, and the client connection is
over SSL, compression is turned off. The Microsoft article ID
for this problem is 825057.
o If the client browser is Microsoft Internet Explorer (any
version), the server response Content-Type is either text/css
or application/x-javascript, and the server sets the header
Cache-Control to no-cache, compression is turned off. The
Microsoft article ID for this problem is 327286.
buffer-size
Specifies the maximum number of uncompressed bytes that the system
buffers before determining whether to compress the response.
Useful when the headers of a server response do not specify the
length of the response content. The default value is 4096.
content-type-exclude
Specifies a string list of HTTP Content-Type responses that you do
not want the system to compress. The default value is none.
content-type-include
Specifies a string list of HTTP Content-Type responses that you
want the system to compress. The default value is { text/
application/ (xml|x-javascript) }.
cpu-saver
Enables or disables the CPU saver feature. When the CPU saver is
enabled, the system monitors the percent of CPU usage and adjusts
compression rates automatically when the CPU usage reaches the
percentage defined in the compress-cpu-saver-low and compress-cpu-
saver-high options. The default value is enabled.
cpu-saver-high
Specifies the percent of CPU usage at which the system starts
automatically decreasing the amount of content being compressed,
as well as the amount of compression that the system is applying.
The default value is 90.
cpu-saver-low
Specifies the percent of CPU usage at which the system resumes
content compression at the user-defined rates. The default value
is 75.
defaults-from
Specifies the profile that you want to use as the parent profile.
Your new profile inherits all settings and values from the parent
profile specified. The default value is httpcompression.
description
User defined description.
gzip-level
Specifies a value that determines the amount of memory that the
system uses when compressing a server response. The default value
is 1.
gzip-memory-level
Specifies the amount of memory (in kilobytes) that the system uses
when compressing a server response. The system rounds the value up
to the nearest power of two. The default value is 8. The maximum
value is 256.
gzip-window-size
Specifies the number of kilobytes in the window size that the
system uses when compressing a server response. The system rounds
the value up to the nearest power of two. The default value is
16k. The maximum value is 128k.
keep-accept-encoding
Specifies where data compression is performed. When enabled, the
target server, rather than the BIG-IP local traffic management
system, performs data compression. The default value is disabled.
method-prefer
Specifies the type of compression that the system prefers. The
default value is gzip.
min-size
Specifies the minimum length in bytes of a server response that is
acceptable for compression. The length in bytes applies to content
length only, not headers. The default value is 1024.
partition
Displays the administrative partition within which the profile
resides.
selective
Enables or disables selective compression mode. Note that the data
compression feature compresses HTTP server responses, and not
client requests. The default value is disabled.
to-folder
http-compression profiles can be moved to any folder under
/Common, but configuration dependencies may restrict moving the
profile out of /Common.
uri-exclude
Disables compression on a specified list of HTTP Request-URI
responses. Use a regular expression to specify a list of URIs you
do not want to compress. The default value is none.
uri-include
Enables compression on a specified list of HTTP Request-URI
responses. Use a regular expression to specify a list of URIs you
want to compress. The default value is { .* }.
vary-header
Enables or disables the insertion of a Vary header into cacheable
server responses. The default value is enabled.
SEE ALSO
create, delete, edit, glob, list, ltm profile fasthttp, 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-2013, 2015. All rights
reserved.
BIG-IP 2015-10-19 ltm profile http-compression(1)