netscaler.adc.appfwsettings (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 AS settings 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:
    - present
    - 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(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

proxyport:
    description:
    - Proxy Server Port to get updated signatures from AWS.
    type: int

ceflogging:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Enable CEF format logs.
    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

proxyserver:
    description:
    - Proxy Server IP to get updated signatures from AWS.
    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

undefaction:
    description:
    - Profile to use when an application firewall policy evaluates to undefined (UNDEF).
    - An UNDEF event indicates an internal error condition. The APPFW_BLOCK built-in profile
      is the default setting. You can specify a different built-in or user-created profile
      as the UNDEF profile.
    type: str

sessionlimit:
    description:
    - Maximum number of sessions that the application firewall allows to be active, regardless
      of user activity. After the max_limit reaches, No more user session will be created
      .
    type: float

signatureurl:
    description:
    - URL to download the mapping file from server
    type: str

proxypassword:
    description:
    - Password with which proxy user logs on.
    type: str

proxyusername:
    description:
    - Proxy Username
    type: str

defaultprofile:
    description:
    - Profile to use when a connection does not match any policy. Default setting is APPFW_BYPASS,
      which sends unmatched connections back to the Citrix ADC without attempting to filter
      them further.
    type: str

entitydecoding:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Transform multibyte (double- or half-width) characters to single width characters.
    type: str

learnratelimit:
    description:
    - Maximum number of connections per second that the application firewall learning
      engine examines to generate new relaxations for learning-enabled security checks.
      The application firewall drops any connections above this limit from the list of
      connections used by the learning engine.
    type: float

nitro_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Which protocol to use when accessing the nitro API objects.
    type: str

sessiontimeout:
    description:
    - Timeout, in seconds, after which a user session is terminated. Before continuing
      to use the protected web site, the user must establish a new session by opening
      a designated start URL.
    type: float

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

importsizelimit:
    description:
    - Cumulative total maximum number of bytes in web forms imported to a protected web
      site. If a user attempts to upload files with a total byte count higher than the
      specified limit, the application firewall blocks the request.
    type: float

logmalformedreq:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Log requests that are so malformed that application firewall parsing doesn't occur.
    type: str

sessionlifetime:
    description:
    - Maximum amount of time (in seconds) that the application firewall allows a user
      session to remain active, regardless of user activity. After this time, the user
      session is terminated. Before continuing to use the protected web site, the user
      must establish a new session by opening a designated start URL.
    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

sessioncookiename:
    description:
    - Name of the session cookie that the application firewall uses to track user sessions.
    - Must begin with a letter or number, and can consist of from 1 to 31 letters, numbers,
      and the hyphen (-) and underscore (_) symbols.
    - ''
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - If the name includes one or more spaces, enclose the name in double or single quotation
      marks (for example, "my cookie name" or 'my cookie name').
    type: str

geolocationlogging:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Enable Geo-Location Logging in CEF format logs.
    type: str

malformedreqaction:
    choices:
    - none
    - block
    - log
    - stats
    description:
    - flag to define action on malformed requests that application firewall cannot parse
    elements: str
    type: list

centralizedlearning:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Flag used to enable/disable ADM centralized learning
    type: str

signatureautoupdate:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Flag used to enable/disable auto update signatures
    type: str

clientiploggingheader:
    description:
    - Name of an HTTP header that contains the IP address that the client used to connect
      to the protected web site or service.
    type: str

cookiepostencryptprefix:
    description:
    - String that is prepended to all encrypted cookie values.
    type: str

useconfigurablesecretkey:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Use configurable secret key in AppFw operations
    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