APIRef_tm_gtm_server

mgmt/tm/gtm/server

/tm/gtm

GTM server configuration

REST Endpoints

Collection URI
/mgmt/tm/gtm/server
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/gtm/server/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, subPath

Properties

Name Type Default Value Required Access Description
appService string   optional read/write The application service that the object belongs to.
datacenter string   optional read/write Specifies the data center to which the server belongs.
description string   optional read/write User defined description.
disabled boolean true optional read/write Disables the server.
enabled boolean true optional read/write Enables the server.
exposeRouteDomains string no optional read/write Allow the GTM server to auto-discover LTM virtual servers from all route domains.
iqAllowPath string yes optional read/write Specifies whether this BIG-IP will be used to conduct a path probe before traffic will be delegated to it. The default value is enabled.
iqAllowServiceCheck string yes optional read/write Specifies whether this BIG-IP system is used to conduct a service check probe before traffic will be delegated to it. The default value is enabled.
iqAllowSnmp string yes optional read/write Specifies whether this BIG-IP system will be used to conduct an SNMP probe before traffic is delegated to it. The default value is enabled.
limitCpuUsage uint64   optional read/write For a server configured as a generic host, specifies the percent of CPU usage, otherwise has no effect. If percent of CPU usage goes above the limit, the server is marked as unavailable.
limitCpuUsageStatus string disabled optional read/write Enables or disables the limit-cpu-usage option for this server. Only used on a server configured as a generic host. The default value is disabled.
limitMaxBps uint64   optional read/write Specifies the maximum allowable data throughput rate, in bits per second, for this server. If the network traffic volume exceeds this limit, the system marks the server as unavailable.
limitMaxBpsStatus string disabled optional read/write Enables or disables the limit-max-bps option for this server. The default value is disabled.
limitMaxConnections uint64   optional read/write Specifies the maximum number of concurrent connections, combined, for all of the virtual servers on this server. If the connections exceed this limit, the system marks the server as unavailable.
limitMaxConnectionsStatus string disabled optional read/write Enables or disables the limit-max-connections option for this server. The default value is disabled.
limitMaxPps uint64   optional read/write Specifies the maximum allowable data transfer rate, in packets per second, for this server. If the network traffic volume exceeds this limit, the system marks the server as unavailable.
limitMaxPpsStatus string disabled optional read/write Enables or disables the limit-max-pps option for this server. The default value is disabled.
limitMemAvail uint64   optional read/write For a server configured as a generic host, specifies the available memory required by the virtual servers on the server. If available memory falls below this limit, the server is marked as unavailable.
limitMemAvailStatus string disabled optional read/write Enables or disables the limit-mem-avail option for this server. Only used on a server configured as a generic host. The default value is disabled.
linkDiscovery string disabled optional read/write Specifies whether the system auto-discovers the links for this server. The default value is disabled.
monitor string   optional read/write Specifies the health monitors that the system uses to determine whether this server is available for load balancing.
proberFallback string inherit optional read/write  
proberPool string   optional read/write Optional prober pool used to monitor the server’s virtual servers.
proberPreference string inherit optional read/write  
product string single-bigip optional read/write Specifies the server type. The server type determines the metrics that the system can collect from the server. Server types ‘redundant-bigip’ and ‘standalone-bigip’ have been deprecated in favor of ‘bigip’.
virtualServerDiscovery string disabled optional read/write Specifies whether the system auto-discovers the virtual servers for this server. The default value is disabled.

Subcollections

Name Type Default Value Required Access Description
devices array_structure   optional read/write GTM device configuration
virtual-servers array_structure   optional read/write GTM virtual server configuration

Array Structures

Name Type Default Value Required Access Description
/addresses array_structure   optional read/write  
/addresses/app-service string   optional read/write  
/addresses/description string   optional read/write  
/addresses/device-name string   optional read/write  
/addresses/explicit-link-name string   optional read/write  
/addresses/translation string   optional read/write  
/metadata array_structure   optional read/write User defined generic data for the server. It is a name and value pair.
/metadata/app-service string   optional read/write The application service that the object belongs to.
/metadata/persist string true optional read/write Specifies whether the command “tmsh save sys config” will save the metadata entry to the configuration files.
/metadata/value string   optional read/write Value of the server metadata
iControl Reference Index
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.