APIRef_tm_wam_policy_nodes

mgmt/tm/wam/policy/nodes

/tm/wam

Defines a node in a policy tree.

REST Endpoints

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

Properties

Name

Type

Default Value

Required

Access

Description

alwaysProxy

string

no

optional

read/write

Specifies when enabled (selected), that the WebAccelerator system sends all requests that match the associated node to the origin server for content. This option overrides any configured proxying rules.

appService

string

optional

read/write

assemblyCompression

string

enabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system compresses content for responses, using gzip-encoding.

assemblyCompressionOws

string

disabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system requests compressed content from OWS.

assemblyConcatenation

string

disabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system perform JavaScript and CSS concatenation in HTML documents.

assemblyConcatenationSets

string

optional

read/write

Specifies the active concatenation sets that will be used by the WebAccelerator system.

assemblyCssInlining

string

disabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system perform inlining of CSS URLs.

assemblyCssInliningUrls

string

optional

read/write

Specifies the list of URLs that may be inlined by the CSS inlining feature in the WebAccelerator system.

assemblyCssReorder

string

disabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system perform reordering of CSS URLs.

assemblyCssReorderCacheSize

integer

8

optional

read/write

Specifies the size of the reorder cache for the CSS URL reordering feature in the WebAccelerator system.

assemblyCssReorderUrls

string

optional

read/write

Specifies the list of URLs that may be reordered by the CSS URL reordering feature in the WebAccelerator system.

assemblyDnsPrefetch

string

disabled

optional

read/write

Specifies, when enabled, that DNS prefetch tags will be sent by the WebAccelerator system to a client over an HTTP connection when supported.

assemblyDnsPrefetchDomainLists

string

optional

read/write

Specifies the lists of domains to be inserted by the WebAccelerator system to a client over a connection when DNS prefetch is enabled.

assemblyDnsPrefetchHttpsAutomatic

string

disabled

optional

read/write

Specifies, when enabled, that an HTML meta tag turning off DNS prefetching after the insertion of our DNS prefetch tags will be sent by the WebAccelerator system to a client over an HTTPS connection when supported.

assemblyDnsPrefetchHttpsEnable

string

disabled

optional

read/write

Specifies, when enabled, that DNS prefetch tags will be sent by the WebAccelerator system to a client over an HTTPS connection when supported.

assemblyIbrTo

string

enabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system manipulates the web browser cache to reduce requests to your site for relatively static content, such as images and style sheet (CSS) files.

assemblyIbrWithin

string

enabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system rewrites links in responses, such as images and style sheet (CSS) files, to reduce requests to your site

assemblyIccCssMaxSize

integer

50

optional

read/write

Specifies the maximum size of the CSS that can be inlined by the Intelligent Client Caching feature in the WebAccelerator system.

assemblyIccForce

string

disabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system perform Intelligent Client Caching of HTML documents even if the client does not support HTML5 localstorage.

assemblyIccImageMaxSize

integer

32

optional

read/write

Specifies the maximum size of the image that can be inlined by the Intelligent Client Caching feature in the WebAccelerator system.

assemblyIccJsMaxSize

integer

50

optional

read/write

Specifies the maximum size of the JS that can be inlined by the Intelligent Client Caching feature in the WebAccelerator system.

assemblyIccMaxNumUrls

integer

10

optional

read/write

Specifies the maximum number of links in an HTML document that can be inlined by the Intelligent Client Caching feature in the WebAccelerator system.

assemblyIccMinClientExpiry

string

172800

optional

read/write

Specifies the minimum client expiry of a resource that can be inlined by the Intelligent Client Caching feature in the WebAccelerator system.

assemblyImageInlining

string

disabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system perform inlining of images.

assemblyImageInliningMaxSize

integer

2

optional

read/write

Specifies the maximum size of the image that can be inlined by the image inlining feature in the WebAccelerator system.

assemblyImageInliningUrls

string

optional

read/write

Specifies the list of URLs that may be inlined by the image inlining feature in the WebAccelerator system.

assemblyIntelligentClientCache

string

disabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system perform Intelligent Client Caching of HTML documents.

assemblyJsInlining

string

disabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system perform inlining of JavaScript URLs.

assemblyJsInliningUrls

string

optional

read/write

Specifies the list of URLs that may be inlined by the JS inlining feature in the WebAccelerator system.

assemblyJsReorder

string

disabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system perform reordering of JavaScript URLs.

