netscaler.adc.l2param (2.5.1) — module

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1

Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for Layer 2 related parameter resource.

Inputs

    
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

api_path:
    default: nitro/v1/config
    description:
    - Base NITRO API path.
    - Define only in case of an ADM service proxy call
    type: str

proxyarp:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Proxies the ARP as Citrix ADC MAC for FreeBSD.
    type: str

usemymac:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Use Citrix ADC MAC for all outgoing packets.
    type: str

garpreply:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Set/reset REPLY form of GARP
    type: str

bdgsetting:
    choices:
    - ENABLED
    - DISABLED
    description:
    - 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.
    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

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

rstintfonhafo:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable the reset interface upon HA failover.
    type: str

bdggrpproxyarp:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Set/reset proxy ARP in bridge group deployment
    type: str

garponvridintf:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Send GARP messagess on VRID-configured interfaces upon failover
    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

macmodefwdmypkt:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Allows MAC mode vserver to pick and forward the packets even if it is destined to
      Citrix ADC owned VIP.
    type: str

mbfinstlearning:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable instant learning of MAC changes in MBF mode.
    type: str

bridgeagetimeout:
    description:
    - 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.
    type: float

mbfpeermacupdate:
    description:
    - When mbf_instant_learning is enabled, learn any changes in peer's MAC after this
      time interval, which is in 10ms ticks.
    type: float

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

stopmacmoveupdate:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Stop Update of server mac change to NAT sessions.
    type: str

maxbridgecollision:
    description:
    - Maximum bridge collision for loop detection
    type: float

returntoethernetsender:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Return to ethernet sender.
    type: str

skipproxyingbsdtraffic:
    choices:
    - ENABLED
    - DISABLED
    description:
    - 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.
    type: str

usenetprofilebsdtraffic:
    choices:
    - ENABLED
    - DISABLED
    description:
    - 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.
    type: str

Outputs

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