Last updated on: 2023-07-24 10:18:39.

Service_UDP (object)¶

Declares a UDP virtual server (w/optional (D)TLS)

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
addressStatus	boolean	true	true, false	Specifies whether the virtual server will contribute to the operational status of the associated virtual address
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
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

Service_UDP.clonePools (object)¶

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

Properties (* = required):

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

Service_UDP.clonePools.egress (object)¶

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

Properties (* = required):

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

Service_UDP.clonePools.ingress (object)¶

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

Properties (* = required):

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

Service_UDP.metadata (object)¶

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

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

Service_UDP.metadata./*/ (object)¶

Properties (* = required):

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

Service_UDP.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

Service_UDP.policyFirewallEnforced (object)¶

Reference to a firewall (AFM) policy

Properties (* = required):

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

Service_UDP.policyFirewallStaged (object)¶

Reference to a firewall (AFM) policy

Properties (* = required):

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

Service_UDP.policyIdleTimeout (object)¶

Reference to a idle timeout policy

Properties (* = required):

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

Service_UDP.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

Service_UDP.profileClassification (object)¶

Reference to a classification profile

Properties (* = required):

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

Service_UDP.profileDiameterEndpoint (object)¶

Reference to a enforcement profile diameter endpoint

Properties (* = required):

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

Service_UDP.profileDNS (object)¶

Reference to a DNS profile

Properties (* = required):

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

Service_UDP.profileEnforcement (object)¶

Reference to a enforcement profile

Properties (* = required):

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

Service_UDP.profileIPOther (object)¶

Reference to a ipother profile

Properties (* = required):

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

Service_UDP.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

Service_UDP.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

Service_UDP.profileRewrite (object)¶

Reference to a Rewrite Profile

Properties (* = required):

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

Service_UDP.profileSubscriberManagement (object)¶

Reference to a enforcement subscriber management profile

Properties (* = required):

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

Service_UDP.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

Service_UDP.profileTrafficLog (object)¶

Reference to a traffic log profile

Properties (* = required):

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

Service_UDP_Core (object)¶

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

Service_UDP_Core.clonePools (object)¶

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

Properties (* = required):

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

Service_UDP_Core.clonePools.egress (object)¶

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

Properties (* = required):

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

Service_UDP_Core.clonePools.ingress (object)¶

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

Properties (* = required):

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

Service_UDP_Core.metadata (object)¶

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

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

Service_UDP_Core.metadata./*/ (object)¶

Properties (* = required):

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

Service_UDP_Core.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

Service_UDP_Core.policyFirewallEnforced (object)¶

Reference to a firewall (AFM) policy

Properties (* = required):

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

Service_UDP_Core.policyFirewallStaged (object)¶

Reference to a firewall (AFM) policy

Properties (* = required):

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

Service_UDP_Core.policyIdleTimeout (object)¶

Reference to a idle timeout policy

Properties (* = required):

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

Service_UDP_Core.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

Service_UDP_Core.profileClassification (object)¶

Reference to a classification profile

Properties (* = required):

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

Service_UDP_Core.profileDiameterEndpoint (object)¶

Reference to a enforcement profile diameter endpoint

Properties (* = required):

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

Service_UDP_Core.profileDNS (object)¶

Reference to a DNS profile

Properties (* = required):

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

Service_UDP_Core.profileEnforcement (object)¶

Reference to a enforcement profile

Properties (* = required):

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

Service_UDP_Core.profileIPOther (object)¶

Reference to a ipother profile

Properties (* = required):

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

Service_UDP_Core.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

Service_UDP_Core.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

Service_UDP_Core.profileRewrite (object)¶

Reference to a Rewrite Profile

Properties (* = required):

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

Service_UDP_Core.profileSubscriberManagement (object)¶

Reference to a enforcement subscriber management profile

Properties (* = required):

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

Service_UDP_Core.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

Service_UDP_Core.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

Previous Next