wide ip object definition¶

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

The physical and logical object relationships that describe the

wide ip

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

Property

Value

Host

device

Parent

gtm pool virtual server

Events

availability change

Health

State Indicator: **Mo

nitor Status** ` <https://devcentral.f5.com/wiki /iControl..ashx>`__ Up a nd available ` <https://devcentral.f5.com/wiki /iControl..ashx>`__ No m onitor associated with the object ; or the object is unknown (objec t would be blue or yellow in the BIG-IP Configuration utility) ` <https://devcentral.f5.com/wiki /iControl..ashx>`__ Obje ct is disabled or marked down by a monitor (object would appear bl ack or red in the BIG-IP Configur ation utility) ================================= ============================ ==== ================================= ================================= ================================= =============================

Statistics

The statistics available for this object are listed here.

Atis (avg/sec)
Failbacks (avg/sec)
Preferred (avg/sec)
Dropped (avg/sec)

Create and Delete

CreateWide IP, DeleteWide IP

Related objects

device <dco_device_object.html> __, gtm pool virtual server

Properties¶

This table lists properties available for the

wide ip

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

Property	Description
get_alias	Gets the list of aliases with which the specified wide IPs are associated. A given wide IP can have more than one alias.
get_all_statistics	Gets the statistics for all the wide IPs.
get_enabled_state	Gets the enabled states for the specified wide IPs.
get_lb_method	Gets the load balancing methods for the specified wide IPs.
get_list	Gets a list of wide IPs.
get_object_status	Gets the statuses of the specified wide IPs.
get_wideip	Gets the list of wide IPs associated with the specified aliases. Each alias maps to exactly one wide IP.
get_wideip_pool	Gets the lists of wide IP pools with which the specified wide IPs are associated.
get_wideip_rule	Gets the lists of wide IP rules with which the specified wide IPs are associated.
set_enabled_state	Sets the enabled states for the specified wide IPs.
set_lb_method	Sets the load balancing methods for the specified wide IPs. This is used by the wide IPs when picking a pool to use when responding to a DNS request.

Methods¶

This table lists methods available for the

wide ip

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

Method	Description
add_alias	Adds/associates aliases to the specified wide IPs. A given wide IP can have more than one alias.
add_wideip_pool	Adds/associates wide IP pools to the specified wide IPs.
add_wideip_rule	Adds/associates wide IP rules to the specified wide IPs.
create	Creates the specified wide IPs with some basic attributes.
delete_all_wideips	Deletes all wide IPs.
delete_wideip	Deletes the specified wide IPs.
remove_alias	Removes aliases from the specified wide IPs. A given wide IP can have more than one alias.
remove_all_aliases	Removes all aliases from the specified wide IPs.
remove_all_wideip_pools	Removes all wide IP pools from the specified wide IPs.
remove_all_wideip_rules	Removes all wide IP rules from the specified wide IPs.
remove_wideip_pool	Removes wide IP pools from the specified wide IPs.
remove_wideip_rule	Removes wide IP rules from the specified wide IPs.
reset_statistics	Resets the statistics for the specified wide IPs.