assemblyJsReorderCacheSize

integer

8

optional

read/write

Specifies the size of the reorder cache for the JavaScript URL reordering feature in the WebAccelerator system.

assemblyJsReorderUrls

string

optional

read/write

Specifies the list of URLs that may be reordered by the CSS URL reordering feature in the WebAccelerator system.

assemblyMinification

string

disabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system performs minification.

assemblyMulticonnectTo

string

enabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system modifies embedded URLs with unique subdomains that prompt the browser to open more persistent connections for each supported protocol (HTTP or HTTPS).

assemblyMulticonnectWithin

string

enabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system modifies embedded URLs in responses with unique subdomains that prompt the browser to open more persistent connections for each supported protocol (HTTP or HTTPS).

assemblyOnProxies

string

yes

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system applies, to content served to clients, the Content Compression and Intelligent Browser Referencing features (if enabled), even if the content is not served from the WebAccelerator system’s cache.

assemblyPdfLinearization

string

disabled

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system performs PDF linearization to content served to clients, in case when requested document is in pdf format.

cacheCompleteOnly

string

yes

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system caches HTML pages only if the HTML code within the page contains begin and end tags.

cacheFirstHit

string

no

optional

read/write

Specifies that the WebAccelerator will cache the response the first time that it is requested. When off, documents are cached when they are retrieved more than once.

cacheMode

string

memory-and-disk

optional

read/write

Specifies whether content matching the associated node may be cached in-memory only, or whether content may be persisted to disk as well.

cachePriority

string

high

optional

read/write

Specifies the cache admission priority of documents matching the policy node. Documents with high priority are more likely to be admitted into the cache. The default value is medium.

cacheStandInPeriod

string

0

optional

read/write

Specifies the amount of time that the WebAccelerator system continues to serve content from cache if the origin web server does not respond to the WebAccelerator system’s requests for fresh content.

code

string

optional

read/write

Specifies numeric code of the node, which is used for policy troubleshooting or tuning.

coherency

string

cluster

optional

read/write

Specifies whether the WebAccelerator system will attempt to keep content matching the associated node in sync across the blades of a cluster. The default behavior is to keep content in sync.

defaultsFrom

string

optional

read/write

Specifies base node in node tree hierarchy.

description

string

optional

read/write

Specifies the description of the node.

jpegProgressiveEncoding

string

no

optional

read/write

Specifies whether JPEG images should use progressive encoding.

jpegQuality

integer

100

optional

read/write

Specifies the amount of compression to use when producing JPEG images.

jpegQualityIsRelative

string

no

optional

read/write

Specifies whether JPEG quality is relative (yes) or absolute (no).

jpegSamplingFactor

string

preserve

optional

read/write

Specifies the sampling factor to be used when creating JPEG images.

jpegStripExif

string

no

optional

read/write

Specifies whether EXIF headers should be stripped from JPEG images never (no), always (yes), only when they do not contain a color profile (if-safe), or only after applying any color profile they contain (make-safe).

Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

jpegxrQuality

integer

30

optional

read/write

Specifies the amount of compression to use when producing JPEG-XR images.

lifetimeCacheControlExtensions

string

optional

read/write

Specifies, which custom lifetime extension values must be recognized by the WebAccelerator system.

lifetimeCacheMaxAge

string

14400

optional

read/write

Specifies the amount of time that the WebAccelerator system serves content from cache, before requesting fresh content from the origin web server.

lifetimeHonorOws

string

no

optional

read/write

Specifies when enabled (selected), that the WebAccelerator system must honor specified lifetime values form HTTP header of the origin web server response.

lifetimeHonorOwsValues

string

optional

read/write

Specifies which lifetime values form HTTP header of OWS response must be honored by the WebAccelerator system.

lifetimeHonorRequest

string

yes

optional

read/write

Specifies when enabled (selected), that the WebAccelerator system must honor specified lifetime values form HTTP header of client request.

lifetimeHonorRequestValues

string

optional

read/write

Specifies which lifetime values form HTTP header of client request must be honored by the WebAccelerator system.

lifetimeHttpHeuristic

integer

50

optional

read/write

Specifies the percentage, based on the HTTP_LAST MODIFIED header, that the WebAccelerator system uses to compute TTL values for cached content.

lifetimeInsertNoCache

string

no

optional

read/write

Specifies, when selected (enabled), that the WebAccelerator system inserts a no-cache directive into the HTTP Cache-Control header, which stops the client’s browser from locally caching content.

