GSLB_Server (object)

Declares a GSLB server object which contains configuration for a load balancer or a host server

Properties (* = required):

name type(s) default allowed values description
bpsLimit integer 0 0 - ∞ Specifies the maximum allowable data throughput rate, in bits per second, for the virtual servers on the server. If the network traffic volume exceeds this limit, the system marks the server as unavailable
bpsLimitEnabled boolean false true, false Enables or disables the maximum Bits Per Second (BPS) option for the virtual servers on the server. The default value is false (disabled)
class* string   “GSLB_Server”  
connectionsLimit integer 0 0 - ∞ The number of current connections allowed for the virtual servers on the server. If the current connections exceed this value, the system marks the server as unavailable
connectionsLimitEnabled boolean false true, false Enables or disables the maximum current connections option for the virtual servers on the server. The default value is false (disabled)
cpuUsageLimit integer   0 - ∞ Specifies the percent of CPU usage. If percent of CPU usage goes above the limit, the system marks the server as unavailable
cpuUsageLimitEnabled boolean   true, false Enables or disables the CPU Usage limit option for this pool. The default value is false (disabled)
dataCenter* object     Reference to a GSLB data center
devices* array     Specifies the actual device(s) that are represented by this server object
enabled boolean true true, false Specifies whether the server is enabled or disabled
exposeRouteDomainsEnabled boolean false true, false Allows virtual servers from all route domains to be auto-discovered. The default setting is false
label string   “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
memoryLimit integer   0 - ∞ Specifies the available memory in kilobytes required by the virtual servers on the server. If available memory falls below this limit, the system marks the server as unavailable
memoryLimitEnabled boolean   true, false Enables or disables the maximum Bits Per Second (BPS) option for this pool. The default value is false (disabled)
monitors array {“bigip”:”/Common/bigip”}   Specifies the health monitors that the system uses to determine whether it can use this server for load balancing
pathProbeEnabled boolean   true, false Specifies whether this BIG-IP device will be used to conduct a path probe before traffic will be delegated to it. The default value is (true) enabled
ppsLimit integer 0 0 - ∞ The maximum allowable data transfer rate, in packets per second, for the virtual servers on the server. If the network traffic volume exceeds this value, the system marks the server as unavailable
ppsLimitEnabled boolean false true, false Enables or disables the maximum Packets Per Second (PPS) option for the virtual servers on the server. The default value is false (disabled)
proberFallback string “inherit” “inherit”, “any-available”, “inside-datacenter”, “none”, “outside-datacenter”, “pool” Specifies the type of prober to use to monitor servers defined in this data center when the preferred type is not available. The default value is any-available
proberPool object     Reference to a GSLB pool
proberPreferred string “inherit” “inherit”, “inside-datacenter”, “outside-datacenter”, “pool” Specifies the type of prober to use to monitor servers defined in this data center. The default value is inside-data-center. Note: Prober pools are not used by the bigip monitor
remark string   “^[^x00-x1fx22x5cx7f]*$” Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
serverType string “bigip” “bigip”, “generic-host” Specifies the server type. The server type determines the metrics that the system can collect from the server
serviceCheckProbeEnabled boolean   true, false Specifies whether this BIG-IP device will be used to conduct a service check probe before traffic will be delegated to it. The default value is (true) enabled
snmpProbeEnabled boolean   true, false Specifies whether this BIG-IP device will be used to conduct a SNMP probe before traffic will be delegated to it. The default value is (true) enabled
virtualServerDiscoveryMode string “disabled” “disabled”, “enabled”, “enabled-no-delete” Specifies virtual server auto-discovery settings. Use ‘enabled’ (add, modify, delete), ‘enabled-no-delete’ (add, modify) or the default ‘disabled’ (manual configuration)
virtualServers array     Specifies the virtual server(s) that are resources on this server object

GSLB_Server.dataCenter (object)

Reference to a GSLB data center

Properties (* = required):

name type(s) default allowed values description
bigip string   “f5bigip” formatted string Pathname of existing BIG-IP GSLB data center
use string     AS3 pointer to GSLB data center declaration

GSLB_Server.proberPool (object)

Reference to a GSLB pool

Properties (* = required):

name type(s) default allowed values description
bigip string   “f5bigip” formatted string Pathname of existing BIG-IP GSLB pool
use string     AS3 pointer to GSLB pool declaration

GSLB_Server_Device (object)

Configures a device for the GSLB Server

Properties (* = required):

name type(s) default allowed values description
/*/        
address* string   “f5ip” formatted string Specifies an external (public) address for the device. If BIG-IP DNS configuration synchronization is enabled and all existing addresses for a device are being replaced, new addresses should be added and synchronized before old addresses are removed, otherwise the changes may fail to synchronize. Alternatively, the address configuration changes can be performed on each BIG-IP DNS system
addressTranslation string   “f5ip” formatted string Specifies the internal (private) address that corresponds to the external address
label string   “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
remark string   “^[^x00-x1fx22x5cx7f]*$” Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks

GSLB_Virtual_Server (object)

GSLB virtual server

Properties (* = required):

name type(s) default allowed values description
address* string   “f5ip” formatted string Format of address for virtual server (such as IPv4)
addressTranslation string   “f5ip” formatted string Specifies the public address that this virtual server translates into when the GSLB provider communicates between the network and the Internet. The default value is disabled
addressTranslationPort integer 0 0 - 65535 L4 port for service (like 443 for HTTPS)
enabled boolean true true, false Specifies whether the virtual server is enabled or disabled
label string   “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
monitors array     Specifies the health monitors that the system uses to determine whether it can use this linked virtual server for load balancing
name string     Specifies the name of the Virtual Server
port* integer   0 - 65535 L4 port for service (like 443 for HTTPS)
remark string   “^[^x00-x1fx22x5cx7f]*$” Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks