netscaler.adc.appflowparam module – Configuration for AppFlow parameter 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.appflowparam.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for AppFlow parameter resource.

Parameters

Parameter

Comments

aaausername

any

Enable AppFlow AAA Username logging.

Choices:

  • "ENABLED"

  • "DISABLED"

analyticsauthtoken

any

Authentication token to be set by the agent.

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

appnamerefresh

any

Interval, in seconds, at which to send Appnames to the configured collectors. Appname refers to the name of an entity (virtual server, service, or service group) in the Citrix ADC.

auditlogs

any

Enable Auditlogs to be sent to the Telemetry Agent

Choices:

  • "ENABLED"

  • "DISABLED"

cacheinsight

any

Flag to determine whether cache records need to be exported or not. If this flag is true and IC is enabled, cache records are exported instead of L7 HTTP records

Choices:

  • "ENABLED"

  • "DISABLED"

clienttrafficonly

any

Generate AppFlow records for only the traffic from the client.

Choices:

  • "YES"

  • "NO"

connectionchaining

any

Enable connection chaining so that the client server flows of a connection are linked. Also the connection chain ID is propagated across Citrix ADCs, so that in a multi-hop environment the flows belonging to the same logical connection are linked. This id is also logged as part of appflow record

Choices:

  • "ENABLED"

  • "DISABLED"

cqareporting

any

TCP CQA reporting enable/disable knob.

Choices:

  • "ENABLED"

  • "DISABLED"

distributedtracing

any

Enable generation of the distributed tracing templates in the Appflow records

Choices:

  • "ENABLED"

  • "DISABLED"

disttracingsamplingrate

any

Sampling rate for Distributed Tracing

emailaddress

any

Enable AppFlow user email-id logging.

Choices:

  • "ENABLED"

  • "DISABLED"

events

any

Enable Events to be sent to the Telemetry Agent

Choices:

  • "ENABLED"

  • "DISABLED"

flowrecordinterval

any

Interval, in seconds, at which to send flow records to the configured collectors.

gxsessionreporting

any

Enable this option for Gx session reporting

Choices:

  • "ENABLED"

  • "DISABLED"

httpauthorization

any

Include the HTTP Authorization header information.

Choices:

  • "ENABLED"

  • "DISABLED"

httpcontenttype

any

Include the HTTP Content-Type header sent from the server to the client to determine the type of the content sent.

Choices:

  • "ENABLED"

  • "DISABLED"

httpcookie

any

Include the cookie that was in the HTTP request the appliance received from the client.

Choices:

  • "ENABLED"

  • "DISABLED"

httpdomain

any

Include the http domain request to be exported.

Choices:

  • "ENABLED"

  • "DISABLED"

httphost

any

Include the host identified in the HTTP request that the appliance received from the client.

Choices:

  • "ENABLED"

  • "DISABLED"

httplocation

any

Include the HTTP location headers returned from the HTTP responses.

Choices:

  • "ENABLED"

  • "DISABLED"

httpmethod

any

Include the method that was specified in the HTTP request that the appliance received from the client.

Choices:

  • "ENABLED"

  • "DISABLED"

httpquerywithurl

any

Include the HTTP query segment along with the URL that the Citrix ADC received from the client.

Choices:

  • "ENABLED"

  • "DISABLED"

httpreferer

any

Include the web page that was last visited by the client.

Choices:

  • "ENABLED"

  • "DISABLED"

httpsetcookie

any

Include the Set-cookie header sent from the server to the client in response to a HTTP request.

Choices:

  • "ENABLED"

  • "DISABLED"

httpsetcookie2

any

Include the Set-cookie header sent from the server to the client in response to a HTTP request.

Choices:

  • "ENABLED"

  • "DISABLED"

httpurl

any

Include the http URL that the Citrix ADC received from the client.

Choices:

  • "ENABLED"

  • "DISABLED"

httpuseragent

