APIRef_tm_ltm_virtual-address¶
mgmt/tm/ltm/virtual-address
Virtual server IP address configuration
REST Endpoints
- Collection URI
/mgmt/tm/ltm/virtual-address- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/ltm/virtual-address/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
address |
string | optional | read/write | ||
appService |
string | optional | read/write | The application service to which the object belongs. | |
arp |
string | enabled | optional | read/write | Enables or disables ARP for the specified virtual address. The default value is enabled. |
autoDelete |
string | true | optional | read/write | Indicates if the virtual address will be deleted automatically on deletion of the last associated virtual server or not. The default value is true. |
connectionLimit |
integer | 0 | optional | read/write | Sets a concurrent connection limit in seconds for one or more virtual servers. The default value is 0 seconds. |
description |
string | optional | read/write | User defined description. | |
enabled |
string | yes | optional | read/write | Specifies whether a virtual server IP address is enabled. The default value is yes. |
floating |
string | enabled | optional | read/write | |
icmpEcho |
string | enabled | optional | read/write | Enables or disables ICMP echo replies for the specified virtual address. The default value is enabled. |
inheritedTrafficGroup |
string | optional | read/write | ||
mask |
string | ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff | optional | read/write | Sets the netmask or one or more network virtual servers only. This setting is required for network virtual servers. |
tmPartition |
string | Common | optional | read/write | Displays the administrative partition within which this profile resides. |
routeAdvertisement |
string | disabled | optional | read/write | Enables or disables route advertisement for the specified virtual address. The default value is disabled. |
serverScope |
string | any | optional | read/write | Specifies the server that uses the specified virtual address. |
spanning |
string | disabled | optional | read/write | Enables or disables spanning for the specified virtual address. The default value is disabled. |
trafficGroup |
string | optional | read/write | Specifies the traffic group for the virtual address. The default traffic group is inherited from the containing folder. | |
unit |
integer | 1 | optional | read/write |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/metadata |
array_structure | optional | read/write | User defined generic data for the virtual address. It is a name and value pair. | |
/metadata/app-service |
string | optional | read/write | ||
/metadata/persist |
string | true | optional | read/write | Specifies whether the command “tmsh save sys config” will save the metadata entry to the configuration files. |
/metadata/value |
string | optional | read/write | Value of the virtual address metadata |
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.