netscaler.adc.botprofile_tps_binding (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

Binding Resource definition for describing association between botprofile and tps resources

Inputs

    
name:
    description:
    - Name for the profile. Must begin with a letter, number, or the underscore character
      (_), and must contain only letters, numbers, and the hyphen (-), period (.), pound
      (#), space ( ), at (@), equals (=), colon (:), and underscore (_) characters. Cannot
      be changed after the profile is added.
    - ''
    - '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 profile" or 'my 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
    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.
    type: str

bot_tps:
    description:
    - TPS binding. For each type only binding can be configured. To  update the values
      of an existing binding, user has to first unbind that binding, and then needs to
      bind again with new values.
    type: bool

api_path:
    default: nitro/v1/config
    description:
    - Base NITRO API path.
    - Define only in case of an ADM service proxy call
    type: str

threshold:
    description:
    - Maximum number of requests that are allowed from (or to) a IP, Geolocation, URL
      or Host in 1 second time interval.
    type: float

logmessage:
    description:
    - Message to be logged for this binding.
    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

percentage:
    description:
    - Maximum percentage increase in the requests from (or to) a IP, Geolocation, URL
      or Host in 30 minutes interval.
    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

bot_tps_type:
    choices:
    - SOURCE_IP
    - GEOLOCATION
    - REQUEST_URL
    - Host
    description:
    - Type of TPS binding.
    type: str

bot_tps_action:
    choices:
    - NONE
    - LOG
    - DROP
    - REDIRECT
    - RESET
    - MITIGATION
    description:
    - One to more actions to be taken if bot is detected based on this TPS binding. Only
      C(LOG) action can be combined with C(DROP), C(RESET), C(REDIRECT), or MITIGIATION
      action.
    elements: str
    type: list

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

bot_tps_enabled:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Enabled or disabled TPS binding.
    type: str

bot_bind_comment:
    description:
    - Any comments about this binding.
    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