Download full document:

mapbmr

Statistics for MAP-T Basic Mapping rule resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeBasic Mapping Rule name.
Minimum length = 1
Maximum length = 127
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
bmrtotv6rxpkts<Double>Read-onlyTotal number of MAP-T BMR V6 Recieved packets.
bmrv6rxpktsrate<Double>Read-onlyRate (/s) counter for bmrtotv6rxpkts
bmrtotv6txpkts<Double>Read-onlyTotal number of MAP-T BMR V6 Transmitted packets.
bmrv6txpktsrate<Double>Read-onlyRate (/s) counter for bmrtotv6txpkts
bmrtotv4rxpkts<Double>Read-onlyTotal number of MAP-T BMR V4 Recieved packets.
bmrv4rxpktsrate<Double>Read-onlyRate (/s) counter for bmrtotv4rxpkts
bmrtotv4txpkts<Double>Read-onlyTotal number of MAP-T BMR V4 Transmitted packets.
bmrv4txpktsrate<Double>Read-onlyRate (/s) counter for bmrtotv4txpkts
bmrtotv6rxpktstcp<Double>Read-onlyTotal number of MAP-T BMR V6 TCP Recieved packets.
bmrv6rxpktstcprate<Double>Read-onlyRate (/s) counter for bmrtotv6rxpktstcp
bmrtotv6txpktstcp<Double>Read-onlyTotal number of MAP-T BMR V6 TCP Transmitted packets.
bmrv6txpktstcprate<Double>Read-onlyRate (/s) counter for bmrtotv6txpktstcp
bmrtotv4rxpktstcp<Double>Read-onlyTotal number of MAP-T BMR V4 TCP Recieved packets.
bmrv4rxpktstcprate<Double>Read-onlyRate (/s) counter for bmrtotv4rxpktstcp
bmrtotv4txpktstcp<Double>Read-onlyTotal number of MAP-T BMR V4 TCP Transmitted packets.
bmrv4txpktstcprate<Double>Read-onlyRate (/s) counter for bmrtotv4txpktstcp
bmrtotv6rxpktsudp<Double>Read-onlyTotal number of MAP-T BMR V6 UDP Recieved packets.
bmrv6rxpktsudprate<Double>Read-onlyRate (/s) counter for bmrtotv6rxpktsudp
bmrtotv6txpktsudp<Double>Read-onlyTotal number of MAP-T BMR V6 UDP Transmitted packets.
bmrv6txpktsudprate<Double>Read-onlyRate (/s) counter for bmrtotv6txpktsudp
bmrtotv4rxpktsudp<Double>Read-onlyTotal number of MAP-T BMR V4 UDP Recieved packets.
bmrv4rxpktsudprate<Double>Read-onlyRate (/s) counter for bmrtotv4rxpktsudp
bmrtotv4txpktsudp<Double>Read-onlyTotal number of MAP-T BMR V4 UDP Transmitted packets.
bmrv4txpktsudprate<Double>Read-onlyRate (/s) counter for bmrtotv4txpktsudp
bmrtotv6rxpktsicmp<Double>Read-onlyTotal number of MAP-T BMR V6 ICMP Recieved packets.
bmrv6rxpktsicmprate<Double>Read-onlyRate (/s) counter for bmrtotv6rxpktsicmp
bmrtotv6txpktsicmp<Double>Read-onlyTotal number of MAP-T BMR V6 ICMP Transmitted packets.
bmrv6txpktsicmprate<Double>Read-onlyRate (/s) counter for bmrtotv6txpktsicmp
bmrtotv4rxpktsicmp<Double>Read-onlyTotal number of MAP-T BMR V4 ICMP Recieved packets.
bmrv4rxpktsicmprate<Double>Read-onlyRate (/s) counter for bmrtotv4rxpktsicmp
bmrtotv4txpktsicmp<Double>Read-onlyTotal number of MAP-T BMR V4 ICMP Transmitted packets.
bmrv4txpktsicmprate<Double>Read-onlyRate (/s) counter for bmrtotv4txpktsicmp

Operations

(click to see Properties)

