BIG-IQ LTM Virtual Server

Overview

API used to create/manage LTM virtual server.

Version information

Version : 5.2, 5.3, 5.4, 6.0

URI scheme

BasePath : /mgmt/cm/adc-core/working-config/ltm
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

Create a LTM virtual server.

POST /virtual

Description

POST to create a BIGIP virtual server.

Responses

HTTP Code Description Schema
200 POST a BIGIP virtual server. properties_collection
400 Error response “Bad Request” 400_error_collection
404 Error response “Public URI path not registered.” 404_error_collection

List all virtual server items as a collection.

GET /virtual

Description

Returns the collection of virtual servers.

Responses

HTTP Code Description Schema
200 Collection of virtual servers. properties_collection
400 Error response “Bad Request” 400_error_collection
404 Error response “Public URI path not registered.” 404_error_collection

Used to get a single virtual server object.

GET /virtual/{objectId}

Description

Returns the virtual server object identified by id for an endpoint URI.

Parameters

Type Name Description Schema Default
Path objectId Unique id assigned to a virtual server. required string(UUID) None

Responses

HTTP Code Description Schema
200 Virtual Server object. properties_virtual
400 Server error response “Bad Request”. 400_error_collection
404 Error response “Public URI path not registered.” 404_error_collection

Definitions

400_error_collection

Name Description Schema
errorStack Error stack trace returned by java. optional, read-only string
items Collection of virtual servers. Errored response from server. optional < object > array
kind Type information for LTM virtual servers - errors cm:adc-core:working-config:ltm:virtual:adcvirtualcollectionstate. optional, read-only string
message Error message returned from server. optional, read-only string
requestBody The data in the request body. GET (None) optional, read-only string
requestOperationId Unique id assigned to rest operation. optional, read-only integer(int64)

404_error_collection

Name Description Schema
errorStack Error stack trace returned by java. optional, read-only string
items Collection of virtual servers. Errored response from server. optional < object > array
kind Type information for virtual server - cm:adc-core:working-config:ltm:virtual:adcvirtualcollectionstate. optional, read-only string
message Error message returned from server. optional, read-only string
requestBody The data in the request body. GET (None) optional, read-only string
requestOperationId Unique id assigned to rest operation. optional, read-only integer(int64)

properties_collection

Name Description Schema
generation A integer that will track change made to a virtual server collection object. generation. optional, read-only integer(int64)
items A collection of virtual servers. Properties defining items. optional < object > array
kind Type information for this virtual servers collection object - cm:adc-core:working-config:ltm:virtual:adcvirtualcollectionstate. optional, read-only string
lastUpdateMicros Update time (micros) for last change made to an virtual server collection object. time. optional, read-only integer(int64)
selfLink A reference link URI to the virtual server collection object. optional, read-only string

properties_virtual

Name Description Schema
addressStatus Specifies the virtual will contribute to the operational status of the associated virtual-address. The default is ‘yes’. optional string
autoLasthop Specifies whether to automatically map last hop for pools or not. The default is to use next level’s default. optional string
connectionLimit Specifies the maximum number of concurrent connections you want to allow for the virtual server. optional integer
defaultCookiePersistenceReference Reference link to profiles that the virtual server uses to manage connection persistence. optional defaultCookiePersistenceReference
description Description of LTM virtual server. optional string
deviceReference Reference link to BIGIP device associated to virtual server. optional deviceReference
fallbackSourceAddrPersistenceReference Reference link fallback persistence profile for the virtual server to use when the default persistence profile is not available. optional fallbackSourceAddrPersistenceReference
generation A integer that will track change made to a LTM virtual server object. - generation. optional, read-only integer(int64)
gtmScore Specifies a score that is associated with the virtual server. Global Traffic Manager (GTM) can rely on this value to load balance traffic in a proportional manner. optional integer
id Unique id assigned to a virtual server object. optional, read-only string
ipProtocol Specifies the IP protocol for which you want the virtual server to direct traffic. Sample protocol names are tcp and udp. optional string
kind Type information for this virtual server object. cm:adc-core:working-config:ltm:virtual:adcvirtualstate optional string
lastUpdateMicros Update time (micros) for last change made to an LTN virtual server object - time. optional, read-only integer(int64)
mask Destination netmask used for client access - ex. 255.255.255.255 or 32. optional string
mirror Enables or disables state mirroring. You can use state mirroring to maintain the same state information in the standby unit that is in the active unit, allowing transactions such as FTP file transfers to continue as though uninterrupted. The default value is disabled. optional string
name Name of LTM virtual server. optional string
nat64 Specifies whether this virtual does NAT64 translation. optional string
partition Displays the administrative partition within which this virtual server profile resides. optional string
poolReference Reference link to virtual pool in which you want the virtual server to automatically direct traffic. optional poolReference
profilesCollectionReference Reference link to profiles for the virtual server to use when directing and managing traffic. optional profilesCollectionReference
rateLimit Specifies the maximum number of connections per second allowed for a virtual server. The default value is disabled. optional string
rateLimitMode Indicates whether the rate limit is applied per virtual object, per source address, per destination address, or some combination thereof. The default value is object, which does not use the source or destination address as part of the key. optional string
selfLink A reference link URI to the LTM virtual server object. optional, read-only string
sourceAddress Source address used for client access to virtual server object. optional string
sourceAddressTranslation Type of address translation pool used for implementing selective and intelligent source address translation. optional sourceAddressTranslation
sourcePort Specifies whether the system preserves the source port of the connection. The default is preserve. Use of the preserve-strict setting should be restricted to UDP only under very special circumstances such as nPath or transparent (that is, no translation of any other L3/L3 field), where there is a 1:1 relationship between virtual IP addresses and node addresses, or when clustered multi-processing (CMP) is disabled. The change setting is useful for obfuscating internal network addresses. optional string
state State of virtual server. enabled / disabled. optional string
subPath Path to virtual server. Partition / app.app. optional ex. Common /app-service_1.app string
translatePort Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance. connections to any service. optional string
vlanReferences Specifies an array of vlans against which the packet will be compared. optional < vlanReferences > array
vlansEnabled Enables the virtual server on the VLANs specified by the VLANs option. optional string

defaultCookiePersistenceReference

Name Description Schema
link Reference link to profiles that the virtual server uses to manage connection persistence. optional string

deviceReference

Name Description Schema
id Unique id assigned to a device referenced by this object. optional string
kind Type information for device. shared:resolver:device-groups:restdeviceresolverdevicestate optional string
link Reference link to adc-core-allbigipDevices in shared resolver device-groups. optional string
machineId Unique id assigned to the hardware device. If virtual could be the same as id object. optional string
name A name used to identify this device. optional string

fallbackSourceAddrPersistenceReference

Name Description Schema
link Reference link fallback persistence profile for the virtual server to use when the default persistence profile is not available. optional string

poolReference

Name Description Schema
link Reference link to virtual pool in which you want the virtual server to automatically direct traffic. optional string

profilesCollectionReference

Name Description Schema
isSubcollection Is this a collection of objects. In this case profiles. default: true optional boolean
link Reference link to profiles for the virtual server to use when directing and managing traffic. optional string

sourceAddressTranslation

Name Description Schema
type Type of address translation pool used for implementing selective and intelligent source address translation. optional string

vlanReferences

Name Description Schema
link Reference link to vlan against which the packet will be compared. optional string