LocalLB¶
Introduced : BIG-IP_v9.0
The LocalLB module contains the Local Load Balancing interfaces that
enable you to get information on and work with the components,
attributes, and devices associated with a local load balancer.
Interfaces¶
| Interface | Description |
| ALGLogProfile | Application level gateway (ALG) log profile controls logging for supported ALG. Currently supports Profile FTP, SIP, and RTSP, the log profile allows control of events that get logged, as well as the triggering action, and optional elements of log messages. |
| CipherGroup | The CipherGroup interface enables you to manipulate the cipher group parameters. Cipher groups are collections of cipher rules that are combined and ultimately result in a list of ciphers used by the client-ssl and server-ssl profiles. |
| CipherRule | The CipherRule interface enables you to manipulate the cipher rule parameters. Cipher Rules are bundled together in Cipher Groups which ultimately determines the ciphers (and their order) available to client-ssl and server-ssl profiles. |
| Class | The Class interface enables you to manipulate a local load balancer’s Class attributes. There are 3 different Class types: Address, String, and Value. |
| ContentPolicy | The Content Policy interface configures the list of Content Policies used by the Content Policy Manager to modify and redirect traffic based upon a set of Content Policy Conditions a connection could match and Content Policy Actions taken based on those conditions matched. Given the nature of Content Policies, a user of this API should familiarize themselves with iControl transactions described in the System::Session interface. As a guide for creating the list of valid Content Policy Conditions, the allowable configurations are listed below. A Content Policy Operand Type is given with the Content Policy Requires needed on the Content Policy, the Content Policy Events that can be selected upon, the specific Content Policy Selectors that can be used, and the functions used to configure those selectors. |
| ContentPolicyStrategy | The Content Policy Strategy interface configures how Content Policy Rules will be matched on a Content Policy (See: LocalLB::ContentPolicy). Given the nature of Content Policy Strategies, a user of this API should familiarize themselves with iControl transactions described in the System::Session interface. |
| `DNSCache <LocalLB__DNSCache.html >`__ | The DNSCache interface allows you to manage DNS caches. There are three types of DNS caches depending on whether DNS resolving and DNSSEC validation are needed: Transparent - cache with no resolving nor DNSSEC validation. Resolver - cache which resolves DNS but does not validate DNSSEC. Validating Resolver - cache which resolves DNS and validates DNSSEC. Each cache has multiple internal caches described below. For answering DNS queries, the message cache will be checked first followed by the resource record cache: Message Cache - cache of entire DNS messages. Resource Record Cache - cache of individual resource records. Name Server Cache - cache of name servers obtained from DNS resolving. DNSSEC Key Cache - cache of keys obtained from validating DNSSEC. |
| DNSExpress | *IMPORTANT* Note that this interface has been deprecated as of v11.5.0. The TSIG related methods in this interface are moved to the new interface DNSTSIGKey. The zone related methods are moved to the new interface DNSZone. A new interface DNSServer is created. Each zone may have at most one DNS Express server and many transfer servers. Transfer target and TSIG key are now associated with a server. The DNSExpress interface allows you to create and maintain DNS Express zones and manage DNS Express TSIG keys. A DNS Express zone allows the system to answer DNS requests authoritatively based on information transferred from a DNS server (the transfer target). |
| DNSGlobals | The DNSGlobals interface allows you to manage global DNS settings. This currently only contains DNS cache settings, but will include any and all DNS-related global settings in the future. |
| DNSServer | The DNSServer interface allows you to create, maintain and configure DNS servers. A DNS server can be either an authoritative name server or a slaver name server. Each DNS server has an IP address, port number and route domain. Also a TSIG key may be associated with a server object for zone transfer. Users are allowed to create and delete server objects, query and reset the statistics of these servers. They are also allowed to set and get IP addresses, port numbers, route domains of the server objects and TSIG keys associated with them. |
| DNSTSIGKey | The DNSTSIGKey interface allows you to create and maintain DNS TSIG keys. |
| DNSZone | The DNSZone interface allows you to create and maintain DNS zones. A DNS zone may have one DNS Express server and several transfer clients. A DNS Express server is a name server which is used to transfer zone data to BIG-IP. A transfer client is a name server which is allowed to transfer zone data from BIG-IP. |
| DataGroupFile | External data group configuration file. These files are intimately tied into the configuration, such that any change to the file itself is treated as a change to the configuration. Such files are also integrated into a file cache for more complete control. |
| FlowEvictionPolicy | The FlowEvictionPolicy interface enables you to define flow eviction policy. It provides a user-controlled way to adjust how and when flows are swept, based on virtual server, route domain, and global constraints. In this context, a flow refers to a TCP connection. These policies define how the connections are evicted from the connection flow table in TMM. Multiple bias algorithms can be enabled at the same time. |
| LSNLogProfile | LSN log profile controls which events of the LSN translation gets logged, as well as the action and the triggering event. A LSN log profile can be referenced from a LSN pool. |
| LSNPool | The LSN pool interface enables you to work with the definitions contained in a local load balancer’s LSN pool. LSN stands for Large Scale Network Address Translation (and is also known as Carrier Grade Network Address Translation, CGNAT). An LSN pool is a set of networks and port numbers that can be translated to one or more subscriber or client IP addresses. NOTE: Translation addresses in an LSN pool are not self-IP addresses. When a subscriber or client device seeks to connect to a server via the service provider, the client’s IP address is translated based on the specifications of the LSN pool that the client classifies into. Translation can be performed in: - Deterministic mode (Deterministic Network Address Translation or DNAT) - Network Address Port Translation mode (or NAPT mode). - Port Block Allocation mode (or PBA mode). Either a virtual server or an iRule can reference an LSN pool. |
| MessageRoutingPeer | The MessageRoutingPeer interface enables you to work with the definitions contained in a message routing peer. A peer specifies the pool for the message parser to use as the destination for message routes. You can also use the peer component to specify how many connections the parser creates to a remote host and which MessageRoutingTransportConfig the parser uses to establish the connection. |
| MessageRoutingSIPRoute | The MessageRoutingSIPRoute interface specifies the static routes to use for SIP message routing. A route specifies an ordered list of peers to use for forwarding messages. See LocalLB::MessageRoutingPeer for more details. |
| MessageRoutingTransportConfig | The MessageRoutingTransportConfig interface enables you to work with the definitions contained in a message routing transport_config. The transport_config is used by the message router to create an outgoing connection. |
| Monitor | The Monitor interface enables you to manipulate a local load balancer’s monitor templates and instances. For example, use the Monitor interface to enable or disable a monitor instance, or to create a monitor template, or to get and set different attributes of a monitor template. |
| NAT | *IMPORTANT* This entire interface has been deprecated (as of 11.0.0) in favor of NATV2, which uses a name of the NAT for the key everywhere instead of translation/origin address. The NAT interface enables you to work with the statistics and definitions contained in a local load balancer’s network address translations (NAT). For example, use the NAT interface to both get and set the NAT statistics and attributes of a local load balancer. |
| NATV2 | The NAT interface enables you to work with the statistics and definitions contained in a local load balancer’s network address translations (NAT). For example, use the NAT interface to both get and set the NAT statistics and attributes of a local load balancer. Note: The NAT interface has been changed with respect to the prior version; it now uses a name everywhere for the NAT key, hence the changed name, NATV2. |
| NodeAddress | *IMPORTANT* This entire interface has been deprecated (as of 11.0.0), due to the change from using IP addresses to using names to identify node addresses. Please use the NodeAddressV2 interface. The NodeAddress interface enables you to work with the states, statistics, limits, availability, ratios, application response deltas, and monitors of a local load balancer’s node address. |
| NodeAddressV2 | The NodeAddress interface enables you to work with the states, statistics, limits, availability, ratios, application response deltas, and monitors of a local load balancer’s node address. This updated interface is required to support the switch from accessing node addresses via their IP address to their name. |
| OCSPStaplingParameters | *IMPORTANT* This entire interface has been deprecated (as of v13.0.0). The functionality has been moved into the CertificateValidatorOCSP interface. The OCSPStaplingParameters interface enables you to manipulate the Online Certificate Status Protocol stapling parameters. OCSP stapling parameters specify the options needed for the TLS extension of certificate status request. This set of parameters is associated with a certificate-key-chain object in a clientSSL profile. |
| Pool | The Pool interface enables you to work with attributes, and statistics for pools. You can also use this interface to create pools, add members to a pool, delete members from a pool, find out the load balancing mode for a pool, and set the load balancing mode for a pool. |
| PoolMember | *IMPORTANT* This entire interface has been deprecated (as of 11.0.0). The functionality has been moved into the Pool interface. The PoolMember interface enables you to work with the pool members and their settings, and statistics. |
| ProfileAnalytics | The ProfileAnalytics interface enables you to manipulate a local load balancer’s Analytics profile. Use the analytics profile interface to add, modify or remove an analytics profile. Modifying an analytics profile can include: - Setting flags which specify which metrics are collected. - Setting flags which specify notification targets for alerts. - Adding or removing references to profiled virtual servers. - Adding or removing configured alerts. - Adding or removing predefined subnets. - Adding or removing traffic capture. |
| ProfileAuth | The ProfileAuth interface enables you to manipulate a local load balancer’s authentication profile. |
| ProfileClassification | The ProfileClassification interface enables you to manipulate a local load balancer’s classification profile. This specifies whether traffic sent to this virtual server is classified to different categories such as web, audio_video, P2P, and mail or to different applications such as facebook and youtube. The system automatically enables classification for virtual servers as needed when you create a policy enforcement listener. |
| ProfileClientLDAP | The ClientLDAP Profile interface configures the handling of the LDAP STARTTLS protocol. The ClientLDAP Profile facilitates allowing STARTTLS to be terminated at the system. STARTTLS allows the client to request that communications on this connection should be encrypted. This profile has the dual advantages of being able to terminate the connection on the system as well as to support this functionality even if the backend LDAP server does not. |
| ProfileClientSSL | The ProfileClientSSL interface enables you to manipulate a local load balancer’s client SSL profile. |
| ProfileDNS | The ProfileDNS interface enables you to manipulate a local load balancer’s DNS profile. |
| ProfileDNSLogging | The DNS Logging interface allows you to manage DNS Logging profiles. There are two components of DNS Logging profiles, Query Logging and Response logging. You may configure a logging profile with either or both of them enabled. The format of logs can be configured by enabling/disabling log parameters. Note: You attach a DNS Logging Profile to a DNS Profile, not to a Virtual Server. |
| ProfileDiameter | The ProfileDiameter interface enables you to manipulate a local load balancer’s Diameter profile. |
| ProfileDiameterEndpoint _ | The ProfileDiameterEndpoint interface enables you to manipulate a local load balancer’s DiameterEndpoint profile. The Diameter base protocol is intended to provide an Authentication, Authorization and Accounting (AAA) framework for applications such as network access or IP mobility. Diameter is also intended to work in both local Authentication, Authorization & Accounting and roaming situations. On top of it, there are some different application types e.g. Gx (communication between Policy Charging Rules Function (PCRF) and Policy Charging Enforcement Function (PCEF)), Gy (charging) etc. The PEM (Policy Enforcement Manager) module uses this profile. |
| ProfileDiameterRouter | The ProfileDiameterRouter interface configures the router instance for message routing Diameter processing. It’s used to define the set of static routes across the router instance. See LocalLB::MessageRoutingDiameterRo ute for more details about static routes. |
| ProfileDiameterSession | The ProfileDiameterSession interface enables you to manipulate a local load balancer’s Diameter Session profile. |
| ProfileFIX | The ProfileFIX interface enables you to manipulate a local load balancer’s FIX (Financial Information eXchange Protocol) profile. |
| ProfileFTP | The ProfileFTP interface enables you to manipulate a local load balancer’s FTP profile. |
| ProfileFastHttp | The ProfileFastHttp interface enables you to manipulate a local load balancer’s Fast HTTP profile. |
| ProfileFastL4 | The ProfileFastL4 interface enables you to manipulate a local load balancer’s L4 profile. |
| ProfileHttp | The ProfileHttp interface enables you to manipulate a local load balancer’s HTTP profile. |
| ProfileHttpClass | *IMPORTANT* This entire interface has been deprecated immediately. As of v11.4.0, attempting to perform any of the functions in this interface will return a not-implemented exception. The ProfileHttpClass interface enables you to manipulate a local load balancer’s ability to classify HTTP traffic. |
| ProfileHttpCompression | The ProfileHttpCompression interface enables you to manipulate a local load balancer’s HTTP compression profile. |
| ProfileICAP | The ProfileICAP interface enables you to manipulate a local load balancer’s ICAP (Internet Content Adaptation Protocol) profile. |
| ProfileIIOP | *IMPORTANT* This entire interface has been deprecated immediately. As of v13.0.0, attempting to use any of the functions in this interface will return a not implemented exception. The ProfileIIOP interface enables you to manipulate a local load balancer’s IIOP profile. |
| ProfileIPsecALG | The ProfileIPsecALG interface enables you to manipulate a local Application-Layer Gateway (ALG) Internet Protocol Security (IPsec) profile. The IPsecALG Profile will allow creating server/client translation addresses for IPsec tunnels to a remote IPSec server created by Internet Key Exchange (IKE/IKEv2) or by manual keying, allowing the use of IPsec security protocols in a CGNAT setup. |
| ProfileOneConnect | The ProfileOneConnect interface enables you to manipulate a local load balancer’s OneConnect profile. |
| ProfilePCP | The ProfilePCP interface enables you to specify a set of predefined Port Control Protocol parameters so that it can be used together to govern the processing of PCP incoming requests. PCP (Port Control Protocol) is a protocol that provides more seamless NAT traversal by allowing communication and control of port/address mappings and session lifetimes between the NAT and the NAT’ed client. The application or CPE requests a NAT mapping and the PCP Server collocated with the CGNAT device responds with the mapped address and port and session lifetime. |
| ProfilePPTP | The ProfilePPTP interface enables you to manipulate a local load balancer’s PPTP profile. PPTP is a tunneling protocol used as a secure VPN tunnel. It tunnels PPP which was originally a dial-up protocol, on an IP network. PPTP (RFC 2637) defines two communication channels - a control channel over TCP and the data channel over GRE. |
| ProfilePersistence | The ProfilePersistence interface enables you to manipulate a local load balancer’s Persistence profile. |
| ProfileRADIUS | The ProfileRADIUS interface enables you to manipulate a local load balancer’s RADIUS profile. |
| ProfileRTSP | The ProfileRTSP interface enables you to manipulate a local load balancer’s RTSP profile. |
| ProfileRequestAdapt | The ProfileRequestAdapt interface enables you to manipulate a local load balancer’s Request Adaptation profile. |
| ProfileRequestLogging | The request logging profile configures the high-speed logging of L7 requests. The logging can be performed both before and after the request is processed (or connection is made). The logging can also be re-directed if an error has occurred when logging. Thus configuration exists to control five independent different cases. request logs a request before its processing to the primary log servers. request_secondary logs error messages to secondary log servers if pre-request logging fails. proxy sends an alternate response to the client if pre-request logging fails. response logs the response after its processing to the primary log servers. response_secondary logs error messages to secondary log servers if response logging fails. Each case can be configured separately. |
| ProfileResponseAdapt | The ProfileResponseAdapt interface enables you to manipulate a local load balancer’s Response Adaptation profile. |
| ProfileSCTP | The ProfileSCTP interface enables you to manipulate a local load balancer’s SCTP profile. |
| ProfileSIP | The ProfileSIP interface enables you to manipulate a local load balancer’s SIP profile. |
| ProfileSIPRouter | The ProfileSIPRouter interface configures the router instance for message routing SIP (Router Initiation Protocol) processing. It’s used to define the set of static routes across the router instance. See LocalLB::MessageRoutingSIPRoute for more details about static routes. |
| ProfileSIPSession | The ProfileSIPSession interface configures the handling of message routing SIP (Session Initiation Protocol) processing. This profile includes settings which affect the SIP message processing. This profile needs to be associated with each virtual server and each peer (see LocalLB::MessageRoutingPeer) which is used in the routing instance. The virtual server and peer(s) process the ingress/egress messages per the settings of this profile. Multiple profiles can be in use in a single routing instance. |
| ProfileSMTPS | The SMTPS Profile interface configures the handling of the SMTP STARTTLS protocol. The SMTPS Profile facilitates allowing STARTTLS to be terminated at the system. STARTTLS allows the client to request that communications on this connection should be encrypted. This profile has the dual advantages of being able to terminate the connection on the system as well as to support this functionality even if the backend SMTP server does not. |
| ProfileSPDY | *IMPORTANT* This entire interface has been deprecated immediately. As of BIG-IP_v13.0.0, attempting to perform any of the functions in this interface will return a not-implemented exception. The SPDY Profile interface configures the handling of the SPDY protocol. The SPDY Profile facilitates conversion of HTTP traffic from a back-end server to clients across the BIG-IP. |
| ProfileSPM | The ProfileSPM interface enables you to manipulate a local load balancer’s Subscriber Policy Manager (SPM) profile. If a subscriber does not have policies assigned to it either dynamically or statically, it is an unknown subscriber. Otherwise, the subscriber has its own policies. On top of that, there are global policies that can be applied to all subscribers (subscribers with their own polices or unknown subscribers). |
| ProfileServerLDAP | The ServerLDAP Profile interface configures the handling of the LDAP STARTTLS protocol. The ServerLDAP Profile facilitates allowing STARTTLS to be terminated at the system. STARTTLS allows the client to request that communications on this connection should be encrypted. This profile has the dual advantages of being able to terminate the connection on the system as well as to support this functionality even if the backend LDAP server does not. |
| ProfileServerSSL | The ProfileServerSSL interface enables you to manipulate a local load balancer’s server SSL profile. |
| ProfileStream | The ProfileStream interface enables you to manipulate a local load balancer’s stream profile. |
| ProfileTCP | The ProfileTCP interface enables you to manipulate a local load balancer’s TCP profile. |
| ProfileTCPAnalytics | The ProfileTCPAnalytics interface enables you to manipulate a local load balancer’s TCP Analytics profile. When this profile is attached to a virtual, it allows collection of TCP performance statistics on a virtual that has a FastL4 or TCP profile if AVR is enabled. |
| ProfileTFTP | The ProfileTFTP interface enables you to manipulate a local Trivial File Transfer Protocol (TFTP) profile. The TFTP ALG Profile will establish the TFTP flows and listeners and remove them on error or completion of the transfer. UDP flows rely on a timeout expiration to detect the completion. ALGs do not have visibility over the actual data to detect if the transfer has completed. |
| ProfileTrafficAcceleration | The ProfileTrafficAcceleration interface enables you to manipulate a local load balancer’s TrafficAcceleration profile. A TrafficAcceleration profile is used to denote a virtual server is in use by and dedicated to Traffic Acceleration. A virtual server cannot contain another profile if it includes a TrafficAcceleration profile. |
| ProfileUDP | The ProfileUDP interface enables you to manipulate a local load balancer’s UDP profile. |
| ProfileUserStatistic | The ProfileUserStatistic interface enables you to manage user-defined statistics in a profile. The user can define up to 32 user-defined statistics in each profile. |
| ProfileWebAcceleration | The ProfileWebAcceleration interface enables you to manipulate a local load balancer’s web acceleration profiles. |
| ProfileXML | The ProfileXML interface enables you to manipulate a local load balancer’s XML profile. |
| RAMCacheInformation | The RAMCacheInformation interface enables you to query for RAM cache entries/statistics, as well as evicting RAM cache entries. |
| RateClass | The RateClass interface enables you to work with the definitions and attributes of a rate class class. Rate filtering refers to the ability to enforce configurable bandwidth consumption limitations upon user-defined traffic classes. The purpose of a Rate class is to allow the network administrator to effectively divide a single bandwidth resource through a gateway among preferred applications or traffic classes. Rate filtering is somewhat related to packet filtering. The key difference between the two is that packet filters seek to enforce an access policy on traffic, and Rate Filter classes seek to enforce a throughput policy on traffic. |
| Rule | The Rule interface enables you to manipulate a local load balancer’s rules. For example, use the Rule interface to get a list of all rules, create rules, delete rules, modify rules, and query rules. |
| SNAT | The SNAT interface enables you to work with the definitions contained in a local load balancer’s top-level secure network address translations (SNAT) object. The top-level SNAT configuration object is a named object in the definition of a standard or a selective SNAT. Standard SNATs translate to a single address, while selective SNATs translate to a pool of translation addresses, i.e. SNAT pool. |
| `SNATPool <LocalLB__SNATPool.html >`__ | The SNATPool interface enables you to work with the definitions contained in a local load balancer’s SNAT pool, which is a set of translation addresses. Either a virtual server, an iRule or a top-level SNAT object can reference a SNAT pool. |
| SNATPoolMember | *IMPORTANT* This entire interface has been deprecated (as of 11.0.0). Its functionality has been moved to the SNATPool interface. The SNATPoolMember interface enables you to work with the SNATPool members and their settings, and statistics. |
| SNATTranslationAddress | *IMPORTANT* This entire interface has been deprecated (as of 11.0.0), due to the change from using IP address to using names for identifying SNAT translation addresses. Please use the SNATTranslationAddressV2 interface. The SNATTranslationAddress interface enables you to work with the definitions contained in a local load balancer’s SNAT translation address. A translation address defines an address to which a client address may be translated on the server side. |
| SNATTranslationAddressV2 | The SNATTranslationAddress interface enables you to work with the definitions contained in a local load balancer’s SNAT translation address. A translation address defines an address to which a client address may be translated on the server side. |
| VirtualAddress | *IMPORTANT* This entire interface has been deprecated (as of 11.0.0), due to the change from using IP addresses to using names to identify virtual addresses. Please use the VirtualAddressV2 interface. The VirtualAddress interface enables you to work with the states, statistics, limits, availability, and settings of a local load balancer’s virtual address. |
| VirtualAddressV2 | The VirtualAddressV2 interface enables you to work with the states, statistics, limits, availability, and settings of a local load balancer’s virtual address. The second version was created to handle the shift from using the IP address to using a name to reference a virtual address. |
| VirtualServer | The VirtualServer interface enables you to work with the states, statistics, limits, availability, and settings of a local load balancer’s 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. |
| iFile | The iFile interface enables you to manipulate a local load balancer’s iFiles. iFiles provide the ability to load an external file into iRules that can be accessed by an iRule using the “ifile” command. To create an iFile, you must first create an iFile file object that loads the file into the system. Then use this interface to create the iFile that can be used by the iRule. |
| iFileFile | The iFileFile interface enables you to manipulate a local load balancer’s iFile file objects. iFiles provide the ability to load an external file into iRules that can be accessed by an iRule using the “ifile” command. To create an iFile, you must first use this interface to create an iFile file object that loads the file into the system. Then use the iFile interface to create the iFile that can be used by the iRule. |
Structures¶
Structure
Description
A struct that describes a pattern, represented either as a glob or a regular expression.
A struct that describes a monitored node address.
A struct that describes monitored node server definition, used in the destination address:port of the monitor template.
A struct that describes a monitor instance.
A struct that describes a monitor instance state.
An struct that specifies a monitor rule.
An struct that specifies an object status.
A struct that describes a persistence record.
A structure that specifies an ActivationMode enum used in profile attributes.
A structure that specifies an Adaptation Service Down Action.
A structure that specifies a profile&aposs authentication method.
ProfileClientSSLCertificateMode
A structure that specifies a profile client-side SSL certificate mode.
A structure that specifies a profile&aposs compression method.
ProfileCookiePersistenceMethod
A structure that specifies a profile&aposs cookie persistence method.
A structure that specifies a profile&aposs credential source.
A structure that specifies an enabled/disabled state used in profile attributes.
ProfileForwardProxyBypassDefaultAction
A structure that specifies a profile&aposs SSL forward proxy bypass default action.
ProfileHardwareAccelerationMode
A structure that specifies a profile&aposs hardware acceleration mode.
A structure that specifies a profile&aposs HTTP chunk mode.
A structure that specifies a profile&aposs HTTP compression mode.
ProfileHttpRedirectRewriteMode
A structure that specifies a profile&aposs HTTP redirect/rewrite mode.
A structure that specifies an IP address used in profile attributes.
A structure that specifies a log actions enum used in profile attributes.
A structure that specifies a log elements sequence used in profile attributes.
ProfileMatchPatternStringArray
A structure that specifies a sequence of match pattern strings used in profile attributes.
A structure that specifies a profile&aposs persistence mode.
A structure that specifies a port number used in profile attributes.
A structure that specifies a profile mode.
ProfileRamCacheCacheControlMode
A structure that specifies a profile&aposs RAMCache cache control mode.
A structure that specifies a profile&aposs SSL response control mode.
A structure that specifies a profile&aposs RTSP proxy type.
ProfileSSLCertificateExtension
A structure that specifies a profile&aposs SSL forward proxy certificate extensions.
A structure that specifies a profile&aposs SSL options.
A structure that specifies a SSL profile sign hash algorithm.
ProfileSecureRenegotiationMode
A structure that specifies a profile&aposs SSL secure renegotiation mode.
ProfileServerSSLCertificateMode
A structure that specifies a profile server-side SSL certificate mode.
A struct that describes profile statistics (by virtual) and timestamp.
A structure that specifies a string used in profile attributes.
A structure that specifies a sequence of strings used in profile attributes.
ProfileTCPCongestionControlMode
A structure that specifies a profile&aposs TCP congestion control mode.
A structure that specifies a profile FastL4&aposs TCP option mode.
A structure that specifies a profile&aposs IP header DF bit mode.
A structure that specifies a profile&aposs IP header TTL value mode.
A structure that specifies an unsigned long used in profile attributes.
A structure that specifies an unsigned short used in profile attributes.
A structure that specifies a profile&aposs unclean shutdown mode.
A structure that specifies a profile&aposs cache control mode.
Enumerations¶
| Enumeration | Description |
| ActivationMode | Determines the manner in which ClientLDAP connections are made. |
| AdaptServiceDownAction | A list of adaptation service down actions. Specifies the action to take if the internal virtual server does not exist or returns an error. |
| AddressType | A list of address types used to differentiate various node definitions. |
| AuthenticationMethod | An enumeration of authentication methods. |
| AvailabilityStatus | A list of possible values for an object&aposs availability status. |
| ClientSSLCertificateMode | A list of client-side SSL certificate modes. |
| ClonePoolType | An enumeration of clone pool types. |
| CompressionMethod | An enumeration of compression methods. |
| CookiePersistenceMethod | A list of cookie persistence modes. |
| CredentialSource | An enumeration of credential sources. |
| DNSCacheLocalZoneType | A list of DNS cache local zone types which determine the cache&aposs operation in case the DNS query does not match the local zone data. |
| DNSCacheType | A list of DNS cache types |
| DNSRRSetRotateType | A list of DNS cache resource record set rotation methods which determine the order of resource records within a cached response. |
| DataGroupType | A list of different data group types. |
| EnabledStatus | A list of possible values for enabled status. |
| ForwardProxyBypassDefaultAction | A list of SSL forward proxy bypass default action. |
| HardwareAccelerationMode | A list of possible levels for hardware acceleration. |
| HttpChunkMode | An enumeration of HTTP chunk modes. |
| HttpCompressionMode | An enumeration of HTTP compression modes. |
| HttpRedirectRewriteMode | An enumeration of HTTP redirect/rewrite modes. |
| LBMethod | A list of load balancing methods. |
| LogAction | A list of log actions, indicating action to be taken when a log event is triggered on a particular type of flow. |
| LogElement | A list of log elements, these are optional elements in a log message. |
| MessageRoutingProtocol | A list of message routing protocols to be used with specific message routing objects. |
| MonitorAssociationRemovalRule | A list of rules on how the monitor association is removed. |
| MonitorInstanceStateType | A list of monitor instance states. |
| MonitorRuleType | An enumeration of different monitor rule types. |
| MonitorStatus | A list of possible values for an object&aposs monitor status. |
| PersistenceMode | A list of persistence modes. |
| PolicyEvent | A Policy Event is an occurrence under a given policy operand (See: PolicyOperand for more details). |
| PolicyOperand | A Content Policy Operand specifies the attribute for a Content Policy Rule to match on. Sometimes this represents a specific value (for example, http-method or http-status), but frequently a Policy Selector (See LocalLB::PolicySelector) must also be specified. |
| PolicySelector | A Content Policy Selector determines the value that will be used to select a specific connection to be modified by a content policy. |
| ProfileContextType | A list of profile context types. |
| ProfileMode | A list of profile modes. |
| ProfileType | A list of profile types. |
| RPZActionType | A list of RPZ Actions. This is how to modify the DNS response if a match is found in a response policy zone. |
| RamCacheCacheControlMode | An enumeration of RAMCache cache control modes. |
| RateLimitMode | A list of Rate Limiting modes. |
| ResponseControlMode | A list of SSL response control modes. |
| RtspProxyType | An enumeration of RTSP proxy types. |
| SSLCertificateExtension | A list of certificate extensions that can be included in SSL forward proxy generated certificates. |
| SSLOption | A list of bug-workaround SSL options |
| SSLSignHash | A list of SSL sign hash options. Specifies the hash algorithm to sign and verify SSL Server Key Exchange and Certificate Verify messages with. |
| SecureRenegotiationMode | A list of SSL secure renegotiation modes. These settings change slightly between client and server SSL profiles. An unpatched client or server does not support secure negotiation as defined in RFC 5476. |
| ServerSSLCertificateMode | A list of server-side SSL certificate modes. |
| ServiceDownAction | A list of action types to take when service is down. |
| SessionStatus | A list of possible values for session status. |
| SnatType | A list of translation types. |
| TCPCongestionControlMode | An enumeration of different TCP congestion control modes. |
| TCPOptionMode | A list of TCP option modes. |
| TCPPacketDFMode | An enumeration of different modes for a TCP profile&aposs IP header DF bit value. |
| TCPPacketTTLMode | An enumeration of different modes for a TCP profile&aposs IP header TTL value. |
| UncleanShutdownMode | A list of profile&aposs unclean shutdown modes. |
| VirtualAddressStatusDependency | An enumeration of virtual address status dependency types. This indicates how status of the related virtual servers affects status of the virtual address. |
| WACacheControlMode | An enumeration of WebAcceleration cache control modes. |
Aliases¶
| Alias | Type | Description |
| AdaptServiceDownActionSequence | AdaptServiceDownAction [] | A sequence of adaptation service down action specifications. |
| AddressTypeSequence | AddressType [] | A sequence of address types. |
| AddressTypeSequenceSequence | AddressType [] [] | A sequence of address type sequences. |
| AuthenticationMethodSequence | AuthenticationMethod [] | A sequence of authentication methods. |
| AvailabilityStatusSequence | AvailabilityStatus [] | A sequence of availability statuses. |
| ClientSSLCertificateModeSequence | ClientSSLCertificateMode [] | A sequence of ClientSSLCertificateMode&aposs. |
| ClonePoolTypeSequence | ClonePoolType [] | A sequence of clone pool types. |
| CompressionMethodSequence | CompressionMethod [] | A sequence of compression methods. |
| CookiePersistenceMethodSequence | CookiePersistenceMethod [] | A sequence of cookie persistence methods. |
| CredentialSourceSequence | CredentialSource [] | A sequence of credential sources. |
| DNSCacheLocalZoneTypeSequence | DNSCacheLocalZoneType [] | A sequence of DNSCacheLocalZoneType. |
| DNSCacheTypeSequence | DNSCacheType [] | A sequence of DNSCacheType&aposs. |
| DNSRRSetRotateTypeSequence | DNSRRSetRotateType [] | A sequence of DNSRRSetRotateType. |
| DataGroupTypeSequence | DataGroupType [] | A sequence of data group types. |
| EnabledStatusSequence | EnabledStatus [] | A sequence of enabled statuses. |
| HardwareAccelerationModeSequence | HardwareAccelerationMode [] | A sequence of hardware acceleration modes. |
| HttpChunkModeSequence | HttpChunkMode [] | A sequence of HTTP chunk modes. |
| HttpCompressionModeSequence | HttpCompressionMode [] | A sequence of HTTP compression modes. |
| HttpRedirectRewriteModeSequence | HttpRedirectRewriteMode [] | A sequence of HTTP redirect/rewrite modes. |
| LBMethodSequence | LBMethod [] | A sequence of load balancing methods. |
| LogActionSequence | LogAction [] | A sequence of log actions. |
| LogElementSequence | LogElement [] | A sequence of log elements. |
| MatchPatternStringSequence | MatchPatternString [] | A list of match pattern strings. |
| MatchPatternStringSequenceSequence | MatchPatternString [] [] | An alias for a sequence of MatchPatternStringSequence. |
| MessageRoutingProtocolSequence | MessageRoutingProtocol [] | A sequence of message routing protocols. |
| MessageRoutingProtocolSequenceSequence | MessageRoutingProtocol [] [] | A sequence of sequences of message routing protocols. |
| MonitorIPPortSequence | MonitorIPPort [] | A sequence of MonitorIPPort&aposs. |
| MonitorIPSequence | MonitorIP [] | A sequence of MonitorIP&aposs. |
| MonitorInstanceSequence | MonitorInstance [] | A sequence of MonitorInstance&aposs. |
| MonitorInstanceStateSequence | MonitorInstanceState [] | A sequence of MonitorInstanceState&aposs. |
| MonitorInstanceStateSequenceSequence | MonitorInstanceState [] [] | A sequence of sequence of MonitorInstanceState&aposs. |
| MonitorInstanceStateTypeSequence | MonitorInstanceStateType [] | A sequence of instance state types. |
| MonitorRuleSequence | MonitorRule [] | A sequence of MonitorRule entries. |
| MonitorRuleSequenceSequence | MonitorRule [] [] | A sequence of MonitorRule sequences. |
| MonitorRuleTypeSequence | MonitorRuleType [] | A sequence of monitor rule types. |
| MonitorStatusSequence | MonitorStatus [] | A sequence of monitor statuses. |
| MonitorStatusSequenceSequence | MonitorStatus [] [] | A sequence of monitor status sequences. |
| ObjectStatusSequence | ObjectStatus [] | A sequence of object statuses. |
| ObjectStatusSequenceSequence | ObjectStatus [] [] | A sequence of object status sequences. |
| PersistenceModeSequence | PersistenceMode [] | A list of pool persistence modes. |
| PersistenceRecordSequence | PersistenceRecord [] | A list of persistence records. |
| PersistenceRecordSequenceSequence | PersistenceRecord [] [] | A alias for a sequence of PersistenceRecordSequence. |
| PolicyEventSequence | PolicyEvent [] | A sequence of PolicyEvents. |
| PolicyEventSequenceSequence | PolicyEvent [] [] | A sequence of sequence of PolicyEvents. |
| PolicyEventSequenceSequenceSequence | PolicyEvent [] [] [] | A sequence of sequence of sequence of PolicyEvents. |
| PolicyOperandSequence | PolicyOperand [] | A sequence of PolicyOperands. |
| PolicyOperandSequenceSequence | PolicyOperand [] [] | A sequence of sequence of PolicyOperands. |
| PolicyOperandSequenceSequenceSequence | PolicyOperand [] [] [] | A sequence of sequence of sequence of PolicyOperands. |
| PolicySelectorSequence | PolicySelector [] | A sequence of PolicySelectors. |
| PolicySelectorSequenceSequence | PolicySelector [] [] | A sequence of sequence of PolicySelectors. |
| PolicySelectorSequenceSequenceSequence | PolicySelector [] [] [] | A sequence of sequence of sequence of PolicySelectors. |
| ProfileActivationModeSequence | ProfileActivationMode [] | A sequence of ProfileActivationModes. |
| ProfileAdaptServiceDownActionSequence | ProfileAdaptServiceDownAction [] | A sequence of Adapation Service Down Action specifications. |
| ProfileAuthenticationMethodSequence | ProfileAuthenticationMethod [] | A sequence of profile authentication methods. |
| ProfileClientSSLCertificateModeSequence | ProfileClientSSLCertificateMode [] | A sequence of profile client-side SSL certificate modes. |
| ProfileCompressionMethodSequence | ProfileCompressionMethod [] | A sequence of profile compression methods. |
| ProfileContextTypeSequence | ProfileContextType [] | A sequence of ProfileContextType&aposs. |
| ProfileCookiePersistenceMethodSequence | ProfileCookiePersistenceMethod [] | A sequence of profile cookie persistence methods. |
| ProfileCredentialSourceSequence | ProfileCredentialSource [] | A sequence of profile credential sources. |
| ProfileEnabledStateSequence | ProfileEnabledState [] | A sequence of profile enabled/disabled states. |
| ProfileForwardProxyBypassDefaultActionSequence | ProfileForwardProxyBypassDefaultAction [] | A sequence of profile SSL forward proxy bypass default action. |
| ProfileHardwareAccelerationModeSequence | ProfileHardwareAccelerationMode [] | A sequence of profile hardware acceleration modes. |
| ProfileHttpChunkModeSequence | ProfileHttpChunkMode [] | A sequence of profile HTTP chunk modes. |
| ProfileHttpCompressionModeSequence | ProfileHttpCompressionMode [] | A sequence of profile HTTP compression modes. |
| ProfileHttpRedirectRewriteModeSequence | ProfileHttpRedirectRewriteMode [] | A sequence of profile HTTP redirect/rewrite modes. |
| ProfileIPAddressSequence | ProfileIPAddress [] | A sequence of profile IP addresses. |
| ProfileLogActionSequence | ProfileLogAction [] | A sequence of profile log actions. |
| ProfileLogElementSequenceSequence | ProfileLogElementSequence [] | A list of profile log element sequences. |
| ProfileMatchPatternStringArraySequence | ProfileMatchPatternStringArray [] | A sequence of sequence of profile match pattern strings. |
| ProfilePersistenceModeSequence | ProfilePersistenceMode [] | A sequence of profile persistence modes. |
| ProfilePortNumberSequence | ProfilePortNumber [] | A sequence of profile port number. |
| ProfileProfileModeSequence | ProfileProfileMode [] | A sequence of profile modes. |
| ProfileRamCacheCacheControlModeSequence | ProfileRamCacheCacheControlMode [] | A sequence of profile RAMCache cache control modes. |
| ProfileResponseControlModeSequence | ProfileResponseControlMode [] | A sequence of profile SSL response control modes. |
| ProfileRtspProxyTypeSequence | ProfileRtspProxyType [] | A sequence of profile RTSP proxy types. |
| ProfileSSLCertificateExtensionSequence | ProfileSSLCertificateExtension [] | A sequence of profile SSL certificate extensions. |
| ProfileSSLOptionSequence | ProfileSSLOption [] | A sequence of profile SSL options. |
| ProfileSSLSignHashSequence | ProfileSSLSignHash [] | A sequence of SSL profile sign hashes. |
| ProfileSecureRenegotiationModeSequence | ProfileSecureRenegotiationMode [] | A sequence of profile SSL secure renegotiation modes. |
| ProfileServerSSLCertificateModeSequence | ProfileServerSSLCertificateMode [] | A sequence of profile server-side SSL certificate modes. |
| ProfileStringArraySequence | ProfileStringArray [] | A sequence of sequence of profile strings. |
| ProfileStringSequence | ProfileString [] | A sequence of profile strings. |
| ProfileTCPCongestionControlModeSequence | ProfileTCPCongestionControlMode [] | A sequence of profile TCP congestion control modes. |
| ProfileTCPOptionModeSequence | ProfileTCPOptionMode [] | A sequence of profile FastL4&aposs TCP option modes. |
| ProfileTCPPacketDFModeSequence | ProfileTCPPacketDFMode [] | A sequence of TCP profile&aposs IP header DF bit modes. |
| ProfileTCPPacketTTLModeSequence | ProfileTCPPacketTTLMode [] | A sequence of TCP profile&aposs IP header TTL value modes. |
| ProfileTypeSequence | ProfileType [] | A sequence of ProfileType&aposs. |
| ProfileULongSequence | ProfileULong [] | A sequence of profile unsigned longs. |
| ProfileULongSequenceSequence | ProfileULong [] [] | A sequence of profile unsigned long sequences. |
| ProfileUShortSequence | ProfileUShort [] | A sequence of profile unsigned shorts. |
| ProfileUncleanShutdownModeSequence | ProfileUncleanShutdownMode [] | A sequence of profile&aposs unclean shutdown modes. |
| ProfileWACacheControlModeSequence | ProfileWACacheControlMode [] | A sequence of profile cache control modes. |
| RPZActionTypeSequence | RPZActionType [] | A sequence of RPZActionType. |
| RPZActionTypeSequenceSequence | RPZActionType [] [] | A sequence of RPZActionType sequences. |
| RamCacheCacheControlModeSequence | RamCacheCacheControlMode [] | A sequence of RAMCache cache control modes. |
| RateLimitModeSequence | RateLimitMode [] | A sequence of RateLimitMode specifications. |
| RtspProxyTypeSequence | RtspProxyType [] | A sequence of RTSP proxy types. |
| SSLCertificateExtensionSequence | SSLCertificateExtension [] | A sequence of SSL certificate extensions. |
| SSLOptionSequence | SSLOption [] | A sequence of SSL options. |
| SSLOptionSequenceSequence | SSLOption [] [] | An alias for a sequence of SSL options. |
| SSLSignHashSequence | SSLSignHash [] | A sequence of SSL sign hash specifications. |
| ServerSSLCertificateModeSequence | ServerSSLCertificateMode [] | A sequence of ServerSSLCertificateMode&aposs. |
| ServiceDownActionSequence | ServiceDownAction [] | A sequence of ServiceDownAction&aposs. |
| SessionStatusSequence | SessionStatus [] | A sequence of session statuses. |
| SessionStatusSequenceSequence | SessionStatus [] [] | A sequence of session status sequences. |
| SnatTypeSequence | SnatType [] | A sequence of SnatType&aposs. |
| TCPCongestionControlModeSequence | TCPCongestionControlMode [] | A sequence of TCP Congestion Control modes. |
| TCPOptionModeSequence | TCPOptionMode [] | A sequence of TCPOptionMode&aposs. |
| TCPPacketDFModeSequence | TCPPacketDFMode [] | A sequence of TCP profile&aposs IP header DF bit modes. |
| TCPPacketTTLModeSequence | TCPPacketTTLMode [] | A sequence of TCP profile&aposs IP header TTL value modes. |
| UncleanShutdownModeSequence | UncleanShutdownMode [] | A sequence of UncleanShutdownMode&aposs. |
| VirtualAddressStatusDependencySequence | VirtualAddressStatusDependency [] | A sequence of VirtualAddressStatusDependency types. |
| WACacheControlModeSequence | WACacheControlMode [] | A sequence of cache control modes. |
See Also¶
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.