gtm pool virtual server object definition¶

The physical and logical object relationships that describe the

gtm pool virtual server

object’s role in the DCO health model are defined here.

Property

Value

Host

device, module

Parent

gtm pool

Events

availability change

Availability

monitor state, session state

Health

State Indicator	Monitor Status
` <https://devcentral.f5.com/wiki/iControl..ashx>`__	Up and available
` <https://devcentral.f5.com/wiki/iControl..ashx>`__	No monitor associated with the object; or the object is unknown (object would be blue or yellow in the BIG-IP Configuration utility)
` <https://devcentral.f5.com/wiki/iControl..ashx>`__	Object is disabled or marked down by a monitor (object would appear black or red in the BIG-IP Configuration utility)

Statistics

The statistics available for this object are listed here.

Create and Delete

CreateGTM Pool Virtual Server, DeleteGTM Pool Virtual Server

Related objects

device, gtm pool

Properties¶

This table lists properties available for the

gtm pool virtual server

object. For API reference information, click the property name.

Property	Description
get_address	Gets the IP address and service associated with a set of virtual servers. Note: A set_address method is not supported.
get_all_statistics	Gets the statistics for all the virtual servers.
get_enabled_state	Gets the enabled states for the specified virtual servers.
get_limit	Gets all metrics limits for a sequence of virtual servers.
get_list	Gets a list of virtual servers.
get_monitor_rule	Gets the monitor rules for a set of virtual servers.
get_object_status	Gets the statuses of the specified virtual servers.
get_server	Gets a list of servers to which the specified virtual servers belong.
get_statistics	Gets the statistics for the specified virtual servers.
set_enabled_state	Sets the enabled states for the specified virtual servers.
set_limit	Sets the limits for virtual server metrics.
set_monitor_association	Sets/creates the monitor associations for the specified virtual servers. This creates the monitor associations between a virtual server and a monitor rule.
set_monitor_rule	Sets the monitor rule for a set of virtual servers.
set_server	Sets the servers to which the specified virtual servers belong.

This table lists methods available for the

gtm pool virtual server

object. For API reference information, click the method name.

Method	Description
create	Creates the specified virtual server.
delete_all_virtual_servers	Deletes all virtual servers.
delete_virtual_server	Deletes the specified virtual servers.
remove_monitor_association	Removes the monitor associations for the specified virtual servers. This deletes the monitor associations between a virtual server and a monitor rule, that is, the specified virtual servers are no longer monitored.
reset_statistics	Resets the statistics for the specified virtual servers.