Try SpotterConfiguration for AppQoS action resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for AppQoS action resource.
name:
description:
- Name for the AppQoE action. Must begin with a letter, number, or the underscore
symbol (_). Other characters allowed, after the first character, are the hyphen
(-), period (.) hash (#), space ( ), at (@), equals (=), and colon (:) characters.
This is a mandatory argument
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
delay:
description:
- Delay threshold, in microseconds, for requests that match the policy's rule. If
the delay statistics gathered for the matching request exceed the specified delay,
configured action triggered for that request, if there is no action then requests
are dropped to the lowest priority level
type: float
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
maxconn:
description:
- Maximum number of concurrent connections that can be open for requests that matches
with rule.
type: float
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
priority:
choices:
- HIGH
- MEDIUM
- LOW
- LOWEST
description:
- Priority for queuing the request. If server resources are not available for a request
that matches the configured rule, this option specifies a priority for queuing the
request until the server resources are available again. If priority is not configured
then Lowest priority will be used to queue the request.
type: str
dosaction:
choices:
- SimpleResponse
- HICResponse
description:
- DoS Action to take when vserver will be considered under DoS attack and corresponding
rule matches. Mandatory if AppQoE actions are to be used for DoS attack prevention.
type: str
polqdepth:
description:
- Policy queue depth threshold value. When the policy queue size (number of requests
queued for the policy binding this action is attached to) increases to the specified
polqDepth value, subsequent requests are dropped to the lowest priority level.
type: float
priqdepth:
description:
- Queue depth threshold value per priorirty level. If the queue size (number of requests
in the queue of that particular priorirty) on the virtual server to which this policy
is bound, increases to the specified qDepth value, subsequent requests are dropped
to the lowest priority level.
type: float
customfile:
description:
- name of the HTML page object to use as the response
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
numretries:
description:
- Retry count
type: float
tcpprofile:
description:
- Bind TCP Profile based on L2/L3/L7 parameters.
type: str
respondwith:
choices:
- ACS
- NS
description:
- 'Responder action to be taken when the threshold is reached. Available settings
function as follows:'
- ' C(ACS) - Serve content from an alternative content service'
- ' Threshold : maxConn or delay'
- ' C(NS) - Serve from the Citrix ADC (built-in response)'
- ' Threshold : maxConn or delay'
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
retryonreset:
choices:
- 'YES'
- 'NO'
description:
- Retry on TCP Reset
type: str
altcontentpath:
description:
- Path to the alternative content service to be used in the ACS
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
retryontimeout:
description:
- Retry on request Timeout(in millisec) upon sending request to backend servers
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
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
altcontentsvcname:
description:
- Name of the alternative content service to be used in the ACS
type: str
dostrigexpression:
description:
- Optional expression to add second level check to trigger DoS actions. Specifically
used for Analytics based DoS response generation
type: str
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