netscaler.adc.contentinspectionaction (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 action resource.

Inputs

    
name:
    description:
    - Name of the remote service action. 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

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
    - INLINEINSPECTION
    - MIRROR
    - NOINSPECTION
    description:
    - 'Type of operation this action is going to perform. following actions are available
      to configure:'
    - '* C(ICAP) - forward the incoming request or response to an C(ICAP) server for modification.'
    - '* C(INLINEINSPECTION) - forward the incoming or outgoing packets to IPS server
      for Intrusion Prevention.'
    - '* C(MIRROR) - Forwards cloned packets for Intrusion Detection.'
    - '* C(NOINSPECTION) - This does not forward incoming and outgoing packets to the
      Inspection device.'
    - '* NSTRACE - capture current and further incoming packets on this transaction.'
    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

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 remoteService
    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

servername:
    description:
    - Name of the LB vserver or service
    type: str

serverport:
    description:
    - Port of remoteService
    type: float

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

ifserverdown:
    choices:
    - CONTINUE
    - DROP
    - RESET
    description:
    - 'Name of the action to perform if the Vserver representing the remote service is
      not UP. This is not supported for NOINSPECTION Type. The Supported actions are:'
    - '* 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.'
    - '* C(CONTINUE) - It bypasses the ContentIsnpection and Continues/resumes the Traffic-Flow
      to Client/Server.'
    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

icapprofilename:
    description:
    - Name of the ICAP profile to be attached to the contentInspection action.
    type: str

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