bridgetable¶

Configuration for bridge table entry resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
mac	<String>	Read-write	The MAC address of the target.
vxlan	<Double>	Read-write	The VXLAN to which this address is associated. Minimum value = 1 Maximum value = 16777215
vtep	<String>	Read-write	The IP address of the destination VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides. Minimum length = 1
vni	<Double>	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	<Double>	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	<Double>	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	<Double>	Read-write	Unique number that identifies the cluster node. Minimum value = 0 Maximum value = 31
vlan	<Double>	Read-write	VLAN whose entries are to be removed. Minimum value = 1 Maximum value = 4094
ifnum	<String>	Read-write	INTERFACE whose entries are to be removed.
flags	<Double>	Read-only	Display flags,.
type	<String>	Read-only	Whether static or dynamic. Possible values = STATIC, PERMANENT, DYNAMIC
channel	<Double>	Read-only	The Tunnel through which bridge entry is learned.
controlplane	<Boolean>	Read-only	This bridge table entry is populated by a control plane protocol.
__count	<Double>	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>
}}

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>

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

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

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

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>
}]}

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"} ] }