Skip to content

xcsh_smsv2_kvm_runtime_interface (Resource)

Adopts one existing XC-owned KVM Secure Mesh Site v2 SLI child and manages only its DHCP/static IPv4 mode. It never creates or deletes the runtime child.

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

# Adopt the exact XC-owned SLI child discovered after a KVM CE registers.
terraform {
required_version = ">= 1.14"
required_providers {
xcsh = {
source = "f5-sales-demo/xcsh"
version = ">= 10.0.0"
}
}
}
resource "xcsh_smsv2_kvm_runtime_interface" "sli" {
namespace = "system"
site = "onprem-example-kvm"
expected_mac = "52:54:00:20:00:11"
ipv4_cidr = "10.201.0.11/24"
}

-> 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.

• namespace - Optional String
Namespace containing the site and runtime child. KVM SMSv2 supports only system

• expected_mac - Required String
Terraform-owned SLI MAC used for live registration correlation

• ipv4_cidr - Required String
Static IPv4 host address and prefix to configure on the SLI

• site - Required String
Secure Mesh Site v2 configuration name

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

• configured - Optional Bool
Whether the exact owned SLI currently uses static IPv4 configuration

• device - Optional String
Exact live registration device resolved from the expected MAC

• hostname - Optional String
Exact live registration hostname resolved from the expected MAC

• id - Optional String
Stable namespace/interface identity

• interface_name - Optional String
Exact platform-generated SLI child name resolved from live ownership. Platform names may exceed 64 characters

• owner_uid - Optional String
Secure Mesh Site v2 UID that owns the runtime child

• resource_version - Optional String
Latest XC concurrency version observed after reconciliation


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.

FieldTypeDescription
nameStringName of the referenced object
namespaceStringNamespace containing the referenced object
tenantStringTenant of the referenced object (system-managed)

Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.

ValueDescription
LOWER_CASEConvert to lowercase
UPPER_CASEConvert to uppercase
BASE64_DECODEDecodebase64 content
NORMALIZE_PATHNormalize URL path
REMOVE_WHITESPACERemove whitespace characters
URL_DECODEDecode URL-encoded characters
TRIM_LEFTTrim leading whitespace
TRIM_RIGHTTrim trailing whitespace
TRIMTrim both leading and trailing whitespace

HTTP methods used for request matching.

ValueDescription
ANYMatch any HTTP method
GETHTTP GET request
HEADHTTP HEAD request
POSTHTTP POST request
PUTHTTP PUT request
DELETEHTTP DELETE request
CONNECTHTTP CONNECT request
OPTIONSHTTP OPTIONS request
TRACEHTTP TRACE request
PATCHHTTP PATCH request
COPYHTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

Section titled “TLS Fingerprints {#common-tls-fingerprints}”

TLS fingerprint categories for malicious client detection.

ValueDescription
TLS_FINGERPRINT_NONENo fingerprint matching
ANY_MALICIOUS_FINGERPRINTMatch any known malicious fingerprint
ADWAREAdware-associated fingerprints
DRIDEXDridex malware fingerprints
GOOTKITGootkit malware fingerprints
RANSOMWARERansomware-associated fingerprints
TRICKBOTTrickbot 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.

ValueDescription
SPAM_SOURCESKnown spam sources
WINDOWS_EXPLOITSWindows exploit sources
WEB_ATTACKSWeb attack sources
BOTNETSKnown botnet IPs
SCANNERSNetwork scanner IPs
REPUTATIONPoor reputation IPs
PHISHINGPhishing-related IPs
PROXYAnonymous proxy IPs
MOBILE_THREATSMobile threat sources
TOR_PROXYTor exit nodes
DENIAL_OF_SERVICEDoS attack sources
NETWORKKnown bad network ranges