lifetimePreserveResponse

string

yes

optional

read/write

Specifies when enabled (selected), that the WebAccelerator system must preserve specified lifetime values form HTTP header of the origin web server response.

lifetimePreserveResponseValues

string

optional

read/write

Specifies which lifetime values form HTTP header of OWS response must be preserved and passed through by the WebAccelerator system.

lifetimeResponseMaxAge

string

2147483647

optional

read/write

Specifies the maximum value in seconds of max-age directive for the HTTP Cache-Control header of HTTP response.

lifetimeResponseSMaxage

string

2147483647

optional

read/write

Specifies the maximum value in seconds of s-maxage directive for the HTTP Cache-Control header of HTTP response.

lifetimeStandInCodes

string

optional

read/write

Indicates that the WebAccelerator system may return stale content when request to the origin web server fails with any of these response codes.

lifetimeUseHeuristic

string

no

optional

read/write

Specifies when enabled (selected), that the WebAccelerator system must use heuristic to compute TTL values for cached content.

objectMaxSize

string

0

optional

read/write

Specifies the maximum object size allowed for content matching the associated node in order to be eligible for caching. The default behavior is to use the maximum object size specified on the associated web-acceleration profile.

objectMinSize

string

-1

optional

read/write

Specifies the minimum object size required in order for content matching the associated node to be eligible for caching. The default behavior is to use the minimum object size specified on the associated web-acceleration profile.

optimizeForClient

string

no

optional

read/write

Specifies whether to convert images to a size and/or format which is best for the specific client making the request.

optimizeImage

string

none

optional

read/write

Specifies whether to enable image optimization and which target format to use.

order

integer

2147483647

optional

read/write

Specifies the order of nodes with the same base node, starting from 2, in which nodes will be processed.

png_256Colors

string

no

optional

read/write

Specifies whether PNG images should be optimized to use only 256 colors.

requestQueueing

string

disabled

optional

read/write

Specifies that the WebAccelerator will queue multiple requests for expired or new objects, proxying fewer requests to the origin web server (OWS) to handle the client traffic.

responseCodesCached

string

optional

read/write

Indicates that the WebAccelerator system caches content from the origin web server if it returns these response codes.

type

string

leaf

optional

read/write

Specifies if node is a branch (it has sub nodes) or is if a leaf (no sub nodes). This attribute is read-only.

videoOptimizationAdFrequency

integer

0

optional

read/write

Specifies the frequency of ad insertion. Units in seconds.

videoOptimizationAdPolicy

string

optional

read/write

Specifies the ad policy applicable when processing the video.

videoOptimizationFastStart

string

disabled

optional

read/write

Specifies, when enabled, that the WebAccelerator system optimizes video by prefetching.

videoOptimizationInsertAd

string

disabled

optional

read/write

Specifies, when enabled, that the WebAccelerator system can insert ad into the video.

videoOptimizationMaxBitrate

integer

0

optional

read/write

Specifies, the maximum bitrate of video that can be allowed.

videoOptimizationPrerollAd

string

disabled

optional

read/write

Specifies, when enabled, that the WebAccelerator system can insert ad at the beginning of the video.

viewstateCache

string

disabled

optional

read/write

Specifies, when enabled, that the WebAccelerator system caches ViewState information from HTML document.

viewstateCacheSize

integer

100

optional

read/write

Specifies the size, in kilobytes, of the ViewState cache. The default value is 100 kilobytes.

viewstateTag

string

__VIEWSTATE

optional

read/write

Specifies the name of hidden form in HTML document where ViewState information is stored. The default is __VIEWSTATE.

webpQuality

integer

75

optional

read/write

Specifies the amount of compression to use when producing WEBP images.

Subcollections

Name Type Default Value Required Access Description
invalidations array_structure   optional read/write Invalidation triggers allow to invalidate specific documents in the cache.
matching array_structure   optional read/write Rule that defines which HTTP requests should be processed by Web Accelerator.
proxy array_structure   optional read/write Rule that defines which HTTP requests should be proxied by Web Accelerator.
proxy-override array_structure   optional read/write Rule that defines which HTTP requests should not be proxied by Web Accelerator.
substitutions array_structure   optional read/write Parameter value substitution.
variation array_structure   optional read/write Rule that defines in which case WebAccelerator system replies to HTTP requests with same document or different document.

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.