netscaler / netscaler.adc / 2.5.1 / module / cacheobject Configuration for cache object resource. | "added in version" 2.0.0 of netscaler.adc" Authors: Sumanth Lingappa (@sumanth-lingappa) preview | supported by communitynetscaler.adc.cacheobject (2.5.1) — module
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections: - name: netscaler.adc version: 2.5.1
Configuration for cache object resource.
url: description: - URL of the particular object whose details is required. Parameter "host" must be specified along with the URL. type: str host: description: - Host name of the object. Parameter "url" must be specified. 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 port: description: - Host port of the object. You must also set the Host parameter. type: int group: description: - Name of the content group whose objects should be listed. type: str state: choices: - flushed default: present description: - The state of the resource being configured by the module on the NetScaler ADC node. - When C(flushed), the resource will be flushed on the NetScaler ADC node. type: str nodeid: description: - Unique number that identifies the cluster node. type: float locator: description: - ID of the cached object. type: float api_path: default: nitro/v1/config description: - Base NITRO API path. - Define only in case of an ADM service proxy call type: str groupname: description: - Name of the content group to which the object belongs. It will display only the objects belonging to the specified content group. You must also set the Host parameter. type: str httpmethod: choices: - GET - POST description: - HTTP request method that caused the object to be stored. type: str httpstatus: description: - HTTP status of the object. 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 tosecondary: choices: - 'YES' - 'NO' description: - Object will be saved onto Secondary. 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 ignoremarkerobjects: choices: - 'ON' - 'OFF' description: - Ignore marker objects. Marker objects are created when a response exceeds the maximum or minimum response size for the content group or has not yet received the minimum number of hits for the content group. type: str includenotreadyobjects: choices: - 'ON' - 'OFF' description: - Include responses that have not yet reached a minimum number of hits before being cached. type: str
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