netscaler.adc.appfwlearningdata (2.5.1) — module

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1

Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for learning data resource.

Inputs

    
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

state:
    choices:
    - absent
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    - When C(absent), the resource will be deleted from the NetScaler ADC node.
    type: str

target:
    description:
    - Target filename for data to be exported.
    type: str

csrftag:
    description:
    - CSRF Form Action URL
    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

starturl:
    description:
    - Start URL configuration.
    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

contenttype:
    description:
    - Content Type Name.
    type: str

fieldformat:
    description:
    - Field format name.
    type: str

profilename:
    description:
    - Name of the profile.
    type: str

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

xmldoscheck:
    description:
    - XML Denial of Service check, one of
    - "\tMaxAttributes"
    - "\tMaxAttributeNameLength"
    - "\tMaxAttributeValueLength"
    - "\tMaxElementNameLength"
    - "\tMaxFileSize"
    - "\tMinFileSize"
    - "\tMaxCDATALength"
    - "\tMaxElements"
    - "\tMaxElementDepth"
    - "\tMaxElementChildren"
    - "\tNumDTDs"
    - "\tNumProcessingInstructions"
    - "\tNumExternalEntities"
    - "\tMaxEntityExpansions"
    - "\tMaxEntityExpansionDepth"
    - "\tMaxNamespaces"
    - "\tMaxNamespaceUriLength"
    - "\tMaxSOAPArraySize"
    - "\tMaxSOAPArrayRank"
    type: str

xmlwsicheck:
    description:
    - Web Services Interoperability Rule ID.
    type: str

sqlinjection:
    description:
    - Form field name.
    type: str

securitycheck:
    choices:
    - startURL
    - cookieConsistency
    - fieldConsistency
    - crossSiteScripting
    - SQLInjection
    - fieldFormat
    - CSRFtag
    - XMLDoSCheck
    - XMLWSICheck
    - XMLAttachmentCheck
    - TotalXMLRequests
    - creditCardNumber
    - ContentType
    description:
    - Name of the security check.
    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

creditcardnumber:
    description:
    - The object expression that is to be excluded from safe commerce check.
    type: str

fieldconsistency:
    description:
    - Form field name.
    type: str

formactionurl_ff:
    description:
    - Form action URL.
    type: str

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

totalxmlrequests:
    description:
    - Total XML requests.
    type: bool

as_value_expr_sql:
    description:
    - SQL value expressions consistituting expressions for Keyword, SpecialString or Wildchar.
    type: str

as_value_expr_xss:
    description:
    - XSS value expressions consistituting expressions for Tag, Attribute or Pattern.
    type: str

as_value_type_sql:
    choices:
    - Keyword
    - SpecialString
    - Wildchar
    description:
    - SQL value type. C(Keyword), C(SpecialString) or C(Wildchar)
    type: str

as_value_type_xss:
    choices:
    - Tag
    - Attribute
    - Pattern
    description:
    - XSS value type. (C(Tag) | C(Attribute) | C(Pattern))
    type: str

cookieconsistency:
    description:
    - Cookie Name.
    type: str

csrfformoriginurl:
    description:
    - CSRF Form Origin URL.
    type: str

formactionurl_ffc:
    description:
    - Form action URL.
    type: str

formactionurl_sql:
    description:
    - Form action URL.
    type: str

formactionurl_xss:
    description:
    - Form action URL.
    type: str

crosssitescripting:
    description:
    - Cross-site scripting.
    type: str

xmlattachmentcheck:
    description:
    - XML Attachment Content-Type.
    type: str

creditcardnumberurl:
    description:
    - The url for which the list of credit card numbers are needed to be bypassed from
      inspection
    type: str

as_scan_location_sql:
    choices:
    - FORMFIELD
    - HEADER
    - COOKIE
    description:
    - Location of sql injection exception - form field, header or cookie.
    type: str

as_scan_location_xss:
    choices:
    - FORMFIELD
    - HEADER
    - COOKIE
    - URL
    description:
    - Location of cross-site scripting exception - form field, header, cookie or url.
    type: str

Outputs

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