netscaler.adc.streamidentifier module – Configuration for identifier resource.

Note

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

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

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for identifier resource.

Parameters

Parameter

Comments

acceptancethreshold

string

Non-Breaching transactions to Total transactions threshold expressed in percent.

Maximum of 6 decimal places is supported.

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

appflowlog

string

Enable/disable Appflow logging for stream identifier

Choices:

  • "ENABLED"

  • "DISABLED"

breachthreshold

float

Breaching transactions threshold calculated over interval.

interval

float

Number of minutes of data to use when calculating session statistics (number of requests, bandwidth, and response times). The interval is a moving window that keeps the most recently collected data. Older data is discarded at regular intervals.

log

string

Location where objects collected on the identifier will be logged.

Choices:

  • "SYSLOG"

  • "NONE"

loginterval

float

Time interval in minutes for logging the collected objects.

Log interval should be greater than or equal to the inteval

of the stream identifier.

loglimit

float

Maximum number of objects to be logged in the log interval.

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.

maxtransactionthreshold

float

Maximum per transcation value of metric. Metric to be tracked is specified by tracktransactions attribute.

mintransactionthreshold

float

Minimum per transcation value of metric. Metric to be tracked is specified by tracktransactions attribute.

name

string

The name of stream identifier.

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.

samplecount

float

Size of the sample from which to select a request for evaluation. The smaller the sample count, the more accurate is the statistical data. To evaluate all requests, set the sample count to 1. However, such a low setting can result in excessive consumption of memory and processing resources.

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

selectorname

string

Name of the selector to use with the stream identifier.

snmptrap

string

Enable/disable SNMP trap for stream identifier

Choices:

  • "ENABLED"

  • "DISABLED"

sort

string

Sort stored records by the specified statistics column, in descending order. Performed during data collection, the sorting enables real-time data evaluation through Citrix ADC policies (for example, compression and caching policies) that use functions such as IS_TOP(n).

Choices:

  • "REQUESTS"

  • "CONNECTIONS"

  • "RESPTIME"

  • "BANDWIDTH"

  • "RESPTIME_BREACHES"

  • "NONE"

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"

streamidentifier_analyticsprofile_binding

dictionary

Bindings for streamidentifier_analyticsprofile_binding resource

binding_members

list / elements=dictionary

List of binding members

Default: []

mode

string

The mode in which to configure the bindings.

If mode is set to 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 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 unbind, the specified bindings will be removed from the resource. The existing bindings in the target ADCs will not be modified.

Choices:

  • "desired" ← (default)

  • "bind"

  • "unbind"

trackackonlypackets

string

Track ack only packets as well. This setting is applicable only when packet rate limiting is being used.

Choices:

  • "ENABLED"

  • "DISABLED"

tracktransactions

string

Track transactions exceeding configured threshold. Transaction tracking can be enabled for following metric: ResponseTime.

By default transaction tracking is disabled

Choices:

  • "RESPTIME"

  • "NONE"

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

---
- name: Sample streamidentifier playbook
  hosts: demo_netscalers
  gather_facts: false
  tasks:
    - name: Configure streamidentifier
      delegate_to: localhost
      netscaler.adc.streamidentifier:
        state: present
        name: xyz
        selectorname: insight_sel
        appflowlog: ENABLED
        tracktransactions: RESPTIME
        maxtransactionthreshold: '2'
        mintransactionthreshold: '1'
        acceptancethreshold: '100.000000'

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)

  • Shiva Shankar Vaddepally (@shivashankar-vaddepally)