netscaler.adc.aaaparameter (2.5.1) — module

Configuration for AAA parameter resource.

| "added in version" 2.0.0 of netscaler.adc"

Authors: Sumanth Lingappa (@sumanth-lingappa)

preview | supported by community

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 AAA parameter resource.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- name: Sample Playbook
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Sample Task | aaaparameter
      delegate_to: localhost
      netscaler.adc.aaaparameter:
        state: present
        maxaaausers: '4294967295'

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

ftmode:
    choices:
    - 'ON'
    - HA
    - 'OFF'
    description:
    - First time user mode determines which configuration options are shown by default
      when logging in to the GUI. This setting is controlled by the GUI.
    type: str

dynaddr:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Set by the DHCP client when the IP address was fetched dynamically.
    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

samesite:
    choices:
    - None
    - LAX
    - STRICT
    description:
    - SameSite attribute value for Cookies generated in AAATM context. This attribute
      value will be appended only for the cookies which are specified in the builtin patset
      ns_cookies_samesite
    type: str

aaadnatip:
    description:
    - Source IP address to use for traffic that is sent to the authentication server.
    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

maxaaausers:
    description:
    - Maximum number of concurrent users allowed to log on to VPN simultaneously.
    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

aaadloglevel:
    choices:
    - EMERGENCY
    - ALERT
    - CRITICAL
    - ERROR
    - WARNING
    - NOTICE
    - INFORMATIONAL
    - DEBUG
    description:
    - AAAD log level, which specifies the types of AAAD events to log in nsvpn.log.
    - 'Available values function as follows:'
    - '* C(EMERGENCY) - Events that indicate an immediate crisis on the server.'
    - '* C(ALERT) - Events that might require action.'
    - '* C(CRITICAL) - Events that indicate an imminent server crisis.'
    - '* C(ERROR) - Events that indicate some type of error.'
    - '* C(WARNING) - Events that require action in the near future.'
    - '* C(NOTICE) - Events that the administrator should know about.'
    - '* C(INFORMATIONAL) - All but low-level events.'
    - '* C(DEBUG) - All events, in extreme detail.'
    type: str

apitokencache:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Option to enable/disable API cache feature.
    type: str

httponlycookie:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Parameter to set/reset HttpOnly Flag for NSC_AAAC/NSC_TMAS cookies in nfactor
    type: str

maxkbquestions:
    description:
    - This will set maximum number of Questions to be asked for KB Validation. Default
      value is 2, Max Value is 6
    type: float

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

defaultauthtype:
    choices:
    - LOCAL
    - LDAP
    - RADIUS
    - TACACS
    - CERT
    description:
    - The default authentication server type.
    type: str

loginencryption:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Parameter to encrypt login information for nFactor flow
    type: str

defaultcspheader:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Parameter to enable/disable default CSP header
    type: str

maxloginattempts:
    description:
    - Maximum Number of login Attempts
    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

aaasessionloglevel:
    choices:
    - EMERGENCY
    - ALERT
    - CRITICAL
    - ERROR
    - WARNING
    - NOTICE
    - INFORMATIONAL
    - DEBUG
    description:
    - Audit log level, which specifies the types of events to log for cli executed commands.
    - 'Available values function as follows:'
    - '* C(EMERGENCY) - Events that indicate an immediate crisis on the server.'
    - '* C(ALERT) - Events that might require action.'
    - '* C(CRITICAL) - Events that indicate an imminent server crisis.'
    - '* C(ERROR) - Events that indicate some type of error.'
    - '* C(WARNING) - Events that require action in the near future.'
    - '* C(NOTICE) - Events that the administrator should know about.'
    - '* C(INFORMATIONAL) - All but low-level events.'
    - '* C(DEBUG) - All events, in extreme detail.'
    type: str

failedlogintimeout:
    description:
    - Number of minutes an account will be locked if user exceeds maximum permissible
      attempts
    type: float

maxsamldeflatesize:
    description:
    - This will set the maximum deflate size in case of SAML Redirect binding.
    type: float

enablesessionstickiness:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Enables/Disables stickiness to authentication servers
    type: str

enablestaticpagecaching:
    choices:
    - 'YES'
    - 'NO'
    description:
    - The default state of VPN Static Page caching. Static Page caching is enabled by
      default.
    type: str

persistentloginattempts:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Persistent storage of unsuccessful user login attempts
    type: str

pwdexpirynotificationdays:
    description:
    - This will set the threshold time in days for password expiry notification. Default
      value is 0, which means no notification is sent
    type: float

enableenhancedauthfeedback:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Enhanced auth feedback provides more information to the end user about the reason
      for an authentication failure.  The default value is set to C(NO).
    type: str

tokenintrospectioninterval:
    description:
    - Frequency at which a token must be verified at the Authorization Server (AS) despite
      being found in cache.
    type: float

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