ADC NITRO APIs

l2param

August 17, 2023

Contributed by:

Configuration for Layer 2 related parameter resource.

Properties

(click to see Operations )

Name	Permissions	Description
mbfpeermacupdate	Read-write	When mbf_instant_learning is enabled, learn any changes in peer’s MAC after this time interval, which is in 10ms ticks. Default value: 10
maxbridgecollision	Read-write	Maximum bridge collision for loop detection . Default value: 20
bdggrpproxyarp	Read-write	Set/reset proxy ARP in bridge group deployment. Default value: ENABLED Possible values = ENABLED, DISABLED
bdgsetting	Read-write	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. Default value: DISABLED Possible values = ENABLED, DISABLED
garponvridintf	Read-write	Send GARP messagess on VRID-configured interfaces upon failover . Default value: ENABLED Possible values = ENABLED, DISABLED
macmodefwdmypkt	Read-write	Allows MAC mode vserver to pick and forward the packets even if it is destined to Citrix ADC owned VIP. Default value: DISABLED Possible values = ENABLED, DISABLED
usemymac	Read-write	Use Citrix ADC MAC for all outgoing packets. Default value: DISABLED Possible values = ENABLED, DISABLED
proxyarp	Read-write	Proxies the ARP as Citrix ADC MAC for FreeBSD. Default value: ENABLED Possible values = ENABLED, DISABLED
garpreply	Read-write	Set/reset REPLY form of GARP . Default value: DISABLED Possible values = ENABLED, DISABLED
mbfinstlearning	Read-write	Enable instant learning of MAC changes in MBF mode. Default value: DISABLED Possible values = ENABLED, DISABLED
rstintfonhafo	Read-write	Enable the reset interface upon HA failover. Default value: DISABLED Possible values = ENABLED, DISABLED
skipproxyingbsdtraffic	Read-write	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. Default value: DISABLED Possible values = ENABLED, DISABLED
returntoethernetsender	Read-write	Return to ethernet sender. Default value: DISABLED Possible values = ENABLED, DISABLED
stopmacmoveupdate	Read-write	Stop Update of server mac change to NAT sessions. Default value: DISABLED Possible values = ENABLED, DISABLED
bridgeagetimeout	Read-write	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. Default value: 300 Minimum value = 60 Maximum value = 300

Operations

(click to see Properties )

UPDATE
UNSET
GET (ALL)

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:*

Mandatory parameters are marked in red and placeholder content is marked in green

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/l2param

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"l2param":{
      "mbfpeermacupdate":<Double_value>,
      "maxbridgecollision":<Double_value>,
      "bdggrpproxyarp":<String_value>,
      "bdgsetting":<String_value>,
      "garponvridintf":<String_value>,
      "macmodefwdmypkt":<String_value>,
      "usemymac":<String_value>,
      "proxyarp":<String_value>,
      "garpreply":<String_value>,
      "mbfinstlearning":<String_value>,
      "rstintfonhafo":<String_value>,
      "skipproxyingbsdtraffic":<String_value>,
      "returntoethernetsender":<String_value>,
      "stopmacmoveupdate":<String_value>,
      "bridgeagetimeout":<Double_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/l2param? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"l2param":{
      "mbfpeermacupdate":true,
      "maxbridgecollision":true,
      "bdggrpproxyarp":true,
      "bdgsetting":true,
      "garponvridintf":true,
      "macmodefwdmypkt":true,
      "usemymac":true,
      "proxyarp":true,
      "garpreply":true,
      "mbfinstlearning":true,
      "rstintfonhafo":true,
      "skipproxyingbsdtraffic":true,
      "returntoethernetsender":true,
      "stopmacmoveupdate":true,
      "bridgeagetimeout":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/l2param

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "l2param": [ {
      "maxbridgecollision":<Double_value>,
      "mbfpeermacupdate":<Double_value>,
      "bdggrpproxyarp":<String_value>,
      "bdgsetting":<String_value>,
      "garponvridintf":<String_value>,
      "macmodefwdmypkt":<String_value>,
      "usemymac":<String_value>,
      "proxyarp":<String_value>,
      "garpreply":<String_value>,
      "mbfinstlearning":<String_value>,
      "rstintfonhafo":<String_value>,
      "skipproxyingbsdtraffic":<String_value>,
      "returntoethernetsender":<String_value>,
      "stopmacmoveupdate":<String_value>,
      "bridgeagetimeout":<Double_value>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

l2param

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

l2param

Properties

Operations

update

unset

get (all)

In this article