gtm server
gtm server(1) BIG-IP TMSH Manual gtm server(1)
NAME
server - Configures servers for the Global Traffic Manager(tm).
MODULE
gtm
SYNTAX
Configure the server component within the gtm module using the syntax
shown in the following sections.
CREATE/MODIFY
create server [name]
modify server [name]
options:
app-service [[string] | none]
datacenter [name]
description [string]
devices
[add | delete | modify | replace-all-with] {
[name] {
addresses
[add | delete | modify | replace-all-with] {
[ip address] {
options:
app-service [[string] | none]
description [string]
explicit-link-name [none | [name] ]
translation [ip address]
}
}
app-service [[string] | none]
description [string]
}
app-service [[string] | none]
description [string]
}
[disabled | enabled]
expose-route-domains [no | yes]
iq-allow-path [no | yes]
iq-allow-service-check [no | yes]
iq-allow-snmp [no | yes]
iquery-cipher-list [string]
iquery-minimum-tls-version [string]
limit-cpu-usage [integer]
limit-cpu-usage-status [disabled | enabled]
limit-mem-avail [integer]
limit-mem-avail-status [disabled | enabled]
limit-max-bps [integer]
limit-max-bps-status [disabled | enabled]
limit-max-connections [integer]
limit-max-connections-status [disabled | enabled]
limit-max-pps [integer]
limit-max-pps-status [disabled | enabled]
link-discovery [disabled | enabled]
metadata
[add | delete | modify] {
[metadata_name ... ] {
value [ "value content" ]
persist [true | false]
}
}
monitor [none | [name] [and [name] ]... ]
monitor min [integer] of { [name]... }
monitor require [integer] from [integer] { [name] }
prober-fallback [ inherit | any-available | inside-datacenter | outside-datacenter | pool | none ]
prober-pool [none | name]
prober-preference [ inherit | inside-datacenter | outside-datacenter | pool ]
product [name]
virtual-server-discovery [disabled | enabled]
virtual-servers none
virtual-servers
[add | delete | replace-all-with] {
[vs-name] {
options:
app-service [[string] | none]
depends-on none
depends-on
[add | delete | replace-all-with] {
[server_name:vs-name]...
}
description [string]
destination [ipv4_address:port | ipv6_address.port]
[disabled | enabled]
explicit-link-name [none | [name] ]
limit-max-bps [integer]
limit-max-bps-status [disabled | enabled]
limit-max-connections [integer]
limit-max-connections-status [disabled | enabled]
limit-max-pps [integer]
limit-max-pps-status [disabled | enabled]
ltm-name [name]
monitor [none | [name] [and [name] ]... ]
monitor min [integer] of { [name]... }
monitor require [integer] from [integer] { [name] }
translation-address [ip address]
translation-port [ [integer] | [name] ]
}
}
edit server [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
reset-stats server
reset-stats server [ [ [name] | [glob] | [regex] ] ... ]
DISPLAY
list server
list server [ [ [name] | [glob] | [regex] ] ... ]
show running-config server
show running-config server [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
partition
show server
show server [ [ [name] | [glob] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
detail
field-fmt
DELETE
delete server [name]
DESCRIPTION
You can use the server component to configure a Global Traffic Manager
server.
EXAMPLES
create server my_server devices add { my_device { addresses add {
10.10.1.1 } } } datacenter my_datacenter
Creates a server named my_server in my_datacenter with a self IP
address of 10.10.1.1.
modify server my_server virtual-servers add {myVs { address
10.10.10.2:80 } }
Adds the virtual server myVs with an IP address of 10.10.10.2:80 as a
resource to the server named my_server.
list server non-default-properties
Displays all non-default properties for all servers.
delete server my_server
Deletes the server named my_server.
show server my_server detail
Shows the link associated with each server IP address for
my_server.
show server all detail
Shows the link assignments for all servers in the system.
show server my_server virtual-servers
Shows the regular server information as well as any virtuals on
my_server. The link associated with a virtual server is displayed,
or --- is shown to indicate that the virtual is not using a
configured link.
OPTIONS
app-service
Specifies the name of the application service to which the server
belongs. The default value is none. Note: If the strict-updates
option is enabled on the application service that owns the object,
you cannot modify or delete the server. Only the application
service can modify or delete the server.
datacenter
Specifies the data center to which the server belongs. This option
is required for the command create.
description
User defined description.
detail
The detail option is used with the show display command. This
shows device statistics, virtual server statistics, and links
associated with the server. Only the device addresses that have an
associated link are displayed. If this server is not using any
links, no link assignment information is printed. By default,
links are automatically matched to device addresses according to
the smallest subnet match. Explicit links may also be defined. How
this link was assigned is displayed in the Link Assignment column:
auto means that the system automatically assigned this link, and
explicit means that the link was explicitly set by the user.
devices
Specifies the names of the devices that represent this server.
Every device must have at least one address. The options are:
addresses
Specifies the IP addresses that represent the device. If GTM
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 GTM. The options are:
app-service
Specifies the name of the application service to which
the address belongs. The default value is none. Note: If
the strict-updates option is enabled on the application
service that owns the object, you cannot modify or
delete the address. Only the application service can
modify or delete the address.
description
User defined description.
explicit-link-name
Specifies the explicit link name for the device. The
default value is none.
translation
Specifies the internal IP address that corresponds to
the external IP address of this device. The default
value is ::.
app-service
Specifies the name of the application service to which the
device belongs. The default value is none. Note: If the
strict-updates option is enabled on the application service
that owns the object, you cannot modify or delete the device.
Only the application service can modify or delete the device.
description
User defined description.
[disabled | enabled]
Enables or disables the server. The default value is enabled.
expose-route-domains
Allow the GTM server to auto-discover LTM virtual servers from all
route domains. The default value is no.
glob Displays the items that match the glob expression. See help glob
for a description of glob expression syntax.
iq-allow-path
Specifies whether the Global Traffic Manager uses this BIG-IP(r)
system to conduct a path probe before delegating traffic to it.
The default value is yes.
iq-allow-service-check
Specifies whether the Global Traffic Manager uses this BIG-IP
system to conduct a service check probe before delegating traffic
to it. The default value is yes.
iq-allow-snmp
Specifies whether the Global Traffic Manager uses this BIG-IP
system to conduct an SNMP probe before delegating traffic to it.
The default value is yes.
iquery-cipher-list
This is a ":" separated list of cipher specifications as accepted
by the "openssl ciphers" command. OpenSSL will use the cipher list
to negotiate a mutually acceptable cipher with the server during
iQuery connection setup. Setting this value on the server will
override the value inherited from the global settings.
iquery-minimum-tls-version
This is a string to specify the minimum TLS version that will be
offered by the client (GTM) during iQuery connection negotiation.
Setting this value on the server will override the value inherited
from the global settings.
limit-cpu-usage
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 system marks the server as unavailable.
limit-cpu-usage-status
Enables or disables the limit-cpu-usage option for this server.
Only has an effect on a server configured as a generic host. The
default value is disabled.
limit-mem-avail
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 system marks the server as
unavailable.
limit-mem-avail-status
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.
limit-max-bps
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.
limit-max-bps-status
Enables or disables the limit-max-bps option for this server. The
default value is disabled.
limit-max-connections
Specifies the maximum number of concurrent connections, combined,
for this server. If the connections exceed this limit, the system
marks the server as unavailable.
limit-max-connections-status
Enables or disables the limit-max-connections option for this
server. The default value is disabled.
limit-max-pps
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.
limit-max-pps-status
Enables or disables the limit-max-pps option for this server. The
default value is disabled.
link-discovery
Specifies whether the system auto-discovers the links for this
server. The default value is disabled. The options are:
disabled
Specifies that the system does not auto-discover the links
that are available for the server.
enabled
Specifies that the system auto-discovers the links that are
configured on the server. With this option, the system
automatically adds, deletes, and modifies link settings in
the configuration.
enabled-no-delete
Specifies that the system auto-discovers the links that are
configured on the server. With this option, the system
automatically adds and modifies link settings in the
configuration, but does not delete them. This option is
useful when you regularly take links in and out of service.
metadata
Specifies user-defined data to associate with a server. By default
the persist attribute is set to true. This means the data is saved
into the configuration file.
monitor
Specifies the health monitors that the system uses to determine
whether this server is available for load balancing. Multiple
monitors may be specified with the and keyword. The min keyword is
used to specify the minimum number of monitors that must succeed
for this server to be declared up. The require keyword is used to
specify the minimum number of probes that must succeed for this
server to be declared up and the number of probers that should be
used.
name Specifies a unique name for the component. This option is required
for the commands create and modify.
partition
Displays the administrative partition within which the object
resides.
prober-fallback
Specifies the type of prober to use to monitor this server's
resources when the preferred type is not available. If this value
is specified, it overrides the prober fallback value on this
server's data center. The default value is inherit.
prober-pool
Specifies the name of a prober pool to use to monitor this
server's resources when either the prober-preference or prober-
fallback value is pool. If neither the prober-preference or
prober-fallback value is pool, the prober-preference and prober-
fallback values are set to pool and any-available. If this value
is specified, it overrides any prober pool set on this server's
data center. The default value is none.
prober-preference
Specifies the type of prober to use to monitor this server's
resources. If this value is specified, it overrides the prober
preference value on this server's data center. The default value
is inherit.
product
Specifies the server type. The server type determines the metrics
that the system can collect from the server. Use the command
completion feature to view the types of servers that are
available.
regex
Displays the items that match the regular expression. The regular
expression must be preceded by an at sign (@[regular expression])
to indicate that the identifier is a regular expression. See help
regex for a description of regular expression syntax.
virtual-server-discovery
Specifies whether the system auto-discovers the virtual servers
for this server. The default value is disabled. The options are:
disabled
Specifies that the system does not auto-discover the virtual
servers that are configured on the server. With this option,
you must configure the virtual servers for this server.
enabled
Specifies that the system auto-discovers the virtual servers
that are configured on the server. With this option, the
system automatically adds, deletes, and modifies virtual
server settings in the configuration.
enabled-no-delete
Specifies that the system auto-discovers the virtual servers
that are configured on the server. With this option, the
system automatically adds and modifies virtual server
settings in the configuration, but does not delete them. This
option is useful when you regularly take virtual servers in
and out of service.
virtual-servers
Specifies the name of the virtual servers that are resources for
this server. You can include the following options for virtual
servers.
app-service
Specifies the name of the application service to which the
virtual server belongs. The default value is none. Note: If
the strict-updates option is enabled on the application
service that owns the object, you cannot modify or delete the
virtual server. Only the application service can modify or
delete the virtual server.
depends-on
Specifies the vs-name of the server on which this virtual
server depends.
description
User defined description.
destination
Specifies the IP address and port of the virtual server.
[disabled | enabled]
Specifies whether this virtual server is available for load
balancing. The default value is enabled.
explicit-link-name
Specifies the explicit link name for the virtual server. The
default value is none.
limit-max-bps
Specifies the maximum allowable data throughput rate, in bits
per second, for this virtual server. If the network traffic
volume exceeds this value, the system marks the virtual
server as unavailable. The default value is 0 (zero).
limit-max-bps-status
Enables or disables the limit-max-bps option for this virtual
server. The default value is disabled.
limit-max-connections
Specifies the number of current connections allowed for this
virtual server. If the current connections exceed this value,
the system marks this virtual server as unavailable. The
default value is 0 (zero).
limit-max-connections-status
Enables or disables the limit-max-connections option for this
virtual server. The default value is disabled.
limit-max-pps
Specifies the maximum allowable data transfer rate, in
packets per second, for this virtual server. If the network
traffic volume exceeds this limit, the system marks the
virtual server as unavailable. The default value is 0 (zero).
limit-max-pps-status
Enables or disables the limit-max-pps option for this virtual
server. The default value is disabled.
ltm-name
The virtual server name found on the LTM. Useful for
differentiating between virtuals with same IP and port, but
different protocols. The ltm-name used in probe requests.
monitor
Specifies the monitor you want to assign to this virtual
server. Multiple monitors may be specified with the and
keyword. The min keyword is used to specify the minimum
number of monitors that must succeed for this server to be
declared up. The require keyword is used to specify the
minimum number of probes that must succeed for this server to
be declared up and the number of probers that should be used.
The default value is none.
translation-address
Specifies the public address that this virtual server
translates into when the Global Traffic Manager communicates
between the network and the Internet. The default value is
::.
translation-port
Specifies the translation port number or service name for the
virtual server, if necessary. The default value is 0.
SEE ALSO
create, delete, edit, glob, gtm datacenter, gtm link, gtm prober-pool,
list, modify, regex, reset-stats, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or
by any means, electronic or mechanical, including photocopying,
recording, or information storage and retrieval systems, for any
purpose other than the purchaser's personal use, without the express
written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2014, 2016. All rights
reserved.
BIG-IP 2018-03-09 gtm server(1)