xcsh_http_loadbalancer (Data Source)

Retrieves information about an HTTP Load Balancer resource in F5 Distributed Cloud for load balancing HTTP/HTTPS traffic with routing and security controls. This is a read-only data source.

~> Note: For more information, see the HTTP Loadbalancer API documentation.

Example Usage

# HTTPLoadBalancer Data Source Example

terraform {
  required_version = ">= 1.0"

  required_providers {
    xcsh = {
      source  = "f5-sales-demo/xcsh"
      version = ">= 0.1.0"
    }
  }
}

# Look up an existing HTTPLoadBalancer by name
data "xcsh_http_loadbalancer" "example" {
  name      = "example-http-loadbalancer"
  namespace = "staging"
}

output "http_loadbalancer_id" {
  value = data.xcsh_http_loadbalancer.example.id
}

Argument Reference

-> Syntax Rule: This provider uses OneOf groups for mutually exclusive options. Fields documented as “Optional Block” use block syntax field_name { ... }. Empty OneOf object attributes use field_name = {}; conditional selection uses condition ? {} : null. Boolean attributes (such as add_hsts and http_redirect) use = true or = false.

🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.

~> Dependencies — This resource requires: origin_pool.

Minimum Configuration

Required fields:

name
namespace
domains

Example (API format):

apiVersion: v1
kind: http_loadbalancer
metadata:
  name: example-app
  namespace: demo-app
spec:
  domains:
    - example.com
  https_auto_cert:
    port: 443
    tls_config:
      default_security: {}
  advertise_on_public_default_vip: {}
  routes:
    - prefix: "/"
      origin_pool:
        pool_name: backend-pool

Metadata Argument Reference

• name - Required String
Name of the HTTPLoadBalancer

• namespace - Required String
Namespace where the HTTPLoadBalancer exists

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• active_service_policies - Optional String
Configuration parameter for active service policies

• add_location - Optional Bool Defaults to false
Add Location. X-example: true Appends header x-F5 Distributed Cloud-location = <RE-site-name> in responses. This configuration is ignored on CE sites. Server applies default when omitted

• advertise_custom - Optional String
Defines a way to advertise a VIP on specific sites

• advertise_on_public - Optional String
Defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available

• advertise_on_public_default_vip - Optional Object
Enable this option

• annotations - Optional Map
Annotations applied to this resource

• api_protection_rules - Optional String
API Protection Rules. API Protection Rules

• api_rate_limit - Optional String
Path- or API-group-scoped rate limiting. Define server_url_rules or api_endpoint_rules and choose inline_rate_limiter for an inline limit, or ref_rate_limiter for a stored rate-limiter reference

• api_specification - Optional String
Settings for API specification (API definition, OpenAPI validation, etc.)

• api_testing - Optional String
API Testing

• app_firewall - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• blocked_clients - Optional List
Define rules to block IP Prefixes or AS numbers

• bot_defense - Optional String
Defines various configuration OPTIONS for Bot Defense Policy

• bot_defense_advanced - Optional String
Configuration parameter for bot defense advanced

• caching_policy - Optional String
Policy configuration for this feature

• captcha_challenge - Optional String
Enables loadbalancer to perform captcha challenge Captcha challenge will be based on Google Recaptcha. With this feature enabled, only clients that pass the captcha challenge will be allowed to complete the HTTP request. When loadbalancer is configured to do Captcha Challenge, it will redirect

• client_side_defense - Optional String
Defines various configuration OPTIONS for Client-Side Defense Policy

• cookie_stickiness - Optional String
Two types of cookie affinity: 1. Passive. Takes a cookie that’s present in the cookies header and hashes on its value. 2. Generated. Generates and sets a cookie with an expiration (TTL) on the first request from the client in its response to the client, based on the endpoint the request gets

