Appendix A: Schema Reference

This page is a reference for the objects you can use in your Declarations for Telemetry Streaming. For more information on BIG-IP objects and terminology, see the BIG-IP documentation at https://support.f5.com/csp/home. Please note: this reference document is currently a work in progress.

Controls

No description provided

Properties:

Name (Type) Default Values Description
class (string)
“Controls” Telemetry Streaming Controls class
debug (boolean) false true, false
logLevel (string) “info” “debug”, “info”, “error”

Shared

No description provided

Properties:

Name (Type) Default Values Description
class (string)
“Shared” Telemetry streaming Shared class

Telemetry

No description provided

No properties

Telemetry_Consumer

No description provided

Properties:

Name (Type) Default Values Description
allowSelfSignedCert (boolean)
true, false
apiVersion (reference)
authenticationProtocol (reference)
bucket (reference)
class (string)
“Telemetry_Consumer” Telemetry Streaming Consumer class
dataType (reference)
enable (boolean) true true, false This property can be used to enable/disable the poller/listener
enableHostConnectivityCheck (boolean)
true, false
format (reference)
headers (reference)
host (reference)
index (reference)
logGroup (reference)
logStream (reference)
method (reference)
passphrase (reference)
path (reference)
port (reference)
protocol (reference)
region (reference)
topic (reference)
trace (boolean | string) false true, false Enables data dumping to file. Boolean uses pre-defined file location, however value could be a string which contains path to a specific file instead
type (string)
“default”, “Generic_HTTP”, “Splunk”, “Azure_Log_Analytics”, “AWS_CloudWatch”, “AWS_S3”, “Graphite”, “Kafka”, “ElasticSearch”, “Sumo_Logic”, “Statsd”
username (reference)
workspaceId (reference)

Telemetry_iHealth_Poller

No description provided

Properties:

Name (Type) Default Values Description
class (string)
“Telemetry_iHealth_Poller” Telemetry Streaming iHealth Poller class
downloadFolder (reference)
enable (reference)
interval (reference)
passphrase (reference)
proxy (reference)
trace (reference)
username (reference)

Telemetry_Listener

No description provided

Properties:

Name (Type) Default Values Description
actions (array<action>) [object Object]
Actions to be performed on the listener.
class (string)
“Telemetry_Listener” Telemetry Streaming Event Listener class
enable (boolean) true true, false This property can be used to enable/disable the poller/listener
match (string) “”
port (integer) 8100 [0, 65535]
tag (Telemetry_Listener_tag)
trace (boolean | string) false true, false Enables data dumping to file. Boolean uses pre-defined file location, however value could be a string which contains path to a specific file instead

Telemetry_Listener_tag

Telemetry_Listener tag possible properties

Properties:

Name (Type) Default Values Description
application (string)
tenant (string)

Telemetry_System

No description provided

Properties:

Name (Type) Default Values Description
allowSelfSignedCert (boolean)
true, false
class (string)
“Telemetry_System” Telemetry Streaming System class
enable (boolean) true true, false This property can be used to enable/disable the poller/listener
enableHostConnectivityCheck (boolean)
true, false
host (string) “localhost”
FQDN or IP address
iHealthPoller (Telemetry_System_iHealthPoller)
passphrase (Telemetry_System_passphrase)
port (integer) 8100 [0, 65535]
protocol (string) “http” “http”, “https”
systemPoller (Telemetry_System_systemPoller)
trace (boolean | string) false true, false Enables data dumping to file. Boolean uses pre-defined file location, however value could be a string which contains path to a specific file instead
username (string)

Telemetry_System_iHealthPoller

Telemetry_System iHealthPoller possible properties

Properties:

Name (Type) Default Values Description
downloadFolder (string)
enable (enable) true
interval (object)
passphrase (secret)
proxy (proxy)
trace (trace) false
username (username)

Telemetry_System_passphrase

Telemetry_System passphrase possible properties

Properties:

Name (Type) Default Values Description
cipherText (string)
class (string) “Secret” “Secret” Telemetry streaming secret class
environmentVar (string)
protected (string) “plainText” “plainText”, “plainBase64”, “SecureVault”

Telemetry_System_systemPoller

Telemetry_System systemPoller possible properties

Properties:

Name (Type) Default Values Description
actions (array<action>) [object Object]
Actions to be performed on the systemPoller.
enable (enable) true
interval (integer) 300 [60, 6000]
tag (tag)
trace (trace) false

Telemetry_System_Poller

No description provided

Properties:

Name (Type) Default Values Description
actions (reference)
allowSelfSignedCert (boolean)
true, false
class (string)
“Telemetry_System_Poller” Telemetry Streaming System Poller class
enable (reference)
enableHostConnectivityCheck (boolean)
true, false
host (string) “localhost”
FQDN or IP address
interval (reference)
passphrase (Telemetry_System_Poller_passphrase)
port (integer) 8100 [0, 65535]
protocol (string) “http” “http”, “https”
tag (reference)
trace (reference)
username (string)

Telemetry_System_Poller_passphrase

Telemetry_System_Poller passphrase possible properties

Properties:

Name (Type) Default Values Description
cipherText (string)
class (string) “Secret” “Secret” Telemetry streaming secret class
environmentVar (string)
protected (string) “plainText” “plainText”, “plainBase64”, “SecureVault”