mapdomain
Statistics for MAP-T Map Domain resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name |
|
Read-write | An integer specifying the VLAN identification number (VID). Possible values: 1 through 4094.
Minimum length = 1 Maximum length = 127 |
| clearstats |
|
Read-write | Clear the statsistics / counters.
Possible values = basic, full |
| maptotv6rxpktstcp |
|
Read-only | Total number of MAP-T IPv6 TCP Recieved packets. |
| mapv6rxpktstcprate |
|
Read-only | Rate (/s) counter for maptotv6rxpktstcp |
| maptotv6txpktstcp |
|
Read-only | Total number of MAP-T IPv6 TCP Transmitted packets. |
| mapv6txpktstcprate |
|
Read-only | Rate (/s) counter for maptotv6txpktstcp |
| maptotv6rxbytestcp |
|
Read-only | Total number of MAP-T IPv6 TCP Recieved Bytes. |
| mapv6rxbytestcprate |
|
Read-only | Rate (/s) counter for maptotv6rxbytestcp |
| maptotv6txbytestcp |
|
Read-only | Total number of MAP-T IPv6 TCP Transmitted Bytes. |
| mapv6txbytestcprate |
|
Read-only | Rate (/s) counter for maptotv6txbytestcp |
| maptotv4rxpktstcp |
|
Read-only | Total number of MAP-T IPv4 TCP Recieved packets. |
| mapv4rxpktstcprate |
|
Read-only | Rate (/s) counter for maptotv4rxpktstcp |
| maptotv4txpktstcp |
|
Read-only | Total number of MAP-T IPv4 TCP Transmitted packets. |
| mapv4txpktstcprate |
|
Read-only | Rate (/s) counter for maptotv4txpktstcp |
| maptotv4rxbytestcp |
|
Read-only | Total number of MAP-T IPv4 TCP Recieved Bytes. |
| mapv4rxbytestcprate |
|
Read-only | Rate (/s) counter for maptotv4rxbytestcp |
| maptotv4txbytestcp |
|
Read-only | Total number of MAP-T IPv4 TCP Transmitted Bytes. |
| mapv4txbytestcprate |
|
Read-only | Rate (/s) counter for maptotv4txbytestcp |
| maptotv6rxpktsudp |
|
Read-only | Total number of MAP-T IPv6 UDP Recieved packets. |
| mapv6rxpktsudprate |
|
Read-only | Rate (/s) counter for maptotv6rxpktsudp |
| maptotv6txpktsudp |
|
Read-only | Total number of MAP-T IPv6 UDP Transmitted packets. |
| mapv6txpktsudprate |
|
Read-only | Rate (/s) counter for maptotv6txpktsudp |
| maptotv6rxbytesudp |
|
Read-only | Total number of MAP-T IPv6 UDP Recieved Bytes. |
| mapv6rxbytesudprate |
|
Read-only | Rate (/s) counter for maptotv6rxbytesudp |
| maptotv6txbytesudp |
|
Read-only | Total number of MAP-T IPv6 UDP Transmitted Bytes. |
| mapv6txbytesudprate |
|
Read-only | Rate (/s) counter for maptotv6txbytesudp |
| maptotv4rxpktsudp |
|
Read-only | Total number of MAP-T IPv4 UDP Recieved packets. |
| mapv4rxpktsudprate |
|
Read-only | Rate (/s) counter for maptotv4rxpktsudp |
| maptotv4txpktsudp |
|
Read-only | Total number of MAP-T IPv4 UDP Transmitted packets. |
| mapv4txpktsudprate |
|
Read-only | Rate (/s) counter for maptotv4txpktsudp |
| maptotv4rxbytesudp |
|
Read-only | Total number of MAP-T IPv4 UDP Recieved Bytes. |
| mapv4rxbytesudprate |
|
Read-only | Rate (/s) counter for maptotv4rxbytesudp |
| maptotv4txbytesudp |
|
Read-only | Total number of MAP-T IPv4 UDP Transmitted Bytes. |
| mapv4txbytesudprate |
|
Read-only | Rate (/s) counter for maptotv4txbytesudp |
| maptotv6rxpktsicmp |
|
Read-only | Total number of MAP-T IPv6 ICMP Recieved packets. |
| mapv6rxpktsicmprate |
|
Read-only | Rate (/s) counter for maptotv6rxpktsicmp |
| maptotv6txpktsicmp |
|
Read-only | Total number of MAP-T IPv6 ICMP Transmitted packets. |
| mapv6txpktsicmprate |
|
Read-only | Rate (/s) counter for maptotv6txpktsicmp |
| maptotv6rxbytesicmp |
|
Read-only | Total number of MAP-T IPv6 ICMP Recieved Bytes. |
| mapv6rxbytesicmprate |
|
Read-only | Rate (/s) counter for maptotv6rxbytesicmp |
| maptotv6txbytesicmp |
|
Read-only | Total number of MAP-T IPv6 ICMP Transmitted Bytes. |
| mapv6txbytesicmprate |
|
Read-only | Rate (/s) counter for maptotv6txbytesicmp |
| maptotv4rxpktsicmp |
|
Read-only | Total number of MAP-T IPv4 ICMP Recieved packets. |
| mapv4rxpktsicmprate |
|
Read-only | Rate (/s) counter for maptotv4rxpktsicmp |
| maptotv4txpktsicmp |
|
Read-only | Total number of MAP-T IPv4 ICMP Transmitted packets. |
| mapv4txpktsicmprate |
|
Read-only | Rate (/s) counter for maptotv4txpktsicmp |
| maptotv4rxbytesicmp |
|
Read-only | Total number of MAP-T IPv4 ICMP Recieved Bytes. |
| mapv4rxbytesicmprate |
|
Read-only | Rate (/s) counter for maptotv4rxbytesicmp |
| maptotv4txbytesicmp |
|
Read-only | Total number of MAP-T IPv4 ICMP Transmitted Bytes. |
| mapv4txbytesicmprate |
|
Read-only | Rate (/s) counter for maptotv4txbytesicmp |
| maptotv6rxpkts |
|
Read-only | Total number of MAP-T V6 Recieved packets. |
| mapv6rxpktsrate |
|
Read-only | Rate (/s) counter for maptotv6rxpkts |
| maptotv6txpkts |
|
Read-only | Total number of MAP-T V6 Transmitted packets. |
| mapv6txpktsrate |
|
Read-only | Rate (/s) counter for maptotv6txpkts |
| maptotv4rxpkts |
|
Read-only | Total number of MAP-T V4 Recieved packets. |
| mapv4rxpktsrate |
|
Read-only | Rate (/s) counter for maptotv4rxpkts |
| maptotv4txpkts |
|
Read-only | Total number of MAP-T V4 Transmitted packets. |
| mapv4txpktsrate |
|
Read-only | Rate (/s) counter for maptotv4txpkts |
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
red
and placeholder content is marked in
green
get (all)
URL: http:// <netscaler-ip-address> /nitro/v1/stat/mapdomain Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/stat/mapdomain? 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 mapdomain resources based on additional properties.
attrs http:// <netscaler-ip-address> /nitro/v1/stat/mapdomain? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
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:
{ "mapdomain": [ {
"name":<String_value>,
"mapv6rxpktsrate":<Double_value>,
"mapv6txbytesicmprate":<Double_value>,
"mapv6rxbytesicmprate":<Double_value>,
"maptotv4txbytesudp":<Double_value>,
"mapv4txbytestcprate":<Double_value>,
"mapv4txpktsrate":<Double_value>,
"mapv4rxbytesicmprate":<Double_value>,
"mapv4txbytesudprate":<Double_value>,
"maptotv4txpktstcp":<Double_value>,
"maptotv6txbytestcp":<Double_value>,
"mapv4rxpktsrate":<Double_value>,
"maptotv6txbytesudp":<Double_value>,
"maptotv4rxbytesicmp":<Double_value>,
"maptotv4txpktsicmp":<Double_value>,
"maptotv4rxpktsudp":<Double_value>,
"maptotv6txpkts":<Double_value>,
"maptotv4rxbytestcp":<Double_value>,
"mapv4txbytesicmprate":<Double_value>,
"maptotv6rxbytesudp":<Double_value>,
"maptotv6rxbytestcp":<Double_value>,
"mapv6rxbytestcprate":<Double_value>,
"maptotv6rxpkts":<Double_value>,
"maptotv6rxpktstcp":<Double_value>,
"maptotv4txpktsudp":<Double_value>,
"maptotv6txpktsudp":<Double_value>,
"mapv4rxbytestcprate":<Double_value>,
"mapv4rxpktsicmprate":<Double_value>,
"maptotv4rxpkts":<Double_value>,
"maptotv6rxpktsicmp":<Double_value>,
"maptotv6rxbytesicmp":<Double_value>,
"mapv6rxpktsudprate":<Double_value>,
"maptotv4txbytesicmp":<Double_value>,
"mapv4txpktsicmprate":<Double_value>,
"maptotv6txpktstcp":<Double_value>,
"mapv6txpktsrate":<Double_value>,
"mapv6rxpktsicmprate":<Double_value>,
"maptotv4txpkts":<Double_value>,
"mapv6txpktsudprate":<Double_value>,
"maptotv6txpktsicmp":<Double_value>,
"mapv6txbytestcprate":<Double_value>,
"maptotv4rxpktstcp":<Double_value>,
"mapv4rxpktstcprate":<Double_value>,
"mapv4rxpktsudprate":<Double_value>,
"maptotv4rxpktsicmp":<Double_value>,
"mapv4txpktsudprate":<Double_value>,
"maptotv6txbytesicmp":<Double_value>,
"mapv4txpktstcprate":<Double_value>,
"maptotv6rxpktsudp":<Double_value>,
"maptotv4txbytestcp":<Double_value>,
"maptotv4rxbytesudp":<Double_value>,
"mapv6txpktstcprate":<Double_value>,
"mapv6rxbytesudprate":<Double_value>,
"mapv4rxbytesudprate":<Double_value>,
"mapv6txbytesudprate":<Double_value>,
"mapv6rxpktstcprate":<Double_value>,
"mapv6txpktsicmprate":<Double_value>
}]}
<!--NeedCopy-->
get
URL: http:// <netscaler-ip-address> /nitro/v1/stat/mapdomain/ 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 error
Response Header:
Content-Type:application/json
Response Payload:
{ "mapdomain": [ {
"name":<String_value>,
"mapv6rxpktsrate":<Double_value>,
"mapv6txbytesicmprate":<Double_value>,
"mapv6rxbytesicmprate":<Double_value>,
"maptotv4txbytesudp":<Double_value>,
"mapv4txbytestcprate":<Double_value>,
"mapv4txpktsrate":<Double_value>,
"mapv4rxbytesicmprate":<Double_value>,
"mapv4txbytesudprate":<Double_value>,
"maptotv4txpktstcp":<Double_value>,
"maptotv6txbytestcp":<Double_value>,
"mapv4rxpktsrate":<Double_value>,
"maptotv6txbytesudp":<Double_value>,
"maptotv4rxbytesicmp":<Double_value>,
"maptotv4txpktsicmp":<Double_value>,
"maptotv4rxpktsudp":<Double_value>,
"maptotv6txpkts":<Double_value>,
"maptotv4rxbytestcp":<Double_value>,
"mapv4txbytesicmprate":<Double_value>,
"maptotv6rxbytesudp":<Double_value>,
"maptotv6rxbytestcp":<Double_value>,
"mapv6rxbytestcprate":<Double_value>,
"maptotv6rxpkts":<Double_value>,
"maptotv6rxpktstcp":<Double_value>,
"maptotv4txpktsudp":<Double_value>,
"maptotv6txpktsudp":<Double_value>,
"mapv4rxbytestcprate":<Double_value>,
"mapv4rxpktsicmprate":<Double_value>,
"maptotv4rxpkts":<Double_value>,
"maptotv6rxpktsicmp":<Double_value>,
"maptotv6rxbytesicmp":<Double_value>,
"mapv6rxpktsudprate":<Double_value>,
"maptotv4txbytesicmp":<Double_value>,
"mapv4txpktsicmprate":<Double_value>,
"maptotv6txpktstcp":<Double_value>,
"mapv6txpktsrate":<Double_value>,
"mapv6rxpktsicmprate":<Double_value>,
"maptotv4txpkts":<Double_value>,
"mapv6txpktsudprate":<Double_value>,
"maptotv6txpktsicmp":<Double_value>,
"mapv6txbytestcprate":<Double_value>,
"maptotv4rxpktstcp":<Double_value>,
"mapv4rxpktstcprate":<Double_value>,
"mapv4rxpktsudprate":<Double_value>,
"maptotv4rxpktsicmp":<Double_value>,
"mapv4txpktsudprate":<Double_value>,
"maptotv6txbytesicmp":<Double_value>,
"mapv4txpktstcprate":<Double_value>,
"maptotv6rxpktsudp":<Double_value>,
"maptotv4txbytestcp":<Double_value>,
"maptotv4rxbytesudp":<Double_value>,
"mapv6txpktstcprate":<Double_value>,
"mapv6rxbytesudprate":<Double_value>,
"mapv4rxbytesudprate":<Double_value>,
"mapv6txbytesudprate":<Double_value>,
"mapv6rxpktstcprate":<Double_value>,
"mapv6txpktsicmprate":<Double_value>
}]}
<!--NeedCopy-->