netscaler / netscaler.adc / 2.5.1 / module / streamidentifier Configuration for identifier resource. | "added in version" 2.0.0 of netscaler.adc" Authors: Sumanth Lingappa (@sumanth-lingappa) preview | supported by communitynetscaler.adc.streamidentifier (2.5.1) — module
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections: - name: netscaler.adc version: 2.5.1
Configuration for identifier resource.
name: description: - The name of stream identifier. 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 sort: choices: - REQUESTS - CONNECTIONS - RESPTIME - BANDWIDTH - RESPTIME_BREACHES - NONE description: - 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). 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 api_path: default: nitro/v1/config description: - Base NITRO API path. - Define only in case of an ADM service proxy call type: str interval: description: - 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. type: float snmptrap: choices: - ENABLED - DISABLED description: - Enable/disable SNMP trap for stream identifier type: str appflowlog: choices: - ENABLED - DISABLED description: - Enable/disable Appflow logging for stream identifier 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 samplecount: description: - 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. type: float 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 selectorname: description: - Name of the selector to use with the stream identifier. 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 breachthreshold: description: - Breaching transactions threshold calculated over interval. type: float nitro_auth_token: description: - The authentication token provided by a login operation. type: str version_added: 2.6.0 version_added_collection: netscaler.adc tracktransactions: choices: - RESPTIME - NONE description: - 'Track transactions exceeding configured threshold. Transaction tracking can be enabled for following metric: ResponseTime.' - By default transaction tracking is disabled type: str acceptancethreshold: description: - Non-Breaching transactions to Total transactions threshold expressed in percent. - Maximum of 6 decimal places is supported. type: str trackackonlypackets: choices: - ENABLED - DISABLED description: - Track ack only packets as well. This setting is applicable only when packet rate limiting is being used. type: str maxtransactionthreshold: description: - Maximum per transcation value of metric. Metric to be tracked is specified by tracktransactions attribute. type: float mintransactionthreshold: description: - Minimum per transcation value of metric. Metric to be tracked is specified by tracktransactions attribute. type: float
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