PEM::ForwardingEndpoint

Introduced : BIG-IP_v11.4.0
You can use the forwarding endpoint interface to configure forwarding endpoint definitions for the Policy Enforcement Manager. A forwarding endpoint represents the final destination of the traffic flow. The endpoint will always point to a single pool; it optionally points to a single SNAT pool and/or a single LSN pool. According to source-ip or destination-ip, the subsequent traffic can be directed to the same pool member, which is called persistence. The persistence feature can be disabled. Note: Before you can create a forwarding endpoint you must create a valid pool with at least one member.

Methods

Method Description Introduced
create Creates a set of PEM forwarding endpoints. BIG-IP_v11.4.0
delete_all_forwarding_endpoints Deletes all user defined forwarding endpoints. BIG-IP_v11.4.0
delete_forwarding_endpoint Deletes the specified forwarding endpoints. BIG-IP_v11.4.0
get_forwarding_endpoint_type Gets the forwarding endpoint types for the specified forwarding endpoints. BIG-IP_v11.5.0
get_list Gets a list of all forwarding endpoints. BIG-IP_v11.4.0
get_lsn_pool Gets the LSN pools for the specified forwarding endpoints. BIG-IP_v11.4.0
get_persistence_type Gets the persistence types of the specified forwarding endpoints. BIG-IP_v11.4.0
get_pool Gets the pools for the specified forwarding endpoints. BIG-IP_v11.4.0
get_snat_pool Gets the SNAT pools for the specified forwarding endpoints. BIG-IP_v11.4.0
get_source_port_behavior Gets the source port behaviors of the specified forwarding endpoints. BIG-IP_v11.4.0
get_translate_address_state Gets the translate address states of the specified forwarding endpoints. BIG-IP_v11.4.0
get_translate_service_state Gets the translate service states of the specified forwarding endpoints. BIG-IP_v11.4.0
get_version Gets the version information for this interface. BIG-IP_v11.4.0
set_forwarding_endpoint_type Sets the forwarding endpoint types for the specified forwarding endpoints. When an endpoint is defined, flow is forwarded to the member in pool associated with the endpoint. If an endpoint is transparent then the proxy is not supposed to modify the flow contents. If an endpoint is non-transparent then proxy can modify the flow contents. BIG-IP_v11.5.0
set_lsn_pool Sets the LSN pools for the specified forwarding endpoints. An LSN pool specifies the name of an existing LSN pool to which the forwarding endpoint will automatically forward traffic. The default value is empty string (no pool). BIG-IP_v11.4.0
set_persistence_type Sets the persistence types of the specified forwarding endpoints which specifies whether traffic persists with pool members. If you want specific traffic to go to the same pool member, set the persistence type to source or destination IP address. BIG-IP_v11.4.0
set_pool Sets the pools for the specified forwarding endpoints. The forwarding endpoint will always point to a single pool. BIG-IP_v11.4.0
set_snat_pool Sets the SNAT pools for the specified forwarding endpoints. A SNAT pool specifies the name of an existing SNAT pool used for translating the client ip address to the self-ip address of the BIG-IP system. The default value is empty string (no pool). BIG-IP_v11.4.0
set_source_port_behavior Sets the source port behaviors of the specified forwarding endpoints. BIG-IP_v11.4.0
set_translate_address_state Sets the translate address states of the specified forwarding endpoints. A translate address specifies, when enabled, that the system translates the original destination address of the virtual server. The default value is disabled. BIG-IP_v11.4.0
set_translate_service_state Sets the translate service states of the specified forwarding endpoints. A translate service specifies, when enabled, that the system translates the original destination port. The default value is disabled. BIG-IP_v11.4.0

Structures

Structure Description

Enumerations

Enumeration Description
ForwardingEndpointType Specifies the type for the endpoint. When an endpoint is defined, flow is forwarded to the member in pool associated with the endpoint. If an endpoint is transparent then the proxy is not supposed to modify the flow contents. If an endpoint is non-transparent then proxy can modify the flow contents.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ForwardingEndpointTypeSequence ForwardingEndpointType [] A sequence of forwarding endpoint types.
ForwardingEndpointTypeSequenceSequence ForwardingEndpointType [] [] A sequence of sequence of forwarding endpoint types.
ForwardingEndpointTypeSequenceSequenceSequence ForwardingEndpointType [] [] [] A sequence of sequence of sequence of forwarding endpoint types.

See Also

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


<p>*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.*</p>