Try SpotterConfiguration for cache parameter 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 cache parameter resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | cacheparameter
delegate_to: localhost
netscaler.adc.cacheparameter:
state: present
via: 'NS-CACHE-10.0: 141'
via:
description:
- String to include in the Via header. A Via header is inserted into all responses
served from a content group if its Insert Via flag is set.
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
state:
choices:
- present
- 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(unset), the resource will be unset on the NetScaler ADC node.
type: str
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:
- Amount of memory available for storing the cache objects. In practice, the amount
of memory available for caching can be less than half the total memory of the Citrix
ADC.
type: float
maxpostlen:
description:
- Maximum number of POST body bytes to consider when evaluating parameters for a content
group for which you have configured hit parameters and invalidation parameters.
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
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
undefaction:
choices:
- NOCACHE
- RESET
description:
- Action to take when a policy cannot be evaluated.
type: str
verifyusing:
choices:
- HOSTNAME
- HOSTNAME_AND_IP
- DNS
description:
- 'Criteria for deciding whether a cached object can be served for an incoming HTTP
request. Available settings function as follows:'
- C(HOSTNAME) - The URL, host name, and host port values in the incoming HTTP request
header must match the cache policy. The IP address and the TCP port of the destination
host are not evaluated. Do not use the C(HOSTNAME) setting unless you are certain
that no rogue client can access a rogue server through the cache.
- C(HOSTNAME_AND_IP) - The URL, host name, host port in the incoming HTTP request
header, and the IP address and TCP port of
- the destination server, must match the cache policy.
- C(DNS) - The URL, host name and host port in the incoming HTTP request, and the
TCP port must match the cache policy. The host name is used for C(DNS) lookup of
the destination server's IP address, and is compared with the set of addresses returned
by the C(DNS) lookup.
type: str
enablebypass:
choices:
- 'YES'
- 'NO'
description:
- Evaluate the request-time policies before attempting hit selection. If set to C(NO),
an incoming request for which a matching object is found in cache storage results
in a response regardless of the policy configuration.
- If the request matches a policy with a NOCACHE action, the request bypasses all
cache processing.
- This parameter does not affect processing of requests that match any invalidation
policy.
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
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
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
enablehaobjpersist:
choices:
- 'YES'
- 'NO'
description:
- The HA object persisting parameter. When this value is set to C(YES), cache objects
can be synced to Secondary in a HA deployment. If set to C(NO), objects will never
be synced to Secondary node.
type: str
prefetchmaxpending:
description:
- Maximum number of outstanding prefetches in the Integrated Cache.
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