xcsh_service_policy (Data Source)

Retrieves information about service_policy creates a new object in the storage backend for metadata.namespace in F5 Distributed Cloud. This is a read-only data source.

~> Note: For more information, see the Service Policy API documentation.

Example Usage

# ServicePolicy Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing ServicePolicy by name
data "xcsh_service_policy" "example" {
  name      = "example-service-policy"
  namespace = "staging"
}

output "service_policy_id" {
  value = data.xcsh_service_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.

Minimum Configuration

Required fields:

name
namespace

Example (API format):

apiVersion: v1
kind: service_policy
metadata:
  name: allow-all
  namespace: demo-app
spec:
  allow_all_requests: {}

Metadata Argument Reference

• name - Required String
Name of the ServicePolicy

• namespace - Required String
Namespace where the ServicePolicy exists

Attributes Reference

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

• allow_all_requests - Optional Object
Configuration parameter for allow all requests

• allow_list - Optional String
List of sources. A request belongs to this list if it satisfies any of the match criteria

• annotations - Optional Map
Annotations applied to this resource

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

• deny_all_requests - Optional Object
Configuration parameter for deny all requests

• deny_list - Optional String
List of sources. A request belongs to this list if it satisfies any of the match criteria

• description - Optional String
Description of the ServicePolicy

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• rule_list - Optional String
Ordered service-policy rules for non-geographic predicates and actions. Do not use country_list for a geo-only rule here: the platform adds match-all any_ip and any_asn selectors on readback, so the rule can match all traffic. Use deny_list or allow_list with country_list for geographic source

• server_name - Optional String
The expected name of the server to which the request API is directed. The actual names for the server are extracted from the HTTP Host header and the name of the virtual_host to which the request is directed. If the request is

• server_name_matcher - Optional String
Matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set of supported match criteria includes a list of exact values and a list of regular expressions

• server_selector - Optional String
Type can be used to establish a ‘selector reference’ from one object(called selector) to a set of other objects(called selectees) based on the value of expressions. A label selector is a label query over a set of resources. An empty label selector matches all objects

• asn_list - Optional String
Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer

• asn_set - Optional List
Addresses that belong to the ASNs in the given bgp_asn_set The ASN is obtained by performing a lookup for the source IPv4 Address in a GeoIP DB

• default_action_allow - Optional Object
Enable this option

• default_action_deny - Optional Object
Enable this option

• default_action_next_policy - Optional Object
Policy configuration for this feature

• ip_prefix_set - Optional List
Addresses that are covered by the prefixes in the given ip_prefix_set

• prefix_list - Optional String
List of IPv4 prefixes that represent an endpoint

• tls_fingerprint_values - Optional List
List of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against

• as_numbers - Optional List
Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer

• 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

• 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

• prefixes - Optional List
List of IPv4 prefixes that represent an endpoint