• Blog
  • Ansible community forum
  • Documentation
Ansible Logo
Ansible Collections Documentation
Ansible collections

Collections:

  • Collection Index
    • Collections in the Netscaler Namespace
      • Netscaler.Adc
        • Description
        • Plugin Index

Plugin indexes:

  • Index of all Modules

Reference indexes:

  • Index of all Collection Environment Variables
Ansible collections
  • Collection Index
  • Collections in the Netscaler Namespace
  • Netscaler.Adc
  • netscaler.adc.l2param module – Configuration for Layer 2 related parameter resource.

netscaler.adc.l2param module – Configuration for Layer 2 related parameter resource.

Note

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

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.l2param.

New in netscaler.adc 2.0.0

  • Synopsis

  • Parameters

  • Notes

  • Examples

  • Return Values

Synopsis

  • Configuration for Layer 2 related parameter resource.

Parameters

Parameter

Comments

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

bdggrpproxyarp

any

Set/reset proxy ARP in bridge group deployment

Choices:

  • "ENABLED"

  • "DISABLED"

bdgsetting

any

Bridging settings for C2C behavior. If enabled, each PE will learn MAC entries independently. Otherwise, when L2 mode is ON, learned MAC entries on a PE will be broadcasted to all other PEs.

Choices:

  • "ENABLED"

  • "DISABLED"

bridgeagetimeout

any

Time-out value for the bridge table entries, in seconds. The new value applies only to the entries that are dynamically learned after the new value is set. Previously existing bridge table entries expire after the previously configured time-out value.

garponvridintf

any

Send GARP messagess on VRID-configured interfaces upon failover

Choices:

  • "ENABLED"

  • "DISABLED"

garpreply

any

Set/reset REPLY form of GARP

Choices:

  • "ENABLED"

  • "DISABLED"

macmodefwdmypkt

any

Allows MAC mode vserver to pick and forward the packets even if it is destined to Citrix ADC owned VIP.

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.

maxbridgecollision

any

Maximum bridge collision for loop detection

mbfinstlearning

any

Enable instant learning of MAC changes in MBF mode.

Choices:

  • "ENABLED"

  • "DISABLED"

mbfpeermacupdate

any

When mbf_instant_learning is enabled, learn any changes in peer’s MAC after this time interval, which is in 10ms ticks.

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.

proxyarp

any

Proxies the ARP as Citrix ADC MAC for FreeBSD.

Choices:

  • "ENABLED"

  • "DISABLED"

returntoethernetsender

any

Return to ethernet sender.

Choices:

  • "ENABLED"

  • "DISABLED"

rstintfonhafo

any

Enable the reset interface upon HA failover.

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

skipproxyingbsdtraffic

any

Control source parameters (IP and Port) for FreeBSD initiated traffic. If Enabled, source parameters are retained. Else proxy the source parameters based on next hop.

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"

stopmacmoveupdate

any

Stop Update of server mac change to NAT sessions.

Choices:

  • "ENABLED"

  • "DISABLED"

usemymac

any

Use Citrix ADC MAC for all outgoing packets.

Choices:

  • "ENABLED"

  • "DISABLED"

usenetprofilebsdtraffic

any

Control source parameters (IP and Port) for FreeBSD initiated traffic. If enabled proxy the source parameters based on netprofile source ip. If netprofile does not have ip configured, then it will continue to use NSIP as earlier.

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

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)

Collection links

  • Issue Tracker
  • Repository (Sources)
Previous Next

© Copyright Ansible contributors.