- Home
- Documentation
- resources
- f5xc_application_profiles Resource - terraform-provider-f5xc
f5xc_application_profiles Resource - terraform-provider-f5xc
f5xc_application_profiles (Resource)
Section titled “f5xc_application_profiles (Resource)”Manages Application Profiles in a given namespace. If one already exists it will give an error. in F5 Distributed Cloud.
~> Note For more information about this resource, please refer to the F5 XC API Documentation.
Example Usage
Section titled “Example Usage”# Application Profiles Resource Example# Manages Application Profiles in a given namespace. If one already exists it will give an error. in F5 Distributed Cloud.
terraform { required_version = ">= 1.0"
required_providers { f5xc = { source = "f5xc-salesdemos/f5xc" version = ">= 0.1.0" } }}
# Basic Application Profiles configurationresource "f5xc_application_profiles" "example" { name = "example-application-profiles" namespace = "staging"
labels = { environment = "production" managed_by = "terraform" }
annotations = { "owner" = "platform-team" }
# Resource-specific configuration # Configuration parameter for advanced tcp profile. advanced_tcp_profile { # Configure advanced_tcp_profile settings } # Configuration parameter for disable tcp advanced profile. disable_tcp_advanced_profile { # Configure disable_tcp_advanced_profile settings } # Configuration parameter for enable tcp advanced profile. enable_tcp_advanced_profile { # Configure enable_tcp_advanced_profile settings }}Argument Reference
Section titled “Argument Reference”🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.
Metadata Argument Reference
Section titled “Metadata Argument Reference”• name - Required String
Name of the Application Profiles. Must be unique within the namespace
• namespace - Required String
Namespace where the Application Profiles will be created
• annotations - Optional Map
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
• description - Optional String
Human readable description for the object
• disable - Optional Bool
A value of true will administratively disable the object
• labels - Optional Map
Labels is a user defined key value map that can be attached to resources for organization and filtering
Spec Argument Reference
Section titled “Spec Argument Reference”• advanced_tcp_profile - Optional Block
Configuration parameter for advanced TCP profile
See Advanced TCP Profile below for details.
• ddos_profile - Optional Block
Configuration parameter for DDOS profile
See DDOS Profile below for details.
• irules - Optional Block
OPTIONS for attaching iRules to BIG-IP Proxy
See Irules below for details.
• timeouts - Optional Block
See Timeouts below for details.
• traffic_policies - Optional Block
Configuration parameter for traffic policies
See Traffic Policies below for details.
• virtual_server - Optional Block
Specifies configuration related to virtual server
See Virtual Server below for details.
Attributes Reference
Section titled “Attributes Reference”In addition to all arguments above, the following attributes are exported:
• id - Optional String
Unique identifier for the resource
Advanced TCP Profile
Section titled “Advanced TCP Profile”An advanced_tcp_profile block supports the following:
• disable_tcp_advanced_profile - Optional Block
Configuration parameter for disable TCP advanced profile
• enable_tcp_advanced_profile - Optional Block
Configuration parameter for enable TCP advanced profile
DDOS Profile
Section titled “DDOS Profile”A ddos_profile block supports the following:
• disable_ddos_mitigation - Optional Block
Enable this option
• enable_ddos_mitigation - Optional Block
Enable this option
Irules
Section titled “Irules”An irules block supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Timeouts
Section titled “Timeouts”A timeouts block supports the following:
• create - Optional String (Defaults to 10 minutes)
Used when creating the resource
• delete - Optional String (Defaults to 10 minutes)
Used when deleting the resource
• read - Optional String (Defaults to 5 minutes)
Used when retrieving the resource
• update - Optional String (Defaults to 10 minutes)
Used when updating the resource
Traffic Policies
Section titled “Traffic Policies”A traffic_policies block supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server
Section titled “Virtual Server”A virtual_server block supports the following:
• address_translation - Optional Block
Specifies, when checked (enabled), that the system translates the address of the virtual server. When cleared (disabled), specifies that the system uses the address without translation. This option is useful when the system is load balancing devices that have the
same IP address
See Address Translation below.
• auto_last_hop - Optional Block
When enabled, allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. As a result, the system can send return traffic to clients even when there is no matching route. For
example, if the
See Auto Last Hop below.
• clone_pool_client - Optional Block
Replicates client-side traffic (that is, prior to address translation) to a member of the specified pool
See Clone Pool Client below.
• clone_pool_server - Optional Block
Replicates server-side traffic (that is, prior to address translation) to a member of the specified pool
See Clone Pool Server below.
• connection_limit - Optional Number
Specifies the maximum number of concurrent connections allowed for the virtual server. Setting this to 0 turns off connection limits. The
• connection_rate_limit - Optional Number
Specifies the maximum number of connections-per-second allowed for a virtual server. When the number of connections-per-second reaches the limit for a given virtual server, the system drops (UDP) or resets (TCP) additional connection requests. This helps
detect Denial of Service attacks, where
• connection_rate_limit_mode - Optional Block
Configuration parameter for connection rate limit mode
See Connection Rate Limit Mode below.
• default_persistence_profile - Optional Block
Configuration parameter for default persistence profile
See Default Persistence Profile below.
• default_pool - Optional Block
Specifies the pool name that you want the virtual server to use as the default pool. A load balancing virtual server sends traffic to this pool automatically, unless an iRule directs the server to send the traffic to another pool instead
See Default
Pool below.
• fallback_persistence_profile - Optional Block
Configuration parameter for fallback persistence profile
See Fallback Persistence Profile below.
• fix_profile - Optional Block
Configuration parameter for fix profile
See Fix Profile below.
• http - Optional Block
HTTP profiles
See HTTP below.
• https - Optional Block
HTTPS profiles
See HTTPS below.
• immediate_action_on_service_down - Optional Block
Specifies the immediate action the BIG-IP system should respond with upon the receipt of the initial client’s SYN packet, if the availability status of the virtual server is Offline or Unavailable. This is supported for the virtual server of Standard type and TCP protocol. The default is
None
See Immediate Action On Service Down below.
• last_hop_pool - Optional Block
Directs reply traffic to the last hop router using the specified pool
See Last Hop Pool below.
• nat64 - Optional Block
When enabled, allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. As a result, the system can send return traffic to clients even when there is no matching route. For example, if the
See
Nat64 below.
• port_translation - Optional Block
Specifies, when checked (enabled), that the system translates the port of the virtual server. When cleared (disabled), specifies that the system uses the port without translation. Turning off port translation for a virtual server is useful if you want to use the virtual
server to load balance
See Port Translation below.
• request_logging_profile - Optional Block
Configuration parameter for request logging profile
See Request Logging Profile below.
• source_port - Optional Block
Specifies whether the system preserves the source port of the connection. The default is Preserve
See Source Port below.
• statistics_profile - Optional Block
Configuration parameter for statistics profile
See Statistics Profile below.
• tcp - Optional Block
TCP profiles
See TCP below.
• udp - Optional Block
These OPTIONS will be enhanced in future MR
See UDP below.
• virtual_server_state - Optional Block
Displays the current state on the object
See Virtual Server State below.
• vs_score - Optional Number
Specifies the virtual server score in percent. Global Traffic Manager (GTM) can rely on this value to load balance traffic in a proportional manner. The , meaning that no additional metric is applied for the virtual server
Virtual Server Address Translation
Section titled “Virtual Server Address Translation”An address_translation block (within virtual_server) supports the following:
• address_translation_disable - Optional Block
Enable this option
• address_translation_enable - Optional Block
Enable this option
Virtual Server Auto Last Hop
Section titled “Virtual Server Auto Last Hop”An auto_last_hop block (within virtual_server) supports the following:
• auto_last_hop_default - Optional Block
Configuration parameter for auto last hop default
• auto_last_hop_disable - Optional Block
Configuration parameter for auto last hop disable
• auto_last_hop_enable - Optional Block
Configuration parameter for auto last hop enable
Virtual Server Clone Pool Client
Section titled “Virtual Server Clone Pool Client”A clone_pool_client block (within virtual_server) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server Clone Pool Server
Section titled “Virtual Server Clone Pool Server”A clone_pool_server block (within virtual_server) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server Connection Rate Limit Mode
Section titled “Virtual Server Connection Rate Limit Mode”A connection_rate_limit_mode block (within virtual_server) supports the following:
• per_destination_address - Optional Block
Destination Address Mask
See Per Destination Address below.
• per_source_address - Optional Block
Source Address Mask
See Per Source Address below.
• per_source_destination_address - Optional Block
Destination and Source Address Mask
See Per Source Destination Address below.
• per_virtual_server - Optional Block
Configuration parameter for per virtual server
• per_virtual_server_destination_address - Optional Block
Destination Address Mask
See Per Virtual Server Destination Address below.
• per_virtual_server_source_address - Optional Block
Source Address Mask
See Per Virtual Server Source Address below.
• per_virtual_server_source_destination_address - Optional Block
Destination and Source Address Mask
See Per Virtual Server Source Destination Address below.
Virtual Server Connection Rate Limit Mode Per Destination Address
Section titled “Virtual Server Connection Rate Limit Mode Per Destination Address”Deeply nested Address block collapsed for readability.
Virtual Server Connection Rate Limit Mode Per Source Address
Section titled “Virtual Server Connection Rate Limit Mode Per Source Address”Deeply nested Address block collapsed for readability.
Virtual Server Connection Rate Limit Mode Per Source Destination Address
Section titled “Virtual Server Connection Rate Limit Mode Per Source Destination Address”Deeply nested Address block collapsed for readability.
Virtual Server Connection Rate Limit Mode Per Virtual Server Destination Address
Section titled “Virtual Server Connection Rate Limit Mode Per Virtual Server Destination Address”Deeply nested Address block collapsed for readability.
Virtual Server Connection Rate Limit Mode Per Virtual Server Source Address
Section titled “Virtual Server Connection Rate Limit Mode Per Virtual Server Source Address”Deeply nested Address block collapsed for readability.
Virtual Server Connection Rate Limit Mode Per Virtual Server Source Destination Address
Section titled “Virtual Server Connection Rate Limit Mode Per Virtual Server Source Destination Address”Deeply nested Address block collapsed for readability.
Virtual Server Default Persistence Profile
Section titled “Virtual Server Default Persistence Profile”A default_persistence_profile block (within virtual_server) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server Default Pool
Section titled “Virtual Server Default Pool”A default_pool block (within virtual_server) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server Fallback Persistence Profile
Section titled “Virtual Server Fallback Persistence Profile”A fallback_persistence_profile block (within virtual_server) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server Fix Profile
Section titled “Virtual Server Fix Profile”A fix_profile block (within virtual_server) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTP
Section titled “Virtual Server HTTP”A http block (within virtual_server) supports the following:
• http_client_profile - Optional Block
HTTP Profile (Client). Client-side configuration
See HTTP Client Profile below.
• http_server_profile - Optional Block
Configuration parameter for HTTP server profile
See HTTP Server Profile below.
• stream_profile - Optional Block
Configuration parameter for stream profile
See Stream Profile below.
• tcp_client_profile - Optional Block
Protocol Profile (Client). Client-side configuration
See TCP Client Profile below.
• tcp_server_profile - Optional Block
Configuration parameter for TCP server profile
See TCP Server Profile below.
• websocket_client_profile - Optional Block
WebSocket Profile Client. Web-related configuration
See WebSocket Client Profile below.
• websocket_server_profile - Optional Block
WebSocket Profile Server. Web-related configuration
See WebSocket Server Profile below.
Virtual Server HTTP HTTP Client Profile
Section titled “Virtual Server HTTP HTTP Client Profile”A http_client_profile block (within virtual_server.http) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTP HTTP Server Profile
Section titled “Virtual Server HTTP HTTP Server Profile”A http_server_profile block (within virtual_server.http) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTP Stream Profile
Section titled “Virtual Server HTTP Stream Profile”A stream_profile block (within virtual_server.http) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTP TCP Client Profile
Section titled “Virtual Server HTTP TCP Client Profile”A tcp_client_profile block (within virtual_server.http) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTP TCP Server Profile
Section titled “Virtual Server HTTP TCP Server Profile”A tcp_server_profile block (within virtual_server.http) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTP WebSocket Client Profile
Section titled “Virtual Server HTTP WebSocket Client Profile”A websocket_client_profile block (within virtual_server.http) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTP WebSocket Server Profile
Section titled “Virtual Server HTTP WebSocket Server Profile”A websocket_server_profile block (within virtual_server.http) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTPS
Section titled “Virtual Server HTTPS”A https block (within virtual_server) supports the following:
• http_client_profile - Optional Block
HTTP Profile (Client). Client-side configuration
See HTTP Client Profile below.
• http_server_profile - Optional Block
Configuration parameter for HTTP server profile
See HTTP Server Profile below.
• stream_profile - Optional Block
Configuration parameter for stream profile
See Stream Profile below.
• tcp_client_profile - Optional Block
Protocol Profile (Client). Client-side configuration
See TCP Client Profile below.
• tcp_server_profile - Optional Block
Configuration parameter for TCP server profile
See TCP Server Profile below.
• websocket_client_profile - Optional Block
WebSocket Profile Client. Web-related configuration
See WebSocket Client Profile below.
• websocket_server_profile - Optional Block
WebSocket Profile Server. Web-related configuration
See WebSocket Server Profile below.
Virtual Server HTTPS HTTP Client Profile
Section titled “Virtual Server HTTPS HTTP Client Profile”A http_client_profile block (within virtual_server.https) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTPS HTTP Server Profile
Section titled “Virtual Server HTTPS HTTP Server Profile”A http_server_profile block (within virtual_server.https) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTPS Stream Profile
Section titled “Virtual Server HTTPS Stream Profile”A stream_profile block (within virtual_server.https) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTPS TCP Client Profile
Section titled “Virtual Server HTTPS TCP Client Profile”A tcp_client_profile block (within virtual_server.https) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTPS TCP Server Profile
Section titled “Virtual Server HTTPS TCP Server Profile”A tcp_server_profile block (within virtual_server.https) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTPS WebSocket Client Profile
Section titled “Virtual Server HTTPS WebSocket Client Profile”A websocket_client_profile block (within virtual_server.https) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server HTTPS WebSocket Server Profile
Section titled “Virtual Server HTTPS WebSocket Server Profile”A websocket_server_profile block (within virtual_server.https) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server Immediate Action On Service Down
Section titled “Virtual Server Immediate Action On Service Down”An immediate_action_on_service_down block (within virtual_server) supports the following:
• immediate_action_on_service_down_drop - Optional Block
Enable this option
• immediate_action_on_service_down_none - Optional Block
Enable this option
• immediate_action_on_service_down_reset - Optional Block
Enable this option
Virtual Server Last Hop Pool
Section titled “Virtual Server Last Hop Pool”A last_hop_pool block (within virtual_server) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server Nat64
Section titled “Virtual Server Nat64”A nat64 block (within virtual_server) supports the following:
• nat64_disable - Optional Block
Configuration parameter for nat64 disable
• nat64_enable - Optional Block
Configuration parameter for nat64 enable
Virtual Server Port Translation
Section titled “Virtual Server Port Translation”A port_translation block (within virtual_server) supports the following:
• port_translation_disable - Optional Block
Enable this option
• port_translation_enable - Optional Block
Enable this option
Virtual Server Request Logging Profile
Section titled “Virtual Server Request Logging Profile”A request_logging_profile block (within virtual_server) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server Source Port
Section titled “Virtual Server Source Port”A source_port block (within virtual_server) supports the following:
• source_port_change - Optional Block
Enable this option
• source_port_preserve - Optional Block
Enable this option
• source_port_preserve_strict - Optional Block
Enable this option
Virtual Server Statistics Profile
Section titled “Virtual Server Statistics Profile”A statistics_profile block (within virtual_server) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server TCP
Section titled “Virtual Server TCP”A tcp block (within virtual_server) supports the following:
• tcp_client_profile - Optional Block
Protocol Profile (Client). Client-side configuration
See TCP Client Profile below.
• tcp_server_profile - Optional Block
Configuration parameter for TCP server profile
See TCP Server Profile below.
Virtual Server TCP TCP Client Profile
Section titled “Virtual Server TCP TCP Client Profile”A tcp_client_profile block (within virtual_server.tcp) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server TCP TCP Server Profile
Section titled “Virtual Server TCP TCP Server Profile”A tcp_server_profile block (within virtual_server.tcp) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server UDP
Section titled “Virtual Server UDP”An udp block (within virtual_server) supports the following:
• tcp_client_profile - Optional Block
Protocol Profile (Client). Client-side configuration
See TCP Client Profile below.
• tcp_server_profile - Optional Block
Configuration parameter for TCP server profile
See TCP Server Profile below.
Virtual Server UDP TCP Client Profile
Section titled “Virtual Server UDP TCP Client Profile”A tcp_client_profile block (within virtual_server.udp) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server UDP TCP Server Profile
Section titled “Virtual Server UDP TCP Server Profile”A tcp_server_profile block (within virtual_server.udp) supports the following:
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Virtual Server Virtual Server State
Section titled “Virtual Server Virtual Server State”A virtual_server_state block (within virtual_server) supports the following:
• state_disabled - Optional Block
Enable this option
• state_enabled - Optional Block
Enable this option
Common Types
Section titled “Common Types”The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.
Object Reference {#common-object-reference}
Section titled “Object Reference {#common-object-reference}”Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format tenant/namespace/name.
| Field | Type | Description |
|---|---|---|
name | String | Name of the referenced object |
namespace | String | Namespace containing the referenced object |
tenant | String | Tenant of the referenced object (system-managed) |
Transformers {#common-transformers}
Section titled “Transformers {#common-transformers}”Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.
| Value | Description |
|---|---|
LOWER_CASE | Convert to lowercase |
UPPER_CASE | Convert to uppercase |
BASE64_DECODE | Decodebase64 content |
NORMALIZE_PATH | Normalize URL path |
REMOVE_WHITESPACE | Remove whitespace characters |
URL_DECODE | Decode URL-encoded characters |
TRIM_LEFT | Trim leading whitespace |
TRIM_RIGHT | Trim trailing whitespace |
TRIM | Trim both leading and trailing whitespace |
HTTP Methods {#common-http-methods}
Section titled “HTTP Methods {#common-http-methods}”HTTP methods used for request matching.
| Value | Description |
|---|---|
ANY | Match any HTTP method |
GET | HTTP GET request |
HEAD | HTTP HEAD request |
POST | HTTP POST request |
PUT | HTTP PUT request |
DELETE | HTTP DELETE request |
CONNECT | HTTP CONNECT request |
OPTIONS | HTTP OPTIONS request |
TRACE | HTTP TRACE request |
PATCH | HTTP PATCH request |
COPY | HTTP COPY request (WebDAV) |
TLS Fingerprints {#common-tls-fingerprints}
Section titled “TLS Fingerprints {#common-tls-fingerprints}”TLS fingerprint categories for malicious client detection.
| Value | Description |
|---|---|
TLS_FINGERPRINT_NONE | No fingerprint matching |
ANY_MALICIOUS_FINGERPRINT | Match any known malicious fingerprint |
ADWARE | Adware-associated fingerprints |
DRIDEX | Dridex malware fingerprints |
GOOTKIT | Gootkit malware fingerprints |
RANSOMWARE | Ransomware-associated fingerprints |
TRICKBOT | Trickbot malware fingerprints |
IP Threat Categories {#common-ip-threat-categories}
Section titled “IP Threat Categories {#common-ip-threat-categories}”IP address threat categories for security filtering.
| Value | Description |
|---|---|
SPAM_SOURCES | Known spam sources |
WINDOWS_EXPLOITS | Windows exploit sources |
WEB_ATTACKS | Web attack sources |
BOTNETS | Known botnet IPs |
SCANNERS | Network scanner IPs |
REPUTATION | Poor reputation IPs |
PHISHING | Phishing-related IPs |
PROXY | Anonymous proxy IPs |
MOBILE_THREATS | Mobile threat sources |
TOR_PROXY | Tor exit nodes |
DENIAL_OF_SERVICE | DoS attack sources |
NETWORK | Known bad network ranges |
Import
Section titled “Import”Import is supported using the following syntax:
# Import using namespace/name formatterraform import f5xc_application_profiles.example system/example