netscaler.adc.appfwlearningsettings module – Configuration for learning settings 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.appfwlearningsettings.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for learning settings resource.

Parameters

Parameter

Comments

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

contenttypeautodeploygraceperiod

any

The number of minutes after the threshold hit alert the learned rule will be deployed

contenttypeminthreshold

any

Minimum threshold to learn Content Type information.

contenttypepercentthreshold

any

Minimum threshold in percent to learn Content Type information.

cookieconsistencyautodeploygraceperiod

any

The number of minutes after the threshold hit alert the learned rule will be deployed

cookieconsistencyminthreshold

any

Minimum number of application firewall sessions that the learning engine must observe to learn cookies.

cookieconsistencypercentthreshold

any

Minimum percentage of application firewall sessions that must contain a particular cookie pattern for the learning engine to learn that cookie.

creditcardnumberminthreshold

any

Minimum threshold to learn Credit Card information.

creditcardnumberpercentthreshold

any

Minimum threshold in percent to learn Credit Card information.

crosssitescriptingautodeploygraceperiod

any

The number of minutes after the threshold hit alert the learned rule will be deployed

crosssitescriptingminthreshold

any

Minimum number of application firewall sessions that the learning engine must observe to learn HTML cross-site scripting patterns.

crosssitescriptingpercentthreshold

any

Minimum percentage of application firewall sessions that must contain a particular cross-site scripting pattern for the learning engine to learn that cross-site scripting pattern.

csrftagautodeploygraceperiod

any

The number of minutes after the threshold hit alert the learned rule will be deployed

csrftagminthreshold

any

Minimum number of application firewall sessions that the learning engine must observe to learn cross-site request forgery (CSRF) tags.

csrftagpercentthreshold

any

Minimum percentage of application firewall sessions that must contain a particular CSRF tag for the learning engine to learn that CSRF tag.

fieldconsistencyautodeploygraceperiod

any

The number of minutes after the threshold hit alert the learned rule will be deployed

fieldconsistencyminthreshold

any

Minimum number of application firewall sessions that the learning engine must observe to learn field consistency information.

fieldconsistencypercentthreshold

any

Minimum percentage of application firewall sessions that must contain a particular field consistency pattern for the learning engine to learn that field consistency pattern.

fieldformatautodeploygraceperiod

any

The number of minutes after the threshold hit alert the learned rule will be deployed

fieldformatminthreshold

any

Minimum number of application firewall sessions that the learning engine must observe to learn field formats.

fieldformatpercentthreshold

any

Minimum percentage of application firewall sessions that must contain a particular web form field pattern for the learning engine to recommend a field format for that form field.

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.

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.

profilename

any

Name of the profile.

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

sqlinjectionautodeploygraceperiod

any

The number of minutes after the threshold hit alert the learned rule will be deployed

sqlinjectionminthreshold

any

Minimum number of application firewall sessions that the learning engine must observe to learn HTML SQL injection patterns.

sqlinjectionpercentthreshold

any

Minimum percentage of application firewall sessions that must contain a particular HTML SQL injection pattern for the learning engine to learn that HTML SQL injection pattern.

starturlautodeploygraceperiod

any

The number of minutes after the threshold hit alert the learned rule will be deployed

starturlminthreshold

any

Minimum number of application firewall sessions that the learning engine must observe to learn start URLs.

starturlpercentthreshold

any

Minimum percentage of application firewall sessions that must contain a particular start URL pattern for the learning engine to learn that start URL.

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"

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)

xmlattachmentminthreshold

any

Minimum number of application firewall sessions that the learning engine must observe to learn XML attachment patterns.

xmlattachmentpercentthreshold

any

Minimum percentage of application firewall sessions that must contain a particular XML attachment pattern for the learning engine to learn that XML attachment pattern.

xmlwsiminthreshold

any

Minimum number of application firewall sessions that the learning engine must observe to learn web services interoperability (WSI) information.

xmlwsipercentthreshold

any

Minimum percentage of application firewall sessions that must contain a particular pattern for the learning engine to learn a web services interoperability (WSI) pattern.

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)