UDP_Profile (object)

Configures a User Datagram Protocol (UDP) profile

Properties (* = required):

name type(s) default allowed values description
allowNoPayload boolean false true, false When true, forward UDP datagrams with empty payloads (default false)
bufferMaxBytes integer 655350 65535 - 16777215 Limit to number of octets which the system may buffer for a UDP flow (default 655350)
bufferMaxPackets integer 0 0 - 255 Limit to number of packets which the system may buffer for a UDP flow (default 0)
class* string   “UDP_Profile”  
datagramLoadBalancing boolean false true, false When true, process UDP datagrams independently, without recognizing flows (default false)
idleTimeout integer 60 -1 - 86400 Number of seconds (default 60) flow may remain idle before it becomes eligible for deletion. Value 0 allows system to recover per-flow resources whenever convenient (always safe with UDP). Value -1 means indefinite (not recommended)
ipDfMode string “pmtu” “clear”, “pmtu”, “preserve”, “set” Controls DF (Don’t Fragment) flag in outgoing datagrams. Value ‘pmtu’ (default) sets DF based on IP PMTU value. Value ‘preserve’ copies DF from received datagram. Value ‘set’ forces DF true in all outgoing datagrams. Value ‘clear’ forces DF false in all outgoing datagrams
ipTosToClient   0   Specifies the IP TOS/DSCP value in packets sent to clients (default 0). Numeric values in this property are decimal representations of eight-bit numbers, of which the leftmost six bits are the DSCP code per rfc2474 (and the rightmost two bits reserved). You may have to calculate the value of this property by multiplying a DSCP code, such as CS5+EF = 46, by four, to obtain the ‘ipTosToClient’ value, such as 184. Value ‘pass-through’ sets DSCP from the initial server-side value. Value ‘mimic’ copies DSCP from the most-recently received server-side packet (allowing DSCP to vary during the life of a connection)
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
linkQosToClient   0   Specifies the Layer-2 QOS value in packets sent to clients (default 0). Ethernet-type networks recognize numeric codes from 0 to 7. Value ‘pass-through’ sets QOS from the initial server-side value
proxyMSS boolean false true, false When true, MSS advertised on the server side will match that negotiated with the client, if permitted by MTU and other constraints (default false)
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
ttlIPv4 integer 255 1 - 255 TTL the system sets in outgoing IPv4 datagrams
ttlIPv6 integer 64 1 - 255 TTL the system sets in outgoing IPv6 datagrams
ttlMode string “proxy” “decrement”, “preserve”, “proxy”, “set” Controls IP TTL in outgoing datagrams. Value ‘set’ forces TTL to value of property ‘ttlIPv4’ or ‘ttlIPv6’ as appropriate. Value ‘proxy’ forces TTL to the default value for IPv4 or IPv6 as appropriate. Value ‘preserve’ copies TTL from received datagram. Value ‘decrement’ sets TTL to one less than received datagrams’s TTL
useChecksum boolean false true, false When true, system will validate UDP checksums for IPv4 datagrams (default false). Checksums are always validated for IPv6