pcpmap

Last published : Oct 30, 2026
Configuration for server resource.

Properties

(click to see Operations)
Name Data Type Permissions Description
nattype <String> Read-write Type of sessions to be displayed.
Default value: NAT44
Possible values = NAT44, DS-Lite, NAT64
pcpsrcip <String> Read-only Internal IP address.
subscrip <String> Read-only IPV4 src address of Client in DS-Lite.
pcpsrcport <Integer> Read-only Internal Port.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
pcpdstip <String> Read-only Remote PEER IP address.
pcpdstport <Integer> Read-only Remote PEER Port.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
pcpnatip <String> Read-only External IP address.
pcpnatport <Integer> Read-only External Port Number.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
pcpprotocol <String> Read-only Protocol of the PCP mapping.
Possible values = HopOpt, icmp, igmp, ggp, ipv4, st, tcp, udp
pcpaddr <Double> Read-only Address of PCP Map entity.
pcpnounce <Double> Read-only PCP Mapping Nounce.
pcprefcnt <Double> Read-only Refcount, which indicates how many session is active.
pcplifetime <Double> Read-only Integer value that shows the requested lifetime.
__count <Double> Read-only count parameter

Operations

(click to see Properties)
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/config/pcpmap
Query-parameters:
args
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpmap?args=nattype:<String_value>
Use this query-parameter to get pcpmap resources based on additional properties.
attrs
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpmap?attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpmap?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of pcpmap resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.
view
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpmap?view=summary
Note:By default, the retrieved results are displayed in detail view (?view=detail).
pagination
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpmap?pagesize=#no;pageno=#no
Use this query-parameter to get the pcpmap resources in chunks.
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:

{ "pcpmap": [ {
nattype:<String_value>"pcpsrcip":<String_value>,
"subscrip":<String_value>,
"pcpsrcport":<Integer_value>,
"pcpdstip":<String_value>,
"pcpdstport":<Integer_value>,
"pcpnatip":<String_value>,
"pcpnatport":<Integer_value>,
"pcpprotocol":<String_value>,
"pcpaddr":<Double_value>,
"pcpnounce":<Double_value>,
"pcprefcnt":<Double_value>,
"pcplifetime":<Double_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpmap?count=yes
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:

{ "pcpmap": [ { "__count": "#no"} ] }