Application (object)

Application declaration main schema

Properties (* = required):

name type(s) default allowed values description
/*/        
class* string   “Application”  
constants object     Named values for (re-)use by declaration objects
enable boolean true true, false Application handles traffic only when enabled (default)
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
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
schemaOverlay string     BIG-IQ name for a supplemental validation schema is applied to the Application class definition before the main AS3 schema
serviceMain       Primary service of the application
template string “generic”   Each application type has certain required and default elements and selects appropriate setup of various ADC/Security features

Application.constants (object)

Named values for (re-)use by declaration objects

Properties (* = required):

name type(s) default allowed values description
/*/ boolean, integer, number, string, array, object   true, false, -∞ - -Infinity  
class* string   “Constants”  

Application.constants./*/ (boolean, integer, number, string, array, object)

Allowed values: true, false, -∞ - -Infinity

Template_generic (object)

Declares a generic application

Properties (* = required):

name type(s) default allowed values description
/*/        
serviceMain object     Declares an ‘Any IP’ (IPOther) virtual server,Core attributes of L4 virtual server,Core attributes of a virtual server,Defines inclusion of one part of the schema into another
template string     In addition to ‘generic’ and ‘shared’ other values may appear here for extensibility

Template_generic.serviceMain (object)

Declares an ‘Any IP’ (IPOther) virtual server Core attributes of L4 virtual server Core attributes of a virtual server Defines inclusion of one part of the schema into another

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
allowVlans array     Names of existing VLANs to add to this virtual server to allow.
class* string   “Service_Generic”  
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 AS3 pointer to persistence method
httpMrfRoutingEnabled boolean false true, false Specifies whether to use the HTTP message routing framework (MRF) functionality. Note: This is available in TMOS versions 14.1 and later.
include       Keyword to allow for inclusion of one part of the declaration into another
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 AS3 pointer to last-hop pool (default ‘default’ means use system setting)
layer4 string “tcp” “any”, “tcp”, “udp”, “3pc”, “a/n”, “ah”, “argus”, “aris”, “ax.25”, “bbn-rcc”, “bna”, “br-sat-mon”, “cbt”, “cftp”, “chaos”, “compaq-peer”, “cphb”, “cpnx”, “crdup”, “crtp”, “dccp”, “dcn”, “ddp”, “ddx”, “dgp”, “dsr”, “egp”, “eigrp”, “emcon”, “encap”, “esp”, “etherip”, “fc”, “fire”, “ggp”, “gmtp”, “gre”, “hip”, “hmp”, “hopopt”, “i-nlsp”, “iatp”, “icmp”, “idpr”, “idpr-cmtp”, “idrp”, “ifmp”, “igmp”, “igp”, “il”, “ip”, “ipcomp”, “ipcv”, “ipencap”, “ipip”, “iplt”, “ippc”, “ipv6”, “ipv6-auth”, “ipv6-crypt”, “ipv6-frag”, “ipv6-icmp”, “ipv6-nonxt”, “ipv6-opts”, “ipv6-route”, “ipx-in-ip”, “irtp”, “isis”, “iso-ip”, “iso-tp4”, “kryptolan”, “l2tp”, “larp”, “leaf-1”, “leaf-2”, “manet”, “merit-inp”, “mfe-nsp”, “micp”, “mobile”, “mpls-in-ip”, “mtp”, “mux”, “narp”, “netblt”, “nsfnet-igp”, “nvp”, “ospf”, “pgm”, “pim”, “pipe”, “pnni”, “prm”, “ptp”, “pup”, “pvp”, “qnx”, “rdp”, “rsvp”, “rsvp-e2e-ignore”, “rvd”, “sat-expak”, “sat-mon”, “scc-sp”, “scps”, “sctp”, “sdrp”, “secure-vmtp”, “shim6”, “skip”, “sm”, “smp”, “snp”, “sprite-rpc”, “sps”, “srp”, “sscopmce”, “st”, “stp”, “sun-nd”, “swipe”, “tcf”, “tlsp”, “tp++”, “trunk-1”, “trunk-2”, “ttp”, “udplite”, “uti”, “vines”, “visa”, “vmtp”, “vrrp”, “wb-expak”, “wb-mon”, “wesp”, “wsn”, “xnet”, “xns-idp”, “xtp” The L4 protocol type for this virtual server
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     List of persistence methods (each by name or AS3 pointer). Element 0 is primary (default) persistence method. Use ‘persistenceMethods: []’ for no persistence.
policyBandwidthControl object     AS3 pointer to Bandwidth Control Policy (policy must be static),Reference to a bandwidth control policy
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     AS3 pointer to NAT policy declaration
pool       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
profileIPOther object     Reference to a ipother profile
profileL4   “basic”   L4 profile; name of built-in or else AS3 pointer
profileProtocolInspection object     AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+,Reference to a Protocol Inspection Profile
profileRewrite object     Reference to a Rewrite Profile
profileSubscriberManagement object     Reference to a enforcement subscriber management profile
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
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 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 port

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_generic.serviceMain.metadata (object)

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

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

Template_generic.serviceMain.metadata./*/ (object)

Properties (* = required):

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

Template_generic.serviceMain.policyBandwidthControl (object)

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

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_generic.serviceMain.policyNAT (object)

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     AS3 pointer to NAT policy declaration

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_generic.serviceMain.profileProtocolInspection (object)

AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+ 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

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_generic.serviceMain.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

Template_http (object)

Declares an HTTP application

Properties (* = required):

name type(s) default allowed values description
/*/        
serviceMain* object     HTTP virtual server,Core attributes of HTTP(S) virtual server,Core attributes of TCP virtual server,Core attributes of a virtual server,Defines inclusion of one part of the schema into another

Template_http.serviceMain (object)

HTTP virtual server Core attributes of HTTP(S) virtual server Core attributes of TCP virtual server Core attributes of a virtual server Defines inclusion of one part of the schema into another

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
allowVlans array     Names of existing VLANs to add to this virtual server to allow.
class* string   “Service_HTTP”  
clientTLS       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 AS3 pointer to persistence method
httpMrfRoutingEnabled boolean false true, false Specifies whether to use the HTTP message routing framework (MRF) functionality. Note: This is available in TMOS versions 14.1 and later.
include       Keyword to allow for inclusion of one part of the declaration into another
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 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     List of persistence methods (each by name or AS3 pointer). Element 0 is primary (default) persistence method. Use ‘persistenceMethods: []’ for no persistence.
policyBandwidthControl object     AS3 pointer to Bandwidth Control Policy (policy must be static),Reference to a bandwidth control policy
policyEndpoint       AS3 pointer to Endpoint policy declaration
policyFirewallEnforced object     Reference to a firewall (AFM) policy
policyFirewallStaged object     Reference to a firewall (AFM) policy
policyIAM object     AS3 pointer to IAM (APM) policy declaration,Reference to a Access Profile
policyIdleTimeout object     Reference to a idle timeout policy
policyNAT object     AS3 pointer to NAT policy declaration
policyPerRequestAccess object     Reference to a Per Request Access Policy
policyWAF object     Reference to a WAF policy
pool       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 option is only available on BIG-IP 14.1+.,Reference to a API_Protection_Profile
profileBotDefense object     Attaches a Bot Defense profile to the service. These are only available on BIG-IP 14.1+.,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 AS3 pointer
profileHTTPAcceleration       Web acceleration profile; name of built-in or else AS3 pointer
profileHTTPCompression       HTTP compression profile; name of built-in or else AS3 pointer
profileIPOther object     Reference to a ipother profile
profileMultiplex       Multiplex (OneConnect) profile; name of built-in or else AS3 pointer
profileNTLM object     Reference to a NT LAN Manager profile
profileProtocolInspection object     AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+,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
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 AS3 pointer
profileTrafficLog object     Reference to a traffic log profile
profileVdi object     VDI profile to attach to service.,Reference to a VDI 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       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 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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.metadata (object)

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

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

