--- title: Data Sources slug: ps/help/en_us/vtm/terraformrg/data-sources docTags: createdAt: 2026-08-02T09:18:27.008Z --- 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: ```bash # 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. ```bash # 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): ```bash # 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. ```bash # 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 | Description | | ---------- | ------------------------------------------------------------------------------------------------------ | | processed | Number of times this action has been processed.
- Type: UInt
- SNMP name: "actionsProcessed" | ### 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. ```bash # 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 | Description | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- | | entries | The total number of ASP sessions stored in the cache.
- Type: UInt
- SNMP name: "aspSessionCacheEntries" | | entries\_max | The maximum number of ASP sessions in the cache.
- Type: UInt
- SNMP name: "aspSessionCacheEntriesMax" | | hit\_rate | The percentage of ASP session lookups that succeeded.
- Type: UInt
- SNMP name: "aspSessionCacheHitRate" | | hits | Number of times a ASP session entry has been successfully found in the cache.
- Type: UInt
- SNMP name: "aspSessionCacheHits" | | lookups | Number of times a ASP session entry has been looked up in the cache.
- Type: UInt
- SNMP name: "aspSessionCacheLookups" | | misses | Number of times a ASP session entry has not been available in the cache.
- Type: UInt
- SNMP name: "aspSessionCacheMisses" | | oldest | The age of the oldest ASP session in the cache (in seconds).
- Type: UInt
- SNMP name: "aspSessionCacheOldest" | ### vtm\_bandwidth\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/bandwidth/\* Bandwidth statistics values. ```bash # 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 | Description | | ---------- | ---------------------------------------------------------------------------------------------------------------------------- | | bytes\_out | Bytes output by connections assigned to this bandwidth class.
- Type: UInt64
- SNMP name: "bandwidthClassBytesOut" | | guarantee | Guaranteed bandwidth class limit (kbits/s). Currently unused.
- Type: UInt
- SNMP name: "bandwidthClassGuarantee" | | maximum | Maximum bandwidth class limit (kbits/s).
- Type: UInt
- SNMP name: "bandwidthClassMaximum" | ### vtm\_cloud\_api\_credential\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/cloud\_api\_credentials/\* Cloud api credentials statistics values. ```bash # 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 | Description | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | node\_creations | The number of instance creation API requests made with this set of cloud credentials.
- Type: UInt
- SNMP name: "cloudcredentialsNodeCreations" | | node\_deletions | The number of instance destruction API requests made with this set of cloud credentials.
- Type: UInt
- SNMP name: "cloudcredentialsNodeDeletions" | | status\_requests | The number of status API requests made with this set of cloud credentials.
- Type: UInt
- SNMP name: "cloudcredentialsStatusRequests" | ### vtm\_connection\_rate\_limit\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/connection\_rate\_limit/\* Connection rate limit statistics values. ```bash # 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 | Description | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | conns\_entered | Connections that have entered the rate class and have been queued.
- Type: UInt
- SNMP name: "rateClassConnsEntered" | | conns\_left | Connections that have left the rate class.
- Type: UInt
- SNMP name: "rateClassConnsLeft" | | current\_rate | The average rate that requests are passing through this rate class.
- Type: UInt
- SNMP name: "rateClassCurrentRate" | | dropped | Requests dropped from this rate class without being processed (e.g. timeouts).
- Type: UInt
- SNMP name: "rateClassDropped" | | max\_rate\_per\_min | The maximum rate that requests may pass through this rate class (requests/min).
- Type: UInt
- SNMP name: "rateClassMaxRatePerMin" | | max\_rate\_per\_sec | The maximum rate that requests may pass through this rate class (requests/sec).
- Type: UInt
- SNMP name: "rateClassMaxRatePerSec" | | queue\_length | The current number of requests queued by this rate class.
- Type: UInt
- SNMP name: "rateClassQueueLength" | ### vtm\_event\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/events/\* Events statistics values. ```bash # 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 | Description | | ---------- | --------------------------------------------------------------------------------------------------------- | | matched | Number of times this event configuration has matched.
- Type: UInt
- SNMP name: "eventsMatched" | ### vtm\_glb\_service\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/glb\_services/\* Glb services statistics values. ```bash # 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 | Description | | ---------- | ------------------------------------------------------------------------------------------------------------------------------ | | discarded | Number of A records this GLB Service has discarded.
- Type: UInt
- SNMP name: "glbServiceDiscarded" | | responses | Number of A records this GLB Service has altered.
- Type: UInt
- SNMP name: "glbServiceResponses" | | unmodified | Number of A records this GLB Service has passed through unmodified.
- Type: UInt
- SNMP name: "glbServiceUnmodified" | ### vtm\_globals\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/globals Globals statistics values. ```bash # 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 | Description | | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | analytics\_transactions\_dropped | Count of transaction metadata records that have been dropped
- Type: UInt
- SNMP name: "analyticsTransactionsDropped" | | analytics\_transactions\_exported | Count of transaction metadata records that have been exported
- Type: UInt
- SNMP name: "analyticsTransactionsExported" | | analytics\_transactions\_memory\_usage | Number of bytes queued in the transaction export transmit buffers.
- Type: UInt
- SNMP name: "analyticsTransactionsMemoryUsage" | | data\_entries | Number of entries in the TrafficScript data.get()/set() storage.
- Type: UInt
- SNMP name: "dataEntries" | | data\_memory\_usage | Number of bytes used in the TrafficScript data.get()/set() storage.
- Type: UInt
- SNMP name: "dataMemoryUsage" | | events\_seen | Events seen by the traffic Manager's event handling process.
- Type: UInt
- SNMP name: "eventsSeen" | | hourly\_peak\_bytes\_in\_per\_second | The peak bytes received from clients per second in the last hour.
- Type: UInt
- SNMP name: "hourlyPeakBytesInPerSecond" | | hourly\_peak\_bytes\_out\_per\_second | The peak bytes sent to clients per second in the last hour.
- Type: UInt
- SNMP name: "hourlyPeakBytesOutPerSecond" | | hourly\_peak\_requests\_per\_second | The peak requests per second in the last hour.
- Type: UInt
- SNMP name: "hourlyPeakRequestsPerSecond" | | hourly\_peak\_ssl\_connections\_per\_second | The peak ssl connections per second in the last hour.
- Type: UInt
- SNMP name: "hourlyPeakSSLConnectionsPerSecond" | | num\_idle\_connections | Total number of idle HTTP connections to all nodes (used for future HTTP requests).
- Type: UInt
- SNMP name: "numIdleConnections" | | number\_child\_processes | The number of traffic manager child processes.
- Type: UInt
- SNMP name: "numberChildProcesses" | | number\_dnsa\_cache\_hits | Requests for DNS A records resolved from the traffic manager's local cache.
- Type: UInt
- SNMP name: "numberDNSACacheHits" | | number\_dnsa\_requests | Requests for DNS A records (hostname->IP address) made by the traffic manager.
- Type: UInt
- SNMP name: "numberDNSARequests" | | number\_dnsptr\_cache\_hits | Requests for DNS PTR records resolved from the traffic manager's local cache.
- Type: UInt
- SNMP name: "numberDNSPTRCacheHits" | | number\_dnsptr\_requests | Requests for DNS PTR records (IP address->hostname) made by the traffic manager.
- Type: UInt
- SNMP name: "numberDNSPTRRequests" | | number\_snmp\_bad\_requests | Malformed SNMP requests received.
- Type: UInt
- SNMP name: "numberSNMPBadRequests" | | number\_snmp\_get\_bulk\_requests | SNMP GetBulkRequests received.
- Type: UInt
- SNMP name: "numberSNMPGetBulkRequests" | | number\_snmp\_get\_next\_requests | SNMP GetNextRequests received.
- Type: UInt
- SNMP name: "numberSNMPGetNextRequests" | | number\_snmp\_get\_requests | SNMP GetRequests received.
- Type: UInt
- SNMP name: "numberSNMPGetRequests" | | number\_snmp\_unauthorised\_requests | SNMP requests dropped due to access restrictions.
- Type: UInt
- SNMP name: "numberSNMPUnauthorisedRequests" | | ssl\_cipher\_3des\_decrypts | Bytes decrypted with 3DES.
- Type: UInt
- SNMP name: "sslCipher3DESDecrypts" | | ssl\_cipher\_3des\_encrypts | Bytes encrypted with 3DES.
- Type: UInt
- SNMP name: "sslCipher3DESEncrypts" | | ssl\_cipher\_aes\_decrypts | Bytes decrypted with AES.
- Type: UInt
- SNMP name: "sslCipherAESDecrypts" | | ssl\_cipher\_aes\_encrypts | Bytes encrypted with AES.
- Type: UInt
- SNMP name: "sslCipherAESEncrypts" | | ssl\_cipher\_aes\_gcm\_decrypts | Bytes decrypted with AES-GCM.
- Type: UInt
- SNMP name: "sslCipherAESGCMDecrypts" | | ssl\_cipher\_aes\_gcm\_encrypts | Bytes encrypted with AES-GCM.
- Type: UInt
- SNMP name: "sslCipherAESGCMEncrypts" | | ssl\_cipher\_decrypts | Bytes decrypted with a symmetric cipher.
- Type: UInt
- SNMP name: "sslCipherDecrypts" | | ssl\_cipher\_des\_decrypts | Bytes decrypted with DES.
- Type: UInt
- SNMP name: "sslCipherDESDecrypts" | | ssl\_cipher\_des\_encrypts | Bytes encrypted with DES.
- Type: UInt
- SNMP name: "sslCipherDESEncrypts" | | ssl\_cipher\_dh\_agreements | Number of Diffie Hellman key agreements.
- Type: UInt
- SNMP name: "sslCipherDHAgreements" | | ssl\_cipher\_dh\_generates | Number of Diffie Hellman keys generated.
- Type: UInt
- SNMP name: "sslCipherDHGenerates" | | ssl\_cipher\_dsa\_signs | Number of DSA signing operations.
- Type: UInt
- SNMP name: "sslCipherDSASigns" | | ssl\_cipher\_dsa\_verifies | Number of DSA verifications.
- Type: UInt
- SNMP name: "sslCipherDSAVerifies" | | ssl\_cipher\_ecdh\_agreements | Number of Elliptic Curve Diffie Hellman key agreements.
- Type: UInt
- SNMP name: "sslCipherECDHAgreements" | | ssl\_cipher\_ecdh\_generates | Number of Elliptic Curve Diffie Hellman keys generated.
- Type: UInt
- SNMP name: "sslCipherECDHGenerates" | | ssl\_cipher\_ecdsa\_signs | Number of ECDSA signing operations.
- Type: UInt
- SNMP name: "sslCipherECDSASigns" | | ssl\_cipher\_ecdsa\_verifies | Number of ECDSA verifications.
- Type: UInt
- SNMP name: "sslCipherECDSAVerifies" | | ssl\_cipher\_encrypts | Bytes encrypted with a symmetric cipher.
- Type: UInt
- SNMP name: "sslCipherEncrypts" | | ssl\_cipher\_rc4\_decrypts | Bytes decrypted with RC4.
- Type: UInt
- SNMP name: "sslCipherRC4Decrypts" | | ssl\_cipher\_rc4\_encrypts | Bytes encrypted with RC4.
- Type: UInt
- SNMP name: "sslCipherRC4Encrypts" | | ssl\_cipher\_rsa\_decrypts | Number of RSA decrypts.
- Type: UInt
- SNMP name: "sslCipherRSADecrypts" | | ssl\_cipher\_rsa\_decrypts\_external | Number of external RSA decrypts.
- Type: UInt
- SNMP name: "sslCipherRSADecryptsExternal" | | ssl\_cipher\_rsa\_encrypts | Number of RSA encrypts.
- Type: UInt
- SNMP name: "sslCipherRSAEncrypts" | | ssl\_cipher\_rsa\_encrypts\_external | Number of external RSA encrypts.
- Type: UInt
- SNMP name: "sslCipherRSAEncryptsExternal" | | ssl\_client\_cert\_expired | Number of times a client certificate has expired.
- Type: UInt
- SNMP name: "sslClientCertExpired" | | ssl\_client\_cert\_invalid | Number of times a client certificate was invalid.
- Type: UInt
- SNMP name: "sslClientCertInvalid" | | ssl\_client\_cert\_not\_sent | Number of times a client certificate was required but not supplied.
- Type: UInt
- SNMP name: "sslClientCertNotSent" | | ssl\_client\_cert\_revoked | Number of times a client certificate was revoked.
- Type: UInt
- SNMP name: "sslClientCertRevoked" | | ssl\_connections | Number of SSL connections negotiated.
- Type: UInt
- SNMP name: "sslConnections" | | ssl\_handshake\_sslv3 | Number of SSLv3 handshakes.
- Type: UInt
- SNMP name: "sslHandshakeSSLv3" | | ssl\_handshake\_tlsv1 | Number of TLSv1.0 handshakes.
- Type: UInt
- SNMP name: "sslHandshakeTLSv1" | | ssl\_handshake\_tlsv11 | Number of TLSv1.1 handshakes.
- Type: UInt
- SNMP name: "sslHandshakeTLSv11" | | ssl\_handshake\_tlsv12 | Number of TLSv1.2 handshakes.
- Type: UInt
- SNMP name: "sslHandshakeTLSv12" | | ssl\_handshake\_tlsv13 | Number of TLSv1.3 handshakes.
- Type: UInt
- SNMP name: "sslHandshakeTLSv13" | | ssl\_session\_id\_mem\_cache\_hit | Number of times the SSL session id was found in the cache and reused.
- Type: UInt
- SNMP name: "sslSessionIDMemCacheHit" | | ssl\_session\_id\_mem\_cache\_miss | Number of times the SSL session id was not found in the cache.
- Type: UInt
- SNMP name: "sslSessionIDMemCacheMiss" | | sys\_cpu\_busy\_percent | Percentage of time that the CPUs are busy.
- Type: UInt
- SNMP name: "sysCPUBusyPercent" | | sys\_cpu\_idle\_percent | Percentage of time that the CPUs are idle.
- Type: UInt
- SNMP name: "sysCPUIdlePercent" | | sys\_cpu\_system\_busy\_percent | Percentage of time that the CPUs are busy running system code.
- Type: UInt
- SNMP name: "sysCPUSystemBusyPercent" | | sys\_cpu\_user\_busy\_percent | Percentage of time that the CPUs are busy running user-space code.
- Type: UInt
- SNMP name: "sysCPUUserBusyPercent" | | sys\_fds\_free | Number of free file descriptors.
- Type: UInt
- SNMP name: "sysFDsFree" | | sys\_mem\_buffered | Buffer memory (MBytes).
- Type: UInt
- SNMP name: "sysMemBuffered" | | sys\_mem\_free | Free memory (MBytes).
- Type: UInt
- SNMP name: "sysMemFree" | | sys\_mem\_in\_use | Memory used (MBytes).
- Type: UInt
- SNMP name: "sysMemInUse" | | sys\_mem\_swap\_total | Total swap space (MBytes).
- Type: UInt
- SNMP name: "sysMemSwapTotal" | | sys\_mem\_swapped | Amount of swap space in use (MBytes).
- Type: UInt
- SNMP name: "sysMemSwapped" | | sys\_mem\_total | Total memory (MBytes).
- Type: UInt
- SNMP name: "sysMemTotal" | | 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).
- Type: UInt
- SNMP name: "timeLastConfigUpdate" | | total\_backend\_server\_errors | Total errors returned from the backend servers.
- Type: UInt
- SNMP name: "totalBackendServerErrors" | | total\_bad\_dns\_packets | Total number of malformed DNS response packets encountered from the backend servers.
- Type: UInt
- SNMP name: "totalBadDNSPackets" | | total\_bytes\_in | Bytes received by the traffic manager from clients.
- Type: UInt64
- SNMP name: "totalBytesIn" | | total\_bytes\_out | Bytes sent by the traffic manager to clients.
- Type: UInt64
- SNMP name: "totalBytesOut" | | total\_conn | Total number of TCP connections received.
- Type: UInt
- SNMP name: "totalConn" | | total\_current\_conn | Number of TCP connections currently established.
- Type: UInt
- SNMP name: "totalCurrentConn" | | total\_dns\_responses | Total number of DNS response packets handled.
- Type: UInt
- SNMP name: "totalDNSResponses" | | total\_requests | Total number of TCP requests received.
- Type: UInt
- SNMP name: "totalRequests" | | total\_transactions | Total number of TCP requests being processed, after applying TPS limits.
- Type: UInt
- SNMP name: "totalTransactions" | | total\_udp\_bytes\_in\_dropped | UDP bytes received by the traffic manager from clients but failed to be sent to backend servers.
- Type: UInt64
- SNMP name: "totalUDPBytesInDropped" | | total\_udp\_bytes\_out\_dropped | UDP bytes received by the traffic manager from backend servers but failed to be sent to clients.
- Type: UInt64
- SNMP name: "totalUDPBytesOutDropped" | | 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).
- Type: UInt
- SNMP name: "upTime" | ### vtm\_traffic\_ips\_ip\_gateway\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/traffic\_ips/ip\_gateway Ip gateway statistics values. ```bash # 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 | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | arp\_message | Number of ARP messages sent for raised Traffic IP Addresses.
- Type: UInt
- SNMP name: "trafficIPARPMessage" | | gateway\_ping\_requests | Number of ping requests sent to the gateway machine.
- Type: UInt
- SNMP name: "trafficIPGatewayPingRequests" | | gateway\_ping\_responses | Number of ping responses received from the gateway machine.
- Type: UInt
- SNMP name: "trafficIPGatewayPingResponses" | | node\_ping\_requests | Number of ping requests sent to the backend nodes.
- Type: UInt
- SNMP name: "trafficIPNodePingRequests" | | node\_ping\_responses | Number of ping responses received from the backend nodes.
- Type: UInt
- SNMP name: "trafficIPNodePingResponses" | | number\_inet46 | The number of traffic IP addresses on this system (includes IPv4 and IPv6 addresses).
- Type: UInt
- SNMP name: "trafficIPNumberInet46" | | number\_raised\_inet46 | The number of traffic IP addresses currently raised on this system (includes IPv4 and IPv6 addresses).
- Type: UInt
- SNMP name: "trafficIPNumberRaisedInet46" | | ping\_response\_errors | Number of ping response errors.
- Type: UInt
- SNMP name: "trafficIPPingResponseErrors" | ### 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. ```bash # 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 | Description | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------- | | entries | The total number of IP sessions stored in the cache.
- Type: UInt
- SNMP name: "ipSessionCacheEntries" | | entries\_max | The maximum number of IP sessions in the cache.
- Type: UInt
- SNMP name: "ipSessionCacheEntriesMax" | | expiries | Number of times an expired IP session entry has been dropped on lookup.
- Type: UInt
- SNMP name: "ipSessionCacheExpiries" | | hit\_rate | The percentage of IP session lookups that succeeded.
- Type: UInt
- SNMP name: "ipSessionCacheHitRate" | | hits | Number of times a IP session entry has been successfully found in the cache.
- Type: UInt
- SNMP name: "ipSessionCacheHits" | | lookups | Number of times a IP session entry has been looked up in the cache.
- Type: UInt
- SNMP name: "ipSessionCacheLookups" | | misses | Number of times a IP session entry has not been available in the cache.
- Type: UInt
- SNMP name: "ipSessionCacheMisses" | | oldest | The age of the oldest IP session in the cache (in seconds).
- Type: UInt
- SNMP name: "ipSessionCacheOldest" | ### 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. ```bash # 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 | Description | | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | | entries | The total number of J2EE sessions stored in the cache.
- Type: UInt
- SNMP name: "j2eeSessionCacheEntries" | | entries\_max | The maximum number of J2EE sessions in the cache.
- Type: UInt
- SNMP name: "j2eeSessionCacheEntriesMax" | | expiries | Number of times an expired J2EE session entry has been dropped on lookup.
- Type: UInt
- SNMP name: "j2eeSessionCacheExpiries" | | hit\_rate | The percentage of J2EE session lookups that succeeded.
- Type: UInt
- SNMP name: "j2eeSessionCacheHitRate" | | hits | Number of times a J2EE session entry has been successfully found in the cache.
- Type: UInt
- SNMP name: "j2eeSessionCacheHits" | | lookups | Number of times a J2EE session entry has been looked up in the cache.
- Type: UInt
- SNMP name: "j2eeSessionCacheLookups" | | misses | Number of times a J2EE session entry has not been available in the cache.
- Type: UInt
- SNMP name: "j2eeSessionCacheMisses" | | oldest | The age of the oldest J2EE session in the cache (in seconds).
- Type: UInt
- SNMP name: "j2eeSessionCacheOldest" | ### vtm\_listen\_ip\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/listen\_ips/\* Listen ips statistics values. ```bash # 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 | Description | | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | bytes\_in | Bytes sent to this listening IP.
- Type: UInt64
- SNMP name: "listenIPBytesIn" | | bytes\_out | Bytes sent from this listening IP.
- Type: UInt64
- SNMP name: "listenIPBytesOut" | | current\_conn | TCP connections currently established to this listening IP.
- Type: UInt
- SNMP name: "listenIPCurrentConn" | | max\_conn | Maximum number of simultaneous TCP connections this listening IP has processed at any one time.
- Type: UInt
- SNMP name: "listenIPMaxConn" | | total\_requests | Requests sent to this listening IP.
- Type: UInt64
- SNMP name: "listenIPTotalRequests" | ### vtm\_location\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/locations/\* Locations statistics values. ```bash # 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 | Description | | ---------- | ----------------------------------------------------------------------------------------------------------------------------- | | load | The mean load metric for this location.
- Type: UInt
- SNMP name: "locationLoad" | | responses | Number of A records that have been altered to point to this location.
- Type: UInt
- SNMP name: "locationResponses" | ### vtm\_network\_interface\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/network\_interface/\* Network interface statistics values. ```bash # 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 | Description | | ----------- | ----------------------------------------------------------------------------------------------------------------- | | collisions | The number of collisions reported by this interface.
- Type: UInt
- SNMP name: "interfaceCollisions" | | rx\_bytes | Bytes received by this interface.
- Type: UInt64
- SNMP name: "interfaceRxBytes" | | rx\_errors | The number of receive errors reported by this interface.
- Type: UInt
- SNMP name: "interfaceRxErrors" | | rx\_packets | The number of packets received by this interface.
- Type: UInt
- SNMP name: "interfaceRxPackets" | | tx\_bytes | Bytes transmitted by this interface.
- Type: UInt64
- SNMP name: "interfaceTxBytes" | | tx\_errors | The number of transmit errors reported by this interface.
- Type: UInt
- SNMP name: "interfaceTxErrors" | | tx\_packets | The number of packets transmitted by this interface.
- Type: UInt
- SNMP name: "interfaceTxPackets" | ### vtm\_nodes\_node\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/nodes/node/\* Node statistics values. ```bash # 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 | Description | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | bytes\_from\_node\_hi | Bytes received from this node ( high 32bits ).
- Type: UInt
- SNMP name: "nodeBytesFromNodeHi" | | bytes\_from\_node\_lo | Bytes received from this node ( low 32bits ).
- Type: UInt
- SNMP name: "nodeBytesFromNodeLo" | | bytes\_to\_node\_hi | Bytes sent to this node ( high 32bits ).
- Type: UInt
- SNMP name: "nodeBytesToNodeHi" | | bytes\_to\_node\_lo | Bytes sent to this node ( low 32bits ).
- Type: UInt
- SNMP name: "nodeBytesToNodeLo" | | current\_conn | Requests currently established to this node. ( does not include idle keepalives ).
- Type: UInt
- SNMP name: "nodeCurrentConn" | | current\_requests | Connections currently established to this node.
- Type: UInt
- SNMP name: "nodeCurrentRequests" | | errors | Number of timeouts, connection problems and other errors for this node.
- Type: UInt
- SNMP name: "nodeErrors" | | failures | Failures of this node.
- Type: UInt
- SNMP name: "nodeFailures" | | new\_conn | Requests that created a new connection to this node.
- Type: UInt
- SNMP name: "nodeNewConn" | | pooled\_conn | Requests that reused an existing pooled/keepalive connection rather than creating a new TCP connection.
- Type: UInt
- SNMP name: "nodePooledConn" | | port | The port this node listens on.
- Type: UInt
- SNMP name: "nodePort" | | response\_max | Maximum response time (ms) in the last second for this node.
- Type: UInt
- SNMP name: "nodeResponseMax" | | response\_mean | Mean response time (ms) in the last second for this node.
- Type: UInt
- SNMP name: "nodeResponseMean" | | response\_min | Minimum response time (ms) in the last second for this node.
- Type: UInt
- SNMP name: "nodeResponseMin" | | state | The state of this node.
- Type: Enum(String)
- SNMP name: "nodeState"
- Permitted values:
"alive": alive(1)
"dead": dead(2)
"unknown": unknown(3) | | total\_conn | Requests sent to this node.
- Type: UInt
- SNMP name: "nodeTotalConn" | ### vtm\_nodes\_node\_inet46\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/nodes/node\_inet46/\* Node inet46 statistics values. ```bash # 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 | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | bytes\_from\_node | Bytes received from this node.
- Type: UInt64
- SNMP name: "nodeInet46BytesFromNode" | | bytes\_to\_node | Bytes sent to this node.
- Type: UInt64
- SNMP name: "nodeInet46BytesToNode" | | current\_conn | Current connections established to this node, includes idle connections and connections being established.
- Type: UInt
- SNMP name: "nodeInet46CurrentConn" | | current\_requests | Active connections established to this node, does not include idle connections.
- Type: UInt
- SNMP name: "nodeInet46CurrentRequests" | | errors | Number of timeouts, connection problems and other errors for this node.
- Type: UInt
- SNMP name: "nodeInet46Errors" | | failures | Failures of this node.
- Type: UInt
- SNMP name: "nodeInet46Failures" | | idle\_conns | Number of idle HTTP connections to this node.
- Type: UInt
- SNMP name: "nodeInet46IdleConns" | | new\_conn | Requests that created a new connection to this node.
- Type: UInt
- SNMP name: "nodeInet46NewConn" | | pooled\_conn | Requests that reused an existing pooled/keepalive connection rather than creating a new TCP connection.
- Type: UInt
- SNMP name: "nodeInet46PooledConn" | | port | The port this node listens on.
- Type: UInt
- SNMP name: "nodeInet46Port" | | response\_max | Maximum response time (ms) in the last second for this node.
- Type: UInt
- SNMP name: "nodeInet46ResponseMax" | | response\_mean | Mean response time (ms) in the last second for this node.
- Type: UInt
- SNMP name: "nodeInet46ResponseMean" | | response\_min | Minimum response time (ms) in the last second for this node.
- Type: UInt
- SNMP name: "nodeInet46ResponseMin" | | state | The state of this node.
- Type: Enum(String)
- SNMP name: "nodeInet46State"
- Permitted values:
"alive": alive(1)
"dead": dead(2)
"unknown": unknown(3) | | total\_conn | Requests sent to this node.
- Type: UInt
- SNMP name: "nodeInet46TotalConn" | ### vtm\_per\_location\_service\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/per\_location\_service/\* Per location service statistics values. ```bash # 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 | Description | | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | draining | The draining state of this location for this GLB Service.
- Type: Enum(String)
- SNMP name: "perLocationServiceDraining"
- Permitted values:
"draining": draining(1)
"active": active(2) | | frontend\_state | The frontend state of this location for this GLB Service.
- Type: Enum(String)
- SNMP name: "perLocationServiceFrontendState"
- Permitted values:
"alive": alive(1)
"dead": dead(2) | | load | The load metric for this location for this GLB Service.
- Type: UInt
- SNMP name: "perLocationServiceLoad" | | monitor\_state | The monitor state of this location for this GLB Service.
- Type: Enum(String)
- SNMP name: "perLocationServiceMonitorState"
- Permitted values:
"alive": alive(1)
"dead": dead(2) | | responses | Number of A records that have been altered to point to this location for this GLB Service.
- Type: UInt
- SNMP name: "perLocationServiceResponses" | | state | The state of this location for this GLB Service.
- Type: Enum(String)
- SNMP name: "perLocationServiceState"
- Permitted values:
"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. ```bash # 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 | Description | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | node\_port | The port number of this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelNodePort" | | response\_max | Maximum response time (ms) in the last second for this SLM class to this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelResponseMax" | | response\_mean | Mean response time (ms) in the last second for this SLM class to this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelResponseMean" | | response\_min | Minimum response time (ms) in the last second for this SLM class to this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelResponseMin" | | total\_conn | Requests handled by this SLM class to this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelTotalConn" | | total\_non\_conf | Non-conforming requests handled by this SLM class to this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelTotalNonConf" | ### 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. ```bash # 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 | Description | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | node\_port | The port number of this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelInet46NodePort" | | response\_max | Maximum response time (ms) in the last second for this SLM class to this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelInet46ResponseMax" | | response\_mean | Mean response time (ms) in the last second for this SLM class to this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelInet46ResponseMean" | | response\_min | Minimum response time (ms) in the last second for this SLM class to this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelInet46ResponseMin" | | total\_conn | Requests handled by this SLM class to this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelInet46TotalConn" | | total\_non\_conf | Non-conforming requests handled by this SLM class to this node.
- Type: UInt
- SNMP name: "perNodeServiceLevelInet46TotalNonConf" | ### 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. ```bash # 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 | Description | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | bytes\_from\_node | Bytes received from this node.
- Type: UInt64
- SNMP name: "perPoolNodeBytesFromNode" | | bytes\_to\_node | Bytes sent to this node.
- Type: UInt64
- SNMP name: "perPoolNodeBytesToNode" | | current\_conn | Current connections established to a node, includes idle connections and connections being established.
- Type: UInt
- SNMP name: "perPoolNodeCurrentConn" | | current\_requests | Active connections established to this node, does not include idle connections.
- Type: UInt
- SNMP name: "perPoolNodeCurrentRequests" | | errors | Number of timeouts, connection problems and other errors for this node.
- Type: UInt
- SNMP name: "perPoolNodeErrors" | | failures | Failures of this node.
- Type: UInt
- SNMP name: "perPoolNodeFailures" | | idle\_conns | Number of idle HTTP connections to this node.
- Type: UInt
- SNMP name: "perPoolNodeIdleConns" | | new\_conn | Requests that created a new connection to this node.
- Type: UInt
- SNMP name: "perPoolNodeNewConn" | | node\_port | The port that this node listens on.
- Type: UInt
- SNMP name: "perPoolNodeNodePort" | | pooled\_conn | Requests that reused an existing pooled/keepalive connection rather than creating a new TCP connection.
- Type: UInt
- SNMP name: "perPoolNodePooledConn" | | response\_max | Maximum response time (ms) in the last second for this node.
- Type: UInt
- SNMP name: "perPoolNodeResponseMax" | | response\_mean | Mean response time (ms) in the last second for this node.
- Type: UInt
- SNMP name: "perPoolNodeResponseMean" | | response\_min | Minimum response time (ms) in the last second for this node.
- Type: UInt
- SNMP name: "perPoolNodeResponseMin" | | state | The state of this node.
- Type: Enum(String)
- SNMP name: "perPoolNodeState"
- Permitted values:
"alive": alive(1)
"dead": dead(2)
"unknown": unknown(3)
"draining": draining(4)
"drainingtodelete": drainingtodelete(5) | | total\_conn | Requests sent to this node.
- Type: UInt
- SNMP name: "perPoolNodeTotalConn" | ### vtm\_pool\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/pools/\* Pools statistics values. ```bash # 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 | Description | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | algorithm | The load-balancing algorithm the pool uses.
- Type: Enum(String)
- SNMP name: "poolAlgorithm"
- Permitted values:
"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.
- Type: UInt64
- SNMP name: "poolBytesIn" | | bytes\_out | Bytes sent by this pool to nodes.
- Type: UInt64
- SNMP name: "poolBytesOut" | | conns\_queued | Total connections currently queued to this pool.
- Type: UInt
- SNMP name: "poolConnsQueued" | | disabled | The number of nodes in this pool that are disabled.
- Type: UInt
- SNMP name: "poolDisabled" | | draining | The number of nodes in this pool which are draining.
- Type: UInt
- SNMP name: "poolDraining" | | http1xx\_responses | Number of HTTP 1xx responses returned by this pool.
- Type: UInt64
- SNMP name: "poolHTTP1xxResponses" | | http2xx\_responses | Number of HTTP 2xx responses returned by this pool.
- Type: UInt64
- SNMP name: "poolHTTP2xxResponses" | | http3xx\_responses | Number of HTTP 3xx responses returned by this pool.
- Type: UInt64
- SNMP name: "poolHTTP3xxResponses" | | http4xx\_responses | Number of HTTP 4xx responses returned by this pool.
- Type: UInt64
- SNMP name: "poolHTTP4xxResponses" | | http503\_retries | Number of times the pool received an HTTP 503 response from a node and retried it against a different node.
- Type: UInt64
- SNMP name: "poolHTTP503Retries" | | http5xx\_responses | Number of HTTP 5xx responses returned by this pool.
- Type: UInt64
- SNMP name: "poolHTTP5xxResponses" | | max\_queue\_time | Maximum time, measured in milliseconds, for which a connection was queued over the last second.
- Type: UInt
- SNMP name: "poolMaxQueueTime" | | mean\_queue\_time | Mean time, measured in milliseconds, for which a connection was queued over the last second.
- Type: UInt
- SNMP name: "poolMeanQueueTime" | | min\_queue\_time | Minimum time, measured in milliseconds, for which a connection was queued over the last second.
- Type: UInt
- SNMP name: "poolMinQueueTime" | | nodes | The number of nodes registered with this pool.
- Type: UInt
- SNMP name: "poolNodes" | | persistence | The session persistence method this pool uses
- Type: Enum(String)
- SNMP name: "poolPersistence"
- Permitted values:
"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.
- Type: UInt
- SNMP name: "poolQueueTimeouts" | | session\_migrated | Sessions migrated to a new node because the desired node was unavailable.
- Type: UInt
- SNMP name: "poolSessionMigrated" | | state | The state of this pool.
- Type: Enum(String)
- SNMP name: "poolState"
- Permitted values:
"active": active(1)
"disabled": disabled(2)
"draining": draining(3)
"unused": unused(4)
"unknown": unknown(5) | | total\_conn | Requests sent to this pool.
- Type: UInt
- SNMP name: "poolTotalConn" | ### vtm\_rule\_authenticator\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/rule\_authenticators/\* Rule authenticators statistics values. ```bash # 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 | Description | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | errors | Number of connection errors that have occurred when trying to connect to an authentication server.
- Type: UInt
- SNMP name: "authenticatorErrors" | | fails | Number of times this Authenticator has failed to authenticate.
- Type: UInt
- SNMP name: "authenticatorFails" | | passes | Number of times this Authenticator has successfully authenticated.
- Type: UInt
- SNMP name: "authenticatorPasses" | | requests | Number of times this Authenticator has been asked to authenticate.
- Type: UInt
- SNMP name: "authenticatorRequests" | ### vtm\_rule\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/rules/\* Rules statistics values. ```bash # 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 | Description | | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | aborts | Number of times this TrafficScript rule has aborted.
- Type: UInt
- SNMP name: "ruleAborts" | | discards | Number of times this TrafficScript rule has discarded the connection.
- Type: UInt
- SNMP name: "ruleDiscards" | | execution\_time\_warnings | Number of times this TrafficScript rule has exceeded the execution time warning threshold.
- Type: UInt
- SNMP name: "ruleExecutionTimeWarnings" | | executions | Number of times this TrafficScript rule has been executed.
- Type: UInt
- SNMP name: "ruleExecutions" | | pool\_select | Number of times this TrafficScript rule has selected a pool to use.
- Type: UInt
- SNMP name: "rulePoolSelect" | | responds | Number of times this TrafficScript rule has responded directly to the client.
- Type: UInt
- SNMP name: "ruleResponds" | | retries | Number of times this TrafficScript rule has forced the request to be retried.
- Type: UInt
- SNMP name: "ruleRetries" | ### vtm\_service\_level\_monitor\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/service\_level\_monitors/\* Service level monitors statistics values. ```bash # 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 | Description | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | conforming | Percentage of requests associated with this SLM class that are conforming
- Type: UInt
- SNMP name: "serviceLevelConforming" | | current\_conns | The number of connections currently associated with this SLM class.
- Type: UInt
- SNMP name: "serviceLevelCurrentConns" | | is\_o\_k | Indicates if this SLM class is currently conforming.
- Type: Enum(String)
- SNMP name: "serviceLevelIsOK"
- Permitted values:
"notok": notok(1)
"ok": ok(2) | | response\_max | Maximum response time (ms) in the last second for this SLM class.
- Type: UInt
- SNMP name: "serviceLevelResponseMax" | | response\_mean | Mean response time (ms) in the last second for this SLM class.
- Type: UInt
- SNMP name: "serviceLevelResponseMean" | | response\_min | Minimum response time (ms) in the last second for this SLM class.
- Type: UInt
- SNMP name: "serviceLevelResponseMin" | | total\_conn | Requests handled by this SLM class.
- Type: UInt
- SNMP name: "serviceLevelTotalConn" | | total\_non\_conf | Non-conforming requests handled by this SLM class.
- Type: UInt
- SNMP name: "serviceLevelTotalNonConf" | ### vtm\_service\_protection\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/service\_protection/\* Service protection statistics values. ```bash # 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 | 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).
- Type: UInt
- SNMP name: "serviceProtLastRefusalTime" | | refusal\_binary | Connections refused by this service protection class because the request contained disallowed binary content.
- Type: UInt
- SNMP name: "serviceProtRefusalBinary" | | refusal\_conc10\_ip | Connections refused by this service protection class because the top 10 source IP addresses issued too many concurrent connections.
- Type: UInt
- SNMP name: "serviceProtRefusalConc10IP" | | refusal\_conc1\_ip | Connections refused by this service protection class because the source IP address issued too many concurrent connections.
- Type: UInt
- SNMP name: "serviceProtRefusalConc1IP" | | refusal\_conn\_rate | Connections refused by this service protection class because the source IP address issued too many connections within 60 seconds.
- Type: UInt
- SNMP name: "serviceProtRefusalConnRate" | | refusal\_ip | Connections refused by this service protection class because the source IP address was banned.
- Type: UInt
- SNMP name: "serviceProtRefusalIP" | | refusal\_rfc2396 | Connections refused by this service protection class because the HTTP request was not RFC 2396 compliant.
- Type: UInt
- SNMP name: "serviceProtRefusalRFC2396" | | refusal\_size | Connections refused by this service protection class because the request was larger than the defined limits allowed.
- Type: UInt
- SNMP name: "serviceProtRefusalSize" | | total\_refusal | Connections refused by this service protection class.
- Type: UInt
- SNMP name: "serviceProtTotalRefusal" | ### vtm\_cache\_ssl\_cache\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/cache/ssl\_cache Ssl cache statistics values. ```bash # 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 | Description | | ------------ | ------------------------------------------------------------------------------------------------------------------------------- | | entries | The total number of SSL sessions stored in the server cache.
- Type: UInt
- SNMP name: "sslCacheEntries" | | entries\_max | The maximum number of SSL entries in the server cache.
- Type: UInt
- SNMP name: "sslCacheEntriesMax" | | hit\_rate | The percentage of SSL server cache lookups that succeeded.
- Type: UInt
- SNMP name: "sslCacheHitRate" | | hits | Number of times a SSL entry has been successfully found in the server cache.
- Type: UInt
- SNMP name: "sslCacheHits" | | lookups | Number of times a SSL entry has been looked up in the server cache.
- Type: UInt
- SNMP name: "sslCacheLookups" | | misses | Number of times a SSL entry has not been available in the server cache.
- Type: UInt
- SNMP name: "sslCacheMisses" | | oldest | The age of the oldest SSL session in the server cache (in seconds).
- Type: UInt
- SNMP name: "sslCacheOldest" | ### vtm\_ssl\_ocsp\_stapling\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/ssl\_ocsp\_stapling Ssl ocsp stapling statistics values. ```bash # 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 | Description | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | cache\_count | The number of entries in the OCSP stapling cache.
- Type: UInt
- SNMP name: "sslOcspStaplingCacheCount" | | counter | The number of outgoing OCSP requests for OCSP stapling.
- Type: UInt
- SNMP name: "sslOcspStaplingCount" | | failure\_count | The number of failed outgoing OCSP requests for OCSP stapling.
- Type: UInt
- SNMP name: "sslOcspStaplingFailureCount" | | good\_count | The number of 'good' OCSP responses for OCSP stapling.
- Type: UInt
- SNMP name: "sslOcspStaplingGoodCount" | | revoked\_count | The number of 'revoked' OCSP responses for OCSP stapling.
- Type: UInt
- SNMP name: "sslOcspStaplingRevokedCount" | | success\_count | The number of successful outgoing OCSP requests for OCSP stapling.
- Type: UInt
- SNMP name: "sslOcspStaplingSuccessCount" | | unknown\_count | The number of 'unknown' OCSP requests for OCSP stapling.
- Type: UInt
- SNMP name: "sslOcspStaplingUnknownCount" | ### 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. ```bash # 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 | Description | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | | entries | The total number of SSL session persistence entries stored in the cache.
- Type: UInt
- SNMP name: "sslSessionCacheEntries" | | entries\_max | The maximum number of SSL session persistence entries in the cache.
- Type: UInt
- SNMP name: "sslSessionCacheEntriesMax" | | hit\_rate | The percentage of SSL session persistence lookups that succeeded.
- Type: UInt
- SNMP name: "sslSessionCacheHitRate" | | hits | Number of times a SSL session persistence entry has been successfully found in the cache.
- Type: UInt
- SNMP name: "sslSessionCacheHits" | | lookups | Number of times a SSL session persistence entry has been looked up in the cache.
- Type: UInt
- SNMP name: "sslSessionCacheLookups" | | misses | Number of times a SSL session persistence entry has not been available in the cache.
- Type: UInt
- SNMP name: "sslSessionCacheMisses" | | oldest | The age of the oldest SSL session in the cache (in seconds).
- Type: UInt
- SNMP name: "sslSessionCacheOldest" | ### vtm\_traffic\_ips\_traffic\_ip\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/traffic\_ips/traffic\_ip/\* Traffic ip statistics values. ```bash # 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 | Description | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | state | Whether this traffic IP address is currently being hosted by this traffic manager.
- Type: Enum(String)
- SNMP name: "trafficIPState"
- Permitted values:
"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).
- Type: UInt
- SNMP name: "trafficIPTime" | ### 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. ```bash # 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 | Description | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | state | Whether this traffic IP address is currently being hosted by this traffic manager.
- Type: Enum(String)
- SNMP name: "trafficIPInet46State"
- Permitted values:
"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).
- Type: UInt
- SNMP name: "trafficIPInet46Time" | ### 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. ```bash # 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 | Description | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | | entries | The total number of universal sessions stored in the cache.
- Type: UInt
- SNMP name: "uniSessionCacheEntries" | | entries\_max | The maximum number of universal sessions in the cache.
- Type: UInt
- SNMP name: "uniSessionCacheEntriesMax" | | expiries | Number of times an expired universal session entry has been dropped on lookup.
- Type: UInt
- SNMP name: "uniSessionCacheExpiries" | | hit\_rate | The percentage of universal session lookups that succeeded.
- Type: UInt
- SNMP name: "uniSessionCacheHitRate" | | hits | Number of times a universal session entry has been successfully found in the cache.
- Type: UInt
- SNMP name: "uniSessionCacheHits" | | lookups | Number of times a universal session entry has been looked up in the cache.
- Type: UInt
- SNMP name: "uniSessionCacheLookups" | | misses | Number of times a universal session entry has not been available in the cache.
- Type: UInt
- SNMP name: "uniSessionCacheMisses" | | oldest | The age of the oldest universal session in the cache (in seconds).
- Type: UInt
- SNMP name: "uniSessionCacheOldest" | ### 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. ```bash # 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 | Description | | ---------- | ------------------------------------------------------------------------------------- | | counter | The value of the user counter.
- Type: UInt
- SNMP name: "userCounterValue" | ### 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. ```bash # 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 | Description | | ---------- | ------------------------------------------------------------------------------------------------ | | counter | The value of the 64-bit user counter.
- Type: UInt64
- SNMP name: "userCounter64Value" | ### vtm\_virtual\_server\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/virtual\_servers/\* Virtual servers statistics values. ```bash # 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 | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | auth\_saml\_redirects | Number of times a user agent was redirected to SAML Identity Provider.
- Type: UInt64
- SNMP name: "virtualserverAuthSamlRedirects" | | auth\_saml\_responses | Number of times a SAML Response was processed.
- Type: UInt64
- SNMP name: "virtualserverAuthSamlResponses" | | auth\_saml\_responses\_accepted | Number of times a SAML Response was accepted.
- Type: UInt64
- SNMP name: "virtualserverAuthSamlResponsesAccepted" | | auth\_saml\_responses\_rejected | Number of times a SAML Response was rejected.
- Type: UInt64
- SNMP name: "virtualserverAuthSamlResponsesRejected" | | auth\_sessions\_created | Number of times an authentication session was created.
- Type: UInt64
- SNMP name: "virtualserverAuthSessionsCreated" | | auth\_sessions\_rejected | Number of times an authentication session was rejected.
- Type: UInt64
- SNMP name: "virtualserverAuthSessionsRejected" | | auth\_sessions\_used | Number of times an authentication session was used.
- Type: UInt64
- SNMP name: "virtualserverAuthSessionsUsed" | | bytes\_in | Bytes received by this virtual server from clients.
- Type: UInt64
- SNMP name: "virtualserverBytesIn" | | bytes\_out | Bytes sent by this virtual server to clients.
- Type: UInt64
- SNMP name: "virtualserverBytesOut" | | cert\_status\_requests | Number of incoming TLS handshakes for this virtual server with certificate status requests.
- Type: UInt
- SNMP name: "virtualserverCertStatusRequests" | | cert\_status\_responses | Number of incoming TLS handshakes for this virtual server to which certificate status responses were attached.
- Type: UInt
- SNMP name: "virtualserverCertStatusResponses" | | connect\_timed\_out | Connections closed by this virtual server because the 'connect\_timeout' interval was exceeded.
- Type: UInt
- SNMP name: "virtualserverConnectTimedOut" | | connection\_errors | Number of transaction or protocol errors in this virtual server.
- Type: UInt
- SNMP name: "virtualserverConnectionErrors" | | connection\_failures | Number of connection failures in this virtual server.
- Type: UInt
- SNMP name: "virtualserverConnectionFailures" | | current\_conn | TCP connections currently established to this virtual server.
- Type: UInt
- SNMP name: "virtualserverCurrentConn" | | data\_timed\_out | Connections closed by this virtual server because the 'timeout' interval was exceeded.
- Type: UInt
- SNMP name: "virtualserverDataTimedOut" | | direct\_replies | Direct replies from this virtual server, without forwarding to a node.
- Type: UInt
- SNMP name: "virtualserverDirectReplies" | | discard | Connections discarded by this virtual server.
- Type: UInt
- SNMP name: "virtualserverDiscard" | | gzip | Responses which have been compressed by content compression.
- Type: UInt
- SNMP name: "virtualserverGzip" | | gzip\_bytes\_saved | Bytes of network traffic saved by content compression.
- Type: UInt64
- SNMP name: "virtualserverGzipBytesSaved" | | http1xx\_responses | Number of HTTP 1xx responses returned by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTP1xxResponses" | | http2xx\_responses | Number of HTTP 2xx responses returned by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTP2xxResponses" | | http3xx\_responses | Number of HTTP 3xx responses returned by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTP3xxResponses" | | http4xx\_responses | Number of HTTP 4xx responses returned by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTP4xxResponses" | | http5xx\_responses | Number of HTTP 5xx responses returned by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTP5xxResponses" | | http\_cache2xx\_responses | Number of HTTP 2xx responses returned from webcache by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPCache2xxResponses" | | http\_cache3xx\_responses | Number of HTTP 3xx responses returned from webcache by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPCache3xxResponses" | | http\_cache4xx\_responses | Number of HTTP 4xx responses returned from webcache by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPCache4xxResponses" | | http\_cache5xx\_responses | Number of HTTP 5xx responses returned from webcache by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPCache5xxResponses" | | http\_cache\_hit\_rate | Percentage hit rate of the web cache for this virtual server.
- Type: UInt
- SNMP name: "virtualserverHttpCacheHitRate" | | http\_cache\_hits | HTTP responses sent directly from the web cache by this virtual server.
- Type: UInt
- SNMP name: "virtualserverHttpCacheHits" | | http\_cache\_lookups | HTTP requests that are looked up in the web cache by this virtual server.
- Type: UInt
- SNMP name: "virtualserverHttpCacheLookups" | | http\_generated2xx\_responses | Number of HTTP 2xx responses generated by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPGenerated2xxResponses" | | http\_generated3xx\_responses | Number of HTTP 3xx responses generated by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPGenerated3xxResponses" | | http\_generated4xx\_responses | Number of HTTP 4xx responses generated by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPGenerated4xxResponses" | | http\_generated5xx\_responses | Number of HTTP 5xx responses generated by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPGenerated5xxResponses" | | http\_rewrite\_cookie | HTTP Set-Cookie headers, supplied by a node, that have been rewritten.
- Type: UInt
- SNMP name: "virtualserverHttpRewriteCookie" | | http\_rewrite\_location | HTTP Location headers, supplied by a node, that have been rewritten.
- Type: UInt
- SNMP name: "virtualserverHttpRewriteLocation" | | http\_server1xx\_responses | Number of HTTP 1xx responses returned from a backend server or TrafficScript rule by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPServer1xxResponses" | | http\_server2xx\_responses | Number of HTTP 2xx responses returned from a backend server or TrafficScript rule by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPServer2xxResponses" | | http\_server3xx\_responses | Number of HTTP 3xx responses returned from a backend server or TrafficScript rule by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPServer3xxResponses" | | http\_server4xx\_responses | Number of HTTP 4xx responses returned from a backend server or TrafficScript rule by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPServer4xxResponses" | | http\_server5xx\_responses | Number of HTTP 5xx responses returned from a backend server or TrafficScript rule by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverHTTPServer5xxResponses" | | keepalive\_timed\_out | Connections closed by this virtual server because the 'keepalive\_timeout' interval was exceeded.
- Type: UInt
- SNMP name: "virtualserverKeepaliveTimedOut" | | max\_conn | Maximum number of simultaneous TCP connections this virtual server has processed at any one time.
- Type: UInt
- SNMP name: "virtualserverMaxConn" | | max\_duration\_timed\_out | Connections closed by this virtual server because the 'max\_transaction\_duration' interval was exceeded.
- Type: UInt
- SNMP name: "virtualserverMaxDurationTimedOut" | | port | The port the virtual server listens on.
- Type: UInt
- SNMP name: "virtualserverPort" | | processing\_timed\_out | Connections closed by this virtual server because the 'timeout' interval was exceeded while waiting for rules or external processing.
- Type: UInt
- SNMP name: "virtualserverProcessingTimedOut" | | protocol | The protocol the virtual server is operating.
- Type: Enum(String)
- SNMP name: "virtualserverProtocol"
- Permitted values:
"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.
- Type: UInt
- SNMP name: "virtualserverSIPRejectedRequests" | | sip\_total\_calls | Total number of SIP INVITE requests seen by this virtual server.
- Type: UInt
- SNMP name: "virtualserverSIPTotalCalls" | | ssl\_cache\_lookup | Number of times a lookup for an existing SSL session was performed.
- Type: UInt64
- SNMP name: "virtualserverSslCacheLookup" | | ssl\_cache\_miss | Number of times a lookup failed to find an existing SSL session.
- Type: UInt64
- SNMP name: "virtualserverSslCacheMiss" | | ssl\_cache\_rejected | Number of times an SSL session was found in the cache but rejected and not resumed.
- Type: UInt64
- SNMP name: "virtualserverSslCacheRejected" | | ssl\_cache\_resumed | Number of times an SSL session was resumed from the cache.
- Type: UInt64
- SNMP name: "virtualserverSslCacheResumed" | | ssl\_cache\_saved | Number of times an SSL session was saved to the cache.
- Type: UInt64
- SNMP name: "virtualserverSslCacheSaved" | | ssl\_hello\_retry\_requested | Number of times a HelloRetryRequest message was sent to TLS clients.
- Type: UInt64
- SNMP name: "virtualserverSslHelloRetryRequested" | | ssl\_new\_session | Number of times a new SSL session was created.
- Type: UInt64
- SNMP name: "virtualserverSslNewSession" | | ssl\_ticket\_expired | Number of SSL session tickets that were rejected because they had expired.
- Type: UInt64
- SNMP name: "virtualserverSslTicketExpired" | | ssl\_ticket\_issued | Number of SSL session tickets that were issued to clients.
- Type: UInt64
- SNMP name: "virtualserverSslTicketIssued" | | 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.
- Type: UInt64
- SNMP name: "virtualserverSslTicketKeyNotFound" | | ssl\_ticket\_received | Number of SSL session tickets received.
- Type: UInt64
- SNMP name: "virtualserverSslTicketReceived" | | ssl\_ticket\_rejected | Number of SSL session tickets that were rejected for a reason other than because they had expired.
- Type: UInt64
- SNMP name: "virtualserverSslTicketRejected" | | ssl\_ticket\_resumed | Number of SSL session tickets that were successfully used to resume a session.
- Type: UInt64
- SNMP name: "virtualserverSslTicketResumed" | | total\_dgram | UDP datagrams processed by this virtual server.
- Type: UInt
- SNMP name: "virtualserverTotalDgram" | | total\_http1\_requests | HTTP/1.x Requests received by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverTotalHTTP1Requests" | | total\_http2\_requests | HTTP/2 Requests received by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverTotalHTTP2Requests" | | total\_http\_requests | HTTP Requests received by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverTotalHTTPRequests" | | total\_requests | Requests received by this virtual server.
- Type: UInt64
- SNMP name: "virtualserverTotalRequests" | | udp\_bytes\_in\_dropped | UDP bytes received by this virtual server from clients but failed to be sent to backend servers.
- Type: UInt64
- SNMP name: "virtualserverUDPBytesInDropped" | | udp\_bytes\_out\_dropped | UDP bytes received by this virtual server from backend servers but failed to be sent to clients.
- Type: UInt64
- SNMP name: "virtualserverUDPBytesOutDropped" | | udp\_timed\_out | Connections closed by this virtual server because the 'udp\_timeout' interval was exceeded.
- Type: UInt
- SNMP name: "virtualserverUdpTimedOut" | ### vtm\_cache\_web\_cache\_stats URI Endpoint: /api/tm/8.3/status/local\_tm/statistics/cache/web\_cache Web cache statistics values. ```bash # 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 | Description | | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | | entries | The number of items in the web cache.
- Type: UInt
- SNMP name: "webCacheEntries" | | hit\_rate | The percentage of web cache lookups that succeeded.
- Type: UInt
- SNMP name: "webCacheHitRate" | | hits | Number of times a page has been successfully found in the web cache.
- Type: UInt64
- SNMP name: "webCacheHits" | | lookups | Number of times a page has been looked up in the web cache.
- Type: UInt64
- SNMP name: "webCacheLookups" | | max\_entries | The maximum number of items in the web cache.
- Type: UInt
- SNMP name: "webCacheMaxEntries" | | mem\_maximum | The maximum amount of memory the web cache can use in kilobytes.
- Type: UInt
- SNMP name: "webCacheMemMaximum" | | mem\_used | Total memory used by the web cache in kilobytes.
- Type: UInt
- SNMP name: "webCacheMemUsed" | | misses | Number of times a page has not been found in the web cache.
- Type: UInt64
- SNMP name: "webCacheMisses" | | oldest | The age of the oldest item in the web cache (in seconds).
- Type: UInt
- SNMP name: "webCacheOldest" | | url\_store\_allocated | Amount of allocated space in the web cache URL store.
- Type: UInt64
- SNMP name: "webCacheURLStoreAllocated" | | url\_store\_free | Amount of free space in the web cache URL store.
- Type: UInt64
- SNMP name: "webCacheURLStoreFree" | | url\_store\_size | Total amount of space in the web cache URL store.
- Type: UInt64
- SNMP name: "webCacheURLStoreSize" | | url\_store\_total\_allocations | Total number of allocations for the web cache URL store.
- Type: UInt64
- SNMP name: "webCacheURLStoreTotalAllocations" | | url\_store\_total\_failures | Total number of allocation failures for the web cache URL store.
- Type: UInt64
- SNMP name: "webCacheURLStoreTotalFailures" | | url\_store\_total\_frees | Total number of blocks freed in the web cache URL store.
- Type: UInt64
- SNMP name: "webCacheURLStoreTotalFrees" | ### System Information System information data sources allow Terraform to access information about the current state of a Traffic Manager, including errors and service statuses. ```bash data "vtm_state" "state_information" {} ``` ### vtm\_backups\_full URI Endpoint: /api/tm/8.3/status/local\_tm/backups/full/\* Full backups. ```bash # 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.}" ``` | Property | Description | | ------------------- | ---------------------------------------------------------------------------- | | name | Name of the object
- Type: string
- Required: true | | backup\_description | Description of the backup
- Type: String | | backup\_time\_stamp | Time the backup was created. Expressed as a UTC value.
- Type: Int | | backup\_version | Version of the traffic manager used to create the backup
- Type: String | ### vtm\_information URI Endpoint: /api/tm/8.3/status/local\_tm/information Static information for the system. ```bash # Example usage of vtm_information data source... data "vtm_information" "my_information" {} # Access with... "${data.vtm_information.my_information.}" ``` | Property | Description | | ------------------------ | --------------------------------------------------------------------------------------------- | | information\_platform | The type of platform on which the Traffic Manager instance is running on.
- Type: String | | information\_tm\_version | Version number of the Traffic Manager instance.
- Type: String | | information\_uuid | The universally unique identifier for the Traffic Manager instance.
- Type: String | ### vtm\_state URI Endpoint: /api/tm/8.3/status/local\_tm/state State information for the traffic manager. ```bash # Example usage of vtm_state data source... data "vtm_state" "my_state" {} # Access with... "${data.vtm_state.my_state.}" ``` | Property | Description | | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | state\_error\_level | The error\_level of the traffic manager.
- Type: Enum(String)
- Permitted values:
"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
- Type: Set(String) | | state\_failed\_nodes | A table of nodes which have failed on the traffic manager
- Type: Table
- Required: false
- Primary key:
- node (String): A node which has failed (Required)
- Sub keys:
- pools (Set(String)): List of pools which use this node. | | 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.
- Type: String
- Required: false
- Default value: \ | | state\_license | Current active license or Community\_Edition
- Type: String | | state\_pools |
- Type: Table
- Required: false
- Primary key:
- name (String): Name of the pool (Required)
- Sub keys:
- failure\_pool (String): Failure pool associated with this pool.
- active\_nodes (Set(String)): List of nodes which are in the active state.
- draining\_nodes (Set(String)): List of nodes which are in the draining state.
- disabled\_nodes (Set(String)): List of nodes which are in the disabled state. | | 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.
- Type: String
- Required: false
- Default value: \ | | state\_tip\_errors | List of traffic IP errors for the traffic manager
- Type: Set(String) | | state\_virtual\_servers | A table of virtual server status
- Type: Table
- Required: false
- Primary key:
- name (String): Name of the virtual server (Required)
- Sub keys:
- pool (String): Pool associated with this virtual server.
- port (UInt): Port the virtual server listens on.
- throughput (UInt64): Through put for the virtual server.
- ts\_redirect\_pools (Set(String)): List of pools which may be selected by Traffic Script Request Rules. | | 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.
- Type: String
- Required: false
- Default value: \ | ### 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: ```bash 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 "\\_\\_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 “\\_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: ```bash # 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