Service_HTTP (object)¶

HTTP virtual server

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
addressStatus	boolean	true	true, false	Specifies whether the virtual server will contribute to the operational status of the associated virtual address
adminState	string	“enable”	“enable”, “disable”	Specifies the state of the Service. When set to disable the Service no longer accepts new connection requests, but will allow current connections to finish processing before going to a down state.
allowVlans	array			Names of existing VLANs to add to this virtual server to allow.
class*	string		“Service_HTTP”
clientTLS				BIG-IP AS3 pointer to TLS Client declaration
clonePools	object			Specifies a pool that the virtual server uses to replicate either client or server traffic
enable	boolean	true	true, false	Virtual server handles traffic only when enabled (default)
fallbackPersistenceMethod				Holds name of simple persistence method or BIG-IP AS3 pointer to persistence method
httpMrfRoutingEnabled	boolean	false	true, false	Specifies whether to use the HTTP message routing framework (MRF) functionality. This property is available on BIGIP 14.1 and above.
include				Keyword to allow for inclusion of one part of the declaration into another
ipIntelligencePolicy	object			Reference to a IP Intelligence Policy
iRules	array			List iRules for this virtual server (order is significant)
label	string		“^[^x00-x1fx22#&<>?x5b-x5d`x7f]$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
lastHop		“default”		Name of built-in last-hop method or BIG-IP AS3 pointer to last-hop pool (default ‘default’ means use system setting)
layer4	string	“tcp”	“tcp”	For TCP virtual server, Layer 4 protocol must be TCP
maxConnections	integer	0	0 - ∞	Specifies the maximum number of concurrent connections you want to allow for the virtual server
maximumBandwidth				Specifies the maximum bandwidth allowed, in Mbps.
metadata	object			Useful datapoints for tracking, tagging, and organizing declarations.
mirroring	string	“none”	“none”, “L4”	Controls connection-mirroring for high-availability
nat64Enabled	boolean	false	true, false	If true, translate IPv6 traffic into IPv4 (default false)
persistenceMethods	array	“cookie”		Default ‘cookie’ is generally good. Use ‘persistenceMethods: []’ for no persistence.
policyBandwidthControl	object			BIG-IP AS3 pointer to Bandwidth Control Policy (policy must be static),Reference to a bandwidth control policy
policyEndpoint				BIG-IP AS3 pointer to Endpoint policy declaration
policyFirewallEnforced	object			Reference to a firewall (AFM) policy
policyFirewallStaged	object			Reference to a firewall (AFM) policy
policyIAM	object			BIG-IP AS3 pointer to IAM (APM) policy declaration,Reference to a Access Profile
policyIdleTimeout	object			Reference to a idle timeout policy
policyNAT	object			BIG-IP AS3 pointer to NAT policy declaration
policyPerRequestAccess	object			Reference to a Per Request Access Policy
policyWAF	object			Reference to a WAF policy
pool				BIG-IP AS3 pointer to pool if any (declared separately)
profileAccess	object			Reference to a Access Profile
profileAnalytics	object			Reference to a Analytics_Profile
profileAnalyticsTcp	object			Reference to a Analytics_TCP_Profile
profileApiProtection	object			API protection profile to attach to service. This property is available on BIGIP 14.1 and above.,Reference to a API_Protection_Profile
profileBotDefense	object			Attaches a Bot Defense profile to the service. This property is available on BIGIP 14.1 and above.,Reference to a bot defense profile
profileClassification	object			Reference to a classification profile
profileConnectivity	object			Reference to a Connectivity Profile
profileDiameterEndpoint	object			Reference to a enforcement profile diameter endpoint
profileDNS	object			Reference to a DNS profile
profileDOS	object			Reference to a DOS Profile
profileEnforcement	object			Reference to a enforcement profile
profileFIX	object			Reference to a FIX profile
profileFPS	object			FPS Profile to attach to service,Reference to a FPS Profile
profileHTML	object			Reference to a HTML_Profile
profileHTTP		“basic”		HTTP profile; name of built-in or else BIG-IP AS3 pointer
profileHTTPAcceleration				Web acceleration profile; name of built-in or else BIG-IP AS3 pointer
profileHTTPCompression				HTTP compression profile; name of built-in or else BIG-IP AS3 pointer
profileIntegratedBotDefense	object			BIG-IP AS3 pointer to an Integrated Bot Defense Profile. These are only supported in tmos version 17.0+.,Reference to a Integrated Bot Defense Profile
profileIPOther	object			Reference to a ipother profile
profileMultiplex				Multiplex (OneConnect) profile; name of built-in or else BIG-IP AS3 pointer
profileNTLM	object			Reference to a NT LAN Manager profile
profilePingAccess	object			Reference to a Access Profile Ping
profileProtocolInspection	object			BIG-IP AS3 pointer to Protocol Inspection Profile declaration,Reference to a Protocol Inspection Profile
profileRequestAdapt	object			Reference to a Request Adapt Profile
profileResponseAdapt	object			Reference to a Response Adapt Profile
profileRewrite	object			Reference to a Rewrite Profile
profileSSHProxy	object			Reference to a SSH proxy profile
profileStatistics	object			Reference to a Statistics Profile
profileStream	object			Reference to a stream profile
profileSubscriberManagement	object			Reference to a enforcement subscriber management profile
profileTCP		“normal”		TCP profile; name of built-in or else BIG-IP AS3 pointer
profileTrafficLog	object			Reference to a traffic log profile
profileVdi	object			VDI profile to attach to service.,Reference to a VDI profile
profileWebSocket	object			Attaches a WebSocket profile to the Service.,Reference to a WebSocket Profile
rateLimit	integer	0	0 - ∞	Specifies the maximum number of connections per second allowed for a virtual server
rejectVlans	array			Names of existing VLANs to add to this virtual server to reject.
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
securityLogProfiles	array			Specifies the log profile applied to the virtual server
serverTLS				BIG-IP AS3 pointer to TLS Server declaration
serviceDownImmediateAction	string	“none”	“none”, “drop”, “reset”	Specifies the immediate action the BIG-IP system should respond with upon the receipt of the initial client’s SYN packet if the availability status of the virtual server is Offline or Unavailable. This is supported for the virtual server of Standard type and TCP protocol. The default value is none.
shareAddresses	boolean	false	true, false	A user set boolean that indicates whether the virtualAddresses should be added to or checked for /Common instead of the tenant. This value defaults to false, and so will put the virtualAddresses into their tenant.
snat		“auto”		Name of built-in SNAT method or BIG-IP AS3 pointer to SNAT pool. If ‘self’, the system uses the virtual-server address as SNAT address
sourceAddress				Accepts either a string or a reference to an Address_List which contains source addresses from which this virtual will listen. A reference to an Address_List is only supported on BIG-IP 14.1 and later. If an Address_List is provided, BIG-IP AS3 will create a traffic-matching-criteria for the virtual. If you also include the virtualAddresses property, those addresses cannot include the accept-from-subnet field.
translateClientPort	boolean, string	false	true, false	If true, hide client’s port number from server. A value of true is the same as the string ‘change’ while a value of false is the same as the string ‘preserve’. The value ‘preserve-strict’ is the only other allowed value for a string
translateServerAddress	boolean	true	true, false	If true (default), make server-side connection to server address (otherwise, treat server as gateway to virtual-server address)
translateServerPort	boolean	true	true, false	If true (default), make server-side connection to server port (otherwise, connect to server on virtual-server port)
virtualAddresses				Accepts either an array or a reference to an Address_List which contains destination addresses to which this virtual will listen. To accept connections only from certain subnet(s), replace IP address in the provided array with array [IP-address, accept-from-subnet]. If you do this, you cannot also include the sourceAddress property. IP address in the provided array can also be replaced by a reference to a Service_Address. A reference to an Address_List is only supported on BIG-IP 14.1 and later. If an Address_List is provided, BIG-IP AS3 will create a traffic-matching-criteria for the virtual.
virtualPort		80		Default 80 is well-known HTTP port. Accepts either an integer or a reference to a Firewall_Port_List that contains the ports on which to listen. Firewall_Port_List is only supported on BIG-IP 14.1 and later. If a Firewall_Port_List is provided, BIG-IP AS3 will create a traffic-matching-criteria for the virtual.
virtualType	string	“standard”	“standard”, “internal”	Type of the virtual

Service_HTTP.clonePools (object)¶

Specifies a pool that the virtual server uses to replicate either client or server traffic

Properties (* = required):

name	type(s)	default	allowed values	description
egress	object			Egress (server-side context) clone pool,Reference to a pool,Reference for a BIG-IP or Use object
ingress	object			Ingress (client-side context) clone pool,Reference to a pool,Reference for a BIG-IP or Use object

Service_HTTP.clonePools.egress (object)¶

Egress (server-side context) clone pool Reference to a pool Reference for a BIG-IP or Use object

Properties (* = required):

name	type(s)	default	allowed values	description
bigip			“f5bigip” formatted string	Pathname of existing BIG-IP pool
use

Service_HTTP.clonePools.ingress (object)¶

Ingress (client-side context) clone pool Reference to a pool Reference for a BIG-IP or Use object

Properties (* = required):

name	type(s)	default	allowed values	description
bigip			“f5bigip” formatted string	Pathname of existing BIG-IP pool
use

Service_HTTP.ipIntelligencePolicy (object)¶

Reference to a IP Intelligence Policy

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP IP Intelligence Policy

Service_HTTP.metadata (object)¶

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

name	type(s)	default	allowed values	description
/*/	object

Service_HTTP.metadata./*/ (object)¶

Properties (* = required):

name	type(s)	default	allowed values	description
persist	boolean	true	true, false
value*	string

Service_HTTP.policyBandwidthControl (object)¶

BIG-IP AS3 pointer to Bandwidth Control Policy (policy must be static) Reference to a bandwidth control policy

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP bandwidth control policy
use	string			AS3 pointer to bandwidth control policy declaration

Service_HTTP.policyFirewallEnforced (object)¶

Reference to a firewall (AFM) policy

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP firewall (AFM) policy
use	string			AS3 pointer to firewall (AFM) policy declaration

Service_HTTP.policyFirewallStaged (object)¶

Reference to a firewall (AFM) policy

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP firewall (AFM) policy
use	string			AS3 pointer to firewall (AFM) policy declaration

Service_HTTP.policyIAM (object)¶

BIG-IP AS3 pointer to IAM (APM) policy declaration Reference to a Access Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Access Profile
use	string			AS3 pointer to Access Profile declaration

Service_HTTP.policyIdleTimeout (object)¶

Reference to a idle timeout policy

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP idle timeout policy
use	string			AS3 pointer to idle timeout policy declaration

Service_HTTP.policyNAT (object)¶

BIG-IP AS3 pointer to NAT policy declaration

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP NAT policy
use	string			BIG-IP AS3 pointer to NAT policy declaration

Service_HTTP.policyPerRequestAccess (object)¶

Reference to a Per Request Access Policy

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Per Request Access Policy
use	string			AS3 pointer to Per Request Access Policy declaration

Service_HTTP.policyWAF (object)¶

Reference to a WAF policy

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP WAF policy
use	string			AS3 pointer to WAF policy declaration

Service_HTTP.profileAccess (object)¶

Reference to a Access Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Access Profile
use	string			AS3 pointer to Access Profile declaration

Service_HTTP.profileAnalytics (object)¶

Reference to a Analytics_Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Analytics_Profile
use	string			AS3 pointer to Analytics_Profile declaration

Service_HTTP.profileAnalyticsTcp (object)¶

Reference to a Analytics_TCP_Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Analytics_TCP_Profile
use	string			AS3 pointer to Analytics_TCP_Profile declaration

Service_HTTP.profileApiProtection (object)¶

API protection profile to attach to service. This property is available on BIGIP 14.1 and above. Reference to a API_Protection_Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP API_Protection_Profile

Service_HTTP.profileBotDefense (object)¶

Attaches a Bot Defense profile to the service. This property is available on BIGIP 14.1 and above. Reference to a bot defense profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP bot defense profile

Service_HTTP.profileClassification (object)¶

Reference to a classification profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP classification profile
use	string			AS3 pointer to classification profile declaration

Service_HTTP.profileConnectivity (object)¶

Reference to a Connectivity Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Connectivity Profile

Service_HTTP.profileDiameterEndpoint (object)¶

Reference to a enforcement profile diameter endpoint

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP enforcement profile diameter endpoint
use	string			AS3 pointer to enforcement profile diameter endpoint declaration

Service_HTTP.profileDNS (object)¶

Reference to a DNS profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP DNS profile
use	string			AS3 pointer to DNS profile declaration

Service_HTTP.profileDOS (object)¶

Reference to a DOS Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP DOS Profile
use	string			AS3 pointer to DOS Profile declaration

Service_HTTP.profileEnforcement (object)¶

Reference to a enforcement profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP PEM spm policy
use	string			AS3 pointer to enforcement profile declaration

Service_HTTP.profileFIX (object)¶

Reference to a FIX profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP FIX profile
use	string			AS3 pointer to FIX profile declaration

Service_HTTP.profileFPS (object)¶

FPS Profile to attach to service Reference to a FPS Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP FPS Profile

Service_HTTP.profileHTML (object)¶

Reference to a HTML_Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP HTML_Profile
use	string			AS3 pointer to HTML_Profile declaration

Service_HTTP.profileIntegratedBotDefense (object)¶

BIG-IP AS3 pointer to an Integrated Bot Defense Profile. These are only supported in tmos version 17.0+. Reference to a Integrated Bot Defense Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Integrated Bot Defense Profile

Service_HTTP.profileIPOther (object)¶

Reference to a ipother profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP ipother profile
use	string			AS3 pointer to ipother profile declaration

Service_HTTP.profileNTLM (object)¶

Reference to a NT LAN Manager profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP NT LAN Manager profile

Service_HTTP.profilePingAccess (object)¶

Reference to a Access Profile Ping

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Access Profile Ping
use	string			AS3 pointer to Access Profile Ping declaration

Service_HTTP.profileProtocolInspection (object)¶

BIG-IP AS3 pointer to Protocol Inspection Profile declaration Reference to a Protocol Inspection Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Protocol Inspection Profile
use	string			AS3 pointer to Protocol Inspection Profile declaration

Service_HTTP.profileRequestAdapt (object)¶

Reference to a Request Adapt Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Request Adapt Profile
use	string			AS3 pointer to Request Adapt Profile declaration

Service_HTTP.profileResponseAdapt (object)¶

Reference to a Response Adapt Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Response Adapt Profile
use	string			AS3 pointer to Response Adapt Profile declaration

Service_HTTP.profileRewrite (object)¶

Reference to a Rewrite Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Rewrite Profile
use	string			AS3 pointer to Rewrite Profile declaration

Service_HTTP.profileSSHProxy (object)¶

Reference to a SSH proxy profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP SSH proxy profile
use	string			AS3 pointer to SSH proxy profile declaration

Service_HTTP.profileStatistics (object)¶

Reference to a Statistics Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Statistics Profile
use	string			AS3 pointer to Statistics Profile declaration

Service_HTTP.profileStream (object)¶

Reference to a stream profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP stream profile
use	string			AS3 pointer to stream profile declaration

Service_HTTP.profileSubscriberManagement (object)¶

Reference to a enforcement subscriber management profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP PEM subscriber-mgmt policy
use	string			AS3 pointer to enforcement subscriber management profile declaration

Service_HTTP.profileTrafficLog (object)¶

Reference to a traffic log profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP Request Logging Profile
use	string			AS3 pointer to traffic log profile declaration

Service_HTTP.profileVdi (object)¶

VDI profile to attach to service. Reference to a VDI profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP VDI profile

Service_HTTP.profileWebSocket (object)¶

Attaches a WebSocket profile to the Service. Reference to a WebSocket Profile

Properties (* = required):

name	type(s)	default	allowed values	description
bigip	string		“f5bigip” formatted string	Pathname of existing BIG-IP WebSocket Profile
use	string			AS3 pointer to WebSocket Profile declaration

Previous Next