Template_http.serviceMain.metadata./*/ (object)

Properties (* = required):

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

Template_http.serviceMain.policyBandwidthControl (object)

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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.policyIAM (object)

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

Template_http.serviceMain.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

Template_http.serviceMain.policyNAT (object)

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     AS3 pointer to NAT policy declaration

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.profileApiProtection (object)

API protection profile to attach to service. This option is only available on BIG-IP 14.1+. 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

Template_http.serviceMain.profileBotDefense (object)

Attaches a Bot Defense profile to the service. These are only available on BIG-IP 14.1+. 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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.profileProtocolInspection (object)

AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+ 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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_http.serviceMain.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

Template_https (object)

Declares an HTTPS application

Properties (* = required):

name type(s) default allowed values description
/*/        
serviceMain* object     HTTPS (HTTP+TLS) virtual server,Core attributes of HTTP(S) virtual server,Core attributes of TCP virtual server,Core attributes of a virtual server,Defines inclusion of one part of the schema into another

Template_https.serviceMain (object)

HTTPS (HTTP+TLS) virtual server Core attributes of HTTP(S) virtual server Core attributes of TCP virtual server Core attributes of a virtual server Defines inclusion of one part of the schema into another

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
allowVlans array     Names of existing VLANs to add to this virtual server to allow.
class* string   “Service_HTTPS”  
clientTLS       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 AS3 pointer to persistence method
httpMrfRoutingEnabled boolean false true, false Specifies whether to use the HTTP message routing framework (MRF) functionality. Note: This is available in TMOS versions 14.1 and later.
include       Keyword to allow for inclusion of one part of the declaration into another
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 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     List of persistence methods (each by name or AS3 pointer). Element 0 is primary (default) persistence method. Use ‘persistenceMethods: []’ for no persistence.
policyBandwidthControl object     AS3 pointer to Bandwidth Control Policy (policy must be static),Reference to a bandwidth control policy
policyEndpoint       AS3 pointer to Endpoint policy declaration
policyFirewallEnforced object     Reference to a firewall (AFM) policy
policyFirewallStaged object     Reference to a firewall (AFM) policy
policyIAM object     AS3 pointer to IAM (APM) policy declaration,Reference to a Access Profile
policyIdleTimeout object     Reference to a idle timeout policy
policyNAT object     AS3 pointer to NAT policy declaration
policyPerRequestAccess object     Reference to a Per Request Access Policy
policyWAF object     Reference to a WAF policy
pool       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 option is only available on BIG-IP 14.1+.,Reference to a API_Protection_Profile
profileBotDefense object     Attaches a Bot Defense profile to the service. These are only available on BIG-IP 14.1+.,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 AS3 pointer
profileHTTP2 string, object     HTTP/2 profile; name of built-in or else AS3 pointer
profileHTTPAcceleration       Web acceleration profile; name of built-in or else AS3 pointer
profileHTTPCompression       HTTP compression profile; name of built-in or else AS3 pointer
profileIPOther object     Reference to a ipother profile
profileMultiplex       Multiplex (OneConnect) profile; name of built-in or else AS3 pointer
profileNTLM object     Reference to a NT LAN Manager profile
profileProtocolInspection object     AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+,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
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 AS3 pointer
profileTrafficLog object     Reference to a traffic log profile
profileVdi object     VDI profile to attach to service.,Reference to a VDI profile
rateLimit integer 0 0 - ∞ Specifies the maximum number of connections per second allowed for a virtual server
redirect80 boolean true true, false If true, AS3 redirects HTTP traffic to any virtualAddress on port 80 to virtualPort
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*       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 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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.metadata (object)

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

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

Template_https.serviceMain.metadata./*/ (object)

Properties (* = required):

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

Template_https.serviceMain.policyBandwidthControl (object)

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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.policyIAM (object)

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

Template_https.serviceMain.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

Template_https.serviceMain.policyNAT (object)

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     AS3 pointer to NAT policy declaration

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.profileApiProtection (object)

API protection profile to attach to service. This option is only available on BIG-IP 14.1+. 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

Template_https.serviceMain.profileBotDefense (object)

Attaches a Bot Defense profile to the service. These are only available on BIG-IP 14.1+. 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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.profileHTTP2 (string, object)

HTTP/2 profile; name of built-in or else AS3 pointer

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.profileProtocolInspection (object)

AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+ 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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_https.serviceMain.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

Template_l4 (object)

Declares a L4 application

Properties (* = required):

name type(s) default allowed values description
/*/        
serviceMain* object     Declares a L4 (FastL4) virtual server,Core attributes of L4 virtual server,Core attributes of a virtual server,Defines inclusion of one part of the schema into another

