Service_TCP (object)

Declares a TCP virtual server (w/optional TLS)

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_TCP”  
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
mqttEnabled boolean false true, false Attaches the MQTT profile /Common/mqtt. MQTT profiles have no configurable properties.
nat64Enabled boolean false true, false If true, translate IPv6 traffic into IPv4 (default false)
persistenceMethods array     List of persistence methods (each by name or BIG-IP AS3 pointer). Element 0 is primary (default) persistence method. 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
policyIdleTimeout object     Reference to a idle timeout policy
policyNAT object     BIG-IP AS3 pointer to NAT policy declaration
pool       BIG-IP AS3 pointer to pool if any (declared separately)
profileAnalyticsTcp object     Reference to a Analytics_TCP_Profile
profileClassification object     Reference to a classification profile
profileDiameterEndpoint object     Reference to a enforcement profile diameter endpoint
profileDNS object     Reference to a DNS profile
profileEnforcement object     Reference to a enforcement profile
profileFIX object     Reference to a FIX profile
profileFTP object     Reference to a FTP protocol profile
profileICAP object     Reference to a ICAP Profile
profileILX object     Reference to a iRules LX Profile
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
profilePPTP object     Reference to a PPTP_Profile
profileProtocolInspection object     BIG-IP AS3 pointer to Protocol Inspection Profile declaration,Reference to a Protocol Inspection Profile
profileRewrite object     Reference to a Rewrite Profile
profileRTSP object     Reference to a Real Time Streaming Protocol Profile
profileSIP object     Reference to a SIP 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
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 string   “f5ip” formatted string Accept connections only from these subnet(s). Only allowed if virtualType is internal, otherwise use virtualAddresses.
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 array     Virtual server will listen to each IP address in list. To accept connections only from certain subnet(s), replace IP address with array [IP-address, accept-from-subnet]. IP address can also be replaced by a reference to a Service_Address.
virtualPort integer   0 - 65535 virtual server TCP port
virtualType string “standard” “standard”, “internal” Type of the virtual

Service_TCP.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
ingress object     Ingress (client-side context) clone pool,Reference to a pool

Service_TCP.clonePools.egress (object)

Egress (server-side context) clone pool Reference to a pool

Properties (* = required):

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

Service_TCP.clonePools.ingress (object)

Ingress (client-side context) clone pool Reference to a pool

Properties (* = required):

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

Service_TCP.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_TCP.metadata (object)

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

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

Service_TCP.metadata./*/ (object)

Properties (* = required):

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

Service_TCP.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_TCP.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_TCP.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_TCP.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_TCP.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_TCP.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_TCP.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_TCP.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_TCP.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_TCP.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_TCP.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_TCP.profileFTP (object)

Reference to a FTP protocol profile

Properties (* = required):

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

Service_TCP.profileICAP (object)

Reference to a ICAP Profile

Properties (* = required):

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

Service_TCP.profileILX (object)

Reference to a iRules LX Profile

Properties (* = required):

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

Service_TCP.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_TCP.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_TCP.profilePPTP (object)

Reference to a PPTP_Profile

Properties (* = required):

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

Service_TCP.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_TCP.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_TCP.profileRTSP (object)

Reference to a Real Time Streaming Protocol Profile

Properties (* = required):

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

Service_TCP.profileSIP (object)

Reference to a SIP profile

Properties (* = required):

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

Service_TCP.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_TCP.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_TCP.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_TCP.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_TCP.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