any

Include the client application through which the HTTP request was received by the Citrix ADC.

Choices:

  • "ENABLED"

  • "DISABLED"

httpvia

any

Include the httpVia header which contains the IP address of proxy server through which the client accessed the server.

Choices:

  • "ENABLED"

  • "DISABLED"

httpxforwardedfor

any

Include the httpXForwardedFor header, which contains the original IP Address of the client using a proxy server to access the server.

Choices:

  • "ENABLED"

  • "DISABLED"

identifiername

any

Include the stream identifier name to be exported.

Choices:

  • "ENABLED"

  • "DISABLED"

identifiersessionname

any

Include the stream identifier session name to be exported.

Choices:

  • "ENABLED"

  • "DISABLED"

logstreamovernsip

any

To use the Citrix ADC IP to send Logstream records instead of the SNIP

Choices:

  • "ENABLED"

  • "DISABLED"

lsnlogging

any

On enabling this option, the Citrix ADC will send the Large Scale Nat(LSN) records to the configured collectors.

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

Enable Citrix ADC Stats to be sent to the Telemetry Agent

Choices:

  • "ENABLED"

  • "DISABLED"

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.

observationdomainid

any

An observation domain groups a set of Citrix ADCs based on deployment: cluster, HA etc. A unique Observation Domain ID is required to be assigned to each such group.

observationdomainname

any

Name of the Observation Domain defined by the observation domain ID.

observationpointid

any

An observation point ID is identifier for the NetScaler from which appflow records are being exported. By default, the NetScaler IP is the observation point ID.

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

securityinsightrecordinterval

any

Interval, in seconds, at which to send security insight flow records to the configured collectors.

securityinsighttraffic

any

Enable/disable the feature individually on appflow action.

Choices:

  • "ENABLED"

  • "DISABLED"

skipcacheredirectionhttptransaction

any

Skip Cache http transaction. This HTTP transaction is specific to Cache Redirection module. In Case of Cache Miss there will be another HTTP transaction initiated by the cache server.

Choices:

  • "ENABLED"

  • "DISABLED"

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 unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "unset"

subscriberawareness

any

Enable this option for logging end user MSISDN in L4/L7 appflow records

Choices:

  • "ENABLED"

  • "DISABLED"

subscriberidobfuscation

any

Enable this option for obfuscating MSISDN in L4/L7 appflow records

Choices:

  • "ENABLED"

  • "DISABLED"

subscriberidobfuscationalgo

any

Algorithm(MD5 or SHA256) to be used for obfuscating MSISDN

Choices:

  • "MD5"

  • "SHA256"

tcpattackcounterinterval

any

Interval, in seconds, at which to send tcp attack counters to the configured collectors. If 0 is configured, the record is not sent.

templaterefresh

any

Refresh interval, in seconds, at which to export the template data. Because data transmission is in UDP, the templates must be resent at regular intervals.

timeseriesovernsip

any

To use the Citrix ADC IP to send Time series data such as metrics and events, instead of the SNIP

Choices:

  • "ENABLED"

  • "DISABLED"

udppmtu

any

MTU, in bytes, for IPFIX UDP packets.

urlcategory

any

Include the URL category record.

Choices:

  • "ENABLED"

  • "DISABLED"

usagerecordinterval

any

On enabling this option, the NGS will send bandwidth usage record to configured collectors.

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)

videoinsight

any

Enable/disable the feature individually on appflow action.

Choices:

  • "ENABLED"

  • "DISABLED"

websaasappusagereporting

any

On enabling this option, NGS will send data used by Web/saas app at the end of every HTTP transaction to configured collectors.

Choices:

  • "ENABLED"

  • "DISABLED"

Notes

Note

Examples

---
- name: Sample Playbook
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Sample Task | appflowparam
      delegate_to: localhost
      netscaler.adc.appflowparam:
        state: present
        observationpointid: '2370493962'

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)