set-cache-rule-prop

Syntax

tadm set-cache-rule-prop common_options --config=config_name --vs=vs_name --cache-rule=cache_rule_name (property_name=property_value)+

Description

Use this command to set up the cache rule properties.

Options

For information about common_options, run the help command.

--config|-c: Specify the name of the configuration for which you want to set cache rule properties.

--vs|-s: Specify the virtual server.

--cache-rule|-r: Specify the cache rule name.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following cache rule properties:

enabled: Specifies whether the caching rule is enabled.
Values: true, false. Default: false.

max-reload-interval: Specifies the maximum time (in seconds) allowed between consecutive up-to-date checks.
Values: Positive integer. Default: 3600.

min-reload-interval: Specifies the minimum time (in seconds) allowed between consecutive up-to-date checks of a cached document.
Values: Positive integer. Default: 0.

last-modified-factor: Represents the factor used in estimating the expiry time, which defines how long a document will be up-to-date based on time it was last modified. This property is used only when the explicit age of the document is not available
Values: Floating. Positive floating value from 0 to any large value.

min-object-size: Specifies the minimum size (in bytes) of any document to be cached.
Values: Positive integer. Must be less than max-object-size.

max-object-size: The maximum size, in bytes, of any document to be cached. This setting enables users to limit the maximum size of cached documents, so that no single document can take too much space. This value cannot exceed the value of max-heap-object-size.
Values: Positive integer.

query-maxlen: Specifies the number of characters in the query string. If this property is set to 0, URIs with query strings are not cached.
Values: Positive integer. Default: 0

compression: If this property value is set to true, the document is compressed before storing in the cache.
Values: true, false. Default: false.

cache-https-response: If this property value is set to true, responses from the HTTPS servers are also cached.
Values: true, false. Default: false.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-cache-rule-prop --config=www.example.org 
--vs=soa.example.org --cache-rule=cache-rule-1 max-reload-interval=2 min-object-size=150

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.