l2param
Configuration for Layer 2 related parameter resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| mbfpeermacupdate | <Double> | Read-write | When mbf_instant_learning is enabled, learn any changes in peers MAC after this time interval, which is in 10ms ticks.<br>Default value: 10 |
| maxbridgecollision | <Double> | Read-write | Maximum bridge collision for loop detection .<br>Default value: 20 |
| bdggrpproxyarp | <String> | Read-write | Set/reset proxy ARP in bridge group deployment.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED |
| bdgsetting | <String> | 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.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| garponvridintf | <String> | Read-write | Send GARP messagess on VRID-configured interfaces upon failover .<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED |
| macmodefwdmypkt | <String> | Read-write | Allows MAC mode vserver to pick and forward the packets even if it is destined to NetScaler owned VIP.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| usemymac | <String> | Read-write | Use Netscaler MAC for all outgoing packets.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| proxyarp | <String> | Read-write | Proxies the ARP as Netscaler MAC for FreeBSD.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED |
| garpreply | <String> | Read-write | Set/reset REPLY form of GARP .<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| mbfinstlearning | <String> | Read-write | Enable instant learning of MAC changes in MBF mode.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| rstintfonhafo | <String> | Read-write | Enable the reset interface upon HA failover.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| skipproxyingbsdtraffic | <String> | 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.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| returntoethernetsender | <String> | Read-write | Return to ethernet sender.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| stopmacmoveupdate | <String> | Read-write | Stop Update of server mac change to NAT sessions.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
Operations
(click to see Properties)
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>
}}
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
}}
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 errorResponse Headers:
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>
}]}