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

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for learning data 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"

as_scan_location_sql

string

Location of sql injection exception - form field, header or cookie.

Choices:

  • "FORMFIELD"

  • "HEADER"

  • "COOKIE"

as_scan_location_xss

string

Location of cross-site scripting exception - form field, header, cookie or url.

Choices:

  • "FORMFIELD"

  • "HEADER"

  • "COOKIE"

  • "URL"

as_value_expr_sql

string

SQL value expressions consistituting expressions for Keyword, SpecialString or Wildchar.

as_value_expr_xss

string

XSS value expressions consistituting expressions for Tag, Attribute or Pattern.

as_value_type_sql

string

SQL value type. Keyword, SpecialString or Wildchar

Choices:

  • "Keyword"

  • "SpecialString"

  • "Wildchar"

as_value_type_xss

string

XSS value type. (Tag | Attribute | Pattern)

Choices:

  • "Tag"

  • "Attribute"

  • "Pattern"

contenttype

string

Content Type Name.

cookieconsistency

string

Cookie Name.

creditcardnumber

string

The object expression that is to be excluded from safe commerce check.

creditcardnumberurl

string

The url for which the list of credit card numbers are needed to be bypassed from inspection

crosssitescripting

string

Cross-site scripting.

csrfformoriginurl

string

CSRF Form Origin URL.

csrftag

string

CSRF Form Action URL

fieldconsistency

string

Form field name.

fieldformat

string

Field format name.

formactionurl_ff

string

Form action URL.

formactionurl_ffc

string

Form action URL.

formactionurl_sql

string

Form action URL.

formactionurl_xss

string

Form action URL.

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

string

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

securitycheck

string

Name of the security check.

Choices:

  • "startURL"

  • "cookieConsistency"

  • "fieldConsistency"

  • "crossSiteScripting"

  • "SQLInjection"

  • "fieldFormat"

  • "CSRFtag"

  • "XMLDoSCheck"

  • "XMLWSICheck"

  • "XMLAttachmentCheck"

  • "TotalXMLRequests"

  • "creditCardNumber"

  • "ContentType"

sqlinjection

string

Form field name.

starturl

string

Start URL configuration.

state

string

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

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

Choices:

  • "absent"

Default: "present"

target

string

Target filename for data to be exported.

totalxmlrequests

boolean

Total XML requests.

Choices:

  • false

  • true

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)

xmlattachmentcheck

string

XML Attachment Content-Type.

xmldoscheck

string

XML Denial of Service check, one of

MaxAttributes

MaxAttributeNameLength

MaxAttributeValueLength

MaxElementNameLength

MaxFileSize

MinFileSize

MaxCDATALength

MaxElements

MaxElementDepth

MaxElementChildren

NumDTDs

NumProcessingInstructions

NumExternalEntities

MaxEntityExpansions

MaxEntityExpansionDepth

MaxNamespaces

MaxNamespaceUriLength

MaxSOAPArraySize

MaxSOAPArrayRank

xmlwsicheck

string

Web Services Interoperability Rule ID.

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)