netscaler.adc.nslimitidentifier (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 limit Indetifier resource.

Inputs

    
mode:
    choices:
    - CONNECTION
    - REQUEST_RATE
    - NONE
    description:
    - Defines the type of traffic to be tracked.
    - '* C(REQUEST_RATE) - Tracks requests/timeslice.'
    - '* C(CONNECTION) - Tracks active transactions.'
    - ''
    - Examples
    - ''
    - '1. To permit 20 requests in 10 ms and 2 traps in 10 ms:'
    - add limitidentifier limit_req -mode request_rate -limitType smooth -timeslice 1000
      -Threshold 2000 -trapsInTimeSlice 200
    - ''
    - '2. To permit 50 requests in 10 ms:'
    - set  limitidentifier limit_req -mode request_rate -timeslice 1000 -Threshold 5000
      -limitType smooth
    - ''
    - '3. To permit 1 request in 40 ms:'
    - set limitidentifier limit_req -mode request_rate -timeslice 2000 -Threshold 50 -limitType
      smooth
    - ''
    - '4. To permit 1 request in 200 ms and 1 trap in 130 ms:'
    - set limitidentifier limit_req -mode request_rate -timeslice 1000 -Threshold 5 -limitType
      smooth -trapsInTimeSlice 8
    - ''
    - '5. To permit 5000 requests in 1000 ms and 200 traps in 1000 ms:'
    - set limitidentifier limit_req  -mode request_rate -timeslice 1000 -Threshold 5000
      -limitType BURSTY
    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

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

limittype:
    choices:
    - BURSTY
    - SMOOTH
    description:
    - Smooth or bursty request type.
    - '* C(SMOOTH) - When you want the permitted number of requests in a given interval
      of time to be spread evenly across the timeslice'
    - '* C(BURSTY) - When you want the permitted number of requests to exhaust the quota
      anytime within the timeslice.'
    - This argument is needed only when the mode is set to REQUEST_RATE.
    type: str

threshold:
    description:
    - Maximum number of requests that are allowed in the given timeslice when requests
      (mode is set as REQUEST_RATE) are tracked per timeslice.
    - When connections (mode is set as CONNECTION) are tracked, it is the total number
      of connections that would be let through.
    type: float

timeslice:
    description:
    - Time interval, in milliseconds, specified in multiples of 10, during which requests
      are tracked to check if they cross the threshold. This argument is needed only when
      the mode is set to REQUEST_RATE.
    type: float

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

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

maxbandwidth:
    description:
    - Maximum bandwidth permitted, in kbps.
    type: float

selectorname:
    description:
    - Name of the rate limit selector. If this argument is NULL, rate limiting will be
      applied on all traffic received by the virtual server or the Citrix ADC (depending
      on whether the limit identifier is bound to a virtual server or globally) without
      any filtering.
    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

limitidentifier:
    description:
    - Name for a rate limit identifier. Must begin with an ASCII letter or underscore
      (_) character, and must consist only of ASCII alphanumeric or underscore characters.
      Reserved words must not be used.
    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

trapsintimeslice:
    description:
    - Number of traps to be sent in the timeslice configured. A value of 0 indicates that
      traps are disabled.
    type: float

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