GET (ALL)| GET

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 redand placeholder content is marked in <green>.

get (all)

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

Query-parameters:

args

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

Use this query-parameter to get mapbmr 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:

{ "mapbmr": [ {
"name":<String_value>,
"bmrv6rxpktsrate":<Double_value>,
"bmrv4rxpktsudprate":<Double_value>,
"bmrtotv6txpkts":<Double_value>,
"bmrv6rxpktsudprate":<Double_value>,
"bmrtotv6txpktsicmp":<Double_value>,
"bmrtotv4rxpktsudp":<Double_value>,
"bmrv6txpktsudprate":<Double_value>,
"bmrv4txpktsicmprate":<Double_value>,
"bmrtotv6rxpkts":<Double_value>,
"bmrv4txpktsrate":<Double_value>,
"bmrtotv4rxpkts":<Double_value>,
"bmrv4txpktstcprate":<Double_value>,
"bmrv4rxpktsicmprate":<Double_value>,
"bmrv4rxpktstcprate":<Double_value>,
"bmrv6txpktsicmprate":<Double_value>,
"bmrv6txpktstcprate":<Double_value>,
"bmrtotv6rxpktsicmp":<Double_value>,
"bmrtotv6txpktsudp":<Double_value>,
"bmrv6rxpktstcprate":<Double_value>,
"bmrtotv4txpktsicmp":<Double_value>,
"bmrtotv4txpktstcp":<Double_value>,
"bmrtotv4rxpktsicmp":<Double_value>,
"bmrv6txpktsrate":<Double_value>,
"bmrtotv4txpktsudp":<Double_value>,
"bmrtotv4rxpktstcp":<Double_value>,
"bmrtotv4txpkts":<Double_value>,
"bmrv4txpktsudprate":<Double_value>,
"bmrtotv6rxpktsudp":<Double_value>,
"bmrtotv6txpktstcp":<Double_value>,
"bmrtotv6rxpktstcp":<Double_value>,
"bmrv4rxpktsrate":<Double_value>,
"bmrv6rxpktsicmprate":<Double_value>
}]}

get

URL:http://<netscaler-ip-address>/nitro/v1/stat/mapbmr/name_value><String>

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:

{ "mapbmr": [ {
"name":<String_value>,
"bmrv6rxpktsrate":<Double_value>,
"bmrv4rxpktsudprate":<Double_value>,
"bmrtotv6txpkts":<Double_value>,
"bmrv6rxpktsudprate":<Double_value>,
"bmrtotv6txpktsicmp":<Double_value>,
"bmrtotv4rxpktsudp":<Double_value>,
"bmrv6txpktsudprate":<Double_value>,
"bmrv4txpktsicmprate":<Double_value>,
"bmrtotv6rxpkts":<Double_value>,
"bmrv4txpktsrate":<Double_value>,
"bmrtotv4rxpkts":<Double_value>,
"bmrv4txpktstcprate":<Double_value>,
"bmrv4rxpktsicmprate":<Double_value>,
"bmrv4rxpktstcprate":<Double_value>,
"bmrv6txpktsicmprate":<Double_value>,
"bmrv6txpktstcprate":<Double_value>,
"bmrtotv6rxpktsicmp":<Double_value>,
"bmrtotv6txpktsudp":<Double_value>,
"bmrv6rxpktstcprate":<Double_value>,
"bmrtotv4txpktsicmp":<Double_value>,
"bmrtotv4txpktstcp":<Double_value>,
"bmrtotv4rxpktsicmp":<Double_value>,
"bmrv6txpktsrate":<Double_value>,
"bmrtotv4txpktsudp":<Double_value>,
"bmrtotv4rxpktstcp":<Double_value>,
"bmrtotv4txpkts":<Double_value>,
"bmrv4txpktsudprate":<Double_value>,
"bmrtotv6rxpktsudp":<Double_value>,
"bmrtotv6txpktstcp":<Double_value>,
"bmrtotv6rxpktstcp":<Double_value>,
"bmrv4rxpktsrate":<Double_value>,
"bmrv6rxpktsicmprate":<Double_value>
}]}