Try SpotterConfiguration for Integrated Cache content group resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for Integrated Cache content group resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | cachecontentgroup
delegate_to: localhost
netscaler.adc.cachecontentgroup:
state: present
name: DEFAULT
- name: Sample Task | cachecontentgroup | 2
delegate_to: localhost
netscaler.adc.cachecontentgroup:
state: present
name: BASEFILE
relexpiry: 86000
weaknegrelexpiry: 600
maxressize: 256
memlimit: 2
- name: Sample Task | cachecontentgroup | 3
delegate_to: localhost
netscaler.adc.cachecontentgroup:
state: present
name: DELTAJS
relexpiry: 86000
weaknegrelexpiry: 600
insertage: 'NO'
maxressize: 256
memlimit: 1
pinned: 'YES'
- name: Sample Task | cachecontentgroup | 4
delegate_to: localhost
netscaler.adc.cachecontentgroup:
state: present
name: NSFEO
maxressize: 1994752
host:
description:
- Flush only objects that belong to the specified host. Do not use except with parameterized
invalidation. Also, the Invalidation Restricted to Host parameter for the group
must be set to YES.
type: str
name:
description:
- Name for the content group. Must begin with an ASCII alphabetic or underscore (_)
character, and must contain only ASCII alphanumeric, underscore, hash (#), period
(.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be
changed after the content group is created.
type: str
nsip:
description:
- The ip address of the NetScaler ADC appliance where the nitro API calls will be
made.
- The port can be specified with the colon (:). E.g. 192.168.1.1:555.
required: true
type: str
type:
choices:
- HTTP
- MYSQL
- MSSQL
description:
- The type of the content group.
type: str
query:
description:
- Query string specifying individual objects to flush from this group by using parameterized
invalidation. If this parameter is not set, all objects are flushed from the group.
type: str
state:
choices:
- present
- absent
- flushed
- unset
default: present
description:
- The state of the resource being configured by the module on the NetScaler ADC node.
- When C(present), the resource will be added/updated configured according to the
module's parameters.
- When C(absent), the resource will be deleted from the NetScaler ADC node.
- When C(flushed), the resource will be flushed on the NetScaler ADC node.
- When C(unset), the resource will be unset on the NetScaler ADC node.
type: str
pinned:
choices:
- 'YES'
- 'NO'
description:
- Do not flush objects from this content group under memory pressure.
type: str
minhits:
description:
- Number of hits that qualifies a response for storage in this content group.
type: int
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
memlimit:
description:
- Maximum amount of memory that the cache can use. The effective limit is based on
the available memory of the Citrix ADC.
type: float
prefetch:
choices:
- 'YES'
- 'NO'
description:
- Attempt to refresh objects that are about to go stale.
type: str
absexpiry:
description:
- 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 command: add cache contentgroup <contentgroup name>
-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 <contentgroup name> -absexpiry
10:00 15:00 18:00 23:00'
elements: str
type: list
hitparams:
description:
- Parameters to use for parameterized hit evaluation of an object. Up to 128 parameters
can be specified. Mutually exclusive with the Hit Selector parameter.
elements: str
type: list
insertage:
choices:
- 'YES'
- 'NO'
description:
- 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.
type: str
insertvia:
choices:
- 'YES'
- 'NO'
description:
- Insert a Via header into the response.
type: str
persistha:
choices:
- 'YES'
- 'NO'
description:
- Setting persistHA to C(YES) causes IC to save objects in contentgroup to Secondary
node in HA deployment.
type: str
relexpiry:
description:
- Relative expiry time, in seconds, after which to expire an object cached in this
content group.
type: float
flashcache:
choices:
- 'YES'
- 'NO'
description:
- Perform flash cache. Mutually exclusive with Poll Every Time (PET) on the same content
group.
type: str
insertetag:
choices:
- 'YES'
- 'NO'
description:
- Insert an ETag header in the response. With ETag header insertion, the integrated
cache does not serve full responses on repeat requests.
type: str
maxressize:
description:
- Maximum size of a response that can be cached in this content group.
type: float
minressize:
description:
- Minimum size of a response that can be cached in this content group.
- ' Default minimum response size is 0.'
type: float
nitro_pass:
description:
- The password with which to authenticate to the NetScaler ADC node.
required: false
type: str
nitro_user:
description:
- The username with which to authenticate to the NetScaler ADC node.
required: false
type: str
hitselector:
description:
- Selector for evaluating whether an object gets stored in a particular content group.
A selector is an abstraction for a collection of PIXL expressions.
type: str
invalparams:
description:
- Parameters for parameterized invalidation of an object. You can specify up to 8
parameters. Mutually exclusive with invalSelector.
elements: str
type: list
save_config:
default: false
description:
- If C(true) the module will save the configuration on the NetScaler ADC node if it
makes any changes.
- The module will not save the configuration on the NetScaler ADC node if it made
no changes.
type: bool
tosecondary:
choices:
- 'YES'
- 'NO'
description:
- content group whose objects are to be sent to secondary.
type: str
absexpirygmt:
description:
- Coordinated Universal Time (GMT), up to 4 times a day, when all objects in the content
group must expire.
elements: str
type: list
cachecontrol:
description:
- Insert a Cache-Control header into the response.
type: str
matchcookies:
choices:
- 'YES'
- 'NO'
description:
- Evaluate for parameters in the cookie header also.
type: str
invalselector:
description:
- Selector for invalidating objects in the content group. A selector is an abstraction
for a collection of PIXL expressions.
type: str
polleverytime:
choices:
- 'YES'
- 'NO'
description:
- Always poll for the objects in this content group. That is, retrieve the objects
from the origin server whenever they are requested.
type: str
removecookies:
choices:
- 'YES'
- 'NO'
description:
- Remove cookies from responses.
type: str
selectorvalue:
description:
- Value of the selector to be used for flushing objects from the content group. Requires
that an invalidation selector be configured for the content group.
type: str
lazydnsresolve:
choices:
- 'YES'
- 'NO'
description:
- 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.
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
prefetchperiod:
description:
- Time period, in seconds before an object's calculated expiry time, during which
to attempt prefetch.
type: float
quickabortsize:
description:
- 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.
type: float
validate_certs:
default: true
description:
- If C(false), SSL certificates will not be validated. This should only be used on
personally controlled sites using self-signed certificates.
required: false
type: bool
heurexpiryparam:
description:
- Heuristic expiry time, in percent of the duration, since the object was last modified.
type: float
ignorereloadreq:
choices:
- 'YES'
- 'NO'
description:
- Ignore any request to reload a cached object from the origin server.
- To guard against Denial of Service attacks, set this parameter to C(YES). For RFC-compliant
behavior, set it to C(NO).
type: str
expireatlastbyte:
choices:
- 'YES'
- 'NO'
description:
- 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.
type: str
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
weaknegrelexpiry:
description:
- '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.'
type: float
weakposrelexpiry:
description:
- 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.
type: float
relexpirymillisec:
description:
- Relative expiry time, in milliseconds, after which to expire an object cached in
this content group.
type: float
alwaysevalpolicies:
choices:
- 'YES'
- 'NO'
description:
- Force policy evaluation for each response arriving from the origin server. Cannot
be set to C(YES) if the Prefetch parameter is also set to C(YES).
type: str
prefetchmaxpending:
description:
- Maximum number of outstanding prefetches that can be queued for the content group.
type: float
ignoreparamvaluecase:
choices:
- 'YES'
- 'NO'
description:
- Ignore case when comparing parameter values during parameterized hit evaluation.
(Parameter value case is ignored by default during parameterized invalidation.)
type: str
ignorereqcachinghdrs:
choices:
- 'YES'
- 'NO'
description:
- Ignore Cache-Control and Pragma headers in the incoming request.
type: str
invalrestrictedtohost:
choices:
- 'YES'
- 'NO'
description:
- Take the host header into account during parameterized invalidation.
type: str
prefetchperiodmillisec:
description:
- Time period, in milliseconds before an object's calculated expiry time, during which
to attempt prefetch.
type: float
changed:
description: Indicates if any change is made by the module
returned: always
sample: true
type: bool
diff:
description: Dictionary of before and after changes
returned: always
sample:
after:
key2: pqr
before:
key1: xyz
prepared: changes done
type: dict
diff_list:
description: List of differences between the actual configured object and the configuration
specified in the module
returned: when changed
sample:
- 'Attribute `key1` differs. Desired: (<class ''str''>) XYZ. Existing: (<class ''str''>)
PQR'
type: list
failed:
description: Indicates if the module failed or not
returned: always
sample: false
type: bool
loglines:
description: list of logged messages by the module
returned: always
sample:
- message 1
- message 2
type: list