Properties for Port Control Protocol (PCP) {{bibref|RFC6887}}. See the PCP Theory of Operation {{bibref|TR-181i2|Appendix XIV}} for a description of the working of this PCP data model. Enables or disables the PCP stack. If the stack is disabled then the status of any enabled {{object|Client}} entries will change to {{enum|StackDisabled|Client.{i}.Status}}. {{list}} Each list item denotes a PCP version supported by the PCP Client. Currently known versions are 0, 1 and 2. This parameter is based on Version from {{bibref|RFC6887}}. This is the version to be used in the first exchange with a new PCP Server. The factory default MUST be the highest supported version, as described in {{bibref|RFC6887|Section 9}}. {{list}} The list of the PCP Options supported by the PCP Client. {{numentries}} Client properties for Port Control Protocol (PCP). The PCP Client interacts with a PCP Server as defined in {{bibref|RFC6887}} for internal device applications or LAN device applications via Interworking functions. Enables or disables the PCP Client. {{reference|the interface stack instance representing the WAN interface this client operates on}} See {{object|##.InterfaceStack}} The status of the PCP Client. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. Enables or disables the MAP OpCode. Enables or disables the PEER OpCode. Enables or disables the ANNOUNCE OpCode. When {{false}} the PCP Client does not support unsolicited ANNOUNCE messages. Enables or disables the THIRD_PARTY Option. Indicates whether THIRD_PARTY Option is enabled or not. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. Enables or disables the FILTER option. {{numentries}} Properties for the Port Control Protocol (PCP) Proxy, as specified in {{bibref|PCPProxy}}. Enables or disables the PCP Proxy for this PCP Client. A string identifying the highest version of PCP that the proxy supports. This parameter is based on Version from {{bibref|RFC6887}}. The status of the PCP Proxy for this PCP Client. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. Properties for the interworking function between UPnP IGD (Internet Gateway Device) and PCP, as specified in {{bibref|RFC6970}}. Enables or disables the UPnP IGD-PCP Interworking Function for this PCP Client. The status of the UPnP IGD-PCP Interworking Function for this PCP Client. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. This table contains the PCP Servers to be used by the PCP Client. Entries are either statically configured or automatically created via DHCP options OPTION_V4_PCP_SERVER and OPTION_V6_PCP_SERVER, as per {{bibref|RFC7291}}. Each OPTION_V4_PCP_SERVER or OPTION_V6_PCP_SERVER option corresponds to a {{object}} instance. If an option returns multiple addresses then that {{object}} instance has multiple addresses. Enables or disables this PCP Server. The status of the PCP Server. {{enum}} The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. Method used to assign {{param|ServerNameOrAddress}} and create this table entry. {{enum}} Note: In the {{enum|DHCPv4}} and {{enum|DHCPv6}} cases, if more than one IP address is received {{param|ServerNameOrAddress}} will be the first address and {{param|AdditionalServerAddresses}} will be the remaining addresses. {{param|ServerNameOrAddress}} is an IPv4 address that was received via OPTION_V4_PCP_SERVER {{param|ServerNameOrAddress}} is an IPv6 address that was received via OPTION_V6_PCP_SERVER {{param|ServerNameOrAddress}} is an FQDN, IPv4 address or IPv6 address that was created by the Controller, by some other management entity (e.g. via a GUI), or is present in the factory default configuration The FQDN or IP address of the PCP Server, assigned as described under {{param|Origin}}. The IP address currently in use for the PCP Server, derived from the value of {{param|ServerNameOrAddress}}. {{empty}} indicates that no PCP Server address is currently known. PCP Server addresses in addition to {{param|ServerNameOrAddress}}. This can be non-empty only if {{param|Origin}} is {{enum|DHCPv4|Origin}} or {{enum|DHCPv6|Origin}} and if more than one PCP Server address was received. The external IP address of the PCP-controlled device hosting this server. This is the version of PCP resulting from client-server Version Negotiation. This parameter is based on Version from {{bibref|RFC6887}}. Indicates the maximum number of inbound filters allowed to be associated with a mapping entry on this server. Indicates the maximum number of ports allocated to this PCP Client on this server. A value of 0 means that there is no limitation. Indicates the preferred lifetime (in {{units}}) to be used for mappings with this server when no preference is selected by an application/user. Indicates the capabilities supported by the PCP Server. {{enum}} {{numentries}} {{numentries}} Inbound Mapping table. This table contains all Inbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode MAP, as described in {{bibref|RFC6887|Section 11}}. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The {{param|Origin}} parameter indicates which mechanism requested the mapping. For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the Controller MAY modify the {{param|Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. Enables or disables this {{object}} instance. The status of this entry. {{enum}} The {{enum|Error_PCPErrorCodeReceived}} value indicates that the PCP Client received an error code from the PCP Server. The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. Provides the PCP error code when {{param|Status}} is {{enum|Error_PCPErrorCodeReceived|Status}}. Error code values are defined in {{bibref|RFC6887|Section 7.4}}. Mechanism via which the mapping was requested. {{enum}} Requested via internal device application Requested via UPnP IGD interworking function Requested via PCP proxy Requested via static configuration, i.e. created by the Controller, by some other management entity (e.g. via a GUI), or is present in the factory default configuration Determines the time to live, in {{units}}, of this Inbound Mapping lease, i.e. the remaining time before this port mapping expires. A value of 0 means that the port mapping is permanent (referred to as a static mapping in {{bibref|RFC6887}}). When a dynamic Inbound Mapping lease expires, the CPE MUST automatically delete the corresponding {{object}} table entry. The external IPv4 or IPv6 Address that the PCP-controlled device will listen on for incoming packets to be forwarded to the PCP Client. This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP client does not know the external address, or does not have a preference, it MUST use {{empty}}. The external port (or the first port of a range of external ports) that the PCP-controlled device will listen on for incoming packets. Those inbound packets will be forwarded to {{param|InternalPort}}. If the PCP client does not know the external port, or does not have a preference, it MUST use 0. This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0. Indicates the last port of the external port range that starts with {{param|SuggestedExternalPort}}. If an external port range is specified, then the behavior described for {{param|SuggestedExternalPort}} applies to all ports within the range. A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of {{param|SuggestedExternalPort}}. If {{param|SuggestedExternalPort}} is zero (wildcard), the value of {{param}} MUST be ignored. If specified, the value of this parameter MUST be zero or be greater than or equal to the value of {{param|SuggestedExternalPort}}. The port on this PCP Client's {{param|##.WANInterface}} that the PCP-controlled device forwards incoming packets to. The protocol number of the {{object}}. Values are taken from {{bibref|IANA-protocolnumbers}}. The value -1 means ''all protocols''. Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in {{bibref|RFC6887|Section 7.3}}. In that case, {{param}} is the IP address of the device for which the PCP operation is requested. For non-third-party mappings, {{param}} SHOULD be {{empty}}. User-readable description of this {{object}}. The external IPAddress returned by the PCP Server. The IP address that the PCP-controlled device is listening on for incoming packets to a corresponding PCP Client. The external port returned by the PCP Server. The external port (or the first port of a range of external ports) that the PCP-controlled device is listening on for incoming packets to a corresponding {{param|InternalPort}}. Inbound packets to this external port on the External interface of the PCP-controlled device is forwarded to the on the {{param|InternalPort}}. Indicates the last port of the external port range that starts with {{param|AssignedExternalPort}}. If an external port range is specified, then the behavior described for {{param|AssignedExternalPort}} applies to all ports within the range. A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of {{param|AssignedExternalPort}}. {{numentries}} Filter table. This table contains all Filters restricting this Inbound Mapping, as defined in {{bibref|RFC6887|}}. Permitted remote peer IP address for this filter. Indicates how many bits of {{param|RemoteHostIPAddress}} are relevant for this filter. Permitted remote peer port number for this filter. The value 0 indicates ''all ports''. Indicates the last port of the remote port range that starts with {{param|RemotePort}}. If an external port range is specified, then the behavior described for {{param|RemotePort}} applies to all ports within the range. A value of zero (0) indicates that no remote port range is specified, i.e. that the range consists only of {{param|RemotePort}}. Note: This parameter was promoted to readWrite in the Device:2.18 version. Outbound Mapping table. This table contains all Outbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode PEER, as described in {{bibref|RFC6887|Section 12}}. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The {{param|Origin}} parameter indicates which mechanism requested the mapping. For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the Controller MAY modify the {{param|Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. Enables or disables this {{object}} instance. The status of this entry. {{enum}} The {{enum|Error_PCPErrorCodeReceived}} value indicates that the PCP Client received an error code from the PCP Server. The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. Provides the PCP Error code when {{param|Status}} is {{enum|Error_PCPErrorCodeReceived|Status}}. Error code values are defined in {{bibref|RFC6887|Section 7.4}}. Mechanism via which the mapping was requested. {{enum}} Requested via internal device application Requested via UPnP IGD interworking function Requested via PCP proxy Requested via static configuration, i.e. created by the Controller, by some other management entity (e.g. via a GUI), or is present in the factory default configuration Determines the time to live, in {{units}}, of this Outbound Mapping lease, i.e. the remaining time before this port mapping expires. A value of 0 means that the port mapping is permanent (referred to as a static mapping in {{bibref|RFC6887}}). When a dynamic Outbound Mapping lease expires, the CPE MUST automatically delete the corresponding {{object}} table entry. The external IPv4 or IPv6 Address that the PCP-controlled device will use to send outgoing packets covered by this mapping. This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external address, or does not have a preference, it MUST use {{empty}}. The external port that the PCP-controlled device will use to send outgoing packets covered by this mapping. This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0. The remote peer's IP address, as seen from the PCP Client, for this Outbound Mapping. The port on PCP Client WAN Interface that the PCP-controlled device SHOULD listen to for this mapping. The remote peer's port, as seen from the PCP Client, for this Outbound Mapping. The protocol number of the {{object}}. Values are taken from the {{bibref|IANA-protocolnumbers}}. The value -1 means ''all protocols''. Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in {{bibref|RFC6887|Section 7.3}}. In that case, {{param}} is the IP address of the device for which the PCP operation is requested. For non-third-party mappings, {{param}} SHOULD be {{empty}}. User-readable description of this {{object}}. The external IP address returned by the PCP Server. The IP address that the PCP-controlled device uses to send outgoing packets corresponding to this mapping. The external port returned by the PCP Server. The port that the PCP-controlled device uses to send outgoing packets corresponding to this mapping.