Template_l4.serviceMain (object)

Declares a L4 (FastL4) virtual server Core attributes of L4 virtual server Core attributes of a virtual server Defines inclusion of one part of the schema into another

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
allowVlans array     Names of existing VLANs to add to this virtual server to allow.
class* string   “Service_L4”  
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 AS3 pointer to persistence method
httpMrfRoutingEnabled boolean false true, false Specifies whether to use the HTTP message routing framework (MRF) functionality. Note: This is available in TMOS versions 14.1 and later.
include       Keyword to allow for inclusion of one part of the declaration into another
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 AS3 pointer to last-hop pool (default ‘default’ means use system setting)
layer4 string “tcp” “any”, “tcp”, “udp”, “3pc”, “a/n”, “ah”, “argus”, “aris”, “ax.25”, “bbn-rcc”, “bna”, “br-sat-mon”, “cbt”, “cftp”, “chaos”, “compaq-peer”, “cphb”, “cpnx”, “crdup”, “crtp”, “dccp”, “dcn”, “ddp”, “ddx”, “dgp”, “dsr”, “egp”, “eigrp”, “emcon”, “encap”, “esp”, “etherip”, “fc”, “fire”, “ggp”, “gmtp”, “gre”, “hip”, “hmp”, “hopopt”, “i-nlsp”, “iatp”, “icmp”, “idpr”, “idpr-cmtp”, “idrp”, “ifmp”, “igmp”, “igp”, “il”, “ip”, “ipcomp”, “ipcv”, “ipencap”, “ipip”, “iplt”, “ippc”, “ipv6”, “ipv6-auth”, “ipv6-crypt”, “ipv6-frag”, “ipv6-icmp”, “ipv6-nonxt”, “ipv6-opts”, “ipv6-route”, “ipx-in-ip”, “irtp”, “isis”, “iso-ip”, “iso-tp4”, “kryptolan”, “l2tp”, “larp”, “leaf-1”, “leaf-2”, “manet”, “merit-inp”, “mfe-nsp”, “micp”, “mobile”, “mpls-in-ip”, “mtp”, “mux”, “narp”, “netblt”, “nsfnet-igp”, “nvp”, “ospf”, “pgm”, “pim”, “pipe”, “pnni”, “prm”, “ptp”, “pup”, “pvp”, “qnx”, “rdp”, “rsvp”, “rsvp-e2e-ignore”, “rvd”, “sat-expak”, “sat-mon”, “scc-sp”, “scps”, “sctp”, “sdrp”, “secure-vmtp”, “shim6”, “skip”, “sm”, “smp”, “snp”, “sprite-rpc”, “sps”, “srp”, “sscopmce”, “st”, “stp”, “sun-nd”, “swipe”, “tcf”, “tlsp”, “tp++”, “trunk-1”, “trunk-2”, “ttp”, “udplite”, “uti”, “vines”, “visa”, “vmtp”, “vrrp”, “wb-expak”, “wb-mon”, “wesp”, “wsn”, “xnet”, “xns-idp”, “xtp” The L4 protocol type for this virtual server
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     List of persistence methods (each by name or AS3 pointer). Element 0 is primary (default) persistence method. Use ‘persistenceMethods: []’ for no persistence.
policyBandwidthControl object     AS3 pointer to Bandwidth Control Policy (policy must be static),Reference to a bandwidth control policy
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     AS3 pointer to NAT policy declaration
pool       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
profileIPOther object     Reference to a ipother profile
profileL4   “basic”   L4 profile; name of built-in or else AS3 pointer
profileProtocolInspection object     AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+,Reference to a Protocol Inspection Profile
profileRewrite object     Reference to a Rewrite Profile
profileSubscriberManagement object     Reference to a enforcement subscriber management profile
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
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 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 port

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_l4.serviceMain.metadata (object)

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

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

