Try SpotterConfiguration for system parameter resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for system parameter resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | systemparameter
delegate_to: localhost
netscaler.adc.systemparameter:
state: present
promptstring: '%u@%s'
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
doppler:
choices:
- ENABLED
- DISABLED
description:
- Enable or disable Doppler
type: str
timeout:
description:
- CLI session inactivity timeout, in seconds. If Restrictedtimeout argument is enabled,
Timeout can have values in the range [300-86400] seconds.
- If Restrictedtimeout argument is disabled, Timeout can have values in the range
[0, 10-100000000] seconds. Default value is 900 seconds.
type: float
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
basicauth:
choices:
- ENABLED
- DISABLED
description:
- Enable or disable basic authentication for Nitro API.
type: str
localauth:
choices:
- ENABLED
- DISABLED
description:
- When enabled, local users can access Citrix ADC even when external authentication
is configured. When disabled, local users are not allowed to access the Citrix ADC,
Local users can access the Citrix ADC only when the configured external authentication
servers are unavailable. This parameter is not applicable to SSH Key-based authentication
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
cliloglevel:
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
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
fipsusermode:
choices:
- ENABLED
- DISABLED
description:
- Use this option to set the FIPS mode for key user-land processes. When enabled,
these user-land processes will operate in FIPS mode. In this mode, these processes
will use FIPS 140-2 certified crypto algorithms.
- With a FIPS license, it is enabled by default and cannot be disabled.
- Without a FIPS license, it is disabled by default, wherein these user-land processes
will not operate in FIPS mode.
type: str
promptstring:
description:
- 'String to display at the command-line prompt. Can consist of letters, numbers,
hyphen (-), period (.), hash (#), space ( ), at (@), equal (=), colon (:), underscore
(_), and the following variables:'
- '* %u - Will be replaced by the user name.'
- '* %h - Will be replaced by the hostname of the Citrix ADC.'
- '* %t - Will be replaced by the current time in 12-hour format.'
- '* %T - Will be replaced by the current time in 24-hour format.'
- '* %d - Will be replaced by the current date.'
- '* %s - Will be replaced by the state of the Citrix ADC.'
- ''
- 'Note: The 63-character limit for the length of the string does not apply to the
characters that replace the variables.'
type: str
rbaonresponse:
choices:
- ENABLED
- DISABLED
description:
- Enable or disable Role-Based Authentication (RBA) on responses.
type: str
minpasswordlen:
description:
- Minimum length of system user password. When strong password is enabled default
minimum length is 8. User entered value can be greater than or equal to 8. Default
mininum value is 1 when strong password is disabled. Maximum value is 127 in both
cases.
type: float
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
strongpassword:
choices:
- enableall
- enablelocal
- disabled
description:
- 'After enabling strong password (C(enableall) / C(enablelocal) - not included in
exclude list), all the passwords / sensitive information must have - Atleast 1 Lower
case character, Atleast 1 Upper case character, Atleast 1 numeric character, Atleast
1 special character ( ~, `, !, @, #, $, %, ^, &, *, -, _, =, +, {, }, [, ], |, \,
:, <, >, /, ., ,, " "). Exclude list in case of C(enablelocal) is - NS_FIPS, NS_CRL,
NS_RSAKEY, NS_PKCS12, NS_PKCS8, NS_LDAP, NS_TACACS, NS_TACACSACTION, NS_RADIUS,
NS_RADIUSACTION, NS_ENCRYPTION_PARAMS. So no Strong Password checks will be performed
on these ObjectType commands for C(enablelocal) case.'
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
googleanalytics:
choices:
- ENABLED
- DISABLED
description:
- Enable or disable Google analytics
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
totalauthtimeout:
description:
- Total time a request can take for authentication/authorization
type: float
maxsessionperuser:
description:
- Maximum number of client connection allowed per user.The maxsessionperuser value
ranges from 1 to 40
type: float
restrictedtimeout:
choices:
- ENABLED
- DISABLED
description:
- Enable/Disable the restricted timeout behaviour. When enabled, timeout cannot be
configured beyond admin configured timeout and also it will have the [minimum -
maximum] range check. When disabled, timeout will have the old behaviour. By default
the value is disabled
type: str
natpcbrstontimeout:
choices:
- ENABLED
- DISABLED
description:
- Send a reset signal to client and server connections when their NATPCBs time out.
Avoids the buildup of idle TCP connections on both the sides.
type: str
forcepasswordchange:
choices:
- ENABLED
- DISABLED
description:
- Enable or disable force password change for nsroot user
type: str
removesensitivefiles:
choices:
- ENABLED
- DISABLED
description:
- Use this option to remove the sensitive files from the system like authorise keys,
public keys etc. The commands which will remove sensitive files when this system
paramter is enabled are rm cluster instance, rm cluster node, rm ha node, clear
config full, join cluster and add cluster instance.
type: str
natpcbforceflushlimit:
description:
- Flush the system if the number of Network Address Translation Protocol Control Blocks
(NATPCBs) exceeds this value.
type: float
reauthonauthparamchange:
choices:
- ENABLED
- DISABLED
description:
- Enable or disable External user reauthentication when authentication parameter changes
type: str
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