pcpprofile

Last published : Oct 30, 2026
Configuration for PCP Profile resource.

Properties

(click to see Operations)
Name Data Type Permissions Description
name <String> Read-write Name for the PCP Profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my pcpProfile" or my pcpProfile).
mapping <String> Read-write This argument is for enabling/disabling the MAP opcode of current PCP Profile.
Default value: ENABLED
Possible values = ENABLED, DISABLED
peer <String> Read-write This argument is for enabling/disabling the PEER opcode of current PCP Profile.
Default value: ENABLED
Possible values = ENABLED, DISABLED
minmaplife <Double> Read-write Integer value that identify the minimum mapping lifetime (in seconds) for a pcp profile. default(120s).
Minimum value = 1
Maximum value = 2147483647
maxmaplife <Double> Read-write Integer value that identify the maximum mapping lifetime (in seconds) for a pcp profile. default(86400s = 24Hours).
Minimum value = 1
Maximum value = 2147483647
announcemulticount <Double> Read-write Integer value that identify the number announce message to be send.
Default value: 10
Minimum value = 0
Maximum value = 65535
thirdparty <String> Read-write This argument is for enabling/disabling the THIRD PARTY opcode of current PCP Profile.
Default value: DISABLED
Possible values = ENABLED, DISABLED
__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>.

add

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpprofile
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:

{"pcpprofile":{
<b>"name":<String_value>,
</b>"mapping":<String_value>,
"peer":<String_value>,
"minmaplife":<Double_value>,
"maxmaplife":<Double_value>,
"announcemulticount":<Double_value>,
"thirdparty":<String_value>
}}
Response:
HTTP Status Code on Success: 201 Created 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 error

delete

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpprofile/name_value<String>
HTTP Method:DELETE
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
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 error

update

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpprofile
HTTP Method:PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:

{"pcpprofile":{
<b>"name":<String_value>,
</b>"mapping":<String_value>,
"peer":<String_value>,
"minmaplife":<Double_value>,
"maxmaplife":<Double_value>,
"announcemulticount":<Double_value>,
"thirdparty":<String_value>
}}
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 error

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpprofile?action=unset
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:

{"pcpprofile":{
<b>"name":<String_value>,
</b>"mapping":true,
"peer":true,
"minmaplife":true,
"maxmaplife":true,
"announcemulticount":true,
"thirdparty":true
}}
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 error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpprofile
Query-parameters:
attrs
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpprofile?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/pcpprofile?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of pcpprofile 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/pcpprofile?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/pcpprofile?pagesize=#no;pageno=#no
Use this query-parameter to get the pcpprofile 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:

{ "pcpprofile": [ {
"name":<String_value>,
"mapping":<String_value>,
"peer":<String_value>,
"minmaplife":<Double_value>,
"maxmaplife":<Double_value>,
"announcemulticount":<Double_value>,
"thirdparty":<String_value>
}]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpprofile/name_value<String>
Query-parameters:
attrs
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpprofile/name_value<String>?attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/pcpprofile/name_value<String>?view=summary
Note:By default, the retrieved results are displayed in detail view (?view=detail).
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:

{ "pcpprofile": [ {
"name":<String_value>,
"mapping":<String_value>,
"peer":<String_value>,
"minmaplife":<Double_value>,
"maxmaplife":<Double_value>,
"announcemulticount":<Double_value>,
"thirdparty":<String_value>
}]}

count

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

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