xcsh_site_registrations_by_state (Data Source)

List Customer Edge registrations by state. This is a read-only data source.

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

Example Usage

# SiteRegistrationsByState DataSource Example

terraform {
  required_version = ">= 1.14"

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

data "xcsh_site_registrations_by_state" "example" {
  state = "NOTSET"
}

output "site_registrations_by_state_result" {
  value = data.xcsh_site_registrations_by_state.example
}

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.

Metadata Argument Reference

• namespace - Optional String
Namespace. Registration namespace, only ‘system’ namespaces is accepted

Spec Argument Reference

• state - Required String Defaults to NOTSET
Possible values are NOTSET, NEW, APPROVED, ADMITTED, RETIRED, FAILED, DONE, PENDING, ONLINE, UPGRADING, MAINTENANCE, FAILED_INACTIVE
[Enum: NOTSET|NEW|APPROVED|ADMITTED|RETIRED|FAILED|DONE|PENDING|ONLINE|UPGRADING|MAINTENANCE|FAILED_INACTIVE] Defines states for registration object State isn’t set Object was created (registration request was received and object created) Registration was approved and waiting for configuration This state can be set by user only if current state is NEW Registration is approved and prepared for to connect

Attributes Reference

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

• errors - Optional List
Errors(if any) while listing items from collection

• items - Optional List
Items represents the collection in response

Errors

An errors block supports the following:

• code - Optional String Defaults to EOK
Possible values are EOK, EPERMS, EBADINPUT, ENOTFOUND, EEXISTS, EUNKNOWN, ESERIALIZE, EINTERNAL, EPARTIAL
[Enum: EOK|EPERMS|EBADINPUT|ENOTFOUND|EEXISTS|EUNKNOWN|ESERIALIZE|EINTERNAL|EPARTIAL] Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL

• error_obj - Optional String
Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a

• message - Optional String
Message. A human readable string of the error

Errors Error Obj

An error_obj block (within errors) supports the following:

• type_url - Optional String
URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one ’/’ character. The last segment of the URL path must represent the fully qualified name of the type (as in )

• value - Optional String
Must be a valid serialized protocol buffer of the above specified type

Items

An items block supports the following:

• annotations - Optional String
The set of annotations present on this registration

• description_spec - Optional String
The description set for this registration

• disabled - Optional Bool
Value of true indicates registration is administratively disabled

• get_spec - Optional String
GET Registration. GET registration specification

• labels - Optional String
The set of labels present on this registration

• metadata - Optional String Specified in GET/Create response of an object
ObjectGetMetaType is metadata that can be

• name - Optional String
Name. The name of this registration

• namespace - Optional String
Namespace. The namespace this item belongs to

• object - Optional String
Registration object stores node registration and information regarding the node

• owner_view - Optional String
ViewRefType represents a reference to a view

• system_metadata - Optional String
SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users

• tenant - Optional String
Tenant. The tenant this item belongs to

• uid - Optional String
UID. The unique uid of this registration

Items Annotations

An annotations block (within items) supports the following:

Items Get Spec

A get_spec block (within items) supports the following:

• infra - Optional String
InfraMetadata stores information about instance infrastructure

• passport - Optional String
Passport stores information about identification and node configuration provided by CE during registration. It can be manually updated by user during approval

• token - Optional String
Token is used for machine and tenant identification

Items Get Spec Infra

An infra block (within items.get_spec) supports the following:

• availability_zone - Optional String
Availability Zone is a high-availability offering that protects your applications and data from datacenter failures

• bond_config - Optional String
Bond device configuration for VPM registration

• certified_hw - Optional String
Certified HW name used to map with F5XC certified_hardware definition

• domain - Optional String
Machine domain. It’s used for Kubernetes cloud provider when domain must be different than F5 Distributed Cloud

• hostname - Optional String
Must be unique in entire cluster and same as OS settings. ’.’ (dots) are not allowed in hostname

• hw_info - Optional String
OsInfo holds information about host OS and HW

• instance_id - Optional String
Instance ID (assigned by infrastructure provider)

• interfaces - Optional String
Machine interfaces present during registration time

• internet_proxy - Optional String
Proxy describes OPTIONS for HTTP or HTTPS proxy configurations

• is_slo_static - Optional Bool
Is SLO Static. Indicates whether the SLO is static

• machine_id - Optional String
Machine ID - generated by operating system

• sw_info - Optional String
SWInfo holds information about sw version

• timestamp - Optional String
It’s used to verify machine have acceptable time difference from server

• zone - Optional String
Instance zone (or region), depends on provider

Items Get Spec Infra Bond Config

A bond_config block (within items.get_spec.infra) supports the following:

• interfaces - Optional List
Member Interfaces. Configuration parameter for interfaces

• mode - Optional String Defaults to BOND_MODE_UNSPECIFIED
Possible values are BOND_MODE_UNSPECIFIED, ACTIVE_BACKUP, LACP_802_3AD
[Enum: BOND_MODE_UNSPECIFIED|ACTIVE_BACKUP|LACP_802_3AD] Bonding mode for bond device configuration Bond mode is not specified Active-backup bond mode (one interface active, others as backup) IEEE 802.3ad Dynamic link aggregation (LACP)

• name - Optional String
Bond Name. Human-readable name for the resource

Items Get Spec Infra Hw Info

A hw_info block (within items.get_spec.infra) supports the following:

• bios - Optional String
Bios Data. BIOS information

• board - Optional String
Board Details. Board information

• chassis - Optional String
Chassis Details. Chassis information

• cpu - Optional String
CPU Information. CPU information

• gpu - Optional String
GPU. GPU information on server

• kernel - Optional String
Kernel. Kernel information

• memory - Optional String
Memory Information. Memory information

• network - Optional List
Network. List of network devices in server

• numa_nodes - Optional Number
Non-uniform memory access (NUMA) nodes count

• os - Optional String
OS. Details of Operating System

• product - Optional String
Product Information. Product information

• storage - Optional List
Storage. List of storage devices in server

• usb - Optional List
USB devices. List of USB devices in server

Items Get Spec Infra Hw Info Bios

A bios block (within items.get_spec.infra.hw_info) supports the following:

• date - Optional String
Information from /sys/class/dmi/ID/bios_date

• vendor - Optional String
Information from /sys/class/dmi/ID/bios_vendor

• version - Optional String
Information from /sys/class/dmi/ID/bios_version

Items Get Spec Infra Hw Info Board

A board block (within items.get_spec.infra.hw_info) supports the following:

• asset_tag - Optional String
Information from /sys/class/dmi/ID/board_asset_tag

• name - Optional String
Information from /sys/class/dmi/ID/board_name

• serial - Optional String
Information from /sys/class/dmi/ID/board_serial

• vendor - Optional String
Information from /sys/class/dmi/ID/board_vendor

• version - Optional String
Information from /sys/class/dmi/ID/board_version

Items Get Spec Infra Hw Info Chassis

A chassis block (within items.get_spec.infra.hw_info) supports the following:

• asset_tag - Optional String
Information from /sys/class/dmi/ID/chassis_asset_tag

• serial - Optional String
Information from /sys/class/dmi/ID/chassis_serial

• type - Optional Number
Information from /sys/class/dmi/ID/chassis_type

• vendor - Optional String
Information from /sys/class/dmi/ID/chassis_vendor

• version - Optional String
Information from /sys/class/dmi/ID/chassis_version

Items Get Spec Infra Hw Info CPU

A cpu block (within items.get_spec.infra.hw_info) supports the following:

• cache - Optional Number
Cache. CPU cache size in KB

• cores - Optional Number
Cores. Number of physical CPU cores

• cpus - Optional Number
CPUs. Number of physical CPUs

• model - Optional String
Model. CPU model

• speed - Optional Number
Speed. CPU clock rate in MHz

• threads - Optional Number
Threads. Number of logical (HT) CPU cores

• vendor - Optional String
Vendor. CPU vendor

Items Get Spec Infra Hw Info GPU

A gpu block (within items.get_spec.infra.hw_info) supports the following:

• cuda_version - Optional String
Cuda Version. GPU Cuda Version

• driver_version - Optional String
Driver Version. GPU Driver Version

• gpu_device - Optional List
GPU devices. List of GPU devices in server

Items Get Spec Infra Hw Info GPU GPU Device

Deeply nested Device block collapsed for readability.

Items Get Spec Infra Hw Info Kernel

A kernel block (within items.get_spec.infra.hw_info) supports the following:

• architecture - Optional String
Architecture. Kernel architecture

• release - Optional String
Release. Kernel release

• version - Optional String
Version. Kernel version

Items Get Spec Infra Hw Info Memory

A memory block (within items.get_spec.infra.hw_info) supports the following:

• size_mb - Optional Number
RAM. RAM size in MB

• speed - Optional Number
Speed. RAM data rate in MT/s

• type - Optional String
Type. Type of memory, eg. DDR4

Items Get Spec Infra Hw Info Network

A network block (within items.get_spec.infra.hw_info) supports the following:

• driver - Optional String
Driver. Driver of device, eg. E1000e

• ip_address - Optional List
IP Address. IP address on interface

• link_quality - Optional String Defaults to QUALITY_UNKNOWN
Possible values are QUALITY_UNKNOWN, QUALITY_GOOD, QUALITY_POOR, QUALITY_DISABLED
[Enum: QUALITY_UNKNOWN|QUALITY_GOOD|QUALITY_POOR|QUALITY_DISABLED] Link quality determined by VER using different probes Unknown quality Link quality is good Link quality is poor Quality disabled

• link_type - Optional String Defaults to LINK_TYPE_UNKNOWN
Possible values are LINK_TYPE_UNKNOWN, LINK_TYPE_ETHERNET, LINK_TYPE_WIFI_802_11AC, LINK_TYPE_WIFI_802_11BGN, LINK_TYPE_4G, LINK_TYPE_WIFI, LINK_TYPE_WAN
[Enum: LINK_TYPE_UNKNOWN|LINK_TYPE_ETHERNET|LINK_TYPE_WIFI_802_11AC|LINK_TYPE_WIFI_802_11BGN|LINK_TYPE_4G|LINK_TYPE_WIFI|LINK_TYPE_WAN] Link type of interface determined operationally Link type unknown Link type ethernet Wi-Fi link of type 802.11ac Wi-Fi link of type 802.11bgn Link type 4G Wi-Fi link Wan link

• mac_address - Optional String
MAC Address. MAC address on interface

• name - Optional String
Name. Name of device, eg. Eth0

• port - Optional String
Port. Used port, eg. Tp

• speed - Optional Number
Speed. Device max supported speed in Mbps

Items Get Spec Infra Hw Info OS

An os block (within items.get_spec.infra.hw_info) supports the following:

• architecture - Optional String
Architecture. Architecture of OS

• name - Optional String
Name. Name of OS

• release - Optional String
Release. Release of the OS

• vendor - Optional String
Vendor. Vendor of OS

• version - Optional String
Version. Version of OS

Items Get Spec Infra Hw Info Product

A product block (within items.get_spec.infra.hw_info) supports the following:

• name - Optional String
Name. Product name, eg. For AWS m5a.xlarge. Info taken from /sys/class/dmi/ID/product_name

• serial - Optional String
Serial number, eg. For AWS 00000000-0000-4000-8000-23460f645a1f. Info taken from /sys/class/dmi/ID/product_serial

• vendor - Optional String
Vendor. Vendor name, eg. For AWS Amazon EC2. Info taken from /sys/class/dmi/ID/product_vendor

• version - Optional String
Version name. Info taken from /sys/class/dmi/ID/product_version

Items Get Spec Infra Hw Info Storage

A storage block (within items.get_spec.infra.hw_info) supports the following:

• driver - Optional String
Driver. Driver of device

• model - Optional String
Model. Model of device

• name - Optional String
Name. Name of device, eg. Nvme0n1

• serial - Optional String
Serial Number. Serial of device

• size_gb - Optional Number
Size(GB). Device size in GB

• vendor - Optional String
Vendor. Vendor of device

Items Get Spec Infra Hw Info Usb

An usb block (within items.get_spec.infra.hw_info) supports the following:

• address - Optional Number
Address of the device on the bus in decimal

• b_device_class - Optional String
Class. The class of this device

• b_device_protocol - Optional String
The protocol (within the subclass) of this device

• b_device_sub_class - Optional String
The subclass (within the class) of this device

• b_max_packet_size - Optional Number
Max packet size. Maximum size of the control transfer

• bcd_device - Optional String
BCD Device. The device version

• bcd_usb - Optional String
BCD Spec. USB Specification Release Number

• bus - Optional Number
The bus on which the device was detected in decimal

• description_spec - Optional String
Description. Device description

• i_manufacturer - Optional String
Manufacturer. Manufacturer name

• i_product - Optional String
Device product. Product name reported by device

• i_serial - Optional String
Index of Serial Number String Descriptor

• id_product - Optional String
Product ID (Assigned by Manufacturer) in hex

• id_vendor - Optional String
Vendor ID. Vendor ID (Assigned by USB Org) in hex

• port - Optional Number
Port on which the device was detected in decimal

• product_name - Optional String
Product ID translated to name (if available)

• speed - Optional String
The negotiated operating speed for the device

• usb_type - Optional String Defaults to UNKNOWN_USB
Possible values are UNKNOWN_USB, INTERNAL, REGISTERED, CONFIGURABLE
[Enum: UNKNOWN_USB|INTERNAL|REGISTERED|CONFIGURABLE] Type of USB device Unknown USB device type Internal USB present in Certified HW USB device present during node registration USB device that can be matched by USB rules

• vendor_name - Optional String
Vendor ID translated to name (if available)

Items Get Spec Infra Interfaces

An interfaces block (within items.get_spec.infra) supports the following:

Items Get Spec Infra internet Proxy

An internet_proxy block (within items.get_spec.infra) supports the following:

• http_proxy - Optional String
It will be used as the proxy URL for HTTP requests and HTTPS requests unless overridden by HTTPSProxy or NoProxy

• https_proxy - Optional String
It will be used as the proxy URL for HTTPS requests unless overridden by NoProxy

• no_proxy - Optional String
It specifies a string that contains comma-separated values specifying hosts that should be excluded from proxying. Each value is represented by an IP address prefix (192.0.2.103), an IP address prefix in CIDR notation (192.0.2.103/8), a domain name, or a special DNS label (*). An IP address

• proxy_cacert_url - Optional String
Allow optional different trust-store for proxy in HTTP CONNECT step by picking proxy CA certificate value

Items Get Spec Infra Sw Info

A sw_info block (within items.get_spec.infra) supports the following:

• sw_version - Optional String
SW Version. SW Version in the site

Items Get Spec Passport

A passport block (within items.get_spec) supports the following:

• cluster_name - Optional String
Cluster Name. Human-readable name for the resource

• cluster_size - Optional Number
Defines how many master nodes is in the cluster, only 1 or 3 is allowed 1 - cluster have single master, without HA 3 - cluster have 3 masters, with HA, all nodes should be allowed at same time, cluster won’t start until ALL nodes are ADMITTED 0 - same as 1 This value can’t be changed after

• cluster_type - Optional String
Cluster Type. Cluster or grouping configuration

• default_os_version - Optional Object
Enable this option

• default_sw_version - Optional Object
Enable this option

• latitude - Optional Number
Latitude. Geographic location of this site

• longitude - Optional Number
Longitude. Geographic location of this site

• operating_system_version - Optional String
Operating System Version is optional parameter, which allows to specify target SW version for particular site e.g. 7.2009.10

• private_network_name - Optional String
Private Network name for private access connectivity to F5XC ADN. It is used for PrivateLink, CloudLink and L3VPN

• volterra_software_version - Optional String
F5XC Software Version is optional parameter, which allows to specify target SW version for particular site e.g. Crt-20210329-1002

Items Get Spec Passport Default OS Version

A default_os_version block (within items.get_spec.passport) supports the following:

Items Get Spec Passport Default Sw Version

A default_sw_version block (within items.get_spec.passport) supports the following:

Items Metadata

A metadata block (within items) supports the following:

• 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. They are not queryable and should be preserved when modifying objects

• description_spec - Optional String
Human readable description for the object

• disable_spec - Optional Bool
Value of true will administratively disable the object

• labels - Optional String
Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression

• name - Optional String
Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API

• namespace - Optional String
Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ”

Items Object

An object block (within items) supports the following:

• metadata - Optional String
ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have. The information in this type can be specified by user during create and replace APIs

• spec - Optional String
Configuration for registration

• status - Optional String
Status Type. Most recent observer status of object

• system_metadata - Optional String
SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users

Items Object Metadata

A metadata block (within items.object) supports the following:

• description_spec - Optional String
Human readable description for the object

• disable_spec - Optional Bool
Value of true will administratively disable the object

• labels - Optional Map
Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression

• name - Optional String
Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API

• uid - Optional String
Uid is the unique in time and space value for this object. Object create will fail if provided by the client and the value exists in the system. Typically generated by the server on successful creation of an object and is not allowed to change once populated

Items Object Spec

A spec block (within items.object) supports the following:

• gc_spec - Optional String
Global Specification

Items Object Spec Gc Spec

A gc_spec block (within items.object.spec) supports the following:

• connected_regions - Optional List
Optional. REs in selected region to which CEs connect, contains primary and backup RE region info

• infra - Optional String
InfraMetadata stores information about instance infrastructure

• passport - Optional String
Passport stores information about identification and node configuration provided by CE during registration. It can be manually updated by user during approval

• role - Optional List
Role of registered node. Used by system to determine what roles should be enforced

• site - Optional List
Site for this registration, assigned after registration is assigned to site

• token - Optional String
Token is used for machine and tenant identification

• tunnel_type - Optional String Defaults to SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL
Possible values are SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL, SITE_TO_SITE_TUNNEL_IPSEC, SITE_TO_SITE_TUNNEL_SSL
[Enum: SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL|SITE_TO_SITE_TUNNEL_IPSEC|SITE_TO_SITE_TUNNEL_SSL] Tunnel encapsulation to be used between sites Tunnel can operate in both IPsec and SSL, with IPsec being preferred over SSL. Tunnel is of type IPsec Tunnel is of type SSL

Items Object Spec Gc Spec Infra

An infra block (within items.object.spec.gc_spec) supports the following: