2.5. Advanced Options & Create String SyntaxΒΆ

The BIG-IP platform allows very fine-grained control of options for L4-7 protocol profiles (ex: TCP, UDP, HTTP, Compression, etc.) and options for Virtual Servers and Pools. To expose the ability to customize these options we use a syntax that can be expressed using the APL String field. The create syntax can be used with specific Profiles, while the option syntax is used with the Virtual Server and Pool objects. This syntax is defined as a string in the following format:

2.5.1. Create String

Desc ript ion

A custom TMOS profile will be created with the specified options. Options are validated at run-time with the underlying TMOS version. Use of this format allows exposure of fine-grained options without exposing each option as a field in the APL Presentation Layer. The following profiles support the this syntax:

  • Client/Server-side L4 Protocol (tcp, udp)
  • Server SSL
  • Client SSL
  • HTTP
  • OneConnect
  • Compression
  • Request Logging
  • Persistence (Default & Fallback)
Synt ax
create:type=<profile type>;<tmsh_option_name>=<tmsh_option

_value>[;<tmsh_option_name>=<tmsh_option_value>]

Exam ple
create:type=tcp;nagle=disabled;proxy-low-buffer=10000;defa

ults-from=/Common/tcp

2.5.2. Advanced Options String

Desc ript ion

The object will be created with the specified TMOS options. Options are validated at run-time with the underlying TMOS version. Use of this format allows exposure of fine-grained options without exposing each option as a field in the APL Presentation Layer. The following object types support the this syntax:

  • Virtual Servers
  • Pools
  • Auto-create Client-SSL Profiles
Synt ax
<tmsh_option_name>=<tmsh_option_value>[;<tmsh_option_name>

=<tmsh_option_value>]

Exam ple
slow-ramp-time=300;min-up-members=1

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.