Try SpotterConfiguration for AppFlow 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 AppFlow action resource.
name:
description:
- Name for the action. Must begin with an ASCII alphabetic or underscore (_) character,
and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space,
colon (:), at (@), equals (=), and hyphen (-) characters.
- ''
- '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 appflow action" or 'my appflow action').
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
comment:
description:
- Any comments about this action. In the CLI, if including spaces between words,
enclose the comment in quotation marks. (The quotation marks are not required in
the configuration utility.)
type: str
newname:
description:
- New name for the AppFlow action. Must begin with an ASCII alphabetic or underscore
(_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period
(.), space, colon (:), at
- (@), equals (=), and hyphen (-) characters.
- ''
- '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 appflow action" or 'my appflow action').
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
ciinsight:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will send the ContentInspection Insight
records to the configured collectors.
type: str
botinsight:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will send the bot insight records to the
configured collectors.
type: str
collectors:
description:
- Name(s) of collector(s) to be associated with the AppFlow action.
elements: str
type: list
metricslog:
description:
- If only the stats records are to be exported, turn on this option.
type: bool
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
webinsight:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will send the webinsight records to the
configured collectors.
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
pagetracking:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will start tracking the page for waterfall
chart by inserting a NS_ESNS cookie in the response.
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
transactionlog:
choices:
- ALL
- ANOMALOUS
description:
- Log C(ANOMALOUS) or C(ALL) transactions
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
videoanalytics:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will send the videoinsight records to the
configured collectors.
type: str
securityinsight:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will send the security insight records to
the configured collectors.
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
distributionalgorithm:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will distribute records among the collectors.
Else, all records will be sent to all the collectors.
type: str
clientsidemeasurements:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will collect the time required to load and
render the mainpage on the client.
type: str
appflowaction_analyticsprofile_binding:
description: Bindings for appflowaction_analyticsprofile_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