ADC NITRO APIs

bridgetable

August 17, 2023

Contributed by:

Configuration for bridge table entry resource.

Properties

(click to see Operations )

Name	Permissions	Description
mac	Read-write	The MAC address of the target.
vxlan	Read-write	The VXLAN to which this address is associated. Minimum value = 1 Maximum value = 16777215
vtep	Read-write	The IP address of the destination VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides. Minimum length = 1
vni	Read-write	The VXLAN VNI Network Identifier (or VXLAN Segment ID) to use to connect to the remote VXLAN tunnel endpoint. If omitted the value specified as vxlan will be used. Minimum value = 1 Maximum value = 16777215
devicevlan	Read-write	The vlan on which to send multicast packets when the VXLAN tunnel endpoint is a muticast group address. Minimum value = 1 Maximum value = 4094
bridgeage	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
nodeid	Read-write	Unique number that identifies the cluster node. Minimum value = 0 Maximum value = 31
vlan	Read-write	VLAN whose entries are to be removed. Minimum value = 1 Maximum value = 4094
ifnum	Read-write	INTERFACE whose entries are to be removed.
flags	Read-only	Display flags,.
type	Read-only	Whether static or dynamic. Possible values = STATIC, PERMANENT, DYNAMIC
channel	Read-only	The Tunnel through which bridge entry is learned.
controlplane	Read-only	This bridge table entry is populated by a control plane protocol.
__count	Read-only	count parameter

Operations

(click to see Properties )

ADD
DELETE
UPDATE
UNSET
GET (ALL)
COUNT
CLEAR

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

add

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"bridgetable":{
<b>      "mac":<String_value>,
</b><b>      "vxlan":<Double_value>,
</b><b>      "vtep":<String_value>,
</b>      "vni":<Double_value>,
      "devicevlan":<Double_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

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

delete

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

Query-parameters:

args= mac:<String_value>, vxlan:<Double_value>, vtep: <String_value> ,devicevlan: <Double_value>

</b>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"bridgetable":{
      "bridgeage":<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/bridgetable? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"bridgetable":{
      "bridgeage":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

clear

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"bridgetable":{
      "vlan":<Double_value>,
      "ifnum":<String_value>,
      "vxlan":<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

get (all)

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

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/bridgetable? args=nodeid: <Double_value>

Use this query-parameter to get bridgetable resources based on additional properties.

attrs

http:// <netscaler-ip-address> /nitro/v1/config/bridgetable? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/bridgetable? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of bridgetable resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/bridgetable? view=summary

Use this query-parameter to get the summary output of bridgetable resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/bridgetable? pagesize=#no;pageno=#no

Use this query-parameter to get the bridgetable resources in chunks.

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:

{ "bridgetable": [ {
nodeid:<Double_value>      "bridgeage":<Double_value>,
      "mac":<String_value>,
      "ifnum":<String_value>,
      "vlan":<Double_value>,
      "vxlan":<Double_value>,
      "vtep":<String_value>,
      "vni":<Double_value>,
      "devicevlan":<Double_value>,
      "flags":<Double_value>,
      "type":<String_value>,
      "channel":<Double_value>,
      "controlplane":<Boolean_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/bridgetable? count=yes

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:

{ "bridgetable": [ { "__count": "#no"} ] }

<!--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

bridgetable

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

bridgetable

Properties

Operations

add

delete

update

unset

clear

get (all)

count

In this article