xcsh_fleet (Data Source)

Retrieves information about fleet will create a fleet object in ‘system’ namespace of the user in F5 Distributed Cloud. This is a read-only data source.

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

Example Usage

# Fleet Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing Fleet by name
data "xcsh_fleet" "example" {
  name      = "example-fleet"
  namespace = "staging"
}

output "fleet_id" {
  value = data.xcsh_fleet.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.

Metadata Argument Reference

• name - Required String
Name of the Fleet

• namespace - Required String
Namespace where the Fleet exists

Attributes Reference

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

• allow_all_usb - Optional Object
Configuration parameter for allow all usb

• annotations - Optional Map
Annotations applied to this resource

• blocked_services - Optional List
Disable node local services on this site

• bond_device_list - Optional String
Bond Devices List. List of bond devices for this fleet

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

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

• default_config - Optional Object
Enable this option

• default_sriov_interface - Optional Object
Configuration parameter for default sriov interface

• default_storage_class - Optional Object
Configuration parameter for default storage class

• deny_all_usb - Optional Object
Configuration parameter for deny all usb

• description - Optional String
Description of the Fleet

• device_list - Optional String
Add device for all interfaces belonging to this fleet

• disable_gpu - Optional Object
Configuration parameter for disable GPU

• disable_log_anonymization - Optional Object
Configuration parameter for disable log anonymization

• disable_vm - Optional Object
Enable this option

• enable_default_fleet_config_download - Optional Bool
Enable default fleet config, It must be set for storage config and GPU config

• enable_gpu - Optional Object
Enable this option

• enable_log_anonymization - Optional Object
Configuration parameter for enable log anonymization

• enable_vgpu - Optional String
Licensing configuration for NVIDIA vGPU

• enable_vm - Optional Object
VM Configuration. VMs support configuration

• fleet_label - Optional String
Fleet_label value is used to create known_label ‘F5 XC/fleet=<fleet_label>’ The known_label is created in the ‘shared’ namespace for the tenant. A virtual_site object with name <fleet_label> is also created in ‘shared’ namespace for tenant. The virtual_site object will select all sites

• id - Optional String
Unique identifier for the resource

• inside_virtual_network - Optional List
Default inside (site local) virtual network for the fleet

• interface_list - Optional String
Add all interfaces belonging to this fleet

• kubernetes_upgrade_drain - Optional String
Specify how worker nodes within a site will be upgraded

• labels - Optional Map
Labels applied to this resource

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

• logs_streaming_disabled - Optional Object
Enable this option

• network_connectors - Optional List
Network Connector defines connection between two virtual networks in a given site. Fleet defines one or more such network connectors. The network connectors configuration is applied on all sites that are member of the fleet

• network_firewall - Optional List
Network Firewall defines firewall to be applied for the virtual networks in the fleet. The network firewall configuration is applied on all sites that are member of the fleet. Constraints The Network Firewall is applied on Virtual Networks of type site local network and site local inside network

• no_bond_devices - Optional Object
Configuration parameter for no bond devices

• no_dc_cluster_group - Optional Object
Enable this option

• no_storage_device - Optional Object
Configuration parameter for no storage device

• no_storage_interfaces - Optional Object
Configuration parameter for no storage interfaces

• no_storage_static_routes - Optional Object
Configuration parameter for no storage static routes

• operating_system_version - Optional String
Desired Operating System version that is applied to all sites that are member of the fleet. Current Operating System version can be overridden via site config

• outside_virtual_network - Optional List
Default outside (site local) virtual network for the fleet

• performance_enhancement_mode - Optional String
Optimize the site for L3 or L7 traffic processing. L7 optimized is the default

• sriov_interfaces - Optional String
List of all custom SR-IOV interfaces configuration

• storage_class_list - Optional String
Add additional custom storage classes in Kubernetes for this fleet

• storage_device_list - Optional String
Add additional custom storage classes in Kubernetes for this fleet

• storage_interface_list - Optional String
Add all interfaces belonging to this fleet

• storage_static_routes - Optional String
Configuration parameter for storage static routes

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

• volterra_software_version - Optional String
F5XC software version is human readable string matching released set of version components. The given software version is applied to all sites that are member of the fleet. Current software installed can be overridden via site config

• dns - Optional Object
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

• ssh - Optional Object
Enable this option

• web_user_interface - Optional Object
Enable this option

• bond_devices - Optional List
Bond Devices. List of bond devices

• active_backup - Optional Object
Configuration parameter for active backup

• devices - Optional List
Ethernet devices that will make up this bond

• lacp - Optional String
LACP parameters. LACP parameters for the bond device

• link_polling_interval - Optional Number
Link Polling Interval. Link polling interval in milliseconds

• link_up_delay - Optional Number
Milliseconds wait before link is declared up

• name - Optional String
Bond Device Name. Name for the Bond. Ex ‘bond0’

• rate - Optional Number
Interval in seconds to transmit LACP packets

• 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

• devices - Optional List
Configuration for all devices in the fleet. Examples of devices are - network interfaces, cameras, scanners etc. Configuration a device is applied on VER node if the VER node is member of this fleet and has an corresponding interface/device

• name - Optional String
Name of the device including the unit number (e.g. Eth0 or disk1). The name must match name of device in host-OS of node

• network_device - Optional String
Represents physical network interface. The ‘interface’ reference points to a Network Interface object. Attributes such as Labels, MTU from Network Interface must be applied to the device

• owner - Optional String Defaults to DEVICE_OWNER_INVALID
Possible values are DEVICE_OWNER_INVALID, DEVICE_OWNER_VER, DEVICE_OWNER_VK8S_WORK_LOAD, DEVICE_OWNER_HOST
[Enum: DEVICE_OWNER_INVALID|DEVICE_OWNER_VER|DEVICE_OWNER_VK8S_WORK_LOAD|DEVICE_OWNER_HOST] Defines ownership for a device. Device owner is invalid Device is owned by VER pod. Usually it will be network interface device or accelerator like crypto engine

• interface - Optional List
Network Interface attributes for the device. User network interface configuration for this network device. Attributes like labels, MTU from the ‘interface’ are applied to corresponding interface in VER node If network interface refers to a virtual-network, the virtual-netowrk type must be

• use - Optional String Defaults to NETWORK_INTERFACE_USE_REGULAR
Possible values are NETWORK_INTERFACE_USE_REGULAR, NETWORK_INTERFACE_USE_OUTSIDE, NETWORK_INTERFACE_USE_INSIDE
[Enum: NETWORK_INTERFACE_USE_REGULAR|NETWORK_INTERFACE_USE_OUTSIDE|NETWORK_INTERFACE_USE_INSIDE] Defines how the device is used If networking device is owned by VER, it is available for users to configure as required If networking device is owned by VER, it is included in bootstrap config and member of outside network. If networking device is owned by VER, it is included in bootstrap config

• 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

• feature_type - Optional String Defaults to UNLICENSED
Possible values are UNLICENSED, VGPU, VWS, VCS
[Enum: UNLICENSED|VGPU|VWS|VCS] Set feature to be enabled Operate with a degraded vGPU performance Enable NVIDIA vGPU Enable NVIDIA RTX Virtual Workstation Enable NVIDIA Virtual Compute Server

• server_address - Optional String
License Server Address. Set License Server Address

• server_port - Optional Number
License Server Port Number. Set License Server port number

• 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

• interfaces - Optional List
Add all interfaces belonging to this fleet

• 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

• disable_upgrade_drain - Optional Object
Configuration parameter for disable upgrade drain

• enable_upgrade_drain - Optional String
Specify batch upgrade settings for worker nodes within a site

• disable_vega_upgrade_mode - Optional Object
Configuration parameter for disable vega upgrade mode

• drain_max_unavailable_node_count - Optional Number
Node Batch Size Count

• drain_max_unavailable_node_percentage - Optional Number
Maximum percentage of nodes unavailable during upgrade draining

• drain_node_timeout - Optional Number
Seconds to wait before initiating upgrade on the next set of nodes. Setting it to 0 will wait indefinitely for all services on nodes to be upgraded gracefully before proceeding to the next set of nodes. (Warning: It may block upgrade if services on a node cannot be gracefully upgraded. It is

• enable_vega_upgrade_mode - Optional Object
Configuration parameter for enable vega upgrade mode