netscaler.adc.cachepolicy (2.5.1) — module

Configuration for Integrated Cache policy resource.

| "added in version" 2.0.0 of netscaler.adc"

Authors: Sumanth Lingappa (@sumanth-lingappa)

preview | supported by community

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1


Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for Integrated Cache policy resource.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- name: Sample Playbook
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Sample Task | cachepolicy
      delegate_to: localhost
      netscaler.adc.cachepolicy:
        state: present
        policyname: _nonGetReq
        rule: '!HTTP.REQ.METHOD.eq(GET)'
        action: NOCACHE
    - name: Sample Task | cachepolicy | 2
      delegate_to: localhost
      netscaler.adc.cachepolicy:
        state: present
        policyname: _cacheableCacheControlRes
        rule: ((HTTP.RES.CACHE_CONTROL.IS_PUBLIC) || (HTTP.RES.CACHE_CONTROL.IS_MAX_AGE)
          || (HTTP.RES.CACHE_CONTROL.IS_MUST_REVALIDATE) || (HTTP.RES.CACHE_CONTROL.IS_PROXY_REVALIDATE)
          || (HTTP.RES.CACHE_CONTROL.IS_S_MAXAGE))
        action: CACHE
        storeingroup: DEFAULT

Inputs

    
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

rule:
    description:
    - Expression against which the traffic is evaluated.
    - 'The following requirements apply only to the Citrix ADC CLI:'
    - '* If the expression includes one or more spaces, enclose the entire expression
      in double quotation marks.'
    - '* If the expression itself includes double quotation marks, escape the quotations
      by using the \ character.'
    - '* Alternatively, you can use single quotation marks to enclose the rule, in which
      case you do not have to escape the double quotation marks.'
    type: str

state:
    choices:
    - present
    - absent
    - 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(unset), the resource will be unset on the NetScaler ADC node.
    type: str

action:
    choices:
    - CACHE
    - NOCACHE
    - MAY_CACHE
    - MAY_NOCACHE
    - INVAL
    description:
    - Action to apply to content that matches the policy.
    - '* C(CACHE) or C(MAY_CACHE) action - positive cachability policy'
    - '* C(NOCACHE) or C(MAY_NOCACHE) action - negative cachability policy'
    - '* C(INVAL) action - Dynamic Invalidation Policy'
    type: str

newname:
    description:
    - New name for the cache policy. 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.
    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

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

policyname:
    description:
    - Name for the policy. 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. Can be changed after the
      policy is created.
    type: str

invalgroups:
    description:
    - Content group(s) to be invalidated when the INVAL action is applied. Maximum number
      of content groups that can be specified is 16.
    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

undefaction:
    choices:
    - NOCACHE
    - RESET
    description:
    - Action to be performed when the result of rule evaluation is undefined.
    type: str

invalobjects:
    description:
    - Content groups(s) in which the objects will be invalidated if the action is INVAL.
    elements: str
    type: list

storeingroup:
    description:
    - Name of the content group in which to store the object when the final result of
      policy evaluation is CACHE. The content group must exist before being mentioned
      here. Use the "show cache contentgroup" command to view the list of existing content
      groups.
    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

cachepolicylabel_cachepolicy_binding:
    description: Bindings for cachepolicylabel_cachepolicy_binding resource
    suboptions:
      binding_members:
        default: []
        description: List of binding members
        elements: dict
        type: list
      mode:
        choices:
        - desired
        - bind
        - unbind
        default: desired
        description:
        - The mode in which to configure the bindings.
        - If mode is set to C(desired), the bindings will be added or removed from the
          target NetScaler ADCs as necessary to match the bindings specified in the state.
        - If mode is set to C(bind), the specified bindings will be added to the resource.
          The existing bindings in the target ADCs will not be modified.
        - If mode is set to C(unbind), the specified bindings will be removed from the
          resource. The existing bindings in the target ADCs will not be modified.
        type: str
    type: dict

Outputs

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