getcachecontentgroupResult Structure Definition

The getcachecontentgroupResult structure defines the return type for getcachecontentgroup API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

cachecontentgroupList

List of cachecontentgroups


cachecontentgroup Structure Definition

The cachecontentgroup structure defines the actual return type values for getcachecontentgroup API.

Syntax



Members

name

Name of the content group about which to display information.

flags

Flags.

type

The type of the content group.

relexpiry

The relative expiry time in seconds.

relexpirymillisec

Relative expiry time, in milliseconds, after which to expire an object cached in this content group.

absexpiry

Local time, up to 4 times a day, at which all objects in the content group must expire. CLI Users: For example, to specify that the objects in the content group should expire by 11:00 PM, type the following method: add cache contentgroup -absexpiry 23:00 To specify that the objects in the content group should expire at 10:00 AM, 3 PM, 6 PM, and 11:00 PM, type: add cache contentgroup -absexpiry 10:00 15:00 18:00 23:00

absexpirygmt

Coordinated Universal Time (GMT), up to 4 times a day, when all objects in the content group must expire.

heurexpiryparam

Heuristic expiry time, in percent of the duration, since the object was last modified.

weakposrelexpiry

Relative expiry time, in seconds, for expiring positive responses with response codes between 200 and 399. Cannot be used in combination with other Expiry attributes. Similar to -relExpiry but has lower precedence.

weaknegrelexpiry

Relative expiry time, in seconds, for expiring negative responses. This value is used only if the expiry time cannot be determined from any other source. It is applicable only to the following status codes: 307, 403, 404, and 410.

hitparams

Parameters to use for parameterized hit evaluation of an object. Up to 128 parameters can be specified. Mutually exclusive with the Hit Selector parameter.

invalparams

Parameters for parameterized invalidation of an object. You can specify up to 8 parameters. Mutually exclusive with invalSelector.

ignoreparamvaluecase

Ignore case when comparing parameter values during parameterized hit evaluation. (Parameter value case is ignored by default during parameterized invalidation.)

matchcookies

Evaluate for parameters in the cookie header also.

invalrestrictedtohost

Take the host header into account during parameterized invalidation.

polleverytime

Always poll for the objects in this content group. That is, retrieve the objects from the origin server whenever they are requested.

ignorereloadreq

Ignore any request to reload a cached object from the origin server. To guard against Denial of Service attacks, set this parameter to YES. For RFC-compliant behavior, set it to NO.

removecookies

Remove cookies from responses.

prefetch

Attempt to refresh objects that are about to go stale.

prefetchperiod

Time period, in seconds before an object's calculated expiry time, during which to attempt prefetch.

prefetchperiodmillisec

Time period, in milliseconds before an object's calculated expiry time, during which to attempt prefetch.

prefetchcur

Current outstanding prefetches.

prefetchmaxpending

Maximum number of outstanding prefetches that can be queued for the content group.

flashcache

Perform flash cache. Mutually exclusive with Poll Every Time (PET) on the same content group.

expireatlastbyte

Force expiration of the content immediately after the response is downloaded (upon receipt of the last byte of the response body). Applicable only to positive responses.

insertvia

Insert a Via header into the response.

insertage

Insert an Age header into the response. An Age header contains information about the age of the object, in seconds, as calculated by the integrated cache.

insertetag

Insert an ETag header in the response. With ETag header insertion, the integrated cache does not serve full responses on repeat requests.

cachecontrol

Insert a Cache-Control header into the response.

quickabortsize

If the size of an object that is being downloaded is less than or equal to the quick abort value, and a client aborts during the download, the cache stops downloading the response. If the object is larger than the quick abort size, the cache continues to download the response.

minressize

Minimum size of a response that can be cached in this content group. Default minimum response size is 0.

maxressize

Maximum size of a response that can be cached in this content group.

memusage

Current memory usage.

memdusage

Current disk memory usage.

disklimit

Maximum amount of disk that the cache can use. The effective limit is based on the available memory of the Citrix ADC.

memlimit

Maximum amount of memory that the cache can use. The effective limit is based on the available memory of the Citrix ADC.

ignorereqcachinghdrs

Ignore Cache-Control and Pragma headers in the incoming request.

cachenon304hits

Cache non 304 hits.

cache304hits

Cache 304 hits.

cachecells

Number of cells.

cachegroupincarnation

Cache group incarnation.

minhits

Number of hits that qualifies a response for storage in this content group.

alwaysevalpolicies

Force policy evaluation for each response arriving from the origin server. Cannot be set to YES if the Prefetch parameter is also set to YES.

persist

Setting persist to YES causes IC to save objects in contentgroup to disk.

persistha

Setting persistHA to YES causes IC to save objects in contentgroup to Secondary node in HA deployment.

pinned

Do not flush objects from this content group under memory pressure.

lazydnsresolve

Perform DNS resolution for responses only if the destination IP address in the request does not match the destination IP address of the cached response.

hitselector

Selector for evaluating whether an object gets stored in a particular content group. A selector is an abstraction for a collection of PIXL expressions.

invalselector

Selector for invalidating objects in the content group. A selector is an abstraction for a collection of PIXL expressions.

policyname

Active cache policies refering to this group.

cachenuminvalpolicy

Number of active Invalidation policies refering to this group.

markercells

Numbers of marker cells in this group.

builtin


_nextgenapiresource


See Also