netscaler.adc.contentinspectioncallout (2.5.1) — module

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 Content Inspection callout resource.

Inputs

    
name:
    description:
    - Name for the Content Inspection callout. Not case sensitive. Must begin with an
      ASCII letter or underscore (_) character, and must consist only of ASCII alphanumeric
      or underscore characters. Must not begin with 're' or 'xp' or be a word reserved
      for use as an expression qualifier prefix (such as HTTP) or enumeration value (such
      as ASCII). Must not be the name of an existing named expression, pattern set, dataset,
      stringmap, or callout.
    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:
    - ICAP
    description:
    - 'Type of the Content Inspection callout. It must be one of the following:'
    - '* C(ICAP) - Sends C(ICAP) request to the configured C(ICAP) server.'
    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

comment:
    description:
    - Any comments to preserve information about this Content Inspection callout.
    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

serverip:
    description:
    - IP address of Content Inspection server. Mutually exclusive with the server name
      parameter.
    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

resultexpr:
    description:
    - 'Expression that extracts the callout results from the response sent by the CI callout
      agent. Must be a response based expression, that is, it must begin with ICAP.RES.
      The operations in this expression must match the return type. For example, if you
      configure a return type of TEXT, the result expression must be a text based expression,
      as in the following example: icap.res.header("ISTag")'
    type: str

returntype:
    choices:
    - BOOL
    - NUM
    - TEXT
    description:
    - Type of data that the target callout agent returns in response to the callout.
    - 'Available settings function as follows:'
    - '* C(TEXT) - Treat the returned value as a text string.'
    - '* C(NUM) - Treat the returned value as a number.'
    - '* C(BOOL) - Treat the returned value as a Boolean value.'
    - 'Note: You cannot change the return type after it is set.'
    type: str

servername:
    description:
    - Name of the load balancing or content switching virtual server or service to which
      the Content Inspection request is issued. Mutually exclusive with server IP address
      and port parameters. The service type must be TCP or SSL_TCP. If there are vservers
      and services with the same name, then vserver is selected.
    type: str

serverport:
    description:
    - Port of the Content Inspection server.
    type: float

profilename:
    description:
    - Name of the Content Inspection profile. The type of the configured profile must
      match the type specified using -type argument.
    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

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

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