gtm link
gtm link(1) BIG-IP TMSH Manual gtm link(1)
NAME
link - Configures Global Traffic Manager(tm) links.
MODULE
gtm
SYNTAX
Configure the link component within the gtm module using the syntax in the following sections.
CREATE/MODIFY
create link [name]
modify link [name]
options:
app-service [[string] | none]
cost-segments {
{ [up-to-bps [integer] ] [dollars-per-mbps [integer] ] }...
}
datacenter [string]
description [string]
[disabled | enabled]
duplex-billing [disabled | enabled]
limit-max-inbound-bps [integer]
limit-max-inbound-bps-status [disabled | enabled]
limit-max-outbound-bps [integer]
limit-max-outbound-bps-status [disabled | enabled]
limit-max-total-bps [integer]
limit-max-total-bps-status [disabled | enabled]
link-ratio [integer]
monitor [none | [name] [and [name] ]... ]
monitor min [integer] of { [name]... }
prepaid-segment [integer]
router-addresses
[add | delete | modify | replace-all-with] {
[ip address] {
app-service [[string] | none]
description [string]
device-name [[string] | none]
translation [disabled | enabled]
}
}
service-provider [name]
uplink-address [ip address]
weighting [price | ratio]
edit link [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
reset-stats link
reset-stats link [ [ [name] | [glob] | [regex] ] ... ]
DISPLAY
list link
list link [ [ [name] | [glob] | [regex] ] ... ]
show running-config link
show running-config link [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
show link
show link [name]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
detail
field-fmt
DELETE
delete link [name]
DESCRIPTION
You can use the link component to create, display, modify, or delete a link.
A link is a physical device that connects the network to the rest of the Internet. You can logically attach
links to a collection of servers in order to manage access to the data sources on the network.
EXAMPLES
create link my_link datacenter DC1 router-addresses add {10.10.1.1}
Creates a link named my_link in the DC1 data center and adds the IP address of the router that uses this link.
list link non-default-properties
Displays all non-default properties for all links.
delete link my_link
Deletes the link named my_link.
show link my_link detail
Show the servers and virtual servers associated with my_link.
show link all detail
Show the servers and virtual servers associated with each respective link in the system.
OPTIONS
app-service
Specifies the name of the application service to which the link 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 link. Only the application service can modify or delete the link.
cost-segments
Specifies the cost of each incremental segment of bandwidth. This option is valid only when the weighting
option is set to price. Note that you cannot modify the list, only replace all of the options in the
list.
By default, the list is empty. The options are:
dollars-per-mps
Specifies the cost in dollars per megabytes per second. By default this value is not specified.
up-to-bps
Specifies the cost in dollars per bytes per second. By default this value is not specified.
datacenter
Specifies the data center to which the link belongs.
description
User defined description.
detail
The detail option is used with the show display command. This shows the server IP addresses and virtual
servers associated with this link. A server can have multiple server IP addresses, however, only the
server IP addresses that use this link will be displayed. Assignment information for servers and virtuals
will not be displayed if there are not any servers or virtuals that use this link. By default, links are
automatically matched to server IP addresses and virtual servers according to their IP addresses.
Explicit links may also be defined. How this link was assigned is displayed under 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.
[disabled | enabled]
Specifies whether the link and its resources are available for load balancing. The default value is
enabled.
duplex-billing
Enables or disables duplex billing for this link. The default value is enabled. This option is valid only
when the weighting option is set to price.
disabled
The internet service provider (ISP) that supplies this link bills for bandwidth usage based on the
total amount of inbound plus outbound traffic on the link.
enabled
The ISP that supplies this link bills for bandwidth usage based on the maximum amount of either
inbound or outbound traffic on the link (whichever is higher), rather than billing for bandwidth
usage based on the total amount of inbound plus outbound traffic on the link.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
limit-max-inbound-bps
Specifies the threshold for inbound traffic on the link. The default value is 0 (zero).
limit-max-inbound-bps-status
Enables or disables the limit-max-inbound-bps option for this link. The default value is disabled.
limit-max-outbound-bps
Specifies the threshold for inbound traffic on the link. The default value is 0 (zero).
limit-max-outbound-bps-status
Enables or disables the limit-max-outbound-bps option for this link. The default value is disabled.
limit-max-total-bps
Specifies the threshold as a sum of inbound and outbound traffic on the link. The default value is 0
(zero).
limit-max-total-bps-status
Enables or disables the limit-max-total-bps option for this link. The default value is disabled.
link-ratio
Specifies the frequency at which the system sends traffic through the link. The default value is 1.
Important: When you set this option, you must also set the weighting option to ratio.
monitor
Specifies the health monitors that the system uses to determine whether this link 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 link to be declared up. The default value is
none.
name Specifies a unique name for the component. This option is required for the commands create and modify.
prepaid-segment
Specifies the amount of bandwidth for which the system is prepaid. This option is valid only when the
weighting option is set to price. The default value is 0 (zero).
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.
router-addresses
Specifies the IP addresses of the routers that use this link. A router address can be associated with
only one link. You can use the following options:
app-service
Specifies the name of the application service to which the link 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 link. Only the application service can modify or delete the link.
description
User defined description.
device-name
Deprecated in v13.0.0 Specifies the name of the device associated with this link. Defaults to none.
translation
Specifies the address that the link uses for translation when communicating between the network and
the Internet. The default value is any6.
service-provider
Specifies the Internet Service Provider (ISP) or vendor that supplies this link. This allows you to
provide a name or description that helps identify this link out of your data center. This is an optional
field.
uplink-address
Specifies the IP address the system uses to gather Simple Network Management Protocol (SNMP) metrics from
the router interface. When you configure an uplink address, the system sends SNMP requests to the IP
addresses configured using the router-addresses option for this link.
weighting
Specifies the weighting methodology the system uses to select a link to which to send traffic. The
default value is ratio. The options are:
price
The system continuously checks the performance of each link, and sends traffic through the link with
the best performance data.
ratio
The system uses the value that you set in the link-ratio option to determine the link to which to
send traffic.
SEE ALSO
create, delete, edit, glob, gtm datacenter, gtm server, 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. All rights reserved.
BIG-IP 2016-11-18 gtm link(1)