- Home
- Documentation
- VPN
- Resources
- xcsh_ike1 (Resource)
xcsh_ike1 (Resource)
Manages a Ike1 resource in F5 Distributed Cloud for ike phase1 profile specification. configuration.
~> Note: For more information, see the F5 Distributed Cloud API documentation.
Example Usage
Section titled “Example Usage”# Ike1 Resource Example# Manages a Ike1 resource in F5 Distributed Cloud for ike phase1 profile specification.
terraform { required_version = ">= 1.0"
required_providers { xcsh = { source = "f5-sales-demo/xcsh" version = ">= 0.1.0" } }}
# Basic Ike1 configurationresource "xcsh_ike1" "example" { name = "example-ike1" namespace = "staging"}Argument Reference
Section titled “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
Section titled “Metadata Argument Reference”• name - Required String
Name of the Ike1. Must be unique within the namespace
• namespace - Required String
Namespace where the Ike1 is 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 administratively disables 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”-> One of the following:
• ike_keylifetime_hours - Optional Block
Configuration parameter for IKE keylifetime hours
See IKE Keylifetime Hours below for details.
• ike_keylifetime_minutes - Optional Block
Configuration parameter for IKE keylifetime minutes
See IKE Keylifetime Minutes below for details.
-> One of the following:
• reauth_disabled - Optional Object
Enable this option
• reauth_timeout_days - Optional Block
Configuration parameter for reauth timeout days
See Reauth Timeout Days below for details.
• reauth_timeout_hours - Optional Block
Configuration parameter for reauth timeout hours
See Reauth Timeout Hours below for details.
• timeouts - Optional Block
See Timeouts below for details.
• use_default_keylifetime - Optional Object
Configuration parameter for use default keylifetime
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
IKE Keylifetime Hours
Section titled “IKE Keylifetime Hours”An ike_keylifetime_hours block supports the following:
• duration - Optional Number
Duration. Configuration parameter for duration
IKE Keylifetime Minutes
Section titled “IKE Keylifetime Minutes”An ike_keylifetime_minutes block supports the following:
• duration - Optional Number
Duration. Configuration parameter for duration
Reauth Disabled
Section titled “Reauth Disabled”A reauth_disabled block supports the following:
Reauth Timeout Days
Section titled “Reauth Timeout Days”A reauth_timeout_days block supports the following:
• duration - Optional Number
Duration. Configuration parameter for duration
Reauth Timeout Hours
Section titled “Reauth Timeout Hours”A reauth_timeout_hours block supports the following:
• duration - Optional Number
Duration. Configuration parameter for duration
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
Use Default Keylifetime
Section titled “Use Default Keylifetime”An use_default_keylifetime block supports the following:
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 xcsh_ike1.example system/example