.. _cgnv6_pcp:

cgnv6 pcp
=========

Set Port Control Protocol parameters


pcp Specification
-----------------

	===================================== ==================================================
	===================================== ==================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      pcp

	 **Element URI**                       /axapi/v3/cgnv6/pcp

	 **Element Attributes**                pcp_attributes

	 **Statistics Data URI**               /axapi/v3/cgnv6/pcp/stats

	 **Schema**                             :download:`pcp schema <cgnv6-pcp/cgnv6-pcp.txt>`
	===================================== ==================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cgnv6/pcp



.. raw:: html

   </td><td valign = 'top'>


:ref:`438_pcp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cgnv6/pcp



.. raw:: html

   </td><td valign = 'top'>


:ref:`438_pcp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cgnv6/pcp



.. raw:: html

   </td><td valign = 'top'>


:ref:`438_pcp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cgnv6/pcp



.. raw:: html

   </td><td valign = 'top'>


:ref:`438_pcp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cgnv6/pcp



.. raw:: html

   </td><td valign = 'top'>


:ref:`438_pcp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _438_pcp_attributes:

pcp attributes
--------------

    **default-template**

        **Description** Bind the default template for PCP (Bind a PCP template)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _438_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **counters1**

        **Description** 'all': all; 'packets-rcv': Packets Received; 'lsn-map-process-success': PCP MAP Request Processing Success (NAT44); 'dslite-map-process-success': PCP MAP Request Processing Success (DS-Lite); 'nat64-map-process-success': PCP MAP Request Processing Success (NAT64); 'lsn-peer-process-success': PCP PEER Request Processing Success (NAT44); 'dslite-peer-process-success': PCP PEER Request Processing Success (DS-Lite); 'nat64-peer-process-success': PCP PEER Request Processing Success (NAT64); 'lsn-announce-process-success': PCP ANNOUNCE Request Processing Success (NAT44); 'dslite-announce-process-success': PCP ANNOUNCE Request Processing Success (DS-Lite); 'nat64-announce-process-success': PCP ANNOUNCE Request Processing Success (NAT64); 'pkt-not-request-drop': Packet Not a PCP Request; 'pkt-too-short-drop': Packet Too Short; 'noroute-drop': Response No Route; 'unsupported-version': Unsupported PCP version; 'not-authorized': PCP Request Not Authorized; 'malform-request': PCP Request Malformed; 'unsupp-opcode': Unsupported PCP Opcode; 'unsupp-option': Unsupported PCP Option; 'malform-option': PCP Option Malformed; 'no-resources': No System or NAT Resources; 'unsupp-protocol': Unsupported Mapping Protocol; 'user-quota-exceeded': User Quota Exceeded; 'cannot-provide-suggest': Cannot Provide Suggested Port When PREFER_FAILURE; 'address-mismatch': PCP Client Address Mismatch; 'excessive-remote-peers': Excessive Remote Peers; 'pkt-not-from-nat-inside': Packet Dropped For Not Coming From NAT Inside; 'l4-process-error': L3/L4 Process Error; 'internal-error-drop': Internal Error; 'unsol_ance_sent_succ': Unsolicited Announce Sent; 'unsol_ance_sent_fail': Unsolicited Announce Send Failure; 'ha_sync_epoch_sent': HA Sync PCP Epoch Sent; 'ha_sync_epoch_rcv': HA Sync PCP Epoch Recv; 'fullcone-ext-alloc': PCP Fullcone Extension Alloc; 'fullcone-ext-free': PCP Fullcone Extension Free; 'fullcone-ext-alloc-failure': PCP Fullcone Extension Alloc Failure; 'fullcone-ext-notfound': PCP Fullcone Extension Not Found; 'fullcone-ext-reuse': PCP Fullcone Extension Reuse; 'client-nonce-mismatch': PCP Client Nonce Mismatch; 'map-filter-set': PCP MAP Filter Set; 'map-filter-deny': PCP MAP Filter Deny Inbound; 'inter-board-pkts': PCP Inter board packets; 

        **Type:** string

        **Supported Values:** all, packets-rcv, lsn-map-process-success, dslite-map-process-success, nat64-map-process-success, lsn-peer-process-success, dslite-peer-process-success, nat64-peer-process-success, lsn-announce-process-success, dslite-announce-process-success, nat64-announce-process-success, pkt-not-request-drop, pkt-too-short-drop, noroute-drop, unsupported-version, not-authorized, malform-request, unsupp-opcode, unsupp-option, malform-option, no-resources, unsupp-protocol, user-quota-exceeded, cannot-provide-suggest, address-mismatch, excessive-remote-peers, pkt-not-from-nat-inside, l4-process-error, internal-error-drop, unsol_ance_sent_succ, unsol_ance_sent_fail, ha_sync_epoch_sent, ha_sync_epoch_rcv, fullcone-ext-alloc, fullcone-ext-free, fullcone-ext-alloc-failure, fullcone-ext-notfound, fullcone-ext-reuse, client-nonce-mismatch, map-filter-set, map-filter-deny, inter-board-pkts

.. _438_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - unsol_ance_sent_fail
      - 8
      - Unsolicited Announce Send Failure

   *  - 
      - malform-request
      - 8
      - PCP Request Malformed

   *  - 
      - unsupp-option
      - 8
      - Unsupported PCP Option

   *  - 
      - unsupported-version
      - 8
      - Unsupported PCP version

   *  - 
      - no-resources
      - 8
      - No System or NAT Resources

   *  - 
      - unsupp-opcode
      - 8
      - Unsupported PCP Opcode

   *  - 
      - dslite-announce-process-success
      - 8
      - PCP ANNOUNCE Request Processing Success (DS-Lite)

   *  - 
      - l4-process-error
      - 8
      - L3/L4 Process Error

   *  - 
      - not-authorized
      - 8
      - PCP Request Not Authorized

   *  - 
      - ha_sync_epoch_sent
      - 8
      - HA Sync PCP Epoch Sent

   *  - 
      - nat64-announce-process-success
      - 8
      - PCP ANNOUNCE Request Processing Success (NAT64)

   *  - 
      - pkt-not-from-nat-inside
      - 8
      - Packet Dropped For Not Coming From NAT Inside

   *  - 
      - user-quota-exceeded
      - 8
      - User Quota Exceeded

   *  - 
      - dslite-map-process-success
      - 8
      - PCP MAP Request Processing Success (DS-Lite)

   *  - 
      - packets-rcv
      - 8
      - Packets Received

   *  - 
      - lsn-announce-process-success
      - 8
      - PCP ANNOUNCE Request Processing Success (NAT44)

   *  - 
      - cannot-provide-suggest
      - 8
      - Cannot Provide Suggested Port When PREFER_FAILURE

   *  - 
      - nat64-map-process-success
      - 8
      - PCP MAP Request Processing Success (NAT64)

   *  - 
      - internal-error-drop
      - 8
      - Internal Error

   *  - 
      - dslite-peer-process-success
      - 8
      - PCP PEER Request Processing Success (DS-Lite)

   *  - 
      - malform-option
      - 8
      - PCP Option Malformed

   *  - 
      - excessive-remote-peers
      - 8
      - Excessive Remote Peers

   *  - 
      - lsn-map-process-success
      - 8
      - PCP MAP Request Processing Success (NAT44)

   *  - 
      - unsupp-protocol
      - 8
      - Unsupported Mapping Protocol

   *  - 
      - ha_sync_epoch_rcv
      - 8
      - HA Sync PCP Epoch Recv

   *  - 
      - unsol_ance_sent_succ
      - 8
      - Unsolicited Announce Sent

   *  - 
      - pkt-not-request-drop
      - 8
      - Packet Not a PCP Request

   *  - 
      - address-mismatch
      - 8
      - PCP Client Address Mismatch

   *  - 
      - noroute-drop
      - 8
      - Response No Route

   *  - 
      - lsn-peer-process-success
      - 8
      - PCP PEER Request Processing Success (NAT44)

   *  - 
      - nat64-peer-process-success
      - 8
      - PCP PEER Request Processing Success (NAT64)

   *  - 
      - pkt-too-short-drop
      - 8
      - Packet Too Short