Template_l4.serviceMain.metadata./*/ (object)

Properties (* = required):

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

Template_l4.serviceMain.policyBandwidthControl (object)

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

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_l4.serviceMain.policyNAT (object)

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     AS3 pointer to NAT policy declaration

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_l4.serviceMain.profileProtocolInspection (object)

AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+ 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

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_l4.serviceMain.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

Template_sctp (object)

Declares a SCTP application

Properties (* = required):

name type(s) default allowed values description
/*/        
serviceMain* object     Declares a SCTP virtual server,Core attributes of a virtual server,Defines inclusion of one part of the schema into another

Template_sctp.serviceMain (object)

Declares a SCTP virtual server Core attributes of a virtual server Defines inclusion of one part of the schema into another

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
allowVlans array     Names of existing VLANs to add to this virtual server to allow.
class* string   “Service_SCTP”  
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 AS3 pointer to persistence method
httpMrfRoutingEnabled boolean false true, false Specifies whether to use the HTTP message routing framework (MRF) functionality. Note: This is available in TMOS versions 14.1 and later.
include       Keyword to allow for inclusion of one part of the declaration into another
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 AS3 pointer to last-hop pool (default ‘default’ means use system setting)
layer4 string “sctp” “sctp” For SCTP virtual server, Layer 4 protocol must be SCTP
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     List of persistence methods (each by name or AS3 pointer). Element 0 is primary (default) persistence method. Use ‘persistenceMethods: []’ for no persistence.
policyBandwidthControl object     AS3 pointer to Bandwidth Control Policy (policy must be static),Reference to a bandwidth control policy
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     AS3 pointer to NAT policy declaration
pool       AS3 pointer to pool if any (declared separately)
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
profileIPOther object     Reference to a ipother profile
profileProtocolInspection object     AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+,Reference to a Protocol Inspection Profile
profileRewrite object     Reference to a Rewrite Profile
profileSCTP object     Reference to a SCTP Profile
profileSubscriberManagement object     Reference to a enforcement subscriber management profile
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
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 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 port

Template_sctp.serviceMain.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

Template_sctp.serviceMain.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

Template_sctp.serviceMain.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

Template_sctp.serviceMain.metadata (object)

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

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

Template_sctp.serviceMain.metadata./*/ (object)

Properties (* = required):

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

Template_sctp.serviceMain.policyBandwidthControl (object)

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

Template_sctp.serviceMain.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

Template_sctp.serviceMain.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

Template_sctp.serviceMain.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

Template_sctp.serviceMain.policyNAT (object)

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     AS3 pointer to NAT policy declaration

Template_sctp.serviceMain.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

Template_sctp.serviceMain.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

Template_sctp.serviceMain.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

Template_sctp.serviceMain.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

Template_sctp.serviceMain.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

Template_sctp.serviceMain.profileProtocolInspection (object)

AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+ 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

Template_sctp.serviceMain.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

Template_sctp.serviceMain.profileSCTP (object)

Reference to a SCTP Profile

Properties (* = required):

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

Template_sctp.serviceMain.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

Template_sctp.serviceMain.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

Template_tcp (object)

Declares a TCP application

Properties (* = required):

name type(s) default allowed values description
/*/        
serviceMain* object     Declares a TCP virtual server (w/optional TLS),Core attributes of TCP virtual server,Core attributes of a virtual server,Defines inclusion of one part of the schema into another

Template_tcp.serviceMain (object)

Declares a TCP virtual server (w/optional TLS) Core attributes of TCP virtual server Core attributes of a virtual server Defines inclusion of one part of the schema into another

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
allowVlans array     Names of existing VLANs to add to this virtual server to allow.
class* string   “Service_TCP”  
clientTLS       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 AS3 pointer to persistence method
httpMrfRoutingEnabled boolean false true, false Specifies whether to use the HTTP message routing framework (MRF) functionality. Note: This is available in TMOS versions 14.1 and later.
include       Keyword to allow for inclusion of one part of the declaration into another
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 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 AS3 pointer). Element 0 is primary (default) persistence method. Use ‘persistenceMethods: []’ for no persistence.
policyBandwidthControl object     AS3 pointer to Bandwidth Control Policy (policy must be static),Reference to a bandwidth control policy
policyEndpoint       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     AS3 pointer to NAT policy declaration
pool       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
profileIPOther object     Reference to a ipother profile
profilePPTP object     Reference to a PPTP_Profile
profileProtocolInspection object     AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+,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
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 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       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 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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.metadata (object)

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

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

