APIRef_tm_ltm_profile_http-compression¶

mgmt/tm/ltm/profile/http-compression

Virtual server HTTP compression profile configuration

REST Endpoints

Collection URI: /mgmt/tm/ltm/profile/http-compression
Collection Methods: OPTIONS, GET
Resource URI: /mgmt/tm/ltm/profile/http-compression/~resource id
Resource Methods: OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key: name, partition, subPath

Properties

Name	Type	Default Value	Required	Access	Description
`allowHttp_10`	string		optional	read/write	Enables or disables compression of HTTP/1.0 server responses.
`appService`	string		optional	read/write	The application service to which the object belongs.
`browserWorkarounds`	string		optional	read/write	Enables or disables browser workarounds. The default value is disabled.
`bufferSize`	integer		optional	read/write	Specifies the maximum number of uncompressed bytes that the system buffers before determining whether or not 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.
`contentTypeExclude`	string		optional	read/write	Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
`contentTypeInclude`	string		optional	read/write	Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
`cpuSaver`	string		optional	read/write	Specifies the CPU saver setting. 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 cpu saver low or the cpu saver high options. The default value is enabled.
`cpuSaverHigh`	integer	90	optional	read/write	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 which the system is applying. The default value is 90 percent.
`cpuSaverLow`	integer	75	optional	read/write	Specifies the percent CPU usage at which the system resumes content compression at the user-defined rates. The default value is 75 percent.
`defaultsFrom`	string		optional	read/write	Specifies the profile that you want to use as the parent profile.
`description`	string		optional	read/write	User defined description.
`gzipLevel`	integer		optional	read/write	Specifies a value that determines the amount of memory that the system uses when compressing a server response. The default is 1.
`gzipMemoryLevel`	integer		optional	read/write	Specifies amount of memory (in kilobytes) that the system uses when compressing a server response. The value will be rounded up to the nearest power of 2. The default value is 8k. The maximum value is 256k.
`gzipWindowSize`	integer		optional	read/write	Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The value will be rounded up to the nearest power of 2. The default is 16k. The maximum value is 128k.
`keepAcceptEncoding`	string		optional	read/write	Enables or disables keep accept encoding. When enabled, causes the target server, rather than the BIG-IP, to perform the data compression.
`methodPrefer`	string	deflate	optional	read/write	Specifies the type of compression that is preferred by the system.
`minSize`	integer		optional	read/write	Specifies the minimum length in bytes of a server response that is acceptable for compressing that response. The length in bytes applies to content length only, not headers. The default value is 1024.
`tmPartition`	string	Common	optional	read/write	Displays the administrative partition within which this profile resides.
`selective`	string		optional	read/write	Enables or disables selective compression mode.
`uriExclude`	string		optional	read/write	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.
`uriInclude`	string		optional	read/write	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 { .* }
`varyHeader`	string		optional	read/write	Enables or disables the insertion of a Vary header into cacheable server responses. The default value is enabled.

iControl Reference Index

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.