• cors_policy - Optional String
Cross-Origin Resource Sharing requests configuration specified at Virtual-host or Route level. Route level configuration takes precedence. An example of an Cross origin HTTP request GET /resources/public-data/ HTTP/1.1 Host: bar.other User-Agent: Mozilla/5.0 (Macintosh; U; Intel macOS X 10.5

• csrf_policy - Optional String
To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request’s origin is the same as its destination.the policy relies on two pieces of information used in determining if a request originated from the same host. 1. The origin that caused the user agent

• data_guard_rules - Optional List
Data Guard prevents responses from exposing sensitive information by masking the data. The system masks credit card numbers and social security numbers leaked from the application from within the HTTP response with a string of asterisks (*)

• ddos_mitigation_rules - Optional List
Define manual mitigation rules to block L7 DDOS attacks

• default_pool - Optional String
Configuration parameter for default pool

• default_pool_list - Optional String
Origin Pool List Type. List of Origin Pools

• default_route_pools - Optional List
Origin Pools used when no route is specified (default route)

• default_sensitive_data_policy - Optional Object Defaults to map[]
Policy configuration for this feature. Server applies default when omitted

• description - Optional String
Description of the HTTPLoadBalancer

• disable_api_definition - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• disable_api_discovery - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• disable_api_testing - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• disable_bot_defense - Optional Object Defaults to map[]
Configuration parameter for disable bot defense. Server applies default when omitted

• disable_caching - Optional Object
Configuration parameter for disable caching

• disable_client_side_defense - Optional Object
Enable this option

• disable_ip_reputation - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• disable_malicious_user_detection - Optional Object Defaults to map[]
Configuration parameter for disable malicious user detection. Server applies default when omitted

• disable_malware_protection - Optional Object Defaults to map[]
Configuration parameter for disable malware protection. Server applies default when omitted

• disable_rate_limit - Optional Object Defaults to map[]
Configuration parameter for disable rate limit. Server applies default when omitted

• disable_threat_mesh - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• disable_trust_client_ip_headers - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• disable_waf - Optional Object Defaults to map[]
Configuration parameter for disable WAF. Server applies default when omitted

• do_not_advertise - Optional Object
Configuration parameter for do not advertise

• domains - Optional List
List of Domains (host/authority header) that will be matched to load balancer. Supported Domains and search order: 1. Exact Domain names: www.example.com. 2

• enable_api_discovery - Optional String
Specifies the settings used for API discovery

• enable_challenge - Optional String
Configure auto mitigation i.e risk based challenges for malicious users

• enable_ip_reputation - Optional String
IP Threat Category List. List of IP threat categories

• enable_malicious_user_detection - Optional Object
Configuration parameter for enable malicious user detection

• enable_threat_mesh - Optional Object
Enable this option

• enable_trust_client_ip_headers - Optional String
Trust Client IP Headers List. List of Client IP Headers

• graphql_rules - Optional List
GraphQL is a query language and server-side runtime for APIs which provides a complete and understandable description of the data in API. GraphQL gives clients the power to ask for exactly what they need, makes it easier to evolve APIs over time, and enables powerful developer tools. Policy

• http - Optional String
HTTP Choice. Choice for selecting HTTP proxy

• https - Optional String
Choice for selecting HTTP proxy with bring your own certificates

• https_auto_cert - Optional String
Choice for selecting HTTP proxy with bring your own certificates

• id - Optional String
Unique identifier for the resource

• js_challenge - Optional String
Enables loadbalancer to perform client browser compatibility test by redirecting to a page with JavaScript. With this feature enabled, only clients that are capable of executing JavaScript(mostly browsers) will be allowed to complete the HTTP request. When loadbalancer is configured to do

• jwt_validation - Optional String
JWT Validation stops JWT replay attacks and JWT tampering by cryptographically verifying incoming JWTs before they are passed to your API origin. JWT Validation will also stop requests with expired tokens or tokens that are not yet valid

• l7_ddos_action_block - Optional Object
Enable this option

• l7_ddos_action_default - Optional Object
Enable this option

• l7_ddos_action_js_challenge - Optional String
Enables loadbalancer to perform client browser compatibility test by redirecting to a page with JavaScript. With this feature enabled, only clients that are capable of executing JavaScript(mostly browsers) will be allowed to complete the HTTP request. When loadbalancer is configured to do

• l7_ddos_protection - Optional String Defaults to map[]
L7 DDOS protection is critical for safeguarding web applications, APIs, and services that are exposed to the internet from sophisticated, volumetric, application-level threats. Configure actions, thresholds and policies to apply during L7 DDOS attack. Server applies default when omitted

• labels - Optional Map
Labels applied to this resource

• least_active - Optional Object
Enable this option

• malware_protection_settings - Optional String
Malware Protection protects Web Apps and APIs, from malicious file uploads by scanning files in real-time

• more_option - Optional String
Defines various OPTIONS to define a route

• multi_lb_app - Optional Object
Configuration parameter for multi LB app

• no_challenge - Optional Object Defaults to map[]
Configuration parameter for no challenge. Server applies default when omitted

• no_service_policies - Optional Object
Configuration parameter for no service policies

• origin_server_subset_rule_list - Optional String
Origin Server Subset Rule List Type. List of Origin Pools

• policy_based_challenge - Optional String
Specifies the settings for policy rule based challenge

• protected_cookies - Optional List
Allows setting attributes (SameSite, Secure, and HttpOnly) on cookies in responses. Cookie Tampering Protection prevents attackers from modifying the value of session cookies. For Cookie Tampering Protection, enabling a web app firewall (WAF) is a prerequisite

• random - Optional Object
Enable this option

• rate_limit - Optional String
Load-balancer-wide per-client rate limiting. The counter applies across every path; use api_rate_limit rules when only selected paths such as /login should be limited

• ring_hash - Optional String
Hash Policy List. List of hash policy rules

• round_robin - Optional Object Defaults to map[]
Configuration parameter for round robin. Server applies default when omitted

• routes - Optional List
Routes allow users to define match condition on a path and/or HTTP method to either forward matching traffic to origin pool or redirect matching traffic to a different URL or respond directly to matching traffic

• sensitive_data_disclosure_rules - Optional String
Sensitive Data Exposure Rules allows specifying rules to mask sensitive data fields in API responses

• sensitive_data_policy - Optional String
Policy configuration for this feature

• service_policies_from_namespace - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• single_lb_app - Optional String
Specific settings for Machine learning analysis on this HTTP LB, independently from other LBs

• slow_ddos_mitigation - Optional String
’Slow and low’ attacks tie up server resources, leaving none available for servicing requests from actual users

• source_ip_stickiness - Optional Object
Enable this option

• system_default_timeouts - Optional Object
Configuration parameter for system default timeouts

• trusted_clients - Optional List
Define rules to skip processing of one or more features such as WAF, Bot Defense etc

• user_id_client_ip - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• user_identification - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• waf_exclusion - Optional String
Configuration parameter for WAF exclusion

• policies - Optional List
Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It’s important to define the correct order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result. For each request, its

• 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

• advertise_where - Optional List
Where should this load balancer be available

• port - Optional Number
Port to Listen

• port_ranges - Optional String
A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by ’-’

• site - Optional String
Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised

• use_default_port - Optional Object
Enable this option

• virtual_network - Optional String
Parameters to advertise on a given virtual network

• virtual_site - Optional String
Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised

• virtual_site_with_vip - Optional String
Defines a reference to a customer site virtual site along with network type and IP where a load balancer could be advertised

• vk8s_service - Optional String
Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network

• public_ip - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• 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

• ip - Optional String
Use given IP address as VIP on the site

• network - Optional String Defaults to SITE_NETWORK_INSIDE_AND_OUTSIDE
Possible values are SITE_NETWORK_INSIDE_AND_OUTSIDE, SITE_NETWORK_INSIDE, SITE_NETWORK_OUTSIDE, SITE_NETWORK_SERVICE, SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP, SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP, SITE_NETWORK_IP_FABRIC
[Enum: SITE_NETWORK_INSIDE_AND_OUTSIDE|SITE_NETWORK_INSIDE|SITE_NETWORK_OUTSIDE|SITE_NETWORK_SERVICE|SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_IP_FABRIC] Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support. All inside networks

• site - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• 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

• default_v6_vip - Optional Object
Enable this option

• default_vip - Optional Object
Enable this option

• specific_v6_vip - Optional String
Use given IPv6 address as VIP on virtual Network

• specific_vip - Optional String
Use given IPv4 address as VIP on virtual Network

• virtual_network - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• 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

• virtual_site - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• 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

• ip - Optional String
Use given IP address as VIP on the site

• network - Optional String Defaults to SITE_NETWORK_SPECIFIED_VIP_OUTSIDE
Possible values are SITE_NETWORK_SPECIFIED_VIP_OUTSIDE, SITE_NETWORK_SPECIFIED_VIP_INSIDE
[Enum: SITE_NETWORK_SPECIFIED_VIP_OUTSIDE|SITE_NETWORK_SPECIFIED_VIP_INSIDE] Defines network types to be used on virtual-site with specified VIP All outside networks. All inside networks