Try SpotterConfiguration for ICAP profile 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 ICAP profile resource.
uri:
description:
- URI representing icap service. It is a mandatory argument while creating an icapprofile.
type: str
mode:
choices:
- REQMOD
- RESPMOD
description:
- ICAP Mode of operation. It is a mandatory argument while creating an icapprofile.
type: str
name:
description:
- Name for an ICAP profile. Must begin with a letter, number, or the underscore \(_\)
character. Other characters allowed, after the first character, are the hyphen \(-\),
period \(.\), hash \(\#\), space \( \), at \(@\), colon \(:\), and equal \(=\) characters.
The name of a ICAP profile cannot be changed after it is created.
- ''
- 'CLI Users: If the name includes one or more spaces, enclose the name in double
or single quotation marks \(for example, "my icap profile" or ''my icap profile''\).'
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
- 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
preview:
choices:
- ENABLED
- DISABLED
description:
- Enable or Disable preview header with ICAP request. This feature allows an ICAP
server to see the beginning of a transaction, then decide if it wants to opt-out
of the transaction early instead of receiving the remainder of the request message.
type: str
allow204:
choices:
- ENABLED
- DISABLED
description:
- 'Enable or Disable sending Allow: 204 header in ICAP request.'
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
logaction:
description:
- Name of the audit message action which would be evaluated on receiving the ICAP
response to emit the logs.
type: str
useragent:
description:
- ICAP User Agent Header String
type: str
hostheader:
description:
- ICAP Host Header
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
reqtimeout:
description:
- Time, in seconds, within which the remote server should respond to the ICAP-request.
If the Netscaler does not receive full response with this time, the specified request
timeout action is performed. Zero value disables this timeout functionality.
type: float
queryparams:
description:
- 'Query parameters to be included with ICAP request URI. Entered values should be
in arg=value format. For more than one parameters, add & separated values. e.g.:
arg1=val1&arg2=val2.'
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
previewlength:
description:
- Value of Preview Header field. Citrix ADC uses the minimum of this set value and
the preview size received on OPTIONS response.
type: float
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
reqtimeoutaction:
choices:
- BYPASS
- DROP
- RESET
description:
- Name of the action to perform if the Vserver/Server representing the remote service
does not respond with any response within the timeout value configured. The Supported
actions are
- '* C(BYPASS) - This Ignores the remote server response and sends the request/response
to Client/Server.'
- ' * If the ICAP response with Encapsulated headers is not received within
the request-timeout value configured, this Ignores the remote ICAP server response
and sends the Full request/response to Server/Client.'
- '* C(RESET) - Reset the client connection by closing it. The client program, such
as a browser, will handle this and may inform the user. The client may then resend
the request if desired.'
- '* C(DROP) - Drop the request without sending a response to the user.'
type: str
inserthttprequest:
description:
- Exact HTTP request, in the form of an expression, which the Citrix ADC encapsulates
and sends to the ICAP server. If you set this parameter, the ICAP request is sent
using only this header. This can be used when the HTTP header is not available to
send or ICAP server only needs part of the incoming HTTP request. The request expression
is constrained by the feature for which it is used.
- The Citrix ADC does not check the validity of this request. You must manually validate
the request.
type: str
inserticapheaders:
description:
- 'Insert custom ICAP headers in the ICAP request to send to ICAP server. The headers
can be static or can be dynamically constructed using PI Policy Expression. For
example, to send static user agent and Client''s IP address, the expression can
be specified as "User-Agent: NS-ICAP-Client/V1.0\r\nX-Client-IP: "+CLIENT.IP.SRC+"\r\n".'
- The Citrix ADC does not check the validity of the specified header name-value. You
must manually validate the specified header syntax.
type: str
connectionkeepalive:
choices:
- ENABLED
- DISABLED
description:
- If enabled, Citrix ADC keeps the ICAP connection alive after a transaction to reuse
it to send next ICAP request.
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