Download full document:

bridge

Statistics for bridge resource.

Properties

(click to see Operations)

Name Data Type PermissionsDescription
clearstats<String>Read-writeClear the statsistics / counters.<br>Possible values = basic, full
tcptotbdgmacmoved<Double>Read-onlyThe number of times bridging registered MAC moved
tcpbdgmacmovedrate<Double>Read-onlyRate (/s) counter for tcptotbdgmacmoved
tcptotbdgcollisions<Double>Read-onlyThe number of bridging table collisions
tcpbdgcollisionsrate<Double>Read-onlyRate (/s) counter for tcptotbdgcollisions
tcperrbdgmuted<Double>Read-onlyThe number of bridging related interface mutes
tcperrbdgmutedrate<Double>Read-onlyRate (/s) counter for tcperrbdgmuted
totbdgpkts<Double>Read-onlyThe total number of bridged packets
bdgpktsrate<Double>Read-onlyRate (/s) counter for totbdgpkts
totbdgmbits<Double>Read-onlyThe total number of bridged Mbits
bdgmbitsrate<Double>Read-onlyRate (/s) counter for totbdgmbits

Operations

(click to see Properties)

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

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/stat/bridge

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/stat/bridge?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

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

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: 

{ "bridge": [ {
      "bdgpktsrate":<Double_value>,
      "totbdgmbits":<Double_value>,
      "bdgmbitsrate":<Double_value>,
      "totbdgpkts":<Double_value>,
      "tcperrbdgmuted":<Double_value>,
      "tcpbdgcollisionsrate":<Double_value>,
      "tcptotbdgcollisions":<Double_value>,
      "tcperrbdgmutedrate":<Double_value>,
      "tcpbdgmacmovedrate":<Double_value>,
      "tcptotbdgmacmoved":<Double_value>
}]}