netscaler.adc.analyticsprofile module – Configuration for Analytics profile resource.

Note

This module is part of the netscaler.adc collection (version 2.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.analyticsprofile.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for Analytics profile resource.

Parameters

Parameter

Comments

allhttpheaders

any

On enabling this option, the Citrix ADC will log all the request and response headers.

Choices:

  • "ENABLED"

  • "DISABLED"

analyticsauthtoken

any

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>.

analyticsendpointcontenttype

any

By default, application/json content-type is used. If this needs to be overridden, specify the value.

analyticsendpointmetadata

any

If the endpoint requires some metadata to be present before the actual json data, specify the same.

analyticsendpointurl

any

The URL at which to upload the analytics data on the endpoint

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

auditlogs

any

This option indicates the whether auditlog should be sent to the REST collector.

Choices:

  • "ENABLED"

  • "DISABLED"

collectors

any

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.

cqareporting

any

On enabling this option, the Citrix ADC will log TCP CQA parameters.

Choices:

  • "ENABLED"

  • "DISABLED"

events

any

This option indicates the whether events should be sent to the REST collector.

Choices:

  • "ENABLED"

  • "DISABLED"

grpcstatus

any

On enabling this option, the Citrix ADC will log the gRPC status headers

Choices:

  • "ENABLED"

  • "DISABLED"

httpauthentication

any

On enabling this option, the Citrix ADC will log Authentication header.

Choices:

  • "ENABLED"

  • "DISABLED"

httpclientsidemeasurements

any

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.

Choices:

  • "ENABLED"

  • "DISABLED"

httpcontenttype

any

On enabling this option, the Citrix ADC will log content-length header.

Choices:

  • "ENABLED"

  • "DISABLED"

httpcookie

any

On enabling this option, the Citrix ADC will log cookie header.

Choices:

  • "ENABLED"

  • "DISABLED"

httpdomainname

any

On enabling this option, the Citrix ADC will log domain name.

Choices:

  • "ENABLED"

  • "DISABLED"

httphost

any

On enabling this option, the Citrix ADC will log the Host header in appflow records

Choices:

  • "ENABLED"

  • "DISABLED"

httplocation

any

On enabling this option, the Citrix ADC will log location header.

Choices:

  • "ENABLED"

  • "DISABLED"

httpmethod

any

On enabling this option, the Citrix ADC will log the method header in appflow records

Choices:

  • "ENABLED"

  • "DISABLED"

httppagetracking

any

On enabling this option, the Citrix ADC will link the embedded objects of a page together.

Choices:

  • "ENABLED"

  • "DISABLED"

httpreferer

any

On enabling this option, the Citrix ADC will log the referer header in appflow records

Choices:

  • "ENABLED"

  • "DISABLED"

httpsetcookie

any

On enabling this option, the Citrix ADC will log set-cookie header.

Choices:

  • "ENABLED"

  • "DISABLED"

httpsetcookie2

any

On enabling this option, the Citrix ADC will log set-cookie2 header.

Choices:

  • "ENABLED"

  • "DISABLED"

httpurl

any

On enabling this option, the Citrix ADC will log the URL in appflow records

Choices:

  • "ENABLED"

  • "DISABLED"

httpurlquery

any

On enabling this option, the Citrix ADC will log URL Query.

Choices:

  • "ENABLED"

  • "DISABLED"

httpuseragent

any

On enabling this option, the Citrix ADC will log User-Agent header.

Choices:

  • "ENABLED"

  • "DISABLED"

httpvia

any

On enabling this option, the Citrix ADC will Via header.

Choices:

  • "ENABLED"

  • "DISABLED"

httpxforwardedforheader

any

On enabling this option, the Citrix ADC will log X-Forwarded-For header.

Choices:

  • "ENABLED"

  • "DISABLED"

integratedcache

any

On enabling this option, the Citrix ADC will log the Integrated Caching appflow records

Choices:

  • "ENABLED"

  • "DISABLED"

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

metrics

any

This option indicates the whether metrics should be sent to the REST collector.

Choices:

  • "ENABLED"

  • "DISABLED"

metricsexportfrequency

any

This option is for configuring the metrics export frequency in seconds, frequency value must be in [30,300] seconds range

name

any

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’).

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

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.

outputmode

any

This option indicates the format of REST API POST body. It depends on the consumer of the analytics data.

Choices:

  • "avro"

  • "prometheus"

  • "influx"

save_config

boolean

If 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.

Choices:

  • false ← (default)

  • true

schemafile

any

This option is for configuring json schema file containing a list of counters to be exported by metricscollector

servemode

any

This option is for setting the mode of how data is provided

Choices:

  • "Push"

  • "Pull"

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

  • "unset"

tcpburstreporting

any

On enabling this option, the Citrix ADC will log TCP burst parameters.

Choices:

  • "ENABLED"

  • "DISABLED"

type

any

This option indicates what information needs to be collected and exported.

Choices:

  • "global"

  • "webinsight"

  • "tcpinsight"

  • "securityinsight"

  • "videoinsight"

  • "hdxinsight"

  • "gatewayinsight"

  • "timeseries"

  • "lsninsight"

  • "botinsight"

  • "CIinsight"

  • "udpinsight"

urlcategory

any

On enabling this option, the Citrix ADC will send the URL category record.

Choices:

  • "ENABLED"

  • "DISABLED"

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

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"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)