f5xc_bgp Resource - terraform-provider-f5xc

f5xc_bgp (Resource)

Manages a BGP resource in F5 Distributed Cloud for bgp object is the configuration for peering with external bgp servers. it is created by users in system namespace. configuration.

~> Note For more information about this resource, please refer to the F5 XC API Documentation.

Example Usage

# BGP Resource Example
# Manages a BGP resource in F5 Distributed Cloud for bgp object is the configuration for peering with external bgp servers. it is created by users in system namespace. configuration.

terraform {
  required_version = ">= 1.0"

  required_providers {
    f5xc = {
      source  = "f5xc-salesdemos/f5xc"
      version = ">= 0.1.0"
    }
  }
}

# Basic BGP configuration
resource "f5xc_bgp" "example" {
  name      = "example-bgp"
  namespace = "staging"

  labels = {
    environment = "production"
    managed_by  = "terraform"
  }

  annotations = {
    "owner" = "platform-team"
  }

  # BGP configuration
  bgp_router_id = "192.168.1.1"

  bgp_peers {
    metadata {
      name = "upstream-peer"
    }
    spec {
      peer_asn     = 65000
      peer_address = "192.168.1.2"
    }
  }

  local_asn = 65001

  # Site reference
  site {
    name      = "example-site"
    namespace = "staging"
  }
}

Argument Reference

🔶 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 BGP. Must be unique within the namespace

• namespace - Required String
Namespace where the BGP 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

• bgp_parameters - Optional Block
Configuration parameter for BGP parameters
See BGP Parameters below for details.

• peers - Optional Block
Peers. List of peers
See Peers below for details.

• timeouts - Optional Block
See Timeouts below for details.

• where - Optional Block
VirtualSiteSiteRefSelector defines a union of reference to site or reference to virtual_site It used to refer site or a group of sites indicated by virtual site
See Where below for details.

Attributes Reference

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

• id - Optional String
Unique identifier for the resource

BGP Parameters

A bgp_parameters block supports the following:

• asn - Optional Number
ASN. Autonomous System Number

• from_site - Optional Block
Enable this option

• ip_address - Optional String
Use the configured IPv4 Address as Router ID

• local_address - Optional Block
Enable this option

Peers

A peers block supports the following:

• bfd_disabled - Optional Block
Enable this option

• bfd_enabled - Optional Block
BFD. BFD parameters
See Bfd Enabled below.

• disable_spec - Optional Block
Enable this option

• external - Optional Block
External BGP Peer. External BGP Peer parameters
See External below.

• label - Optional String
Label. Specify whether this peer should be

• metadata - Optional Block
MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create
See Metadata below.

• passive_mode_disabled - Optional Block
Enable this option

• passive_mode_enabled - Optional Block
Enable this option

• routing_policies - Optional Block
List of rules which can be applied on all or particular nodes
See Routing Policies below.

Peers Bfd Enabled

A bfd_enabled block (within peers) supports the following:

• multiplier - Optional Number
Specify Number of missed packets to bring session down’

• receive_interval_milliseconds - Optional Number
BFD receive interval timer, in milliseconds

• transmit_interval_milliseconds - Optional Number
BFD transmit interval timer, in milliseconds

Peers External

An external block (within peers) supports the following:

• address - Optional String
Specify IPv4 peer address

• address_ipv6 - Optional String
Specify peer IPv6 address

• asn - Optional Number
Autonomous System Number for BGP peer

• default_gateway - Optional Block
Configuration parameter for default gateway

• default_gateway_v6 - Optional Block
Configuration parameter for default gateway v6

• disable_spec - Optional Block
Enable this option

• disable_v6 - Optional Block
Enable this option

• external_connector - Optional Block
Configuration parameter for external connector

• family_inet - Optional Block
Configuration parameter for family inet
See Family Inet below.

• from_site - Optional Block
Enable this option

• from_site_v6 - Optional Block
Enable this option

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

• interface_list - Optional Block
Interface List. List of network interfaces
See Interface List below.

• md5_auth_key - Optional String
MD5 key for protecting BGP Sessions (RFC 2385)

• no_authentication - Optional Block
Configuration parameter for no authentication

• port - Optional Number
Peer Port. Peer TCP port number

• subnet_begin_offset - Optional Number
Calculate peer address using offset from the beginning of the subnet

