Data Sources
Data sources are used to obtain information about an object or environment.
Resources
Each configuration resource is also available as an identical Terraform "data source" object. All properties in a data source remain the same as the configuration resource on which it is based, but read-only. Configuration data sources allow a Terraform template to query the contents of a Traffic Manager configuration object that was created externally from the template. For example:
# Create a data source object to represent an existing virtual server
data “vtm_virtual_server” “my_vs_data” {
name = “MyVS”
}
# Set up a new virtual server referencing the data source
resource “vtm_virtual_server” “my_new_vs” {
name = “MyNewVS
pool = “discard”
port = 1234
ssl_decrypt = true
ssl_server_cert_default = "${data.vtm_virtual_server.my_vs_data.ssl_server_cert_default}"
}
For details of the available properties for a particular resource, refer to the corresponding configuration resource reference earlier in this chapter.
Resource Lists
Resource list data sources represent a list of stored configuration objects of the named type. For example, to obtain the current list of virtual servers, use the "vtm_virtual_server_list" data source. By default, a resource list data source returns all objects of the given type. To filter the results, use the "starts_with", "ends_with", "contains", or "regex_match" filters in the data source definition. To obtain the resulting filtered object list, use the "object_list" property.
# Create a list of all pools
data "vtm_pool_list" "my_pool_list" {}
# Create a list of virtual servers with names starting "Exchange_"
data "vtm_virtual_server_list" "my_vs_list" {
starts_with = "Exchange_"
}
# Create a TrafficScript rule list based on a regex match
data "vtm_rule_list" "my_rule_list" {
regex_match = "^Rule-.*?-[0-9]$"
}
# Use the rule list in a virtual server definition
resource "vtm_virtual_server" "my_vs" {
...
request_rules = ["${data.vtm_rule_list.my_rule_list.object_list}"]
...
}
The available resource list data sources are:
- vtm_action_list
- vtm_action_program_list
- vtm_aptimizer_profile_list
- vtm_aptimizer_scope_list
- vtm_bandwidth_list
- vtm_bgpneighbor_list
- vtm_cloud_api_credential_list
- vtm_custom_list
- vtm_dns_server_zone_file_list
- vtm_dns_server_zone_list
- vtm_event_type_list
- vtm_extra_file_list
- vtm_glb_service_list
- vtm_kerberos_keytab_list
- vtm_kerberos_krb5conf_list
- vtm_kerberos_principal_list
- vtm_license_key_list
- vtm_location_list
- vtm_log_export_list
- vtm_monitor_list
- vtm_monitor_script_list
- vtm_persistence_list
- vtm_pool_list
- vtm_protection_list
- vtm_rate_list
- vtm_rule_authenticator_list
- vtm_rule_list
- vtm_saml_trustedidp_list
- vtm_service_level_monitor_list
- vtm_servicediscovery_list
- vtm_ssl_admin_ca_list
- vtm_ssl_ca_list
- vtm_ssl_client_key_list
- vtm_ssl_server_key_list
- vtm_ssl_ticket_key_list
- vtm_traffic_ip_group_list
- vtm_traffic_manager_list
- vtm_user_authenticator_list
- vtm_user_group_list
- vtm_virtual_server_list
Statistics
Statistics data sources allow Terraform to access a Traffic Manager's SNMP counter values. Some statistics data sources access single objects and take no parameters (for example, vtm_globals_stats), while others represent a collection of objects and require a "name" parameter (for example, vtm_virtual_server_stats):
# Single object
data "vtm_globals_stats" "global_stats" {}
# Collection of objects
data "vtm_virtual_server_stats" "vs_stats" {
name = "MyVirtualServer"
}vtm_action_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/actions/*
Actions statistics values.
# Example usage of vtm_action_stats data source...
data "vtm_action_stats" "my_action_stats" {
name = "MyAction"
}
# Access with...
"${data.vtm_action_stats.my_action_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
processed | Number of times this action has been processed.
|
vtm_cache_asp_session_cache_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/cache/asp_session_cache
Asp session cache statistics values.
# Example usage of vtm_cache_asp_session_cache_stats data source...
data "vtm_cache_asp_session_cache_stats" "my_cache_asp_session_cache_stats" {}
# Access with...
"${data.vtm_cache_asp_session_cache_stats.my_cache_asp_session_cache_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
entries | The total number of ASP sessions stored in the cache.
|
entries_max | The maximum number of ASP sessions in the cache.
|
hit_rate | The percentage of ASP session lookups that succeeded.
|
hits | Number of times a ASP session entry has been successfully found in the cache.
|
lookups | Number of times a ASP session entry has been looked up in the cache.
|
misses | Number of times a ASP session entry has not been available in the cache.
|
oldest | The age of the oldest ASP session in the cache (in seconds).
|
vtm_bandwidth_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/bandwidth/*
Bandwidth statistics values.
# Example usage of vtm_bandwidth_stats data source...
data "vtm_bandwidth_stats" "my_bandwidth_stats" {
name = "MyBandwidth"
}
# Access with...
"${data.vtm_bandwidth_stats.my_bandwidth_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
bytes_out | Bytes output by connections assigned to this bandwidth class.
|
guarantee | Guaranteed bandwidth class limit (kbits/s). Currently unused.
|
maximum | Maximum bandwidth class limit (kbits/s).
|
vtm_cloud_api_credential_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/cloud_api_credentials/*
Cloud api credentials statistics values.
# Example usage of vtm_cloud_api_credential_stats data source...
data "vtm_cloud_api_credential_stats" "my_cloud_api_credential_stats" {
name = "MyCloudApiCredential"
}
# Access with...
"${data.vtm_cloud_api_credential_stats.my_cloud_api_credential_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
node_creations | The number of instance creation API requests made with this set of cloud credentials.
|
node_deletions | The number of instance destruction API requests made with this set of cloud credentials.
|
status_requests | The number of status API requests made with this set of cloud credentials.
|
vtm_connection_rate_limit_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/connection_rate_limit/*
Connection rate limit statistics values.
# Example usage of vtm_connection_rate_limit_stats data source...
data "vtm_connection_rate_limit_stats" "my_connection_rate_limit_stats" {
name = "MyConnectionRateLimit"
}
# Access with...
"${data.vtm_connection_rate_limit_stats.my_connection_rate_limit_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
conns_entered | Connections that have entered the rate class and have been queued.
|
conns_left | Connections that have left the rate class.
|
current_rate | The average rate that requests are passing through this rate class.
|
dropped | Requests dropped from this rate class without being processed (e.g. timeouts).
|
max_rate_per_min | The maximum rate that requests may pass through this rate class (requests/min).
|
max_rate_per_sec | The maximum rate that requests may pass through this rate class (requests/sec).
|
queue_length | The current number of requests queued by this rate class.
|
vtm_event_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/events/*
Events statistics values.
# Example usage of vtm_event_stats data source...
data "vtm_event_stats" "my_event_stats" {
name = "MyEvent"
}
# Access with...
"${data.vtm_event_stats.my_event_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
matched | Number of times this event configuration has matched.
|
vtm_glb_service_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/glb_services/*
Glb services statistics values.
# Example usage of vtm_glb_service_stats data source...
data "vtm_glb_service_stats" "my_glb_service_stats" {
name = "MyGlbService"
}
# Access with...
"${data.vtm_glb_service_stats.my_glb_service_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
discarded | Number of A records this GLB Service has discarded.
|
responses | Number of A records this GLB Service has altered.
|
unmodified | Number of A records this GLB Service has passed through unmodified.
|
vtm_globals_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/globals
Globals statistics values.
# Example usage of vtm_globals_stats data source...
data "vtm_globals_stats" "my_globals_stats" {}
# Access with...
"${data.vtm_globals_stats.my_globals_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
analytics_transactions_dropped | Count of transaction metadata records that have been dropped
|
analytics_transactions_exported | Count of transaction metadata records that have been exported
|
analytics_transactions_memory_usage | Number of bytes queued in the transaction export transmit buffers.
|
data_entries | Number of entries in the TrafficScript data.get()/set() storage.
|
data_memory_usage | Number of bytes used in the TrafficScript data.get()/set() storage.
|
events_seen | Events seen by the traffic Manager's event handling process.
|
hourly_peak_bytes_in_per_second | The peak bytes received from clients per second in the last hour.
|
hourly_peak_bytes_out_per_second | The peak bytes sent to clients per second in the last hour.
|
hourly_peak_requests_per_second | The peak requests per second in the last hour.
|
hourly_peak_ssl_connections_per_second | The peak ssl connections per second in the last hour.
|
num_idle_connections | Total number of idle HTTP connections to all nodes (used for future HTTP requests).
|
number_child_processes | The number of traffic manager child processes.
|
number_dnsa_cache_hits | Requests for DNS A records resolved from the traffic manager's local cache.
|
number_dnsa_requests | Requests for DNS A records (hostname->IP address) made by the traffic manager.
|
number_dnsptr_cache_hits | Requests for DNS PTR records resolved from the traffic manager's local cache.
|
number_dnsptr_requests | Requests for DNS PTR records (IP address->hostname) made by the traffic manager.
|
number_snmp_bad_requests | Malformed SNMP requests received.
|
number_snmp_get_bulk_requests | SNMP GetBulkRequests received.
|
number_snmp_get_next_requests | SNMP GetNextRequests received.
|
number_snmp_get_requests | SNMP GetRequests received.
|
number_snmp_unauthorised_requests | SNMP requests dropped due to access restrictions.
|
ssl_cipher_3des_decrypts | Bytes decrypted with 3DES.
|
ssl_cipher_3des_encrypts | Bytes encrypted with 3DES.
|
ssl_cipher_aes_decrypts | Bytes decrypted with AES.
|
ssl_cipher_aes_encrypts | Bytes encrypted with AES.
|
ssl_cipher_aes_gcm_decrypts | Bytes decrypted with AES-GCM.
|
ssl_cipher_aes_gcm_encrypts | Bytes encrypted with AES-GCM.
|
ssl_cipher_decrypts | Bytes decrypted with a symmetric cipher.
|
ssl_cipher_des_decrypts | Bytes decrypted with DES.
|
ssl_cipher_des_encrypts | Bytes encrypted with DES.
|
ssl_cipher_dh_agreements | Number of Diffie Hellman key agreements.
|
ssl_cipher_dh_generates | Number of Diffie Hellman keys generated.
|
ssl_cipher_dsa_signs | Number of DSA signing operations.
|
ssl_cipher_dsa_verifies | Number of DSA verifications.
|
ssl_cipher_ecdh_agreements | Number of Elliptic Curve Diffie Hellman key agreements.
|
ssl_cipher_ecdh_generates | Number of Elliptic Curve Diffie Hellman keys generated.
|
ssl_cipher_ecdsa_signs | Number of ECDSA signing operations.
|
ssl_cipher_ecdsa_verifies | Number of ECDSA verifications.
|
ssl_cipher_encrypts | Bytes encrypted with a symmetric cipher.
|
ssl_cipher_rc4_decrypts | Bytes decrypted with RC4.
|
ssl_cipher_rc4_encrypts | Bytes encrypted with RC4.
|
ssl_cipher_rsa_decrypts | Number of RSA decrypts.
|
ssl_cipher_rsa_decrypts_external | Number of external RSA decrypts.
|
ssl_cipher_rsa_encrypts | Number of RSA encrypts.
|
ssl_cipher_rsa_encrypts_external | Number of external RSA encrypts.
|
ssl_client_cert_expired | Number of times a client certificate has expired.
|
ssl_client_cert_invalid | Number of times a client certificate was invalid.
|
ssl_client_cert_not_sent | Number of times a client certificate was required but not supplied.
|
ssl_client_cert_revoked | Number of times a client certificate was revoked.
|
ssl_connections | Number of SSL connections negotiated.
|
ssl_handshake_sslv3 | Number of SSLv3 handshakes.
|
ssl_handshake_tlsv1 | Number of TLSv1.0 handshakes.
|
ssl_handshake_tlsv11 | Number of TLSv1.1 handshakes.
|
ssl_handshake_tlsv12 | Number of TLSv1.2 handshakes.
|
ssl_handshake_tlsv13 | Number of TLSv1.3 handshakes.
|
ssl_session_id_mem_cache_hit | Number of times the SSL session id was found in the cache and reused.
|
ssl_session_id_mem_cache_miss | Number of times the SSL session id was not found in the cache.
|
sys_cpu_busy_percent | Percentage of time that the CPUs are busy.
|
sys_cpu_idle_percent | Percentage of time that the CPUs are idle.
|
sys_cpu_system_busy_percent | Percentage of time that the CPUs are busy running system code.
|
sys_cpu_user_busy_percent | Percentage of time that the CPUs are busy running user-space code.
|
sys_fds_free | Number of free file descriptors.
|
sys_mem_buffered | Buffer memory (MBytes).
|
sys_mem_free | Free memory (MBytes).
|
sys_mem_in_use | Memory used (MBytes).
|
sys_mem_swap_total | Total swap space (MBytes).
|
sys_mem_swapped | Amount of swap space in use (MBytes).
|
sys_mem_total | Total memory (MBytes).
|
time_last_config_update | The time (in hundredths of a second) since the configuration of traffic manager was updated (this value will wrap if no configuration changes are made for 497 days).
|
total_backend_server_errors | Total errors returned from the backend servers.
|
total_bad_dns_packets | Total number of malformed DNS response packets encountered from the backend servers.
|
total_bytes_in | Bytes received by the traffic manager from clients.
|
total_bytes_out | Bytes sent by the traffic manager to clients.
|
total_conn | Total number of TCP connections received.
|
total_current_conn | Number of TCP connections currently established.
|
total_dns_responses | Total number of DNS response packets handled.
|
total_requests | Total number of TCP requests received.
|
total_transactions | Total number of TCP requests being processed, after applying TPS limits.
|
total_udp_bytes_in_dropped | UDP bytes received by the traffic manager from clients but failed to be sent to backend servers.
|
total_udp_bytes_out_dropped | UDP bytes received by the traffic manager from backend servers but failed to be sent to clients.
|
up_time | The time (in hundredths of a second) that vTM software has been operational for (this value will wrap if it has been running for more than 497 days).
|
vtm_traffic_ips_ip_gateway_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/traffic_ips/ip_gateway
Ip gateway statistics values.
# Example usage of vtm_traffic_ips_ip_gateway_stats data source...
data "vtm_traffic_ips_ip_gateway_stats" "my_traffic_ips_ip_gateway_stats" {}
# Access with...
"${data.vtm_traffic_ips_ip_gateway_stats.my_traffic_ips_ip_gateway_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
arp_message | Number of ARP messages sent for raised Traffic IP Addresses.
|
gateway_ping_requests | Number of ping requests sent to the gateway machine.
|
gateway_ping_responses | Number of ping responses received from the gateway machine.
|
node_ping_requests | Number of ping requests sent to the backend nodes.
|
node_ping_responses | Number of ping responses received from the backend nodes.
|
number_inet46 | The number of traffic IP addresses on this system (includes IPv4 and IPv6 addresses).
|
number_raised_inet46 | The number of traffic IP addresses currently raised on this system (includes IPv4 and IPv6 addresses).
|
ping_response_errors | Number of ping response errors.
|
vtm_cache_ip_session_cache_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/cache/ip_session_cache
Ip session cache statistics values.
# Example usage of vtm_cache_ip_session_cache_stats data source...
data "vtm_cache_ip_session_cache_stats" "my_cache_ip_session_cache_stats" {}
# Access with...
"${data.vtm_cache_ip_session_cache_stats.my_cache_ip_session_cache_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
entries | The total number of IP sessions stored in the cache.
|
entries_max | The maximum number of IP sessions in the cache.
|
expiries | Number of times an expired IP session entry has been dropped on lookup.
|
hit_rate | The percentage of IP session lookups that succeeded.
|
hits | Number of times a IP session entry has been successfully found in the cache.
|
lookups | Number of times a IP session entry has been looked up in the cache.
|
misses | Number of times a IP session entry has not been available in the cache.
|
oldest | The age of the oldest IP session in the cache (in seconds).
|
vtm_cache_j2ee_session_cache_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/cache/j2ee_session_cache
J2ee session cache statistics values.
# Example usage of vtm_cache_j2ee_session_cache_stats data source...
data "vtm_cache_j2ee_session_cache_stats" "my_cache_j2ee_session_cache_stats" {}
# Access with...
"${data.vtm_cache_j2ee_session_cache_stats.my_cache_j2ee_session_cache_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
entries | The total number of J2EE sessions stored in the cache.
|
entries_max | The maximum number of J2EE sessions in the cache.
|
expiries | Number of times an expired J2EE session entry has been dropped on lookup.
|
hit_rate | The percentage of J2EE session lookups that succeeded.
|
hits | Number of times a J2EE session entry has been successfully found in the cache.
|
lookups | Number of times a J2EE session entry has been looked up in the cache.
|
misses | Number of times a J2EE session entry has not been available in the cache.
|
oldest | The age of the oldest J2EE session in the cache (in seconds).
|
vtm_listen_ip_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/listen_ips/*
Listen ips statistics values.
# Example usage of vtm_listen_ip_stats data source...
data "vtm_listen_ip_stats" "my_listen_ip_stats" {
name = "MyListenIp"
}
# Access with...
"${data.vtm_listen_ip_stats.my_listen_ip_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
bytes_in | Bytes sent to this listening IP.
|
bytes_out | Bytes sent from this listening IP.
|
current_conn | TCP connections currently established to this listening IP.
|
max_conn | Maximum number of simultaneous TCP connections this listening IP has processed at any one time.
|
total_requests | Requests sent to this listening IP.
|
vtm_location_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/locations/*
Locations statistics values.
# Example usage of vtm_location_stats data source...
data "vtm_location_stats" "my_location_stats" {
name = "MyLocation"
}
# Access with...
"${data.vtm_location_stats.my_location_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
load | The mean load metric for this location.
|
responses | Number of A records that have been altered to point to this location.
|
vtm_network_interface_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/network_interface/*
Network interface statistics values.
# Example usage of vtm_network_interface_stats data source...
data "vtm_network_interface_stats" "my_network_interface_stats" {
name = "MyNetworkInterface"
}
# Access with...
"${data.vtm_network_interface_stats.my_network_interface_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
collisions | The number of collisions reported by this interface.
|
rx_bytes | Bytes received by this interface.
|
rx_errors | The number of receive errors reported by this interface.
|
rx_packets | The number of packets received by this interface.
|
tx_bytes | Bytes transmitted by this interface.
|
tx_errors | The number of transmit errors reported by this interface.
|
tx_packets | The number of packets transmitted by this interface.
|
vtm_nodes_node_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/nodes/node/*
Node statistics values.
# Example usage of vtm_nodes_node_stats data source...
data "vtm_nodes_node_stats" "my_nodes_node_stats" {
name = "MyNodesNode"
}
# Access with...
"${data.vtm_nodes_node_stats.my_nodes_node_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
bytes_from_node_hi | Bytes received from this node ( high 32bits ).
|
bytes_from_node_lo | Bytes received from this node ( low 32bits ).
|
bytes_to_node_hi | Bytes sent to this node ( high 32bits ).
|
bytes_to_node_lo | Bytes sent to this node ( low 32bits ).
|
current_conn | Requests currently established to this node. ( does not include idle keepalives ).
|
current_requests | Connections currently established to this node.
|
errors | Number of timeouts, connection problems and other errors for this node.
|
failures | Failures of this node.
|
new_conn | Requests that created a new connection to this node.
|
pooled_conn | Requests that reused an existing pooled/keepalive connection rather than creating a new TCP connection.
|
port | The port this node listens on.
|
response_max | Maximum response time (ms) in the last second for this node.
|
response_mean | Mean response time (ms) in the last second for this node.
|
response_min | Minimum response time (ms) in the last second for this node.
|
state | The state of this node.
"alive": alive(1) "dead": dead(2) "unknown": unknown(3) |
total_conn | Requests sent to this node.
|
vtm_nodes_node_inet46_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/nodes/node_inet46/*
Node inet46 statistics values.
# Example usage of vtm_nodes_node_inet46_stats data source...
data "vtm_nodes_node_inet46_stats" "my_nodes_node_inet46_stats" {
name = "MyNodesNodeInet46"
}
# Access with...
"${data.vtm_nodes_node_inet46_stats.my_nodes_node_inet46_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
bytes_from_node | Bytes received from this node.
|
bytes_to_node | Bytes sent to this node.
|
current_conn | Current connections established to this node, includes idle connections and connections being established.
|
current_requests | Active connections established to this node, does not include idle connections.
|
errors | Number of timeouts, connection problems and other errors for this node.
|
failures | Failures of this node.
|
idle_conns | Number of idle HTTP connections to this node.
|
new_conn | Requests that created a new connection to this node.
|
pooled_conn | Requests that reused an existing pooled/keepalive connection rather than creating a new TCP connection.
|
port | The port this node listens on.
|
response_max | Maximum response time (ms) in the last second for this node.
|
response_mean | Mean response time (ms) in the last second for this node.
|
response_min | Minimum response time (ms) in the last second for this node.
|
state | The state of this node.
"alive": alive(1) "dead": dead(2) "unknown": unknown(3) |
total_conn | Requests sent to this node.
|
vtm_per_location_service_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/per_location_service/*
Per location service statistics values.
# Example usage of vtm_per_location_service_stats data source...
data "vtm_per_location_service_stats" "my_per_location_service_stats" {
name = "MyPerLocationService"
}
# Access with...
"${data.vtm_per_location_service_stats.my_per_location_service_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
draining | The draining state of this location for this GLB Service.
"draining": draining(1) "active": active(2) |
frontend_state | The frontend state of this location for this GLB Service.
"alive": alive(1) "dead": dead(2) |
load | The load metric for this location for this GLB Service.
|
monitor_state | The monitor state of this location for this GLB Service.
"alive": alive(1) "dead": dead(2) |
responses | Number of A records that have been altered to point to this location for this GLB Service.
|
state | The state of this location for this GLB Service.
"alive": alive(1) "dead": dead(2) |
vtm_per_node_slm_per_node_service_level_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/per_node_slm/per_node_service_level/*
Per node service level statistics values.
# Example usage of vtm_per_node_slm_per_node_service_level_stats data source...
data "vtm_per_node_slm_per_node_service_level_stats" "my_per_node_slm_per_node_service_level_stats" {
name = "MyPerNodeSlmPerNodeServiceLevel"
}
# Access with...
"${data.vtm_per_node_slm_per_node_service_level_stats.my_per_node_slm_per_node_service_level_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
node_port | The port number of this node.
|
response_max | Maximum response time (ms) in the last second for this SLM class to this node.
|
response_mean | Mean response time (ms) in the last second for this SLM class to this node.
|
response_min | Minimum response time (ms) in the last second for this SLM class to this node.
|
total_conn | Requests handled by this SLM class to this node.
|
total_non_conf | Non-conforming requests handled by this SLM class to this node.
|
vtm_per_node_slm_per_node_service_level_inet46_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/per_node_slm/per_node_service_level_inet46/*
Per node service level inet46 statistics values.
# Example usage of vtm_per_node_slm_per_node_service_level_inet46_stats data source...
data "vtm_per_node_slm_per_node_service_level_inet46_stats" "my_per_node_slm_per_node_service_level_inet46_stats" {
name = "MyPerNodeSlmPerNodeServiceLevelInet46"
}
# Access with...
"${data.vtm_per_node_slm_per_node_service_level_inet46_stats.my_per_node_slm_per_node_service_level_inet46_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
node_port | The port number of this node.
|
response_max | Maximum response time (ms) in the last second for this SLM class to this node.
|
response_mean | Mean response time (ms) in the last second for this SLM class to this node.
|
response_min | Minimum response time (ms) in the last second for this SLM class to this node.
|
total_conn | Requests handled by this SLM class to this node.
|
total_non_conf | Non-conforming requests handled by this SLM class to this node.
|
vtm_nodes_per_pool_node_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/nodes/per_pool_node/*
Per pool node statistics values.
# Example usage of vtm_nodes_per_pool_node_stats data source...
data "vtm_nodes_per_pool_node_stats" "my_nodes_per_pool_node_stats" {
name = "MyNodesPerPoolNode"
}
# Access with...
"${data.vtm_nodes_per_pool_node_stats.my_nodes_per_pool_node_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
bytes_from_node | Bytes received from this node.
|
bytes_to_node | Bytes sent to this node.
|
current_conn | Current connections established to a node, includes idle connections and connections being established.
|
current_requests | Active connections established to this node, does not include idle connections.
|
errors | Number of timeouts, connection problems and other errors for this node.
|
failures | Failures of this node.
|
idle_conns | Number of idle HTTP connections to this node.
|
new_conn | Requests that created a new connection to this node.
|
node_port | The port that this node listens on.
|
pooled_conn | Requests that reused an existing pooled/keepalive connection rather than creating a new TCP connection.
|
response_max | Maximum response time (ms) in the last second for this node.
|
response_mean | Mean response time (ms) in the last second for this node.
|
response_min | Minimum response time (ms) in the last second for this node.
|
state | The state of this node.
"alive": alive(1) "dead": dead(2) "unknown": unknown(3) "draining": draining(4) "drainingtodelete": drainingtodelete(5) |
total_conn | Requests sent to this node.
|
vtm_pool_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/pools/*
Pools statistics values.
# Example usage of vtm_pool_stats data source...
data "vtm_pool_stats" "my_pool_stats" {
name = "MyPool"
}
# Access with...
"${data.vtm_pool_stats.my_pool_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
algorithm | The load-balancing algorithm the pool uses.
"roundrobin": roundrobin(1) "weightedRoundRobin": weightedRoundRobin(2) "perceptive": perceptive(3) "leastConnections": leastConnections(4) "fastestResponseTime": fastestResponseTime(5) "random": random(6) "weightedLeastConnections": weightedLeastConnections(7) |
bytes_in | Bytes received by this pool from nodes.
|
bytes_out | Bytes sent by this pool to nodes.
|
conns_queued | Total connections currently queued to this pool.
|
disabled | The number of nodes in this pool that are disabled.
|
draining | The number of nodes in this pool which are draining.
|
http1xx_responses | Number of HTTP 1xx responses returned by this pool.
|
http2xx_responses | Number of HTTP 2xx responses returned by this pool.
|
http3xx_responses | Number of HTTP 3xx responses returned by this pool.
|
http4xx_responses | Number of HTTP 4xx responses returned by this pool.
|
http503_retries | Number of times the pool received an HTTP 503 response from a node and retried it against a different node.
|
http5xx_responses | Number of HTTP 5xx responses returned by this pool.
|
max_queue_time | Maximum time, measured in milliseconds, for which a connection was queued over the last second.
|
mean_queue_time | Mean time, measured in milliseconds, for which a connection was queued over the last second.
|
min_queue_time | Minimum time, measured in milliseconds, for which a connection was queued over the last second.
|
nodes | The number of nodes registered with this pool.
|
persistence | The session persistence method this pool uses
"none": none(1) "ip": ip(2) "rule": rule(3) "transparent": transparent(4) "applicationCookie": applicationCookie(5) "xZeusBackend": xZeusBackend(6) "ssl": ssl(7) |
queue_timeouts | Total connections that timed-out while queued.
|
session_migrated | Sessions migrated to a new node because the desired node was unavailable.
|
state | The state of this pool.
"active": active(1) "disabled": disabled(2) "draining": draining(3) "unused": unused(4) "unknown": unknown(5) |
total_conn | Requests sent to this pool.
|
vtm_rule_authenticator_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/rule_authenticators/*
Rule authenticators statistics values.
# Example usage of vtm_rule_authenticator_stats data source...
data "vtm_rule_authenticator_stats" "my_rule_authenticator_stats" {
name = "MyRuleAuthenticator"
}
# Access with...
"${data.vtm_rule_authenticator_stats.my_rule_authenticator_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
errors | Number of connection errors that have occurred when trying to connect to an authentication server.
|
fails | Number of times this Authenticator has failed to authenticate.
|
passes | Number of times this Authenticator has successfully authenticated.
|
requests | Number of times this Authenticator has been asked to authenticate.
|
vtm_rule_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/rules/*
Rules statistics values.
# Example usage of vtm_rule_stats data source...
data "vtm_rule_stats" "my_rule_stats" {
name = "MyRule"
}
# Access with...
"${data.vtm_rule_stats.my_rule_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
aborts | Number of times this TrafficScript rule has aborted.
|
discards | Number of times this TrafficScript rule has discarded the connection.
|
execution_time_warnings | Number of times this TrafficScript rule has exceeded the execution time warning threshold.
|
executions | Number of times this TrafficScript rule has been executed.
|
pool_select | Number of times this TrafficScript rule has selected a pool to use.
|
responds | Number of times this TrafficScript rule has responded directly to the client.
|
retries | Number of times this TrafficScript rule has forced the request to be retried.
|
vtm_service_level_monitor_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/service_level_monitors/*
Service level monitors statistics values.
# Example usage of vtm_service_level_monitor_stats data source...
data "vtm_service_level_monitor_stats" "my_service_level_monitor_stats" {
name = "MyServiceLevelMonitor"
}
# Access with...
"${data.vtm_service_level_monitor_stats.my_service_level_monitor_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
conforming | Percentage of requests associated with this SLM class that are conforming
|
current_conns | The number of connections currently associated with this SLM class.
|
is_o_k | Indicates if this SLM class is currently conforming.
"notok": notok(1) "ok": ok(2) |
response_max | Maximum response time (ms) in the last second for this SLM class.
|
response_mean | Mean response time (ms) in the last second for this SLM class.
|
response_min | Minimum response time (ms) in the last second for this SLM class.
|
total_conn | Requests handled by this SLM class.
|
total_non_conf | Non-conforming requests handled by this SLM class.
|
vtm_service_protection_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/service_protection/*
Service protection statistics values.
# Example usage of vtm_service_protection_stats data source...
data "vtm_service_protection_stats" "my_service_protection_stats" {
name = "MyServiceProtection"
}
# Access with...
"${data.vtm_service_protection_stats.my_service_protection_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
last_refusal_time | The time (in hundredths of a second) since this service protection class last refused a connection (this value will wrap if no connections are refused in more than 497 days).
|
refusal_binary | Connections refused by this service protection class because the request contained disallowed binary content.
|
refusal_conc10_ip | Connections refused by this service protection class because the top 10 source IP addresses issued too many concurrent connections.
|
refusal_conc1_ip | Connections refused by this service protection class because the source IP address issued too many concurrent connections.
|
refusal_conn_rate | Connections refused by this service protection class because the source IP address issued too many connections within 60 seconds.
|
refusal_ip | Connections refused by this service protection class because the source IP address was banned.
|
refusal_rfc2396 | Connections refused by this service protection class because the HTTP request was not RFC 2396 compliant.
|
refusal_size | Connections refused by this service protection class because the request was larger than the defined limits allowed.
|
total_refusal | Connections refused by this service protection class.
|
vtm_cache_ssl_cache_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/cache/ssl_cache
Ssl cache statistics values.
# Example usage of vtm_cache_ssl_cache_stats data source...
data "vtm_cache_ssl_cache_stats" "my_cache_ssl_cache_stats" {}
# Access with...
"${data.vtm_cache_ssl_cache_stats.my_cache_ssl_cache_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
entries | The total number of SSL sessions stored in the server cache.
|
entries_max | The maximum number of SSL entries in the server cache.
|
hit_rate | The percentage of SSL server cache lookups that succeeded.
|
hits | Number of times a SSL entry has been successfully found in the server cache.
|
lookups | Number of times a SSL entry has been looked up in the server cache.
|
misses | Number of times a SSL entry has not been available in the server cache.
|
oldest | The age of the oldest SSL session in the server cache (in seconds).
|
vtm_ssl_ocsp_stapling_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/ssl_ocsp_stapling
Ssl ocsp stapling statistics values.
# Example usage of vtm_ssl_ocsp_stapling_stats data source...
data "vtm_ssl_ocsp_stapling_stats" "my_ssl_ocsp_stapling_stats" {}
# Access with...
"${data.vtm_ssl_ocsp_stapling_stats.my_ssl_ocsp_stapling_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
cache_count | The number of entries in the OCSP stapling cache.
|
counter | The number of outgoing OCSP requests for OCSP stapling.
|
failure_count | The number of failed outgoing OCSP requests for OCSP stapling.
|
good_count | The number of 'good' OCSP responses for OCSP stapling.
|
revoked_count | The number of 'revoked' OCSP responses for OCSP stapling.
|
success_count | The number of successful outgoing OCSP requests for OCSP stapling.
|
unknown_count | The number of 'unknown' OCSP requests for OCSP stapling.
|
vtm_cache_ssl_session_cache_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/cache/ssl_session_cache
Ssl session cache statistics values.
# Example usage of vtm_cache_ssl_session_cache_stats data source...
data "vtm_cache_ssl_session_cache_stats" "my_cache_ssl_session_cache_stats" {}
# Access with...
"${data.vtm_cache_ssl_session_cache_stats.my_cache_ssl_session_cache_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
entries | The total number of SSL session persistence entries stored in the cache.
|
entries_max | The maximum number of SSL session persistence entries in the cache.
|
hit_rate | The percentage of SSL session persistence lookups that succeeded.
|
hits | Number of times a SSL session persistence entry has been successfully found in the cache.
|
lookups | Number of times a SSL session persistence entry has been looked up in the cache.
|
misses | Number of times a SSL session persistence entry has not been available in the cache.
|
oldest | The age of the oldest SSL session in the cache (in seconds).
|
vtm_traffic_ips_traffic_ip_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/traffic_ips/traffic_ip/*
Traffic ip statistics values.
# Example usage of vtm_traffic_ips_traffic_ip_stats data source...
data "vtm_traffic_ips_traffic_ip_stats" "my_traffic_ips_traffic_ip_stats" {
name = "MyTrafficIpsTrafficIp"
}
# Access with...
"${data.vtm_traffic_ips_traffic_ip_stats.my_traffic_ips_traffic_ip_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
state | Whether this traffic IP address is currently being hosted by this traffic manager.
"raised": raised(1) "lowered": lowered(2) |
time | The time (in hundredths of a second) since trafficIPState last changed (this value will wrap if the state hasn't changed for 497 days).
|
vtm_traffic_ips_traffic_ip_inet46_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/traffic_ips/traffic_ip_inet46/*
Traffic ip inet46 statistics values.
# Example usage of vtm_traffic_ips_traffic_ip_inet46_stats data source...
data "vtm_traffic_ips_traffic_ip_inet46_stats" "my_traffic_ips_traffic_ip_inet46_stats" {
name = "MyTrafficIpsTrafficIpInet46"
}
# Access with...
"${data.vtm_traffic_ips_traffic_ip_inet46_stats.my_traffic_ips_traffic_ip_inet46_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
state | Whether this traffic IP address is currently being hosted by this traffic manager.
"raised": raised(1) "lowered": lowered(2) |
time | The time (in hundredths of a second) since trafficIPState last changed (this value will wrap if the state hasn't changed for 497 days).
|
vtm_cache_uni_session_cache_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/cache/uni_session_cache
Uni session cache statistics values.
# Example usage of vtm_cache_uni_session_cache_stats data source...
data "vtm_cache_uni_session_cache_stats" "my_cache_uni_session_cache_stats" {}
# Access with...
"${data.vtm_cache_uni_session_cache_stats.my_cache_uni_session_cache_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
entries | The total number of universal sessions stored in the cache.
|
entries_max | The maximum number of universal sessions in the cache.
|
expiries | Number of times an expired universal session entry has been dropped on lookup.
|
hit_rate | The percentage of universal session lookups that succeeded.
|
hits | Number of times a universal session entry has been successfully found in the cache.
|
lookups | Number of times a universal session entry has been looked up in the cache.
|
misses | Number of times a universal session entry has not been available in the cache.
|
oldest | The age of the oldest universal session in the cache (in seconds).
|
vtm_extras_user_counters_32_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/extras/user_counters_32
User counters 32 statistics values.
# Example usage of vtm_extras_user_counters_32_stats data source...
data "vtm_extras_user_counters_32_stats" "my_extras_user_counters_32_stats" {}
# Access with...
"${data.vtm_extras_user_counters_32_stats.my_extras_user_counters_32_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
counter | The value of the user counter.
|
vtm_extras_user_counters_64_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/extras/user_counters_64
User counters 64 statistics values.
# Example usage of vtm_extras_user_counters_64_stats data source...
data "vtm_extras_user_counters_64_stats" "my_extras_user_counters_64_stats" {}
# Access with...
"${data.vtm_extras_user_counters_64_stats.my_extras_user_counters_64_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
counter | The value of the 64-bit user counter.
|
vtm_virtual_server_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/virtual_servers/*
Virtual servers statistics values.
# Example usage of vtm_virtual_server_stats data source...
data "vtm_virtual_server_stats" "my_virtual_server_stats" {
name = "MyVirtualServer"
}
# Access with...
"${data.vtm_virtual_server_stats.my_virtual_server_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
auth_saml_redirects | Number of times a user agent was redirected to SAML Identity Provider.
|
auth_saml_responses | Number of times a SAML Response was processed.
|
auth_saml_responses_accepted | Number of times a SAML Response was accepted.
|
auth_saml_responses_rejected | Number of times a SAML Response was rejected.
|
auth_sessions_created | Number of times an authentication session was created.
|
auth_sessions_rejected | Number of times an authentication session was rejected.
|
auth_sessions_used | Number of times an authentication session was used.
|
bytes_in | Bytes received by this virtual server from clients.
|
bytes_out | Bytes sent by this virtual server to clients.
|
cert_status_requests | Number of incoming TLS handshakes for this virtual server with certificate status requests.
|
cert_status_responses | Number of incoming TLS handshakes for this virtual server to which certificate status responses were attached.
|
connect_timed_out | Connections closed by this virtual server because the 'connect_timeout' interval was exceeded.
|
connection_errors | Number of transaction or protocol errors in this virtual server.
|
connection_failures | Number of connection failures in this virtual server.
|
current_conn | TCP connections currently established to this virtual server.
|
data_timed_out | Connections closed by this virtual server because the 'timeout' interval was exceeded.
|
direct_replies | Direct replies from this virtual server, without forwarding to a node.
|
discard | Connections discarded by this virtual server.
|
gzip | Responses which have been compressed by content compression.
|
gzip_bytes_saved | Bytes of network traffic saved by content compression.
|
http1xx_responses | Number of HTTP 1xx responses returned by this virtual server.
|
http2xx_responses | Number of HTTP 2xx responses returned by this virtual server.
|
http3xx_responses | Number of HTTP 3xx responses returned by this virtual server.
|
http4xx_responses | Number of HTTP 4xx responses returned by this virtual server.
|
http5xx_responses | Number of HTTP 5xx responses returned by this virtual server.
|
http_cache2xx_responses | Number of HTTP 2xx responses returned from webcache by this virtual server.
|
http_cache3xx_responses | Number of HTTP 3xx responses returned from webcache by this virtual server.
|
http_cache4xx_responses | Number of HTTP 4xx responses returned from webcache by this virtual server.
|
http_cache5xx_responses | Number of HTTP 5xx responses returned from webcache by this virtual server.
|
http_cache_hit_rate | Percentage hit rate of the web cache for this virtual server.
|
http_cache_hits | HTTP responses sent directly from the web cache by this virtual server.
|
http_cache_lookups | HTTP requests that are looked up in the web cache by this virtual server.
|
http_generated2xx_responses | Number of HTTP 2xx responses generated by this virtual server.
|
http_generated3xx_responses | Number of HTTP 3xx responses generated by this virtual server.
|
http_generated4xx_responses | Number of HTTP 4xx responses generated by this virtual server.
|
http_generated5xx_responses | Number of HTTP 5xx responses generated by this virtual server.
|
http_rewrite_cookie | HTTP Set-Cookie headers, supplied by a node, that have been rewritten.
|
http_rewrite_location | HTTP Location headers, supplied by a node, that have been rewritten.
|
http_server1xx_responses | Number of HTTP 1xx responses returned from a backend server or TrafficScript rule by this virtual server.
|
http_server2xx_responses | Number of HTTP 2xx responses returned from a backend server or TrafficScript rule by this virtual server.
|
http_server3xx_responses | Number of HTTP 3xx responses returned from a backend server or TrafficScript rule by this virtual server.
|
http_server4xx_responses | Number of HTTP 4xx responses returned from a backend server or TrafficScript rule by this virtual server.
|
http_server5xx_responses | Number of HTTP 5xx responses returned from a backend server or TrafficScript rule by this virtual server.
|
keepalive_timed_out | Connections closed by this virtual server because the 'keepalive_timeout' interval was exceeded.
|
max_conn | Maximum number of simultaneous TCP connections this virtual server has processed at any one time.
|
max_duration_timed_out | Connections closed by this virtual server because the 'max_transaction_duration' interval was exceeded.
|
port | The port the virtual server listens on.
|
processing_timed_out | Connections closed by this virtual server because the 'timeout' interval was exceeded while waiting for rules or external processing.
|
protocol | The protocol the virtual server is operating.
"http": http(1) "https": https(2) "ftp": ftp(3) "imaps": imaps(4) "imapv2": imapv2(5) "imapv3": imapv3(6) "imapv4": imapv4(7) "pop3": pop3(8) "pop3s": pop3s(9) "smtp": smtp(10) "ldap": ldap(11) "ldaps": ldaps(12) "telnet": telnet(13) "sslforwarding": sslforwarding(14) "udpstreaming": udpstreaming(15) "udp": udp(16) "dns": dns(17) "genericserverfirst": genericserverfirst(18) "genericclientfirst": genericclientfirst(19) "dnstcp": dnstcp(20) "sipudp": sipudp(21) "siptcp": siptcp(22) "rtsp": rtsp(23) "stream": stream(24) "l4acceltcp": l4acceltcp(25) "l4acceludp": l4acceludp(26) "l4accelgeneric": l4accelgeneric(27) "l4accelstateless": l4accelstateless(28) |
sip_rejected_requests | Number of SIP requests rejected due to them exceeding the maximum amount of memory allocated to the connection.
|
sip_total_calls | Total number of SIP INVITE requests seen by this virtual server.
|
ssl_cache_lookup | Number of times a lookup for an existing SSL session was performed.
|
ssl_cache_miss | Number of times a lookup failed to find an existing SSL session.
|
ssl_cache_rejected | Number of times an SSL session was found in the cache but rejected and not resumed.
|
ssl_cache_resumed | Number of times an SSL session was resumed from the cache.
|
ssl_cache_saved | Number of times an SSL session was saved to the cache.
|
ssl_hello_retry_requested | Number of times a HelloRetryRequest message was sent to TLS clients.
|
ssl_new_session | Number of times a new SSL session was created.
|
ssl_ticket_expired | Number of SSL session tickets that were rejected because they had expired.
|
ssl_ticket_issued | Number of SSL session tickets that were issued to clients.
|
ssl_ticket_key_not_found | Number of SSL session tickets that could not be decrypted because the ticket key they referenced could not be found.
|
ssl_ticket_received | Number of SSL session tickets received.
|
ssl_ticket_rejected | Number of SSL session tickets that were rejected for a reason other than because they had expired.
|
ssl_ticket_resumed | Number of SSL session tickets that were successfully used to resume a session.
|
total_dgram | UDP datagrams processed by this virtual server.
|
total_http1_requests | HTTP/1.x Requests received by this virtual server.
|
total_http2_requests | HTTP/2 Requests received by this virtual server.
|
total_http_requests | HTTP Requests received by this virtual server.
|
total_requests | Requests received by this virtual server.
|
udp_bytes_in_dropped | UDP bytes received by this virtual server from clients but failed to be sent to backend servers.
|
udp_bytes_out_dropped | UDP bytes received by this virtual server from backend servers but failed to be sent to clients.
|
udp_timed_out | Connections closed by this virtual server because the 'udp_timeout' interval was exceeded.
|
vtm_cache_web_cache_stats
URI Endpoint: /api/tm/8.3/status/local_tm/statistics/cache/web_cache
Web cache statistics values.
# Example usage of vtm_cache_web_cache_stats data source...
data "vtm_cache_web_cache_stats" "my_cache_web_cache_stats" {}
# Access with...
"${data.vtm_cache_web_cache_stats.my_cache_web_cache_stats.<FIELD_NAME>}"Field Name | Description |
|---|---|
entries | The number of items in the web cache.
|
hit_rate | The percentage of web cache lookups that succeeded.
|
hits | Number of times a page has been successfully found in the web cache.
|
lookups | Number of times a page has been looked up in the web cache.
|
max_entries | The maximum number of items in the web cache.
|
mem_maximum | The maximum amount of memory the web cache can use in kilobytes.
|
mem_used | Total memory used by the web cache in kilobytes.
|
misses | Number of times a page has not been found in the web cache.
|
oldest | The age of the oldest item in the web cache (in seconds).
|
url_store_allocated | Amount of allocated space in the web cache URL store.
|
url_store_free | Amount of free space in the web cache URL store.
|
url_store_size | Total amount of space in the web cache URL store.
|
url_store_total_allocations | Total number of allocations for the web cache URL store.
|
url_store_total_failures | Total number of allocation failures for the web cache URL store.
|
url_store_total_frees | Total number of blocks freed in the web cache URL store.
|
System Information
System information data sources allow Terraform to access information about the current state of a Traffic Manager, including errors and service statuses.
data "vtm_state" "state_information" {}vtm_backups_full
URI Endpoint: /api/tm/8.3/status/local_tm/backups/full/*
Full backups.
# Example usage of vtm_backups_full data source...
data "vtm_backups_full" "my_backups_full" {
name = "MyBackupsFull"
}
# Access with...
"${data.vtm_backups_full.my_backups_full.<FIELD_NAME>}"Property | Description |
|---|---|
name | Name of the object
|
backup_description | Description of the backup
|
backup_time_stamp | Time the backup was created. Expressed as a UTC value.
|
backup_version | Version of the traffic manager used to create the backup
|
vtm_information
URI Endpoint: /api/tm/8.3/status/local_tm/information
Static information for the system.
# Example usage of vtm_information data source...
data "vtm_information" "my_information" {}
# Access with...
"${data.vtm_information.my_information.<FIELD_NAME>}"Property | Description |
|---|---|
information_platform | The type of platform on which the Traffic Manager instance is running on.
|
information_tm_version | Version number of the Traffic Manager instance.
|
information_uuid | The universally unique identifier for the Traffic Manager instance.
|
vtm_state
URI Endpoint: /api/tm/8.3/status/local_tm/state
State information for the traffic manager.
# Example usage of vtm_state data source...
data "vtm_state" "my_state" {}
# Access with...
"${data.vtm_state.my_state.<FIELD_NAME>}"Property | Description |
|---|---|
state_error_level | The error_level of the traffic manager.
"ok": System has no problems "warn": System has minor issues "error": System has major issues "fatal": System has issues which causes it to die/crash/fail to startup |
state_errors | List of configuration errors for the traffic manager
|
state_failed_nodes | A table of nodes which have failed on the traffic manager
|
state_failed_nodes_json | A Traffic Manager REST-compatible JSON representation of the "state_failed_nodes" table property. Use this field with the "vtm_state_failed_nodes_table" data source for dynamic table generation from input variables.
|
state_license | Current active license or Community_Edition
|
state_pools |
|
state_pools_json | A Traffic Manager REST-compatible JSON representation of the "state_pools" table property. Use this field with the "vtm_state_pools_table" data source for dynamic table generation from input variables.
|
state_tip_errors | List of traffic IP errors for the traffic manager
|
state_virtual_servers | A table of virtual server status
|
state_virtual_servers_json | A Traffic Manager REST-compatible JSON representation of the "state_virtual_servers" table property. Use this field with the "vtm_state_virtual_servers_table" data source for dynamic table generation from input variables.
|
Table Field Data Sources
When hard-coding a Terraform template, you can include nested data structures that represent the table structures used by some Traffic Manager configuration fields. For example, the "nodes_table" field of the "vtm_pool" resource can have multiple rows specified as shown in the code sample that follows:
resource "vtm_pool" "my_pool" {
name = "MyPool"
nodes_table {
node = "192.0.2.1:80"
state = "active"
}
nodes_table {
node = "192.0.2.2:80"
state = "active"
}
nodes_table {
node = "192.0.2.3:80"
state = "disabled"
}
}To add a new row to the "nodes_table" field through this method, add another "nodes_table {}" block with the relevant field values. Often, however, it is desirable to assign configuration data to a template using input variables, although currently there is no supported method for passing in nested structures.
To facilitate the use-case of passing table configuration into a template through input variables, the Traffic Manager provides table field data sources that can accept standard list variables as inputs to each column of the table field. To identify the corresponding table property, each table field data source uses the naming convention "<RESOURCE_NAME>_<TABLE_FIELD_NAME>_table". Each data source supports the same fields, with the same default values, as the corresponding table and returns a JSON string that can be supplied to a configuration resource. Each data source also contains a "json" field that automatically computes the properly-formatted JSON representation of the table row. These json values can then be assembled into a JSON list and assigned to a special field on the resource object called “<TABLE_FIELD_NAME>_json”.
For example, using the “vtm_pool” -> “nodes_table” data from the preceding code sample, use the table field data source “vtm_pool_nodes_table_table” to apply the same configuration through input variables:
# In the terraform.tfvars file (or equivalent through the command line)
node_list = ["192.0.2.1:80", "192.0.2.2:80", "192.0.2.3:80"]
node_state_list = ["active", "active", "disabled"]
# In the Terraform template...
variable "node_list" {
type = list
}
variable "node_state_list" {
type = list
}
data "vtm_pool_nodes_table_table" "nodes_table" {
count = "${length(var.node_list)}"
node = "${var.node_list[count.index]}"
state = "${var.node_state_list[count.index]}"
}
resource "vtm_pool" "my_pool" {
name = "MyPool"
nodes_table_json = "[${join(",", data.vtm_pool_nodes_table_table.nodes_table.*.json)}]"
}The following list contains all available table field data sources:
- vtm_action_arguments_table
- vtm_appliance_nat_many_to_one_all_ports_table
- vtm_appliance_nat_many_to_one_port_locked_table
- vtm_appliance_nat_one_to_one_table
- vtm_appliance_nat_port_mapping_table
- vtm_custom_string_lists_table
- vtm_glb_service_dnssec_keys_table
- vtm_glb_service_location_settings_table
- vtm_global_settings_appliance_returnpath_table
- vtm_log_export_metadata_table
- vtm_monitor_arguments_table
- vtm_pool_nodes_table_table
- vtm_state_failed_nodes_table
- vtm_state_pools_table
- vtm_state_virtual_servers_table
- vtm_traffic_ip_group_ip_mapping_table
- vtm_traffic_manager_appliance_card_table
- vtm_traffic_manager_appliance_sysctl_table
- vtm_traffic_manager_hosts_table
- vtm_traffic_manager_if_table
- vtm_traffic_manager_ip_table
- vtm_traffic_manager_routes_table
- vtm_traffic_manager_trafficip_table
- vtm_user_group_permissions_table
- vtm_virtual_server_ca_sites_table
- vtm_virtual_server_ocsp_issuers_table
- vtm_virtual_server_profile_table
- vtm_virtual_server_server_cert_host_mapping_table