Try SpotterConfiguration for system config 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 config resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | nsconfig
delegate_to: localhost
netscaler.adc.nsconfig:
state: present
ipaddress: 10.10.10.10
netmask: 255.255.255.0
all:
description:
- Use this option to do saveconfig for all partitions
type: bool
cip:
choices:
- ENABLED
- DISABLED
description:
- The option to control (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.
- l If cipHeader is specified, it will be used as the client IP header.
- l If it is not specified, then the value that has been set by the set ns config
CLI command 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
force:
description:
- Configurations will be cleared without prompting for confirmation.
type: bool
ifnum:
description:
- Interfaces of the appliances that must be bound to the NSVLAN.
elements: str
type: list
level:
choices:
- basic
- extended
- full
description:
- Types of configurations to be cleared.
- '* C(basic): Clears all configurations except the following:'
- ' - NSIP, default route (gateway), static routes, MIPs, and SNIPs'
- ' - Network settings (DG, VLAN, RHI and DNS settings)'
- ' - Cluster settings'
- ' - HA node definitions'
- ' - Feature and mode settings'
- ' - nsroot password'
- '* C(extended): Clears the same configurations as the ''C(basic)'' option. In addition,
it clears the feature and mode settings.'
- '* C(full): Clears all configurations except NSIP, default route, and interface
settings.'
- 'Note: When you clear the configurations through the cluster IP address, by specifying
the level as ''C(full)'', the cluster is deleted and all cluster nodes become standalone
appliances. The ''C(basic)'' and ''C(extended)'' levels are propagated to the cluster
nodes.'
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
config:
description:
- configuration File to be used to find weak passwords, if not specified, running
config is taken as input.
type: str
maxreq:
description:
- The maximum number of requests that the system can pass on a particular connection
between the system and a server attached to it. Setting this value to 0 allows an
unlimited number of requests to be passed.
type: float
nsvlan:
description:
- VLAN (NSVLAN) for the subnet on which the IP address resides.
type: float
tagged:
choices:
- 'YES'
- 'NO'
description:
- Specifies that the interfaces will be added as 802.1q tagged interfaces. Packets
sent on these interface on this VLAN will have an additional 4-byte 802.1q tag which
identifies the VLAN.
- To use 802.1q tagging, the switch connected to the appliance's interfaces must also
be configured for tagging.
type: str
config1:
description:
- Location of the configurations.
type: str
config2:
description:
- Location of the configurations.
type: str
maxconn:
description:
- The maximum number of connections that will be made from the system to the web server(s)
attached to it. The value entered here is applied globally to all attached servers.
type: float
netmask:
description:
- Netmask corresponding to the IP address. This parameter is mandatory to bring up
the appliance.
type: str
outtype:
choices:
- cli
- xml
description:
- Format to display the difference in configurations.
type: str
pmtumin:
description:
- The minimum Path MTU.
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:
- The 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
template:
description:
- File that contains the commands to be compared.
type: bool
timezone:
description:
- Name of the timezone
type: str
cipheader:
description:
- The text that will be used as the client IP header.
type: str
ipaddress:
description:
- IP address of the Citrix ADC. Commonly referred to as NSIP address. This parameter
is mandatory to bring up the appliance.
type: str
rbaconfig:
choices:
- 'YES'
- 'NO'
description:
- RBA configurations and TACACS policies bound to system global will not be cleared
if RBA is set to C(NO).This option is applicable only for BASIC level of clear configuration.Default
is C(YES), which will clear rba configurations.
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:
- The timeout value in minutes.
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:
- Port range configured for FTP services.
type: str
securecookie:
choices:
- ENABLED
- DISABLED
description:
- enable/disable secure flag for persistence cookie
type: str
weakpassword:
description:
- Option to list all weak passwords (not adhering to strong password requirements).
Takes config file as input, if no input specified, running configuration is considered.
Command => query ns config -weakpassword / query ns config -weakpassword /nsconfig/ns.conf
type: bool
cookieversion:
choices:
- '0'
- '1'
description:
- The version of the cookie inserted by system.
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
changedpassword:
description:
- Option to list all passwords changed which would not work when downgraded to older
releases. Takes config file as input, if no input specified, running configuration
is considered. Command => query ns config -changedpassword / query ns config -changedpassword
/nsconfig/ns.conf
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
grantquotamaxclient:
description:
- The percentage of shared quota to be granted at a time for maxClient
type: float
grantquotaspillover:
description:
- The percentage of shared quota to be granted at a time for spillover
type: float
ignoredevicespecific:
description:
- Suppress device specific differences.
type: bool
exclusivequotamaxclient:
description:
- The percentage of maxClient to be given to PEs
type: float
exclusivequotaspillover:
description:
- The percentage of max limit to be given to PEs
type: float
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