APIRef_tm_gtm_server_virtual-serversΒΆ
mgmt/tm/gtm/server/virtual-servers
GTM virtual server configuration
REST Endpoints
- Collection URI
/mgmt/tm/gtm/server/virtual-servers- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/gtm/server/virtual-servers/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
appService |
string | optional | read/write | ||
description |
string | optional | read/write | User defined description. | |
destination |
string | optional | read/write | Specifies the IP address and port of the virtual server. | |
disabled |
boolean | true | optional | read/write | Specifies that this virtual server is not available for load balancing. |
enabled |
boolean | true | optional | read/write | Specifies that this virtual server is available for load balancing. |
explicitLinkName |
string | optional | read/write | Specifies the specific link name that you want to associate with this virtual server. | |
limitMaxBps |
uint64 | optional | read/write | 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. | |
limitMaxBpsStatus |
string | disabled | optional | read/write | Enables or disables the limit-max-bps option for this virtual server. The default value is disabled. |
limitMaxConnections |
uint64 | optional | read/write | 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. | |
limitMaxConnectionsStatus |
string | disabled | optional | read/write | Enables or disables the limit-max-connection option for this virtual server. The default value is disabled. |
limitMaxPps |
uint64 | optional | read/write | Specifies the maximum allowable data transfer rate, in packets per second, for this virtual server. If the network traffic volume exceeds this value, the system marks this virtual server as unavailable. | |
limitMaxPpsStatus |
string | disabled | optional | read/write | Enables or disables the limit-max-pps option for this virtual server. The default value is disabled. |
ltmName |
string | optional | read/write | Name of virtual server on LTM. | |
monitor |
string | optional | read/write | Enables or disables the monitor assigned to this virtual server. | |
translationAddress |
string | optional | read/write | Specifies the public address that this virtual server translates into when GTM communicates between the network and the Internet. The default value is disabled. | |
translationPort |
integer | 0 | optional | read/write | Specifies the translation port number or service name for the virtual server, if necessary. |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/depends-on |
array_structure | optional | read/write | ||
/depends-on/app-service |
string | optional | read/write | The application service that the object belongs to. |
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.