• subnet_begin_offset_v6 - Optional Number
Calculate peer address using offset from the beginning of the subnet

• subnet_end_offset - Optional Number
Calculate peer address using offset from the end of the subnet

• subnet_end_offset_v6 - Optional Number
Calculate peer address using offset from the end of the subnet

Peers External Family Inet

A family_inet block (within peers.external) supports the following:

• disable_spec - Optional Block
Enable this option

• enable - Optional Block
Enable this option

Peers External Interface

An interface block (within peers.external) supports the following:

• 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

Peers External Interface List

An interface_list block (within peers.external) supports the following:

• interfaces - Optional Block
List of network interfaces
See Interfaces below.

Peers External Interface List Interfaces

An interfaces block (within peers.external.interface_list) supports the following:

• 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

Peers Metadata

A metadata block (within peers) supports the following:

• description_spec - Optional String
Description. Human readable description

• name - Optional String
Name of the message. The value of name has to follow DNS-1035 format

Peers Routing Policies

A routing_policies block (within peers) supports the following:

• route_policy - Optional Block
Policy configuration for this feature
See Route Policy below.

Peers Routing Policies Route Policy

A route_policy block (within peers.routing_policies) supports the following:

• all_nodes - Optional Block
Enable this option

• inbound - Optional Block
Enable this option

• node_name - Optional Block
List of nodes on which BGP routing policy has to be applied
See Node Name below.

• object_refs - Optional Block
Select route policy to apply
See Object Refs below.

• outbound - Optional Block
Enable this option

Peers Routing Policies Route Policy Node Name

A node_name block (within peers.routing_policies.route_policy) supports the following:

• node - Optional List
Select BGP Session on which policy will be applied

Peers Routing Policies Route Policy Object Refs

An object_refs block (within peers.routing_policies.route_policy) 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

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

Where

A where block supports the following:

• site - Optional Block
Specifies a direct reference to a site configuration object
See Site below.

• virtual_site - Optional Block
Virtual Site. A reference to virtual_site object
See Virtual Site below.

Where Site

A site block (within where) supports the following:

• disable_internet_vip - Optional Block
Enable this option

• enable_internet_vip - Optional Block
Enable this option

• network_type - Optional String Defaults to VIRTUAL_NETWORK_SITE_LOCAL
Possible values are VIRTUAL_NETWORK_SITE_LOCAL, VIRTUAL_NETWORK_SITE_LOCAL_INSIDE, VIRTUAL_NETWORK_PER_SITE, VIRTUAL_NETWORK_PUBLIC, VIRTUAL_NETWORK_GLOBAL, VIRTUAL_NETWORK_SITE_SERVICE, VIRTUAL_NETWORK_VER_INTERNAL, VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE, VIRTUAL_NETWORK_IP_AUTO, VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK, VIRTUAL_NETWORK_SRV6_NETWORK, VIRTUAL_NETWORK_IP_FABRIC, VIRTUAL_NETWORK_SEGMENT, VIRTUAL_NETWORK_MANAGEMENT
[Enum: VIRTUAL_NETWORK_SITE_LOCAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE|VIRTUAL_NETWORK_PER_SITE|VIRTUAL_NETWORK_PUBLIC|VIRTUAL_NETWORK_GLOBAL|VIRTUAL_NETWORK_SITE_SERVICE|VIRTUAL_NETWORK_VER_INTERNAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE|VIRTUAL_NETWORK_IP_AUTO|VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK|VIRTUAL_NETWORK_SRV6_NETWORK|VIRTUAL_NETWORK_IP_FABRIC|VIRTUAL_NETWORK_SEGMENT|VIRTUAL_NETWORK_MANAGEMENT] Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to

• ref - Optional Block
Reference. A site direct reference
See Ref below.

Where Site Ref

A ref block (within where.site) 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

Where Virtual Site

A virtual_site block (within where) supports the following:

• disable_internet_vip - Optional Block
Enable this option

• enable_internet_vip - Optional Block
Enable this option

• ref - Optional Block
Virtual_site direct reference
See Ref below.

Where Virtual Site Ref

A ref block (within where.virtual_site) 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

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

Import

Import is supported using the following syntax:

# Import using namespace/name format
terraform import f5xc_bgp.example system/example