Try SpotterConfiguration for videooptimization detectionpolicy 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 videooptimization detectionpolicy resource.
name:
description:
- Name for the videooptimization detection policy. 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.Can be modified, removed or renamed.
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
rule:
description:
- Expression that determines which request or response match the video optimization
detection policy.
- ''
- 'The following requirements apply only to the Citrix ADC CLI:'
- '* If the expression includes one or more spaces, enclose the entire expression
in double quotation marks.'
- '* If the expression itself includes double quotation marks, escape the quotations
by using the \ character.'
- '* Alternatively, you can use single quotation marks to enclose the rule, in which
case you do not have to escape the double quotation marks.'
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
action:
description:
- 'Name of the videooptimization detection action to perform if the request matches
this videooptimization detection policy. Built-in actions should be used. These
are:'
- '* DETECT_CLEARTEXT_PD - Cleartext PD is detected and increment related counters.'
- '* DETECT_CLEARTEXT_ABR - Cleartext ABR is detected and increment related counters.'
- '* DETECT_ENCRYPTED_ABR - Encrypted ABR is detected and increment related counters.'
- '* TRIGGER_ENC_ABR_DETECTION - This is potentially encrypted ABR. Internal traffic
heuristics algorithms will further process traffic to confirm detection.'
- '* TRIGGER_CT_ABR_BODY_DETECTION - This is potentially cleartext ABR. Internal
traffic heuristics algorithms will further process traffic to confirm detection.'
- '* RESET - Reset the client connection by closing it.'
- '* DROP - Drop the connection without sending a response.'
type: str
comment:
description:
- Any type of information about this videooptimization detection policy.
type: str
newname:
description:
- New name for the videooptimization detection policy. Must begin with a letter, number,
or the underscore character (_), and must contain only letters, numbers, and the
hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore
characters.
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
logaction:
description:
- Name of the messagelog action to use for requests that match this policy.
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
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
undefaction:
description:
- Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF
event indicates an internal error condition. Only the above built-in actions can
be used.
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
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
videooptimizationdetectionpolicylabel_videooptimizationdetectionpolicy_binding:
description: Bindings for videooptimizationdetectionpolicylabel_videooptimizationdetectionpolicy_binding
resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
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