APIRef_tm_ltm_policy_rules_actions

mgmt/tm/ltm/policy/rules/actions

/tm/ltm

REST Endpoints

Collection URI
/mgmt/tm/ltm/policy/rules/actions
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/ltm/policy/rules/actions/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, partition, subPath

Properties

Name Type Default Value Required Access Description
appService string   optional read/write The application service to which the object belongs.
application string   optional read/write Text application name
asm boolean   optional read/write Enable/disable Application Security Manager
avr boolean   optional read/write Enable/disable Application Visibility and Reporting
cache boolean   optional read/write Turn caching on or off
carp boolean   optional read/write Hash persistence using Cache Array Routing Protocol (CARP) algorithm
category string   optional read/write Category name
ce boolean   optional read/write Traffic classification engine
classification boolean   optional read/write This action will perform flow related tasks based on classification result.
classificationDetected boolean request optional read/write  
classify boolean   optional read/write This action will classify a stream.
clonePool string   optional read/write This action will clone the stream and send it to this pool.
code integer   optional read/write This action has the following code.
compress boolean   optional read/write Turn compression on or off
content string   optional read/write This action will insert/replace content.
cookieHash boolean   optional read/write Persist connection using cookie hash method
cookieInsert boolean   optional read/write Persist connection using cookie insertion method
cookiePassive boolean   optional read/write Persist connection using cookie passive method
cookieRewrite boolean   optional read/write Persist connection using cookie rewrite method
decompress boolean   optional read/write Turn decompression on or off
defer boolean   optional read/write This action will defer an action.
destinationAddress boolean   optional read/write Persist the connection based on the destination IP address
disable boolean   optional read/write Turn off
domain string   optional read/write Internet domain, e.g. example.com
drop boolean   optional read/write This action will drop connection silently.
enable boolean   optional read/write Turn on
expiry string   optional read/write Expiration duration expressed as Dd HHMM:]SS
expirySecs integer   optional read/write (for internal use only)
expression string   optional read/write Tcl expression to be evaluated
extension string   optional read/write This action will use the specified extension.
facility string   optional read/write Standard syslog facility, e.g. auth, kern, daemon, user
forward boolean   optional read/write Many options for forwarding connection to backend
fromProfile string   optional read/write This action will come from a profile.
hash boolean   optional read/write Persist connection using hash of the specified key
host string   optional read/write This action will affect the host.
http boolean   optional read/write Enable/disable HTTP filter processing
httpBasicAuth boolean   optional read/write This policy action is performed on basic http authentication.
httpCookie boolean   optional read/write Create/modify/delete HTTP Cookie: header
httpHeader boolean   optional read/write Create/modify/delete specified HTTP header
httpHost boolean   optional read/write Replace HTTP Host: header in a request
httpReferer boolean   optional read/write Modify HTTP Referer: header
httpReply boolean   optional read/write Generate a reply without waiting for server response
httpSetCookie boolean   optional read/write Modify HTTP Set-Cookie: header
httpUri boolean   optional read/write Modify the request’s URI, path, or query string
ifile string   optional read/write This action will use the given iFile.
insert boolean   optional read/write Insert HTTP header
internalVirtual string   optional read/write This action will use following internal virtual.
ipAddress string   optional read/write IPv4 or IPv6 address
key string   optional read/write  
l7dos boolean   optional read/write Enable/disable layer 7 Denial-of-Service processing
length integer   optional read/write  
location string   optional read/write URL to put in response Location: header
log boolean   optional read/write Text to write to system log files
ltmPolicy boolean   optional read/write Disable LTM Policy processing
member string   optional read/write This action will direct the stream to this member.
message string   optional read/write This action will create this message.
tmName string   optional read/write This name of a value used in an action.
netmask string   optional read/write Specify an IPv4/IPv6 netmask, e.g. 192.168.10.0/24 or 192.168.10.0/255.255.255.0
nexthop string   optional read/write Specify next vlan or vlan-id destination of connection
node string   optional read/write This action will direct the stream to this node.
offset integer   optional read/write Specify offset parameter
path string   optional read/write Path part of a URL
pem boolean   optional read/write Classify traffic
persist boolean   optional read/write Specify persistence method for a connection
pin boolean   optional read/write This action will affect a pin.
policy string   optional read/write This action will use this policy.
pool string   optional read/write This action will direct the stream to this pool.
port integer   optional read/write TCP port number
priority string   optional read/write Standard syslog priority, e.g. emerg, alert, err, warning, notice, info, debug
profile string   optional read/write This action will use the specified profile.
protocol string   optional read/write This action will use the following protocol.
queryString string   optional read/write Query string of a URL
rateclass string   optional read/write This action will apply this rate class policy.
redirect boolean   optional read/write Send redirect response with new URL
reject boolean   optional read/write This action will close connection gracefully.
remove boolean   optional read/write Remove HTTP header
replace boolean   optional read/write Replace HTTP header
request boolean request optional read/write At HTTP request time.
requestAdapt boolean   optional read/write Enable/disable request adaptation, optionally routing to internal virtual server
reset boolean   optional read/write Terminate connection
response boolean request optional read/write At HTTP response time.
responseAdapt boolean   optional read/write Enable/disable response adaptation, optionally routing to internal virtual server
scheme string   optional read/write This action will use the specified scheme.
script string   optional read/write This action will run this script.
select boolean   optional read/write Choose a method for forwarding connection to backend.
serverSsl boolean   optional read/write Enable or disable encrypted connections to backend servers
setVariable boolean   optional read/write Sets specified variable to value of expression in runtime environment
snat string   optional read/write This action will use this snat rule.
snatpool string   optional read/write This action will use this snatpool.
sourceAddress boolean   optional read/write Persist the connection based on the source IP address
sslClientHello boolean request optional read/write When SSL hello is issued on client side.
sslServerHandshake boolean request optional read/write When SSL handshake occurs on server side.
sslServerHello boolean request optional read/write When SSL hello is issued on server side.
sslSessionId boolean   optional read/write SSL session identifier
status integer   optional read/write This action will set a status.
tcl boolean   optional read/write Set a Tcl variable in runtime environment
tcpNagle boolean   optional read/write Enable or disable Nagle’s algorithm on a connection
text string   optional read/write This specifies a text value.
timeout integer   optional read/write Timeout value in seconds
uie boolean   optional read/write  
universal boolean   optional read/write Persist connection using user-defined key
value string   optional read/write This action will use the specified value
virtual string   optional read/write This action will use this virtual server.
vlan string   optional read/write This action will affect this vlan.
vlanId integer   optional read/write This action will affect the vlan with this id.
wam boolean   optional read/write Enable/disable Web Acceleration
websocket boolean   optional read/write Enable or disable websocket processing
write boolean   optional read/write Write message to syslog
wsRequest boolean request optional read/write At Websocket request time.
wsResponse boolean request optional read/write At Websocket response time.
iControl Reference Index
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.