APIRef_tm_gtm_link¶

mgmt/tm/gtm/link

Link configuration

REST Endpoints

Collection URI: /mgmt/tm/gtm/link
Collection Methods: OPTIONS, GET
Resource URI: /mgmt/tm/gtm/link/~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.
`costSegments`	string		optional	read/write	Specifies the cost of each incremental segment of bandwidth. This option is valid only if the weighting is set to price.
`datacenter`	string		required	read/write	Specifies the data center to which the link belongs.
`description`	string		optional	read/write	User defined description.
`disabled`	boolean	true	optional	read/write	Specifies that the link and its resources are not available for load balancing.
`duplexBilling`	string	enabled	optional	read/write	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.
`enabled`	boolean	true	optional	read/write	Specifies that the link and its resources are available for load balancing.
`limitMaxInboundBps`	uint64		optional	read/write	Specifies the threshold for inbound traffic on the link.
`limitMaxInboundBpsStatus`	string	disabled	optional	read/write	Enables or disables the limit-max-inbound-bps option for this link. The default value is disabled.
`limitMaxOutboundBps`	uint64		optional	read/write	Specifies the threshold for outbound traffic on the link.
`limitMaxOutboundBpsStatus`	string	disabled	optional	read/write	Enables or disables the limit-max-outbound-bps option for this link. The default value is disabled.
`limitMaxTotalBps`	uint64		optional	read/write	Specifies the threshold as a sum of inbound and outbound traffic on the link.
`limitMaxTotalBpsStatus`	string	disabled	optional	read/write	Enables or disables the limit-max-total-bps option for this link. The default value is disabled.
`linkRatio`	integer	1	optional	read/write	Specifies the frequency at which the system sends traffic through the link. When you set this option, you must also set the Weighting option to Ratio.
`monitor`	string		optional	read/write	Specifies the health monitors that the system uses to determine whether this link is available for load balancing.
`prepaidSegment`	uint64		optional	read/write	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).
`serviceProvider`	string		optional	read/write	Specifies the name of the Internet service provider that supplies this link.
`uplinkAddress`	string		optional	read/write	Specifies the IP address used to gather SNMP metrics from the router interface. When you configure an uplink address, the system sends SNMP requests to the IP addresses configured in the Router Address List for this link.
`weighting`	string	ratio	optional	read/write	Specifies the weighting methodology the system uses to select a link to which to send traffic. The options are Ratio (Specifies that the system uses the value that you set in the Link-Ratio option to determine the link to which to send traffic.) and Price/Dynamic Ratio (Specifies that the system continuously checks the performance of each link and sends traffic through the link with the best performance data.)

Array Structures

Name	Type	Required	Access	Description
`/router-addresses`	array_structure	optional	read/write	Adds, modifies, replaces, or deletes a router address.
`/router-addresses/app-service`	string	optional	read/write	The application service that the object belongs to.
`/router-addresses/description`	string	optional	read/write	User defined description.
`/router-addresses/device-name`	string	optional	read/write	Deprecated in 13.0.0. Specifies the name of this system in a redundant pair. The default value is none.
`/router-addresses/translation`	string	optional	read/write	Specifies whether the link uses address translation when communicating between the network and the Internet. The default value is disabled.

iControl Reference Index

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.