LocalLB::VirtualServer¶
Introduced : BIG-IP_v9.0
The VirtualServer interface enables you to work with the states,
statistics, limits, availability, and settings of a local load
balancer&aposs virtual servers. For example, you can use the Virtual
Server interface to create a virtual server from a specified pool or
rule or to delete a virtual server from a specified pool. Note that
the source and destination addresses in the firewall methods
(get_fw_rule and so on) are type Common::NetAddress, a type which
allows one to specify a prefix length after the address, e.g.,
“10.1.1.0/24”. The source address in set_source_address and so on is
type Common::NetAddress as well.
Methods¶
| Method | Description | Introduced |
| add_authentication_profile | Adds/associates authentication profiles to the specified virtual servers. | BIG-IP_v9.0 |
| add_clone_pool | Adds/associates clone pools to the specified virtual servers. | BIG-IP_v9.0 |
| add_content_policy | Adds a list of Content Policies to associate with the specified virtual servers. | BIG-IP_v12.0.0 |
| add_fw_rule | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds firewall rules to the specified virtual servers. Note that the abilities to add more than one rule or, especially, to add partial rules and to build them up introduce a need for best practices: (1) introduce the rule or rules initially disabled (using the states parameter) and enable them (or set them as scheduled) as a whole when you have them complete or (2) use transactions (see System::Session::start_transaction) to avoid accidentally putting partial rules or incomplete rule sets into place. | BIG-IP_v11.3.0 |
| add_fw_rule_destination_address | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use add_fw_rule_destination_address_range instead. When using this method, the system will create a corresponding one-element address range where begin is equal to end. Adds (inlined) destination addresses to the specified firewall rules. | BIG-IP_v11.3.0 |
| add_fw_rule_destination_address_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds destination address lists to the specified firewall rules. See the Security::FirewallAddressList interface for more information on address lists. | BIG-IP_v11.3.0 |
| add_fw_rule_destination_address_range | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds a list of (inlined) destination address ranges for the specified firewall rules. | BIG-IP_v11.5.0 |
| add_fw_rule_destination_geo | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds (inlined) destination geo locations to the specified firewall rules. | BIG-IP_v11.5.0 |
| add_fw_rule_destination_port | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds (inlined) destination ports to the specified firewall rules. | BIG-IP_v11.3.0 |
| add_fw_rule_destination_port_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds destination port lists to the specified firewall rules. See the Security::FirewallPortList interface for more information on port lists. | BIG-IP_v11.3.0 |
| add_fw_rule_icmp_typecode | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds (inlined) ICMP type/code values to the specified firewall rules. | BIG-IP_v11.3.0 |
| add_fw_rule_source_address | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use add_fw_rule_source_address_range instead. When using this method, the system will create a corresponding one-element address range where begin is equal to end. Adds (inlined) source addresses to the specified firewall rules. | BIG-IP_v11.3.0 |
| add_fw_rule_source_address_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds source address lists to the specified firewall rules. See the Security::FirewallAddressList interface for more information on address lists. | BIG-IP_v11.3.0 |
| add_fw_rule_source_address_range | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds a list of (inlined) source address ranges for the specified firewall rules. | BIG-IP_v11.5.0 |
| add_fw_rule_source_geo | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds (inlined) source geo locations to the specified firewall rules. | BIG-IP_v11.5.0 |
| add_fw_rule_source_port | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds (inlined) source ports to the specified firewall rules. | BIG-IP_v11.3.0 |
| add_fw_rule_source_port_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds source port lists to the specified firewall rules. See the Security::FirewallPortList interface for more information on port lists. | BIG-IP_v11.3.0 |
| add_fw_rule_source_vlan | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds source VLANs to the specified firewall rules. | BIG-IP_v11.3.0 |
| add_fw_rule_with_rule_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Adds firewall rules to the specified virtual servers, having each of those rules point at a rule list. This method is intended as a convenience to prevent you from having to add firewall rules as a transaction. See the Security::FirewallRuleList interface for more information on rule lists. | BIG-IP_v11.3.0 |
| add_httpclass_profile | As of v11.4.0 this function is deprecated immediately. Attempting to perform this function will return a not-implemented exception. Adds/associates HTTP class profiles to the specified virtual servers. | BIG-IP_v9.2.0 |
| add_metadata | Adds the metadata for the specified virtual servers. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| add_persistence_profile | Adds/associates persistence profiles to the specified virtual servers. | BIG-IP_v9.0 |
| add_profile | Adds/associates profiles to the specified virtual servers. | BIG-IP_v9.0 |
| add_related_rule | Adds/associates related rules to the specified virtual servers. | BIG-IP_v11.2.0 |
| add_rule | Adds/associates rules to the specified virtual servers. | BIG-IP_v9.0 |
| add_security_log_profile | Adds/associates Security log profiles to the specified virtual servers. Please see the LogProfile interface in the Security module for more information. | BIG-IP_v11.3.0 |
| create | Creates or updates virtual servers from the specified resources. Takes additional, optional parameters that enable you to override the default optional values. | BIG-IP_v9.0 |
| delete_all_virtual_servers | Deletes all virtual servers. | BIG-IP_v9.0 |
| delete_persistence_record | Deletes the persistence records based on the specified persistent modes for the specified virtual servers. | BIG-IP_v9.0 |
| delete_virtual_server | Deletes the specified virtual servers. | BIG-IP_v9.0 |
| get_actual_hardware_acceleration | Gets the actual hardware acceleration modes for the specified virtual servers. | BIG-IP_v9.0 |
| get_all_fw_rule_statistics | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the statistics for all firewall rules on the specified virtual servers. | BIG-IP_v11.4.0 |
| get_all_statistics | Gets the statistics for all the virtual servers. | BIG-IP_v9.0 |
| get_authentication_profile | Gets the lists of authentication profiles the specified virtual servers are associated with. | BIG-IP_v9.0 |
| get_auto_lasthop | Gets the attribute that specifies auto-lasthop behavior, for the specified virtual servers. | BIG-IP_v11.4.0 |
| get_bw_controller_policy | Gets the bandwidth controller policy of the specified virtual servers. | BIG-IP_v11.3.0 |
| get_clone_pool | Gets the lists of clone pools the specified virtual servers are associated with. | BIG-IP_v9.0 |
| get_cmp_enable_mode | Gets the CMP enable modes from the specified virtual servers. This is read-only, as the modes are set according to the system and configuration, and influenced by the desired CMP enabled state. | BIG-IP_v9.4.0 |
| get_cmp_enabled_state | Gets the CMP enabled states for the specified virtual servers. Enables or disables CMP. Note that this setting can influence the CMP enable mode set automatically by the system and configuration. You can not always enable CMP, but you can always disable it. | BIG-IP_v9.4.0 |
| get_connection_limit | Gets the connection limits for the specified virtual servers. | BIG-IP_v9.0 |
| get_connection_mirror_state | Gets the mirror connection states for the specified virtual servers. | BIG-IP_v9.0 |
| get_content_policy | Gets the list of Content Policies associated with the specified virtual servers. See LocalLB::ContentPolicy for more information on Content Policies. | BIG-IP_v12.0.0 |
| get_contribute_to_address_status | Gets the setting on the virtual servers determining whether it participates in the operational status of its associated virtual address. If &apostrue&apos, a virtual server&aposs status is taken into consideration when calculating the associated virtual address&apos status. | BIG-IP_v11.5.1 |
| get_default_pool_name | Gets the default pool names for the specified virtual servers. | BIG-IP_v9.0 |
| get_description | Gets the descriptions for a set of virtual servers. | BIG-IP_v11.0.0 |
| get_destination | This method has been deprecated due to changing the virtual address key. Please use set_destination_v2 in its stead. Gets the destination IP and port of the specified virtual servers. | BIG-IP_v9.0 |
| get_destination_v2 | Gets the destination virtual address and port of the specified virtual servers. | BIG-IP_v11.0.0 |
| get_enabled_state | Gets the enabled state of the specified virtual server. | BIG-IP_v9.0 |
| get_enforced_firewall_policy | Gets the firewall policies enforced on the virtual servers. | BIG-IP_v11.4.0 |
| get_eviction_policy | Gets the eviction strategy assigned to the specified virtual servers. | BIG-IP_v11.6.0 |
| get_fallback_persistence_profile | Gets the persistence profiles to use for fallback persistence for the specified virtual servers. | BIG-IP_v9.0 |
| get_fw_rule | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the firewall rules for the specified virtual servers. | BIG-IP_v11.3.0 |
| get_fw_rule_action | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the action for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the descriptions for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_destination_address | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use get_fw_rule_destination_address_range instead. Firewall addresses are now supplied and stored in the form of an address range. Single addresses are converted to a corresponding one-element range where begin is equal to end; for each range, this method returns the start of the address range. Gets (inlined) destination addresses for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_destination_address_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use get_fw_rule_destination_address_range_description instead. Gets the descriptions for the specified firewall rules&apos destination addresses. | BIG-IP_v11.3.0 |
| get_fw_rule_destination_address_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets destination address lists for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_destination_address_range | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets (inlined) destination address ranges for the specified firewall rules. | BIG-IP_v11.5.0 |
| get_fw_rule_destination_address_range_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the descriptions for the specified firewall rule destination address ranges. | BIG-IP_v11.5.0 |
| get_fw_rule_destination_geo | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets (inlined) destination geo locations for the specified firewall rules. The geo location is a combination of country code and state name. The country code is two characters long. The state name is the full name of a state that belongs to the country represented by country code. | BIG-IP_v11.5.0 |
| get_fw_rule_destination_geo_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the descriptions for the specified firewall rules&apos destination geo locations. | BIG-IP_v11.5.0 |
| get_fw_rule_destination_port | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets (inlined) destination ports for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_destination_port_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the descriptions for the specified firewall rules&apos (inlined) destination ports. | BIG-IP_v11.3.0 |
| get_fw_rule_destination_port_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets destination port lists for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_icmp_typecode | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets (inlined) ICMP type/code values for the specified firewall rules. A value of 255 for either ICMP type or code is a wildcard value. | BIG-IP_v11.3.0 |
| get_fw_rule_icmp_typecode_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the descriptions for the specified firewall rules&apos (inlined) ICMP type/code values. | BIG-IP_v11.3.0 |
| get_fw_rule_irule | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the iRules for the specified firewall rules. | BIG-IP_v11.5.0 |
| get_fw_rule_log_state | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the logging property for the specified firewall rules. | BIG-IP_v11.4.0 |
| get_fw_rule_order | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the order (numerically) for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_protocol | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the (IP) protocol for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_protocol_numeric | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the IP protocol (numerically) for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_rule_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the rule list for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_source_address | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use get_fw_rule_source_address_range instead. Firewall addresses are now supplied and stored in the form of an address range. Single addresses are converted to a corresponding one-element range where begin is equal to end; for each range, this method returns the start of the address range. Gets (inlined) source addresses for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_source_address_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use get_fw_rule_source_address_range_description instead. Gets the descriptions for the specified firewall rules&apos source addresses. | BIG-IP_v11.3.0 |
| get_fw_rule_source_address_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets source address lists for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_source_address_range | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets (inlined) source address ranges for the specified firewall rules. | BIG-IP_v11.5.0 |
| get_fw_rule_source_address_range_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the descriptions for the specified firewall rule source address ranges. | BIG-IP_v11.5.0 |
| get_fw_rule_source_geo | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets (inlined) source geo locations for the specified firewall rules. The geo location is a combination of country code and state name. The country code is two characters long. The state name is the full name of a state that belongs to the country represented by country code. | BIG-IP_v11.5.0 |
| get_fw_rule_source_geo_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the descriptions for the specified firewall rules&apos source geo locations. | BIG-IP_v11.5.0 |
| get_fw_rule_source_port | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets (inlined) source ports for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_source_port_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the descriptions for the specified firewall rules&apos (inlined) source ports. | BIG-IP_v11.3.0 |
| get_fw_rule_source_port_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets source port lists for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_source_vlan | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets source VLANs for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_state | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the state for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_fw_rule_statistics | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets the statistics for the specified firewall rules. | BIG-IP_v11.4.0 |
| get_fw_rule_weekly_schedule | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Gets a weekly schedule for the specified firewall rules. | BIG-IP_v11.3.0 |
| get_gtm_score | Returns the gtm scores for the specified virtual servers. | BIG-IP_v9.4.0 |
| get_httpclass_profile | As of v11.4.0 this function is deprecated immediately. Attempting to perform this function will return a not-implemented exception. Gets the lists of HTTP class profiles the specified virtual servers are associated with. If a specified virtual server is not associated with any HTTP class profile, then the list of HTTP class profiles for that virtual server will be empty. | BIG-IP_v9.2.0 |
| get_ip_intelligence_policy | Gets the IP intelligence policies for the specified virtual servers. | BIG-IP_v11.5.0 |
| get_last_hop_pool | Gets the last hop pools for the specified virtual servers. | BIG-IP_v9.0 |
| get_list | Gets a list of virtual servers. | BIG-IP_v9.0 |
| get_metadata | Gets the user metadata for the specified virtual servers. User metadata, also metadata for short, is mainly a name/value pair that is associated with a metadata capable config (MCC) object. Some exmaples of MCC objects are ltm pool and virtual server. The combination of the MCC object name and the metadata name uniguely identify an instance of the metadata. One MCC object may have multiple instances of metadata associated with it. In addition to name/value pair, metadata also has a persistence attribute. See Common::MetadataPersistence for its definition. | BIG-IP_v11.2.0 |
| get_metadata_description | Gets the metadata descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_metadata_persistence | Gets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_metadata_value | Gets the metadata values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_module_score | Returns the module scores for the specified virtual servers. | BIG-IP_v10.0.0 |
| get_nat64_state | Gets the NAT64 translation states for the specified virtual servers. | BIG-IP_v11.0.0 |
| get_object_status | Gets the status of each of the specified virtual servers. | BIG-IP_v9.0 |
| get_persistence_profile | Gets the lists of persistence profiles the specified virtual servers are associated with. | BIG-IP_v9.0 |
| get_persistence_record | Gets the persistence records based on the specified persistent modes for the specified virtual servers. | BIG-IP_v9.0 |
| get_profile | Gets the lists of profiles the specified virtual servers are associated with. | BIG-IP_v9.0 |
| get_protocol | Gets the protocols supported by the specified virtual servers. | BIG-IP_v9.0 |
| get_rate_class | Gets the rate classes that will be used to rate limit the traffic. | BIG-IP_v9.0 |
| get_rate_limit | Gets the rate limits for the specified virtual servers. | BIG-IP_v11.2.1 |
| get_rate_limit_destination_mask | Gets the rate limit destination masks for the specified virtual servers. | BIG-IP_v11.2.1 |
| get_rate_limit_mode | Gets the rate limit modes for the specified virtual servers. | BIG-IP_v11.2.1 |
| get_rate_limit_source_mask | Gets the rate limit source masks for the specified virtual servers. | BIG-IP_v11.2.1 |
| get_related_rule | Gets the lists of related rules the specified virtual servers are associated with. If a specified virtual server is not associated with any rule, then the list of rules for that virtual server will be empty. Related rules run only on the associated channel (such as the FTP data channel). | BIG-IP_v11.2.0 |
| get_rule | Gets the lists of rules the specified virtual servers are associated with. If a specified virtual server is not associated with any rule, then the list of rules for that virtual server will be empty. | BIG-IP_v9.0 |
| get_security_log_profile | Gets the lists of Security log profiles the specified virtual servers are associated with. | BIG-IP_v11.3.0 |
| get_snat_pool | This method has been deprecated due to adding large scale NAT as an address translation method (SNAT is no longer the only way to translate.) Please use get_source_address_translation_snat_pool in its stead. Gets the SNAT pools to be used in iSNAT configurations for the specified virtual servers. | BIG-IP_v9.0 |
| get_snat_type | This method has been deprecated due to adding large scale NAT as an address translation method (SNAT is no longer the only way to translate.) Please use get_source_address_translation_type in its stead. Gets the SNAT type for the specified virtual servers. | BIG-IP_v9.0 |
| get_source_address | Gets the source address for the specified virtual servers. | BIG-IP_v11.3.0 |
| get_source_address_translation_lsn_pool | Gets the LSN pools, if any, associated with the specified virtual servers. | BIG-IP_v11.3.0 |
| get_source_address_translation_snat_pool | Gets the SNAT pools, if any, associated with the specified virtual servers. | BIG-IP_v11.3.0 |
| get_source_address_translation_type | Gets the Source Address Translation type for the specified virtual servers. | BIG-IP_v11.3.0 |
| get_source_port_behavior | Gets the source port behavior for the specified virtual servers. | BIG-IP_v10.0.0 |
| get_staged_firewall_policy | Gets the firewall policies staged on the virtual servers. | BIG-IP_v11.4.0 |
| get_statistics | Gets the statistics for the specified virtual servers. | BIG-IP_v9.0 |
| get_traffic_acceleration_status | Gets the traffic acceleration status of the specified virtual servers, which specifies whether the virtual server is in use by traffic acceleration. | BIG-IP_v13.0.0 |
| get_translate_address_state | Gets the address translation states for the specified virtual servers. Enables or disables address translation. | BIG-IP_v9.0 |
| get_translate_port_state | Gets the port translation states for the specified virtual servers. Enables or disables port translation. | BIG-IP_v9.0 |
| get_type | Gets the types of the specified virtual servers. | BIG-IP_v9.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| get_vlan | Gets the lists of VLANs on which access to the specified Virtual Servers are enabled/disabled. | BIG-IP_v9.0 |
| get_wildmask | Gets the wildmasks for the specified virtual servers. | BIG-IP_v9.0 |
| remove_all_authentication_profiles | Removes all authentication profiles from the specified virtual servers. | BIG-IP_v9.0 |
| remove_all_clone_pools | Removes all clone pools from the specified virtual servers. | BIG-IP_v9.0 |
| remove_all_content_policies | Removes all of the Content Policies associated with the specified virtual servers. | BIG-IP_v12.0.0 |
| remove_all_fw_rule_destination_address_lists | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all destination address lists from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_all_fw_rule_destination_address_ranges | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all (inlined) destination address ranges from the specified firewall rules. | BIG-IP_v11.5.0 |
| remove_all_fw_rule_destination_addresses | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use remove_all_fw_rule_destination_address_ranges instead. Removes all (inlined) destination addresses from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_all_fw_rule_destination_geos | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all (inlined) destination geo locations from the specified firewall rules. | BIG-IP_v11.5.0 |
| remove_all_fw_rule_destination_port_lists | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all destination port lists from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_all_fw_rule_destination_ports | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all (inlined) destination ports from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_all_fw_rule_icmp_typecodes | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all (inlined) ICMP type/code values from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_all_fw_rule_source_address_lists | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all source address lists from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_all_fw_rule_source_address_ranges | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all (inlined) source address ranges from the specified firewall rules. | BIG-IP_v11.5.0 |
| remove_all_fw_rule_source_addresses | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use remove_all_fw_rule_source_address_ranges instead. Removes all (inlined) source addresses from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_all_fw_rule_source_geos | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all (inlined) source geo locations from the specified firewall rules. | BIG-IP_v11.5.0 |
| remove_all_fw_rule_source_port_lists | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all source port lists from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_all_fw_rule_source_ports | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all (inlined) source ports from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_all_fw_rule_source_vlans | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all source VLANs from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_all_fw_rules | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes all firewall rules from the specified virtual servers. | BIG-IP_v11.3.0 |
| remove_all_httpclass_profiles | As of v11.4.0 this function is deprecated immediately. Attempting to perform this function will return a not-implemented exception. Removes all HTTP class profiles from the specified virtual servers. | BIG-IP_v9.2.0 |
| remove_all_metadata | Removes all the metadata instances for the specified virtual servers. | BIG-IP_v11.2.0 |
| remove_all_persistence_profiles | Removes all persistence profiles from the specified virtual servers. | BIG-IP_v9.0 |
| remove_all_profiles | Removes all profiles from the specified virtual servers. | BIG-IP_v9.0 |
| remove_all_related_rules | Removes all rules from the specified virtual servers. | BIG-IP_v11.2.0 |
| remove_all_rules | Removes all rules from the specified virtual servers. | BIG-IP_v9.0 |
| remove_all_security_log_profiles | Removes all Security log profiles from the specified virtual servers. | BIG-IP_v11.3.0 |
| remove_authentication_profile | Removes authentication profiles from the specified virtual servers. | BIG-IP_v9.0 |
| remove_clone_pool | Removes clone pools from the specified virtual servers. | BIG-IP_v9.0 |
| remove_content_policy | Removes a list of Content Policies associated with the specified virtual servers. | BIG-IP_v12.0.0 |
| remove_fw_rule | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes firewall rules from the specified virtual servers. | BIG-IP_v11.3.0 |
| remove_fw_rule_destination_address | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use remove_fw_rule_destination_address_range instead. When using this method, the system will create a corresponding one-element address range where begin is equal to end. Removes (inlined) destination addresses from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_fw_rule_destination_address_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes destination address lists from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_fw_rule_destination_address_range | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes a list of (inlined) destination address ranges from the specified firewall rules. | BIG-IP_v11.5.0 |
| remove_fw_rule_destination_geo | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes (inlined) destination geo locations from the specified firewall rules. | BIG-IP_v11.5.0 |
| remove_fw_rule_destination_port | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes (inlined) destination ports from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_fw_rule_destination_port_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes destination port lists from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_fw_rule_icmp_typecode | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes (inlined) ICMP type/code values from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_fw_rule_source_address | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use remove_fw_rule_source_address_range instead. When using this method, the system will create a corresponding one-element address range where begin is equal to end. Removes (inlined) source addresses from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_fw_rule_source_address_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes source address lists from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_fw_rule_source_address_range | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes a list of (inlined) source address ranges from the specified firewall rules. | BIG-IP_v11.5.0 |
| remove_fw_rule_source_geo | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes (inlined) source geo locations from the specified firewall rules. | BIG-IP_v11.5.0 |
| remove_fw_rule_source_port | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes (inlined) source ports from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_fw_rule_source_port_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes source port lists from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_fw_rule_source_vlan | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Removes source VLANs from the specified firewall rules. | BIG-IP_v11.3.0 |
| remove_httpclass_profile | As of v11.4.0 this function is deprecated immediately. Attempting to perform this function will return a not-implemented exception. Removes HTTP class profiles from the specified virtual servers. | BIG-IP_v9.2.0 |
| remove_metadata | Removes the metadata for the specified virtual servers and names. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| remove_persistence_profile | Removes persistence profiles from the specified virtual servers. | BIG-IP_v9.0 |
| remove_profile | Removes profiles from the specified virtual servers. | BIG-IP_v9.0 |
| remove_related_rule | Removes rules from the specified virtual servers. | BIG-IP_v11.2.0 |
| remove_rule | Removes rules from the specified virtual servers. | BIG-IP_v9.0 |
| remove_security_log_profile | Removes Security log profiles from the specified virtual servers. | BIG-IP_v11.3.0 |
| reset_fw_rule_statistics | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Resets the statistics for the specified firewall rules. | BIG-IP_v11.4.0 |
| reset_statistics | Resets the statistics for the specified virtual servers. | BIG-IP_v9.0 |
| set_auto_lasthop | Sets the attribute that specifies auto-lasthop behavior, for the specified virtual servers. This controls how the system routes return traffic. The default is AUTO_LASTHOP_DEFAULT. | BIG-IP_v11.4.0 |
| set_bw_controller_policy | Sets the bandwidth controller policy for the specified virtual servers. | BIG-IP_v11.3.0 |
| set_cmp_enabled_state | Sets the CMP enabled states for the specified virtual servers. Enables or disables CMP. Note that this setting can influence the CMP enable mode set automatically by the system and configuration. You can not always enable CMP, but you can always disable it. | BIG-IP_v9.4.0 |
| set_connection_limit | Sets the connection limits of the specified virtual servers. | BIG-IP_v9.0 |
| set_connection_mirror_state | Sets the mirror connection states for the specified virtual servers. | BIG-IP_v9.0 |
| set_contribute_to_address_status | Sets the attribute on the virtual servers determining whether it participates in the operational status of its associated virtual address. If &apostrue&apos, a virtual server&aposs status is taken into consideration when calculating the associated virtual address&apos status. | BIG-IP_v11.5.1 |
| set_default_pool_name | Sets the default pool names for the specified virtual servers. | BIG-IP_v9.0 |
| set_description | Sets the description for a set of virtual servers. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_destination | This method has been deprecated due to changing the virtual address key. Please use set_destination_v2 in its stead. Sets the destination IP and port for the specified virtual servers. | BIG-IP_v9.0 |
| set_destination_v2 | Sets the destination virtual address and port for the specified virtual servers. | BIG-IP_v11.0.0 |
| set_enabled_state | Sets the enabled state of the specified virtual servers. | BIG-IP_v9.0 |
| set_enforced_firewall_policy | Sets the enforced firewall policies on the virtual servers. The enforced policy&aposs rules are enforced as if the same rules were defined as inline rules. The empty string means no enforced policy. The enforced firewall policy is mutually exclusive with inline rules. | BIG-IP_v11.4.0 |
| set_eviction_policy | Sets the eviction policy assigned to the specified virtual servers. | BIG-IP_v11.6.0 |
| set_fallback_persistence_profile | Sets the persistence profiles to use for fallback persistence for the specified virtual servers. | BIG-IP_v9.0 |
| set_fw_rule_action | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the action for the specified firewall rules. | BIG-IP_v11.3.0 |
| set_fw_rule_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the description for the specified firewall rules. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_fw_rule_destination_address_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use set_fw_rule_destination_address_range_description instead. Sets the description for the specified firewall rules&apos destination addresses. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_fw_rule_destination_address_range_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the descriptions for the specified firewall rule destination address ranges. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.5.0 |
| set_fw_rule_destination_geo_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the description for the specified firewall rules&apos destination geo locations. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.5.0 |
| set_fw_rule_destination_port_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the description for the specified firewall rules&apos (inlined) destination ports. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_fw_rule_icmp_typecode_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the description for the specified firewall rules&apos (inlined) ICMP type/code values. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_fw_rule_irule | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the iRules for the specified firewall rules. Specify the iRule as an action when the traffic matches the filter criteria. | BIG-IP_v11.5.0 |
| set_fw_rule_log_state | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the logging property for the specified firewall rules. Specifies whether the security software should write a log entry for all packets that match this rule. You must also enable network filter logging in the “security log profile” component for this option to have any effect. Note that the security software always increments the statistics counter when a packet matches a rule, no matter how you set this option. | BIG-IP_v11.4.0 |
| set_fw_rule_order | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the order (numerically) for the specified firewall rules. Two rules can&apost have the same order, so one must manage order carefully if using numeric order to arrange firewall rules. See add_fw_rule for more information. | BIG-IP_v11.3.0 |
| set_fw_rule_protocol | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the (IP) protocol for the specified firewall rules. Note: if the protocol is not one of the supported standard protocols, use set_fw_rule_protocol_numeric. | BIG-IP_v11.3.0 |
| set_fw_rule_protocol_numeric | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the IP protocol (numerically) for the specified firewall rules. | BIG-IP_v11.3.0 |
| set_fw_rule_rule_list | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the rule list for the specified firewall rules. If a list is specified then the system will validate that no other properties were specified in the current transaction, and will clear all other match criteria fields (src, dst, ip protocol, et cetera). The empty string means no rule list. | BIG-IP_v11.3.0 |
| set_fw_rule_source_address_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. This method has been deprecated. Please use set_fw_rule_source_address_range_description instead. Sets the description for the specified firewall rules&apos source addresses. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_fw_rule_source_address_range_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the descriptions for the specified firewall rule source address ranges. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.5.0 |
| set_fw_rule_source_geo_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the description for the specified firewall rules&apos source geo locations. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.5.0 |
| set_fw_rule_source_port_description | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the description for the specified firewall rules&apos (inlined) source ports. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_fw_rule_state | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets the state for the specified firewall rules. You can add a rule as enabled or disabled initially, build it up, then enable it. You can temporarily disable a rule with no other effect on it, so that it can be enabled easily later without having to rebuild it. You can use the state of FW_RULE_STATE_SCHEDULED to enable scheduling for the rule. See add_fw_rule for more information. | BIG-IP_v11.3.0 |
| set_fw_rule_weekly_schedule | *IMPORTANT* This method has been deprecated immediately. As of v11.6.0, attempting to perform this method will return a not-implemented exception. Sets a weekly schedule for the specified firewall rules. See Security::FirewallWeeklySchedule for how to create and manipulate weekly schedules. | BIG-IP_v11.3.0 |
| set_gtm_score | Sets the gtm score for the specified virtual servers. | BIG-IP_v9.4.0 |
| set_ip_intelligence_policy | Sets the IP intelligence policies for the specified virtual servers. Specifies an existing IP intelligence policy which is applied to all packets passing through the virtual server. | BIG-IP_v11.5.0 |
| set_last_hop_pool | Sets the last hop pools for the specified virtual servers. | BIG-IP_v9.0 |
| set_metadata_description | Sets the descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_metadata_persistence | Sets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_metadata_value | Sets the values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_nat64_state | Sets the NAT64 translation states for the specified virtual servers. When this setting is enabled, the system translates IPv6 to IPv4 by chopping off the first 96 bits of the incoming destination address. The remaining 32 bits are kept as an IPv4 address and used as the translation destination. | BIG-IP_v11.0.0 |
| set_protocol | Sets the protocols supported by the specified virtual servers, one of IP, TCP or UDP. | BIG-IP_v9.0 |
| set_rate_class | Sets the rate classes that will be used to rate limit the traffic. | BIG-IP_v9.0 |
| set_rate_limit | Sets the rate limits of the specified virtual servers. | BIG-IP_v11.2.1 |
| set_rate_limit_destination_mask | Sets the rate limit destination masks of the specified virtual servers. The mask is applied against the destination address when the mode specifies using the source address as part of the rate limiting categorization. Setting this value to &apos0&apos is the equivalent of using the entire IP address. | BIG-IP_v11.2.1 |
| set_rate_limit_mode | Sets the rate limit modes of the specified virtual servers. Indicates whether the rate limit is applied per virtual object, per source address, per destination address, or some combination thereof. The default value is &aposRATE_LIMIT_MODE_OBJECT&apos, which does not use the source or destination address as part of the key. | BIG-IP_v11.2.1 |
| set_rate_limit_source_mask | Sets the rate limit source masks of the specified virtual servers. The mask is applied against the source address when the mode specifies using the source address as part of the rate limiting categorization. Setting this value to &apos0&apos is the equivalent of using the entire IP address. | BIG-IP_v11.2.1 |
| set_snat_automap | This method has been deprecated due to adding large scale NAT as an address translation method (SNAT is no longer the only way to translate.) Please use set_source_address_translation_automap in its stead. Sets the SNAT automap state for the specified virtual servers. | BIG-IP_v9.0 |
| set_snat_none | This method has been deprecated due to adding large scale NAT as an address translation method (SNAT is no longer the only way to translate.) Please use set_source_address_translation_none in its stead. Sets the state to use no SNATs for the specified virtual servers. | BIG-IP_v9.0 |
| set_snat_pool | This method has been deprecated due to adding large scale NAT as an address translation method (SNAT is no longer the only way to translate.) Please use set_source_address_translation_snat_pool in its stead. Sets the SNAT pools to be used in iSNAT configurations for the specified virtual servers. | BIG-IP_v9.0 |
| set_source_address | Sets the source addresses for the specified virtual servers. This specifies an IP address or network from which the virtual server will accept traffic. | BIG-IP_v11.3.0 |
| set_source_address_translation_automap | Sets the source address translation to automap (i.e. use self IP addresses) for the specified virtual servers. | BIG-IP_v11.3.0 |
| set_source_address_translation_lsn_pool | Sets the translation of the specified virtual servers to use Large Scale NAT pools. | BIG-IP_v11.3.0 |
| set_source_address_translation_none | Sets the state to use no translation for the specified virtual servers. | BIG-IP_v11.3.0 |
| set_source_address_translation_snat_pool | Sets the translation of the specified virtual servers to use SNAT pools. | BIG-IP_v11.3.0 |
| set_source_port_behavior | Sets the source port behavior for the specified virtual servers. | BIG-IP_v10.0.0 |
| set_staged_firewall_policy | Sets the staged firewall policies on the virtual servers. The staged policy&aposs rules provide the visibility only (statistics, logging events and network reports) of what would happen if the rules were enforced. They are actually not enforced. The empty string means no staged policy. | BIG-IP_v11.4.0 |
| set_translate_address_state | Sets the address translation states for the specified virtual servers. Enables or disables address translation. | BIG-IP_v9.0 |
| set_translate_port_state | Sets the port translation states for the specified virtual servers. Enables or disables port translation. | BIG-IP_v9.0 |
| set_type | Sets the types for the specified virtual servers. | BIG-IP_v9.0 |
| set_vlan | Sets VLANs to the list of VLANs on which access to the specified Virtual Servers are enabled/disabled. | BIG-IP_v9.0 |
| set_wildmask | Sets the wildmasks for the specified virtual servers. | BIG-IP_v9.0 |
Structures¶
Structure
Description
A struct that describes the virtual server&aposs authentication profile and its attributes.
A struct that describes the virtual server&aposs pool and its attributes.
Note that this struct has been deprecated immediately as of v11.4.0. A struct that describes the virtual server&aposs HTTP class profile name and its priority.
A struct that describes a virtual server&aposs module score.
A struct that describes the virtual server&aposs persistence profile and its attributes.
A struct that describes the profile name and its profile context.
A struct that describes the profile name, profile type, and profile context.
A struct that describes the virtual server&aposs resource type and resources.
A struct that describes the virtual server&aposs rule and its attributes.
A struct that describes a virtual server and its statistics.
A struct that describes virtual server statistics and timestamp.
Enumerations¶
| Enumeration | Description |
| SourceAddressTranslationType | A list of source address translation types. |
| VirtualServerCMPEnableMode | A list of CMP enable modes. |
| VirtualServerType | A list of virtual server types. |
Aliases¶
| Alias | Type | Description |
| SourceAddressTranslationTypeSequence | SourceAddressTranslationType [] | A sequence of SourceAddressTranslationType&aposs. |
| VirtualServerAuthenticationSequence | VirtualServerAuthentication [] | A sequence of virtual server authentication profiles. |
| VirtualServerAuthenticationSequenceSequence | VirtualServerAuthentication [] [] | An alias of sequence of virtual server authentication profiles. |
| VirtualServerCMPEnableModeSequence | VirtualServerCMPEnableMode [] | A sequence of virtual server CMPEnableMode items. |
| VirtualServerClonePoolSequence | VirtualServerClonePool [] | A sequence of clone pool names. |
| VirtualServerClonePoolSequenceSequence | VirtualServerClonePool [] [] | An alias of sequence of clone pool names. |
| VirtualServerHttpClassSequence | VirtualServerHttpClass [] | Note that this sequence has been deprecated immediately as of v11.4.0. A sequence of profile types and names. |
| VirtualServerHttpClassSequenceSequence | VirtualServerHttpClass [] [] | Note that this sequencesequence has been deprecated immediately as of v11.4.0. An alias of sequence of profile types and names. |
| VirtualServerModuleScoreSequence | VirtualServerModuleScore [] | A sequence of virtual server module scores. |
| VirtualServerModuleScoreSequenceSequence | VirtualServerModuleScore [] [] | An alias of sequence of virtual module scores. |
| VirtualServerPersistenceSequence | VirtualServerPersistence [] | A sequence of virtual persistence profiles. |
| VirtualServerPersistenceSequenceSequence | VirtualServerPersistence [] [] | An alias of sequence of virtual persistence profiles. |
| VirtualServerProfileAttributeSequence | VirtualServerProfileAttribute [] | A sequence of profile types and names. |
| VirtualServerProfileAttributeSequenceSequence | VirtualServerProfileAttribute [] [] | An alias of sequence of profile types, contexts, and names. |
| VirtualServerProfileSequence | VirtualServerProfile [] | A sequence of profile types and names. |
| VirtualServerProfileSequenceSequence | VirtualServerProfile [] [] | An alias of sequence of profile types and names. |
| VirtualServerResourceSequence | VirtualServerResource [] | A sequence of virtual server resource types and names. |
| VirtualServerRuleSequence | VirtualServerRule [] | A sequence of rule names. |
| VirtualServerRuleSequenceSequence | VirtualServerRule [] [] | An alias of sequence of rule names. |
| VirtualServerStatisticEntrySequence | VirtualServerStatisticEntry [] | A sequence of virtual server statistics. |
| VirtualServerTypeSequence | VirtualServerType [] | A sequence of virtual server types. |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
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.