Try SpotterConfiguration for Citrix ADC parameters 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 Citrix ADC parameters resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | nsparam
delegate_to: localhost
netscaler.adc.nsparam:
state: present
timezone: GMT+09:00-KST-Asia/Seoul
cip:
choices:
- ENABLED
- DISABLED
description:
- Enable or disable the insertion of the actual client IP address into the HTTP header
request passed from the client to one, some, or all servers attached to the system.
The passed address can then be accessed through a minor modification to the server.
- '* If the CIP header is specified, it will be used as the client IP header.'
- '* If the CIP header is not specified, the value that has been set will be used
as the client IP header.'
type: str
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
ipttl:
description:
- Set the IP Time to Live (TTL) and Hop Limit value for all outgoing packets from
Citrix ADC.
type: float
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
maxreq:
description:
- Maximum number of requests that the system can pass on a particular connection between
the appliance and a server attached to it. Setting this value to 0 allows an unlimited
number of requests to be passed. This value is overridden by the maximum number
of requests configured on the individual service.
type: float
tcpcip:
choices:
- ENABLED
- DISABLED
description:
- Enable or disable the insertion of the client TCP/IP header in TCP payload passed
from the client to one, some, or all servers attached to the system. The passed
address can then be accessed through a minor modification to the server.
type: str
maxconn:
description:
- Maximum number of connections that will be made from the appliance to the web server(s)
attached to it. The value entered here is applied globally to all attached servers.
type: float
pmtumin:
description:
- Minimum path MTU value that Citrix ADC will process in the ICMP fragmentation needed
message. If the ICMP message contains a value less than this value, then this value
is used instead.
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
httpport:
description:
- HTTP ports on the web server. This allows the system to perform connection off-load
for any client request that has a destination port matching one of these configured
ports.
elements: int
type: list
icaports:
description:
- The ICA ports on the Web server. This allows the system to perform connection off-load
for any
- ' client request that has a destination port matching one of
these configured ports.'
elements: int
type: list
timezone:
description:
- Time zone for the Citrix ADC. Name of the time zone should be specified as argument.
type: str
cipheader:
description:
- Text that will be used as the client IP address header.
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
crportrange:
description:
- Port range for cache redirection services.
type: str
pmtutimeout:
description:
- Interval, in minutes, for flushing the PMTU entries.
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
ftpportrange:
description:
- Minimum and maximum port (port range) that FTP services are allowed to use.
type: str
mgmthttpport:
description:
- This allow the configuration of management HTTP port.
type: int
securecookie:
choices:
- ENABLED
- DISABLED
description:
- Enable or disable secure flag for persistence cookie.
type: str
useproxyport:
choices:
- ENABLED
- DISABLED
description:
- Enable/Disable use_proxy_port setting
type: str
cookieversion:
choices:
- '0'
- '1'
description:
- Version of the cookie inserted by the system.
type: str
mgmthttpsport:
description:
- This allows the configuration of management HTTPS port.
type: int
proxyprotocol:
choices:
- ENABLED
- DISABLED
description:
- Disable/Enable v1 or v2 proxy protocol header for client info insertion
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
secureicaports:
description:
- The Secure ICA ports on the Web server. This allows the system to perform connection
off-load for any
- ' client request that has a destination port matching one of these configured
ports.'
elements: int
type: list
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
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
internaluserlogin:
choices:
- ENABLED
- DISABLED
description:
- Enables/disables the internal user from logging in to the appliance. Before disabling
internal user login, you must have key-based authentication set up on the appliance.
The file name for the key pair must be "ns_comm_key".
type: str
grantquotamaxclient:
description:
- Percentage of shared quota to be granted at a time for maxClient.
type: float
grantquotaspillover:
description:
- Percentage of shared quota to be granted at a time for spillover.
type: float
advancedanalyticsstats:
choices:
- ENABLED
- DISABLED
description:
- Disable/Enable advanace analytics stats
type: str
servicepathingressvlan:
description:
- VLAN on which the subscriber traffic arrives on the appliance.
type: float
exclusivequotamaxclient:
description:
- Percentage of maxClient to be given to PEs.
type: float
exclusivequotaspillover:
description:
- Percentage of maximum limit to be given to PEs.
type: float
aftpallowrandomsourceport:
choices:
- ENABLED
- DISABLED
description:
- Allow the FTP server to come from a random source port for active FTP data connections
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