netscaler.adc.botsettings (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 Bot engine settings resource.

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

state:
    choices:
    - present
    - 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(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

proxyport:
    description:
    - Proxy Server Port to get updated signatures from AWS.
    type: int

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

proxyserver:
    description:
    - Proxy Server IP to get updated signatures from AWS.
    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

signatureurl:
    description:
    - URL to download the bot signature mapping file from server
    type: str

proxypassword:
    description:
    - Password with which user logs on.
    type: str

proxyusername:
    description:
    - Proxy Username
    type: str

trapurllength:
    description:
    - Length of the auto-generated trap URL.
    type: float

defaultprofile:
    description:
    - Profile to use when a connection does not match any policy. Default setting is "
      ", which sends unmatched connections back to the Citrix ADC without attempting to
      filter them further.
    type: str

javascriptname:
    description:
    - Name of the JavaScript that the Bot Management feature  uses in response.
    - Must begin with a letter or number, and can consist of from 1 to 31 letters, numbers,
      and the hyphen (-) and underscore (_) symbols.
    - ''
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - If the name includes one or more spaces, enclose the name in double or single quotation
      marks (for example, "my cookie name" or 'my cookie name').
    type: str

nitro_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Which protocol to use when accessing the nitro API objects.
    type: str

sessiontimeout:
    description:
    - Timeout, in seconds, after which a user session is terminated.
    type: float

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

dfprequestlimit:
    description:
    - Number of requests to allow without bot session cookie if device fingerprint is
      enabled
    type: float

trapurlinterval:
    description:
    - Time in seconds after which trap URL is updated.
    type: float

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

sessioncookiename:
    description:
    - Name of the SessionCookie that the Bot Management feature uses for tracking.
    - Must begin with a letter or number, and can consist of from 1 to 31 letters, numbers,
      and the hyphen (-) and underscore (_) symbols.
    - ''
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - If the name includes one or more spaces, enclose the name in double or single quotation
      marks (for example, "my cookie name" or 'my cookie name').
    type: str

signatureautoupdate:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Flag used to enable/disable bot auto update signatures
    type: str

trapurlautogenerate:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Enable/disable trap URL auto generation. When enabled, trap URL is updated within
      the configured interval.
    type: str

defaultnonintrusiveprofile:
    choices:
    - BOT_BYPASS
    - BOT_STATS
    - BOT_LOG
    description:
    - Profile to use when the feature is not enabled but feature is licensed. NonIntrusive
      checks will be disabled and IPRep cronjob(24 Hours) will be removed if this is set
      to C(BOT_BYPASS).
    type: str

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