netscaler.adc.l3param module – Configuration for Layer 3 related parameter resource.

Note

This module is part of the netscaler.adc collection (version 2.6.2).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.l3param.

New in netscaler.adc 2.0.0

Synopsis 

Configuration for Layer 3 related parameter resource.

Parameters 

Parameter	Comments
acllogtime string	Parameter to tune acl logging time
allowclasseipv4 string	Enable/Disable IPv4 Class E address clients Choices: `"ENABLED"` `"DISABLED"`
api_path string	Base NITRO API path. Define only in case of an ADM service proxy call Default: `"nitro/v1/config"`
dropdfflag string	Enable dropping the IP DF flag. Choices: `"ENABLED"` `"DISABLED"`
dropipfragments string	Enable dropping of IP fragments. Choices: `"ENABLED"` `"DISABLED"`
dynamicrouting string	Enable/Disable Dynamic routing on partition. This configuration is not applicable to default partition Choices: `"ENABLED"` `"DISABLED"`
externalloopback string	Enable external loopback. Choices: `"ENABLED"` `"DISABLED"`
forwardicmpfragments string	Enable forwarding of ICMP fragments. Choices: `"ENABLED"` `"DISABLED"`
icmpgenratethreshold float	NS generated ICMP pkts per 10ms rate threshold
implicitaclallow string	Do not apply ACLs for internal ports Choices: `"ENABLED"` `"DISABLED"`
implicitpbr string	Enable/Disable Policy Based Routing for control packets Choices: `"ENABLED"` `"DISABLED"`
ipv6dynamicrouting string	Enable/Disable IPv6 Dynamic routing Choices: `"ENABLED"` `"DISABLED"`
managed_netscaler_instance_id string added in netscaler.adc 2.6.0	The ID of the managed NetScaler instance to which NetScaler Console has to configure as a proxy server. Define only in case of an ADM service proxy call
managed_netscaler_instance_ip string added in netscaler.adc 2.6.0	The IP of the managed NetScaler instance to which NetScaler Console has to configure as a proxy server. Define only in case of an ADM service proxy call
managed_netscaler_instance_name string added in netscaler.adc 2.6.0	The name of the managed NetScaler instance to which NetScaler Console has to configure as a proxy server. Define only in case of an ADM service proxy call
managed_netscaler_instance_password string added in netscaler.adc 2.6.0	The password of the managed NetScaler instance. Define only in case of an ADM service proxy call In Settings > Administration > System Configurations > Basic Settings, if you select Prompt Credentials for Instance Login, ensure to configure username and password of a managed instance.
managed_netscaler_instance_username string added in netscaler.adc 2.6.0	The username of the managed NetScaler instance. Define only in case of an ADM service proxy call In Settings > Administration > System Configurations > Basic Settings, if you select Prompt Credentials for Instance Login, ensure to configure username and password of a managed instance.
miproundrobin string	Enable round robin usage of mapped IPs. Choices: `"ENABLED"` `"DISABLED"`
netscaler_console_as_proxy_server boolean added in netscaler.adc 2.6.0	The IP address of the NetScaler ADC appliance acting as a proxy server. Define only in case of an ADM service proxy call Choices: `false` ← (default) `true`
nitro_auth_token string	The authentication token provided by a login operation.
nitro_pass string	The password with which to authenticate to the NetScaler ADC node.
nitro_protocol string	Which protocol to use when accessing the nitro API objects. Choices: `"http"` `"https"` ← (default)
nitro_user string	The username with which to authenticate to the NetScaler ADC node.
nsip string / required	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.
overridernat string	USNIP/USIP settings override RNAT settings for configured service/virtual server traffic.. Choices: `"ENABLED"` `"DISABLED"`
save_config boolean	If `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. Choices: `false` ← (default) `true`
srcnat string	Perform NAT if only the source is in the private network Choices: `"ENABLED"` `"DISABLED"`
state string	The state of the resource being configured by the module on the NetScaler ADC node. When `present`, the resource will be added/updated configured according to the module’s parameters. When `unset`, the resource will be unset on the NetScaler ADC node. Choices: `"present"` ← (default) `"unset"`
tnlpmtuwoconn string	Enable/Disable learning PMTU of IP tunnel when ICMP error does not contain connection information. Choices: `"ENABLED"` `"DISABLED"`
usipserverstraypkt string	Enable detection of stray server side pkts in USIP mode. Choices: `"ENABLED"` `"DISABLED"`
validate_certs boolean	If `false`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Choices: `false` `true` ← (default)

Notes 

Note

For more information on using Ansible to manage NetScaler ADC Network devices see https://www.ansible.com/integrations/networks/citrixadc.

Examples 

---
- name: Sample l3param playbook
  hosts: demo_netscalers
  gather_facts: false
  tasks:
    - name: Configure l3param
      delegate_to: localhost
      netscaler.adc.l3param:
        state: present
        icmperrgenerate: DISABLED

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
changed boolean	Indicates if any change is made by the module Returned: always Sample: `true`
diff dictionary	Dictionary of before and after changes Returned: always Sample: `{"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}`
diff_list list / elements=string	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"]
failed boolean	Indicates if the module failed or not Returned: always Sample: `false`
loglines list / elements=string	list of logged messages by the module Returned: always Sample: `["message 1", "message 2"]`

Authors

Sumanth Lingappa (@sumanth-lingappa)
Shiva Shankar Vaddepally (@shivashankar-vaddepally)

netscaler.adc.l3param module – Configuration for Layer 3 related parameter resource.

Synopsis

Parameters

Notes

Examples

Return Values