xcsh_bgp_routing_policy (Data Source)

Retrieves information about a BGP Routing Policy resource in F5 Distributed Cloud for bgp routing policy is a list of rules containing match criteria and action to be applied. these rules help control routes which are imported or exported to bgp peers. configuration. This is a read-only data source.

~> Note: For more information, see the F5 Distributed Cloud API documentation.

Example Usage

# BGPRoutingPolicy Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing BGPRoutingPolicy by name
data "xcsh_bgp_routing_policy" "example" {
  name      = "example-bgp-routing-policy"
  namespace = "staging"
}

output "bgp_routing_policy_id" {
  value = data.xcsh_bgp_routing_policy.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.

Metadata Argument Reference

• name - Required String
Name of the BGPRoutingPolicy

• namespace - Required String
Namespace where the BGPRoutingPolicy exists

Attributes Reference

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

• annotations - Optional Map
Annotations applied to this resource

• description - Optional String
Description of the BGPRoutingPolicy

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• rules - Optional List
BGP Routing policy is composed of one or more rules. Note that the order of rules is critical as rules are applied top to bottom

---

Rules

A rules block supports the following:

• action - Optional String
Action to be enforced if the BGP route matches the rule

• match - Optional String
Predicates which have to match information in route for action to be applied

Rules Action

An action block (within rules) supports the following:

• allow - Optional Object
Enable this option

• as_path - Optional String
AS-Path Prepending is generally used to influence incoming traffic

• community - Optional String
BGP Community list. List of BGP communities

• deny - Optional Object
Enable this option

• local_preference - Optional Number
BGP Local Preference is generally used to influence outgoing traffic

• metric - Optional Number
The Multi-Exit Discriminator metric to indicate the preferred path to AS

Rules Action Community

A community block (within rules.action) supports the following:

• community - Optional List
Unordered set of RFC 1997 defined 4-byte community, first 16 bits being ASN and lower 16 bits being value

Rules Match

A match block (within rules) supports the following:

• as_path - Optional String
AS path can also be a regex, which will be matched against route information

• community - Optional String
BGP Community list. List of BGP communities

• ip_prefixes - Optional String
List of IP prefix and prefix length range match condition

Rules Match Community

A community block (within rules.match) supports the following:

• community - Optional List
Unordered set of RFC 1997 defined 4-byte community, first 16 bits being ASN and lower 16 bits being value

Rules Match IP Prefixes

An ip_prefixes block (within rules.match) supports the following:

• prefixes - Optional List
Prefix list. List of IP prefix

Rules Match IP Prefixes Prefixes

A prefixes block (within rules.match.ip_prefixes) supports the following:

• equal_or_longer_than - Optional Object
Configuration parameter for equal or longer than

• exact_match - Optional Object
Configuration parameter for exact match

• ip_prefixes - Optional String
IP Prefix. IP prefix to match on BGP route

• longer_than - Optional Object
Configuration parameter for longer than

Rules Match IP Prefixes Prefixes Equal Or Longer Than

Deeply nested Than block collapsed for readability.

Rules Match IP Prefixes Prefixes Exact Match

An exact_match block (within rules.match.ip_prefixes.prefixes) supports the following:

Rules Match IP Prefixes Prefixes Longer Than

A longer_than block (within rules.match.ip_prefixes.prefixes) supports the following:

---

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}

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}

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}

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}

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}

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