Skip to content

mapdomain

Statistics for MAP-T Map Domain resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> Read-write An integer specifying the VLAN identification number (VID). Possible values: 1 through 4094.

Minimum length = 1

Maximum length = 127
clearstats <String> Read-write Clear the statsistics / counters.

Possible values = basic, full
maptotv6rxpktstcp <Double> Read-only Total number of MAP-T IPv6 TCP Recieved packets.
mapv6rxpktstcprate <Double> Read-only Rate (/s) counter for maptotv6rxpktstcp
maptotv6txpktstcp <Double> Read-only Total number of MAP-T IPv6 TCP Transmitted packets.
mapv6txpktstcprate <Double> Read-only Rate (/s) counter for maptotv6txpktstcp
maptotv6rxbytestcp <Double> Read-only Total number of MAP-T IPv6 TCP Recieved Bytes.
mapv6rxbytestcprate <Double> Read-only Rate (/s) counter for maptotv6rxbytestcp
maptotv6txbytestcp <Double> Read-only Total number of MAP-T IPv6 TCP Transmitted Bytes.
mapv6txbytestcprate <Double> Read-only Rate (/s) counter for maptotv6txbytestcp
maptotv4rxpktstcp <Double> Read-only Total number of MAP-T IPv4 TCP Recieved packets.
mapv4rxpktstcprate <Double> Read-only Rate (/s) counter for maptotv4rxpktstcp
maptotv4txpktstcp <Double> Read-only Total number of MAP-T IPv4 TCP Transmitted packets.
mapv4txpktstcprate <Double> Read-only Rate (/s) counter for maptotv4txpktstcp
maptotv4rxbytestcp <Double> Read-only Total number of MAP-T IPv4 TCP Recieved Bytes.
mapv4rxbytestcprate <Double> Read-only Rate (/s) counter for maptotv4rxbytestcp
maptotv4txbytestcp <Double> Read-only Total number of MAP-T IPv4 TCP Transmitted Bytes.
mapv4txbytestcprate <Double> Read-only Rate (/s) counter for maptotv4txbytestcp
maptotv6rxpktsudp <Double> Read-only Total number of MAP-T IPv6 UDP Recieved packets.
mapv6rxpktsudprate <Double> Read-only Rate (/s) counter for maptotv6rxpktsudp
maptotv6txpktsudp <Double> Read-only Total number of MAP-T IPv6 UDP Transmitted packets.
mapv6txpktsudprate <Double> Read-only Rate (/s) counter for maptotv6txpktsudp
maptotv6rxbytesudp <Double> Read-only Total number of MAP-T IPv6 UDP Recieved Bytes.
mapv6rxbytesudprate <Double> Read-only Rate (/s) counter for maptotv6rxbytesudp
maptotv6txbytesudp <Double> Read-only Total number of MAP-T IPv6 UDP Transmitted Bytes.
mapv6txbytesudprate <Double> Read-only Rate (/s) counter for maptotv6txbytesudp
maptotv4rxpktsudp <Double> Read-only Total number of MAP-T IPv4 UDP Recieved packets.
mapv4rxpktsudprate <Double> Read-only Rate (/s) counter for maptotv4rxpktsudp
maptotv4txpktsudp <Double> Read-only Total number of MAP-T IPv4 UDP Transmitted packets.
mapv4txpktsudprate <Double> Read-only Rate (/s) counter for maptotv4txpktsudp
maptotv4rxbytesudp <Double> Read-only Total number of MAP-T IPv4 UDP Recieved Bytes.
mapv4rxbytesudprate <Double> Read-only Rate (/s) counter for maptotv4rxbytesudp
maptotv4txbytesudp <Double> Read-only Total number of MAP-T IPv4 UDP Transmitted Bytes.
mapv4txbytesudprate <Double> Read-only Rate (/s) counter for maptotv4txbytesudp
maptotv6rxpktsicmp <Double> Read-only Total number of MAP-T IPv6 ICMP Recieved packets.
mapv6rxpktsicmprate <Double> Read-only Rate (/s) counter for maptotv6rxpktsicmp
maptotv6txpktsicmp <Double> Read-only Total number of MAP-T IPv6 ICMP Transmitted packets.
mapv6txpktsicmprate <Double> Read-only Rate (/s) counter for maptotv6txpktsicmp
maptotv6rxbytesicmp <Double> Read-only Total number of MAP-T IPv6 ICMP Recieved Bytes.
mapv6rxbytesicmprate <Double> Read-only Rate (/s) counter for maptotv6rxbytesicmp
maptotv6txbytesicmp <Double> Read-only Total number of MAP-T IPv6 ICMP Transmitted Bytes.
mapv6txbytesicmprate <Double> Read-only Rate (/s) counter for maptotv6txbytesicmp
maptotv4rxpktsicmp <Double> Read-only Total number of MAP-T IPv4 ICMP Recieved packets.
mapv4rxpktsicmprate <Double> Read-only Rate (/s) counter for maptotv4rxpktsicmp
maptotv4txpktsicmp <Double> Read-only Total number of MAP-T IPv4 ICMP Transmitted packets.
mapv4txpktsicmprate <Double> Read-only Rate (/s) counter for maptotv4txpktsicmp
maptotv4rxbytesicmp <Double> Read-only Total number of MAP-T IPv4 ICMP Recieved Bytes.
mapv4rxbytesicmprate <Double> Read-only Rate (/s) counter for maptotv4rxbytesicmp
maptotv4txbytesicmp <Double> Read-only Total number of MAP-T IPv4 ICMP Transmitted Bytes.
mapv4txbytesicmprate <Double> Read-only Rate (/s) counter for maptotv4txbytesicmp
maptotv6rxpkts <Double> Read-only Total number of MAP-T V6 Recieved packets.
mapv6rxpktsrate <Double> Read-only Rate (/s) counter for maptotv6rxpkts
maptotv6txpkts <Double> Read-only Total number of MAP-T V6 Transmitted packets.
mapv6txpktsrate <Double> Read-only Rate (/s) counter for maptotv6txpkts
maptotv4rxpkts <Double> Read-only Total number of MAP-T V4 Recieved packets.
mapv4rxpktsrate <Double> Read-only Rate (/s) counter for maptotv4rxpkts
maptotv4txpkts <Double> Read-only Total number of MAP-T V4 Transmitted packets.
mapv4txpktsrate <Double> 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.

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

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