APIRef_tm_pem_forwarding-endpointΒΆ

mgmt/tm/pem/forwarding-endpoint

/tm/pem

Defines PEM forwarding endpoint that is used to forward all the traffic to.

REST Endpoints

Collection URI
/mgmt/tm/pem/forwarding-endpoint
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/pem/forwarding-endpoint/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, partition, subPath

Properties

Name Type Default Value Required Access Description
appService string   optional read/write The application service that the object belongs to.
description string   optional read/write User defined description.
endpointType string transparent optional read/write Specifies the endpoint type.
tmPartition string Common optional read/write Displays the administrative partition within which this endpoint resides.
pool string   required read/write The name of a pre-configured LTM pool where the traffic is going to be forwarded to. A valid pool name must be specified.
snatPool string   optional read/write Specifies the name of an existing LTM SNAT pool (snatpool) that is used to translate the client IP address to one of the configured IP addresses in that SNAT pool. Self-IP addresses of the BIG-IP system must not be included in the SNAT pool. The default value is none.
sourcePort string preserve optional read/write Specifies whether the system preserves the source port of the connection. The default value is preserve.
translateAddress string disabled optional read/write Specifies, when enabled, that the system translates the original destination address of the virtual server. When disabled, specifies that the system uses the address without translation. The default value is disabled.
translateService string disabled optional read/write Note that translate-service is really translate-port. It specifies, when enabled, that the system translates the original destination port. When disabled, it specifies that the system uses the original destination port without translation. The default value is disabled.

Structures

Name Type Default Value Required Access Description
/persistence array_structure   optional read/write  
/persistence/fallback string disabled optional read/write Specifies the value of fallback persistence method. The options are destination-ip, disabled and source-ip.
/persistence/type string disabled optional read/write Specifies the value of default persistence method. The options are destination-ip, disabled, hash and source-ip.
/persistence/hash-settings array_structure   optional read/write  
/persistence/hash-settings/algorithm string carp optional read/write Specifies the value of hash algorithm. The only available option is carp.
/persistence/hash-settings/length integer 1024 optional read/write Specifies the length in bytes of value used for hash calculation. Length counted starting from offset bytes from the beginning of the source string.
/persistence/hash-settings/offset integer 0 optional read/write Specifies the offset in bytes from start of the source of value for hash calculation.
/persistence/hash-settings/source string uri optional read/write Specifies the source of value for hash calculation. The options are uri and tcl-snippet. The default option is uri.
/persistence/hash-settings/tcl-value string   optional read/write Specifies the tcl snippet which result is used as a value for the hash calculation. This field is mandatory if tcl-snippet option is selected for the hash source.
/persistence/hash-settings/algorithm string carp optional read/write Specifies the value of hash algorithm. The only available option is carp.
/persistence/hash-settings/length integer 1024 optional read/write Specifies the length in bytes of value used for hash calculation. Length counted starting from offset bytes from the beginning of the source string.
/persistence/hash-settings/offset integer 0 optional read/write Specifies the offset in bytes from start of the source of value for hash calculation.
/persistence/hash-settings/source string uri optional read/write Specifies the source of value for hash calculation. The options are uri and tcl-snippet. The default option is uri.
/persistence/hash-settings/tcl-value string   optional read/write Specifies the tcl snippet which result is used as a value for the hash calculation. This field is mandatory if tcl-snippet option is selected for the hash source.
/persistence/fallback string disabled optional read/write Specifies the value of fallback persistence method. The options are destination-ip, disabled and source-ip.
/persistence/type string disabled optional read/write Specifies the value of default persistence method. The options are destination-ip, disabled, hash and source-ip.
iControl Reference Index
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

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.