gtm object definition¶

iControl Wiki Home :: DCO Home Page :: DCO Health Model :: gtm object definition

The physical and logical object relationships that describe the gtm object’s role in the DCO health model are defined here.

Property	Value
Host	device <dco_device_object.html> __, module <dco_module_object.html> __
Parent	device <dco_device_object.html> __, module <dco_module_object.html> __
Child	wide ip _, data center, gtm pool _, gtm pool virtual server, `gtm server <dco_gtm_node_object.html> `__, `gtm irule <dco_gtm_irules_object.html >`__
Statistics	The statistics available for this object are listed here. Bytes In (avg/sec) Bytes Out (avg/sec) Packets In (avg/sec) Packets Out (avg/sec) Maximum Connections (avg/sec) Total Connections (avg/sec) Current Connections
Related objects	device <dco_device_object.html> __, module <dco_module_object.html> __, wide ip _, data center, gtm pool _, gtm pool virtual server, `gtm server <dco_gtm_node_object.html> `__, `gtm irule <dco_gtm_irules_object.html >`__

Properties¶

This table lists properties available for the

gtm

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

Property	Description
get_application_context_status	Gets the statuses of the specified application context objects.
get_data_centers	Gets the data centers associated with a set of distributed applications.
get_list	Gets a list of applications.
get_object_status	Gets the statuses of the specified applications.
get_servers	Gets the servers associated with a set of distributed applications.
get_wide_ips	Gets the wide IPs associated with a set of distributed applications.

Methods¶

This table lists methods available for the

gtm

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

Method	Description
create	Creates the specified applications.
delete_all_applications	Deletes all applications.
delete_application	Deletes the specified applications.
disable_application_context_object	Disables the specified objects within the applications’ context.
enable_application_context_object	Enables the specified objects within the applications’ context.

set_device_context

GTM child objects¶

Click a link for more detail on the child objects.

Name	Definition
wide ip _	The wide ip object maps a fully-qualified domain name (FQDN) to a set of virtual servers that host the domain’s content, such as a web site, an e-commerce site, or a content delivery network. Wide IPs work with pools and virtual servers to first balance requests to the appropriate pool, and then within the pool to the appropriate virtual server.
data center	The data center object defines the group of Global Traffic Managers, Local Traffic Managers, and host systems that reside in a single physical location. Within the Global Traffic Manager, a data center contains at least one server and one link. Every resource, whether physical or logical, is associated in some way with a data center. The statistics for data centers revolve around the amount of traffic flowing to and from each data center.
gtm pool _	The gtm pool object is a group of virtual servers managed by a BIG-IP system, or a host. The Global Traffic Manager load balances among pools (using the Pool LB Mode), as well as among individual virtual servers.
gtm pool virtual server	The gtm pool virtual server object is a collection of IP addresses and port numbers, a pool is a collection of virtual servers. Pools represent virtual servers that share a common role on the network. A virtual server, in the context of the Global Traffic Manager, is a combination of IP address and port number that points to a specific resource on the network.
`gtm server <dco_gtm_node_object.html> `__	The gtm server object is the IP address associated with a device on the network. This IP address can be the real IP address of a network server, or it can be an alias IP address on a network server. The devices represented by the IP address of pool members are referred to as nodes.
`gtm irule <dco_gtm_irules_object.html >`__	The gtm irule object is a user-written script that controls the behavior of a connection passing through the BIG-IP system. iRules are an F5 Networks feature and are frequently used to direct certain connections to a non-default load balancing pool. However, iRules can perform other tasks, such as implementing secure network address translation and enabling session persistence.