Template_tcp.serviceMain.metadata./*/ (object)

Properties (* = required):

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

Template_tcp.serviceMain.policyBandwidthControl (object)

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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.policyNAT (object)

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     AS3 pointer to NAT policy declaration

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.profileProtocolInspection (object)

AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+ 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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_tcp.serviceMain.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

Template_udp (object)

Declares a UDP application

Properties (* = required):

name type(s) default allowed values description
/*/        
serviceMain* object     Declares a UDP virtual server (w/optional (D)TLS),Core attributes of UDP virtual server,Core attributes of a virtual server,Defines inclusion of one part of the schema into another

Template_udp.serviceMain (object)

Declares a UDP virtual server (w/optional (D)TLS) Core attributes of UDP virtual server Core attributes of a virtual server Defines inclusion of one part of the schema into another

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
allowVlans array     Names of existing VLANs to add to this virtual server to allow.
class* string   “Service_UDP”  
clientTLS       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 AS3 pointer to persistence method
httpMrfRoutingEnabled boolean false true, false Specifies whether to use the HTTP message routing framework (MRF) functionality. Note: This is available in TMOS versions 14.1 and later.
include       Keyword to allow for inclusion of one part of the declaration into another
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 AS3 pointer to last-hop pool (default ‘default’ means use system setting)
layer4 string “udp” “udp” For UDP virtual server, Layer 4 protocol must be UDP
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     List of persistence methods (each by name or AS3 pointer). Element 0 is primary (default) persistence method. Use ‘persistenceMethods: []’ for no persistence.
policyBandwidthControl object     AS3 pointer to Bandwidth Control Policy (policy must be static),Reference to a bandwidth control policy
policyEndpoint       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     AS3 pointer to NAT policy declaration
pool       AS3 pointer to pool if any (declared separately)
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
profileIPOther object     Reference to a ipother profile
profileProtocolInspection object     AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+,Reference to a Protocol Inspection Profile
profileRADIUS object     Reference to a radius profile
profileRewrite object     Reference to a Rewrite Profile
profileSubscriberManagement object     Reference to a enforcement subscriber management profile
profileTFTP object     Reference to a TFTP profile
profileTrafficLog object     Reference to a traffic log profile
profileUDP   “normal”   UDP profile; name of built-in or else AS3 pointer
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       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 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 UDP port
virtualType string “standard” “standard”, “internal” Type of the virtual

Template_udp.serviceMain.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

Template_udp.serviceMain.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

Template_udp.serviceMain.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

Template_udp.serviceMain.metadata (object)

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

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

Template_udp.serviceMain.metadata./*/ (object)

Properties (* = required):

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

Template_udp.serviceMain.policyBandwidthControl (object)

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

Template_udp.serviceMain.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

Template_udp.serviceMain.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

Template_udp.serviceMain.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

Template_udp.serviceMain.policyNAT (object)

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     AS3 pointer to NAT policy declaration

Template_udp.serviceMain.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

Template_udp.serviceMain.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

Template_udp.serviceMain.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

Template_udp.serviceMain.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

Template_udp.serviceMain.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

Template_udp.serviceMain.profileProtocolInspection (object)

AS3 pointer to Protocol Inspection Profile declaration. Protocol Inspection Profiles are only supported in tmos version 13.1+ 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

Template_udp.serviceMain.profileRADIUS (object)

Reference to a radius profile

Properties (* = required):

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

Template_udp.serviceMain.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

Template_udp.serviceMain.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

Template_udp.serviceMain.profileTFTP (object)

Reference to a TFTP profile

Properties (* = required):

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

Template_udp.serviceMain.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