Try SpotterConfiguration for Analytics profile 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 Analytics profile resource.
name:
description:
- Name for the analytics profile. 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 profile" or 'my appflow 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
type:
choices:
- global
- webinsight
- tcpinsight
- securityinsight
- videoinsight
- hdxinsight
- gatewayinsight
- timeseries
- lsninsight
- botinsight
- CIinsight
- udpinsight
description:
- This option indicates what information needs to be collected and exported.
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
events:
choices:
- ENABLED
- DISABLED
description:
- This option indicates the whether events should be sent to the REST collector.
type: str
httpurl:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log the URL in appflow records
type: str
httpvia:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will Via header.
type: str
metrics:
choices:
- ENABLED
- DISABLED
description:
- This option indicates the whether metrics should be sent to the REST collector.
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
httphost:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log the Host header in appflow records
type: str
auditlogs:
choices:
- ENABLED
- DISABLED
description:
- This option indicates the whether auditlog should be sent to the REST collector.
type: str
servemode:
choices:
- Push
- Pull
description:
- This option is for setting the mode of how data is provided
type: str
collectors:
description:
- The collector can be an IP, an appflow collector name, a service or a vserver. If
IP is specified, the transport is considered as logstream and default port of 5557
is taken. If collector name is specified, the collector properties are taken from
the configured collector. If service is specified, the configured service is assumed
as the collector. If vserver is specified, the services bound to it are considered
as collectors and the records are load balanced.
type: str
grpcstatus:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log the gRPC status headers
type: str
httpcookie:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log cookie header.
type: str
httpmethod:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log the method header in appflow records
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
outputmode:
choices:
- avro
- prometheus
- influx
description:
- This option indicates the format of REST API POST body. It depends on the consumer
of the analytics data.
type: str
schemafile:
description:
- This option is for configuring json schema file containing a list of counters to
be exported by metricscollector
type: str
httpreferer:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log the referer header in appflow records
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
urlcategory:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will send the URL category record.
type: str
cqareporting:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log TCP CQA parameters.
type: str
httplocation:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log location header.
type: str
httpurlquery:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log URL Query.
type: str
httpsetcookie:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log set-cookie header.
type: str
httpuseragent:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log User-Agent header.
type: str
allhttpheaders:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log all the request and response headers.
type: str
httpdomainname:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log domain name.
type: str
httpsetcookie2:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log set-cookie2 header.
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
httpcontenttype:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log content-length header.
type: str
integratedcache:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log the Integrated Caching appflow
records
type: str
httppagetracking:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will link the embedded objects of a page
together.
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
tcpburstreporting:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log TCP burst parameters.
type: str
analyticsauthtoken:
description:
- Token for authenticating with the endpoint. If the endpoint requires the Authorization
header in a particular format, specify the complete format as the value to this
parameter. For eg., in case of splunk, the Authorizaiton header is required to be
of the form - Splunk <auth-token>.
type: str
httpauthentication:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log Authentication header.
type: str
analyticsendpointurl:
description:
- The URL at which to upload the analytics data on the endpoint
type: str
metricsexportfrequency:
description:
- This option is for configuring the metrics export frequency in seconds, frequency
value must be in [30,300] seconds range
type: float
httpxforwardedforheader:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will log X-Forwarded-For header.
type: str
analyticsendpointmetadata:
description:
- If the endpoint requires some metadata to be present before the actual json data,
specify the same.
type: str
httpclientsidemeasurements:
choices:
- ENABLED
- DISABLED
description:
- On enabling this option, the Citrix ADC will insert a javascript into the HTTP response
to collect the client side page-timings and will send the same to the configured
collectors.
type: str
analyticsendpointcontenttype:
description:
- By default, application/json content-type is used. If this needs to be overridden,
specify the value.
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