LocalLB::ProfilePCP¶
Introduced : BIG-IP_v11.5.0
The ProfilePCP interface enables you to specify a set of predefined
Port Control Protocol parameters so that it can be used together to
govern the processing of PCP incoming requests. PCP (Port Control
Protocol) is a protocol that provides more seamless NAT traversal by
allowing communication and control of port/address mappings and
session lifetimes between the NAT and the NAT&aposed client. The
application or CPE requests a NAT mapping and the PCP Server
collocated with the CGNAT device responds with the mapped address and
port and session lifetime.
Methods¶
| Method | Description | Introduced |
| add_third_party_allowed_subnet | Adds third party allowed subnets to the specified PCP profiles. | BIG-IP_v11.5.0 |
| create | Creates the specified PCP profiles. | BIG-IP_v11.5.0 |
| delete_all_profiles | Deletes all PCP profiles. | BIG-IP_v11.5.0 |
| delete_profile | Deletes the specified PCP profiles. | BIG-IP_v11.5.0 |
| get_announce_after_failover_state | Gets the announce after failover state for the specified profiles. If enabled a multicast announcement will be sent when a PCP Server fails over its HA pair. | BIG-IP_v11.5.0 |
| get_announce_multicast_repeats | Gets the number of multicast announcements that are sent after after PCP Server loses state for the specified profiles. | BIG-IP_v11.5.0 |
| get_default_profile | Gets the names of the default profiles from which the specified profiles will derive default values for its attributes. | BIG-IP_v11.5.0 |
| get_description | Gets the descriptions for a set of PCP profiles. | BIG-IP_v11.5.0 |
| get_list | Gets a list of all PCP profiles. | BIG-IP_v11.5.0 |
| get_listening_port | Gets the listening port for the specified profiles. This is the port on which the PCP server listens. | BIG-IP_v11.5.0 |
| get_mapping_filter_limit | Gets the higher limit for the number of filters that must be applied to an incoming PCP packet for the specified PCP profiles. | BIG-IP_v11.5.0 |
| get_mapping_limit_per_client | Gets the limit of outstanding mappings any one client can have for the specified PCP profiles. | BIG-IP_v11.5.0 |
| get_mapping_recycle_delay | Gets the minimum delay (in seconds) the PCP Server will wait before recycling mappings that have expired for new client requests for the specified PCP profiles. | BIG-IP_v11.5.0 |
| get_maximum_mapping_lifetime | Gets the higher lifetime limit (in seconds) for the specified PCP profiles. | BIG-IP_v11.5.0 |
| get_minimum_mapping_lifetime | Gets the lower lifetime limit (in seconds) for the specified PCP profiles. | BIG-IP_v11.5.0 |
| get_multicast_port | Gets the multicast port for the specified profiles. This is the port the PCP server uses to send multicast announcements. | BIG-IP_v11.5.0 |
| get_rule | Gets the iRules that the specified profiles will be using to monitor and control PCP actions. | BIG-IP_v9.0 |
| get_third_party_allowed_subnet | Gets the list of third party allowed subnets for the specified PCP profiles. PCP allows clients behind a CPE device to issue PCP request on their behalf to the CGNAT PCP Server via the CPE. For this the PCP Server must use a PCP profile that has a DS-Lite tunnel specified so that the third party encapsulated IPv4 packets are delivered to the PCP Server via the DS-Lite tunnel. PCP also allows you to specify subnets from which it will accept third party requests. | BIG-IP_v11.5.0 |
| get_third_party_option_state | Gets the third party option state for the specified profiles. If enabled, third party options for PCP are accepted. | BIG-IP_v11.5.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.5.0 |
| is_base_profile | Determines whether the specified PCP profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). | BIG-IP_v11.5.0 |
| is_system_profile | Determines whether the specified PCP profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). | BIG-IP_v11.5.0 |
| remove_all_third_party_allowed_subnets | Removes all third party allowed subnets to the specified PCP profiles. | BIG-IP_v11.5.0 |
| remove_third_party_allowed_subnet | Removes third party allowed subnets to the specified PCP profiles. | BIG-IP_v11.5.0 |
| set_announce_after_failover_state | Sets the announce after failover state for the specified profiles. If enabled a multicast announcement will be sent when a PCP Server fails over its HA pair. In a pair of BIG-IPs, it is unlikely to lose state when a fail over occurs. However, there is a small possibility that the &aposlast&apos mappings have not yet been replicated and this method allows enabling sending a multicast announcement after the fail over. | BIG-IP_v11.5.0 |
| set_announce_multicast_repeats | Sets the number of multicast announcements that are sent after PCP Server loses state for the specified profiles. The PCP Server is required to inform all clients if it loses state; for example, if it restarted. This is done by multicast. To guard against packet loss the multicast is repeated a configurable number of times. | BIG-IP_v11.5.0 |
| set_default_profile | Sets the names of the default profiles from which the specified profiles will derive default values for its attributes. | BIG-IP_v11.5.0 |
| set_description | Sets the description for a set of PCP profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.5.0 |
| set_mapping_filter_limit | Sets the higher limit for the number of filters that must be applied to an incoming PCP packet for the specified PCP profiles. PCP allows PCP clients to specify a list of subnet/address/[port] filters for denying access. A higher limit can be specified according to the networking conditions. | BIG-IP_v11.5.0 |
| set_mapping_limit_per_client | Sets the limit for the number of outstanding mappings any one client can have for the specified PCP profiles. PCP allows PCP servers to use limit the number of outstanding port/address mappings a client can have according to the networking conditions. | BIG-IP_v11.5.0 |
| set_mapping_recycle_delay | Sets the minimum delay (in seconds) the PCP Server will wait before recycling mappings that have expired for new client requests for the specified PCP profiles. PCP defines a configurable delay after mapping expiration to prevent other clients from hijacking expired mappings if the original owner failed to renew them on time. | BIG-IP_v11.5.0 |
| set_maximum_mapping_lifetime | Sets the higher lifetime limit (in seconds) for the specified PCP profiles. PCP allows clients to request a lifetime for their port/address mapping request. However, the PCP server has a configurable valid range for lifetime that can be adjusted based on the networking conditions. | BIG-IP_v11.5.0 |
| set_minimum_mapping_lifetime | Sets the lower lifetime limit (in seconds) for the specified PCP profiles. PCP allows clients to request a lifetime for their port/address mapping request. However, the PCP server has a configurable valid range for lifetime that can be adjusted based on the networking conditions. | BIG-IP_v11.5.0 |
| set_rule | Sets the iRules that the specified profiles will be using to monitor and control PCP actions. | BIG-IP_v9.0 |
| set_third_party_option_state | Sets the third party option state for the specified profiles. When enabled, third party options for PCP are accepted. PCP allows clients behind a CPE device issue PCP request on their behalf to the CGNAT PCP Server via the CPE. For this the PCP Server must use a PCP profile that has a DS-Lite tunnel specified so that the third party encapsulated IPv4 packets are delivered to the PCP Server via the DS-Lite tunnel. | BIG-IP_v11.5.0 |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.