Citrix ADC 12.1 NITRO API Reference

mapbmr

August 17, 2023

Contributed by:

Statistics for MAP-T Basic Mapping rule resource.

Properties

(click to see Operations)

Name	Permissions	Description
name	Read-write	Basic Mapping Rule name. Minimum length = 1 Maximum length = 127
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
bmrtotv6rxpkts	Read-only	Total number of MAP-T BMR V6 Recieved packets.
bmrv6rxpktsrate	Read-only	Rate (/s) counter for bmrtotv6rxpkts
bmrtotv6txpkts	Read-only	Total number of MAP-T BMR V6 Transmitted packets.
bmrv6txpktsrate	Read-only	Rate (/s) counter for bmrtotv6txpkts
bmrtotv4rxpkts	Read-only	Total number of MAP-T BMR V4 Recieved packets.
bmrv4rxpktsrate	Read-only	Rate (/s) counter for bmrtotv4rxpkts
bmrtotv4txpkts	Read-only	Total number of MAP-T BMR V4 Transmitted packets.
bmrv4txpktsrate	Read-only	Rate (/s) counter for bmrtotv4txpkts
bmrtotv6rxpktstcp	Read-only	Total number of MAP-T BMR V6 TCP Recieved packets.
bmrv6rxpktstcprate	Read-only	Rate (/s) counter for bmrtotv6rxpktstcp
bmrtotv6txpktstcp	Read-only	Total number of MAP-T BMR V6 TCP Transmitted packets.
bmrv6txpktstcprate	Read-only	Rate (/s) counter for bmrtotv6txpktstcp
bmrtotv4rxpktstcp	Read-only	Total number of MAP-T BMR V4 TCP Recieved packets.
bmrv4rxpktstcprate	Read-only	Rate (/s) counter for bmrtotv4rxpktstcp
bmrtotv4txpktstcp	Read-only	Total number of MAP-T BMR V4 TCP Transmitted packets.
bmrv4txpktstcprate	Read-only	Rate (/s) counter for bmrtotv4txpktstcp
bmrtotv6rxpktsudp	Read-only	Total number of MAP-T BMR V6 UDP Recieved packets.
bmrv6rxpktsudprate	Read-only	Rate (/s) counter for bmrtotv6rxpktsudp
bmrtotv6txpktsudp	Read-only	Total number of MAP-T BMR V6 UDP Transmitted packets.
bmrv6txpktsudprate	Read-only	Rate (/s) counter for bmrtotv6txpktsudp
bmrtotv4rxpktsudp	Read-only	Total number of MAP-T BMR V4 UDP Recieved packets.
bmrv4rxpktsudprate	Read-only	Rate (/s) counter for bmrtotv4rxpktsudp
bmrtotv4txpktsudp	Read-only	Total number of MAP-T BMR V4 UDP Transmitted packets.
bmrv4txpktsudprate	Read-only	Rate (/s) counter for bmrtotv4txpktsudp
bmrtotv6rxpktsicmp	Read-only	Total number of MAP-T BMR V6 ICMP Recieved packets.
bmrv6rxpktsicmprate	Read-only	Rate (/s) counter for bmrtotv6rxpktsicmp
bmrtotv6txpktsicmp	Read-only	Total number of MAP-T BMR V6 ICMP Transmitted packets.
bmrv6txpktsicmprate	Read-only	Rate (/s) counter for bmrtotv6txpktsicmp
bmrtotv4rxpktsicmp	Read-only	Total number of MAP-T BMR V4 ICMP Recieved packets.
bmrv4rxpktsicmprate	Read-only	Rate (/s) counter for bmrtotv4rxpktsicmp
bmrtotv4txpktsicmp	Read-only	Total number of MAP-T BMR V4 ICMP Transmitted packets.
bmrv4txpktsicmprate	Read-only	Rate (/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 Citrix ADC appliance, the URL is as follows:

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/mapbmr

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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>
}]}

<!--NeedCopy-->

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/mapbmr/name_value><String>

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

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

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

mapbmr

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

mapbmr

Properties

Operations

get (all)

get

In this article