{ "id":"/axapi/v3/slb/template", "type":"object", "node-type":"intermediate", "title":"template", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "description":"Define an SLB template", "properties":{ "http-list":{ "type":"array", "minItems":1, "items":{ "type":"http" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/http/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"HTTP Template Name", "optional":false }, "compression-auto-disable-on-high-cpu":{ "type":"number", "format":"number", "minimum":1, "maximum":100, "partition-visibility":"shared", "description":"Auto-disable software compression on high cpu usage (Disable compression if cpu usage is above threshold. Default is off.)", "optional":true }, "compression-content-type":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "content-type":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Compression content-type" } } } ] }, "compression-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable Compression", "optional":true }, "compression-exclude-content-type":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "exclude-content-type":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Compression exclude content-type (Compression exclude content type)" } } } ] }, "compression-exclude-uri":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "exclude-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Compression exclude uri" } } } ] }, "compression-keep-accept-encoding":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Keep accept encoding", "optional":true }, "compression-keep-accept-encoding-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable Server Accept Encoding", "optional":true }, "compression-level":{ "type":"number", "format":"number", "minimum":1, "maximum":9, "default":1, "partition-visibility":"shared", "description":"gzip compression level, default 1 (gzip compression level value, default is 1)", "optional":true }, "compression-br-level":{ "type":"number", "format":"number", "minimum":1, "maximum":9, "default":1, "partition-visibility":"shared", "description":"brotli compression level, default 1 (brotli compression level value, default is 1)", "optional":true }, "compression-br-sliding-window-size":{ "type":"number", "format":"number", "minimum":10, "maximum":24, "partition-visibility":"shared", "description":"brotli compression sliding window size, default 10 (brotli compression sliding window size in the form of log (i.e., 10 means 1k-16MB bytes))", "optional":true }, "compression-minimum-content-length":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "default":120, "partition-visibility":"shared", "description":"Minimum Content Length (Minimum content length for compression in bytes. Default is 120.)", "optional":true }, "compression-method-order":{ "type":"string", "format":"string-rlx", "minLength":11, "maxLength":11, "partition-visibility":"shared", "description":"Method Order (Order to decide which compression algorithm to be applied when multiple algorithms are acceptable)", "optional":true }, "default-charset":{ "type":"string", "format":"enum", "default":"utf-8", "partition-visibility":"shared", "description":"'iso-8859-1': Use ISO-8859-1 as the default charset; 'utf-8': Use UTF-8 as the default charset; 'us-ascii': Use US-ASCII as the default charset; ", "enum":[ "iso-8859-1", "utf-8", "us-ascii" ], "optional":true }, "max-concurrent-streams":{ "type":"number", "format":"number", "minimum":1, "maximum":1000, "default":50, "partition-visibility":"shared", "description":"(http2 only) Max concurrent streams, default 50", "optional":true }, "stream-cancellation-limit":{ "type":"number", "format":"number", "minimum":0, "maximum":1000, "default":0, "partition-visibility":"shared", "description":"cancellation limit, default 0 (accumulated cancellation limit value, default is 0)", "optional":true }, "stream-cancellation-rate":{ "type":"number", "format":"number", "minimum":0, "maximum":1000, "default":10, "partition-visibility":"shared", "description":"cancellation rate, default 10 (cancellation rate value, default is 10)", "optional":true }, "frame-limit":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "default":10000, "partition-visibility":"shared", "description":"Limit the number of CONTINUATION, PING, PRIORITY, RESET, SETTINGS and empty frames in one HTTP2 connection, default 10000", "optional":true }, "failover-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Failover to this URL (Failover URL Name)", "optional":true }, "host-switching":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "host-switching-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'contains': Select service group if hostname contains another string; 'ends-with': Select service group if hostname ends with another string; 'equals': Select service group if hostname equals another string; 'starts-with': Select service group if hostname starts with another string; 'regex-match': Select service group if URL string matches with regular expression; 'host-hits-enable': Enables Host Hits counters; ", "enum":[ "contains", "ends-with", "equals", "starts-with", "regex-match", "host-hits-enable" ] }, "host-match-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Hostname String" }, "host-service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Create a Service Group comprising Servers (Service Group Name)" } } } ] }, "insert-client-ip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Insert Client IP address into HTTP header", "optional":true }, "insert-client-ip-header-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"HTTP Header Name for inserting Client IP", "optional":true }, "client-ip-hdr-replace":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Replace the existing header", "optional":true }, "insert-client-port":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Insert Client Port address into HTTP header", "optional":true }, "insert-client-port-header-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"HTTP Header Name for inserting Client Port", "optional":true }, "client-port-hdr-replace":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Replace the existing header", "optional":true }, "log-retry":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"log when HTTP request retry", "optional":true }, "non-http-bypass":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Bypass non-http traffic instead of dropping", "optional":true }, "bypass-sg":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Select service group for non-http traffic (Service Group Name)", "optional":true }, "redirect":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Automatically send a redirect response", "optional":true }, "rd-simple-loc":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "not-list":[ "rd-secure", "rd-port" ], "description":"Redirect location tag absolute URI string", "optional":true }, "rd-secure":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"rd-simple-loc", "description":"Use HTTPS", "optional":true }, "rd-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "not":"rd-simple-loc", "description":"Port (Port Number)", "optional":true }, "rd-resp-code":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'301': Moved Permanently; '302': Found; '303': See Other; '307': Temporary Redirect; ", "enum":[ "301", "302", "303", "307" ], "optional":true }, "redirect-rewrite":{ "type":"object", "properties":{ "match-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "redirect-match":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"URL Matching (Pattern URL String)" }, "rewrite-to":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Rewrite to Destination URL String" } } } ] }, "redirect-secure":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use HTTPS" }, "redirect-secure-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":443, "partition-visibility":"shared", "description":"Port (Port Number)" } } }, "request-header-erase-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "request-header-erase":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Erase a header from HTTP request (Header Name)" } } } ] }, "request-header-insert-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "request-header-insert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Insert a header into HTTP request (Header Content (Format: \"[name]:[value]\"))" }, "request-header-insert-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; ", "enum":[ "insert-if-not-exist", "insert-always" ] } } } ] }, "response-content-replace-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "response-content-replace":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"replace the data from HTTP response content (String in the http content need to be replaced)" }, "response-new-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"String will be in the http content" } } } ] }, "response-header-erase-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "response-header-erase":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Erase a header from HTTP response (Header Name)" } } } ] }, "response-header-insert-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "response-header-insert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Insert a header into HTTP response (Header Content (Format: \"[name]:[value]\"))" }, "response-header-insert-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; ", "enum":[ "insert-if-not-exist", "insert-always" ] } } } ] }, "request-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":120, "partition-visibility":"shared", "description":"Request timeout if response not received (timeout in seconds)", "optional":true }, "retry-on-5xx":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"retry-on-5xx-per-req", "description":"Retry http request on HTTP 5xx code and request timeout", "optional":true }, "retry-on-5xx-val":{ "type":"number", "format":"number", "minimum":1, "maximum":3, "default":3, "partition-visibility":"shared", "description":"Number of times to retry (default is 3)", "optional":true }, "retry-on-5xx-per-req":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"retry-on-5xx", "description":"Retry http request on HTTP 5xx code for each request", "optional":true }, "retry-on-5xx-per-req-val":{ "type":"number", "format":"number", "minimum":1, "maximum":3, "default":3, "partition-visibility":"shared", "description":"Number of times to retry (default is 3)", "optional":true }, "strict-transaction-switch":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Force server selection on every HTTP request", "optional":true }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/logging", "description":"Logging template (Logging Config name)" } } }, "term-11client-hdr-conn-close":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Terminate HTTP 1.1 client when req has Connection: close", "optional":true }, "persist-on-401":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Persist to the same server if the response code is 401", "optional":true }, "100-cont-wait-for-req-complete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"When REQ has Expect 100 and response is not 100, then wait for whole request to be sent", "optional":true }, "http2-client-no-snat":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Set max-concurrent-stream = 1 when the client side is HTTP2 and no source-nat configuration is under vport", "optional":true }, "url-hash-persist":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use URL's hash value to select server", "optional":true }, "url-hash-offset":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "partition-visibility":"shared", "description":"Skip part of URL to calculate hash value (Offset of the URL string)", "optional":true }, "url-hash-first":{ "type":"number", "format":"number", "minimum":4, "maximum":128, "partition-visibility":"shared", "not":"url-hash-last", "description":"Use the begining part of URL to calculate hash value (URL string length to calculate hash value)", "optional":true }, "url-hash-last":{ "type":"number", "format":"number", "minimum":4, "maximum":128, "partition-visibility":"shared", "not":"url-hash-first", "description":"Use the end part of URL to calculate hash value (URL string length to calculate hash value)", "optional":true }, "use-server-status":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use Server-Status header to do URL hashing", "optional":true }, "url-switching":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "url-switching-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'contains': Select service group if URL string contains another string; 'ends-with': Select service group if URL string ends with another string; 'equals': Select service group if URL string equals another string; 'starts-with': Select service group if URL string starts with another string; 'regex-match': Select service group if URL string matches with regular expression; 'url-case-insensitive': Case insensitive URL switching; 'url-hits-enable': Enables URL Hits; ", "enum":[ "contains", "ends-with", "equals", "starts-with", "regex-match", "url-case-insensitive", "url-hits-enable" ] }, "url-match-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"URL String" }, "url-service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Create a Service Group comprising Servers (Service Group Name)" } } } ] }, "req-hdr-wait-time":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"HTTP request header wait time before abort connection", "optional":true }, "req-hdr-wait-time-val":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "default":7, "partition-visibility":"shared", "description":"Number of seconds wait for client request header (default is 7)", "optional":true }, "request-line-case-insensitive":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Parse http request line as case insensitive", "optional":true }, "keep-client-alive":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Keep client alive", "optional":true }, "cookie-format":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'rfc6265': Follow rfc6265; ", "enum":[ "rfc6265" ], "optional":true }, "prefix":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'host': the cookie will have been set with a Secure attribute, a Path attribute with a value of /, and no Domain attribute; 'secure': the cookie will have been set with a Secure attribute; 'check': check server prefix and enforce prefix format; ", "enum":[ "host", "secure", "check" ], "optional":true }, "cookie-samesite":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'none': none; 'lax': lax; 'strict': strict; ", "enum":[ "none", "lax", "strict" ], "optional":true }, "server-support-http2-only":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Notify the vport regarding whether server supports http2 only", "optional":true }, "server-support-http2-only-value":{ "type":"string", "format":"enum", "default":"auto-detect", "partition-visibility":"shared", "description":"'auto-detect': Commuincate with the server via HTTP/2 when an support-http2-only rport is detected; 'force': Communicate with the server via HTTP/2 when possible; ", "enum":[ "auto-detect", "force" ], "optional":true }, "client-idle-timeout":{ "type":"number", "format":"number", "minimum":0, "maximum":120, "default":0, "partition-visibility":"shared", "description":"Client session timeout if the next request is not received (timeout in seconds. 0 means disable, default is 0)", "optional":true }, "disallowed-methods":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1023, "partition-visibility":"shared", "not":"allowed-methods", "description":"Enable disallowed-method check (List of disallowed HTTP methods)", "optional":true }, "disallowed-methods-action":{ "type":"string", "format":"enum", "default":"drop", "partition-visibility":"shared", "description":"'drop': Respond 400 directly; ", "enum":[ "drop" ], "optional":true }, "allowed-methods":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1023, "partition-visibility":"shared", "not":"disallowed-methods", "description":"Enable allowed-method check (List of allowed HTTP methods)", "optional":true }, "allowed-methods-action":{ "type":"string", "format":"enum", "default":"drop", "partition-visibility":"shared", "description":"'drop': Respond 400 directly; ", "enum":[ "drop" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "http-protocol-check":{ "type":"object", "$ref":"/axapi/v3/slb/template/http/{name}/http-protocol-check", "properties":{ "h2up-content-length-alias":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Drop the request and send 400 to the client side; ", "enum":[ "drop" ] }, "malformed-h2up-header-value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Drop the request and send 400 to the client side; ", "enum":[ "drop" ] }, "malformed-h2up-scheme-value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Drop the request and send 400 to the client side; ", "enum":[ "drop" ] }, "h2up-with-transfer-encoding":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Drop the request and send 400 to the client side; ", "enum":[ "drop" ] }, "multiple-content-length":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Drop the request and send 400 to the client side; ", "enum":[ "drop" ] }, "multiple-transfer-encoding":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Drop the request and send 400 to the client side; ", "enum":[ "drop" ] }, "transfer-encoding-and-content-length":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Drop the request and Send 400 to the client side; ", "enum":[ "drop" ] }, "get-and-payload":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Drop the request and send 400 to the client side; ", "enum":[ "drop" ] }, "h2up-with-host-and-auth":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Drop the request and send 400 to the client side; ", "enum":[ "drop" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "header-filter-rule-list":{ "type":"array", "minItems":1, "items":{ "type":"header-filter-rule" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/http/{name}/http-protocol-check/header-filter-rule/{seq-num}", "array":[ { "properties":{ "seq-num":{ "type":"number", "format":"number", "minimum":0, "maximum":4, "partition-visibility":"shared", "description":"Specify a sequence number", "optional":false }, "match-type-value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'full-text': Full text match; 'pcre': PCRE match; ", "enum":[ "full-text", "pcre" ], "optional":true }, "header-name-value":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Header name value", "optional":true }, "header-value-value":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Header value", "optional":true }, "action-value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Drop the request; ", "enum":[ "drop" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "seq-num" ] } ] } } } }, "required":[ "name" ] } ] }, "cache-list":{ "type":"array", "minItems":1, "items":{ "type":"cache" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/cache/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify cache template name", "optional":false }, "accept-reload-req":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Accept reload requests via cache-control directives in HTTP headers", "optional":true }, "age":{ "type":"number", "format":"number", "minimum":1, "maximum":999999, "default":3600, "partition-visibility":"shared", "description":"Specify duration in seconds cached content valid, default is 3600 seconds (seconds that the cached content is valid (default 3600 seconds))", "optional":true }, "default-policy-nocache":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify default policy to be to not cache", "optional":true }, "disable-insert-age":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable insertion of age header in response served from RAM cache", "optional":true }, "disable-insert-via":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable insertion of via header in response served from RAM cache", "optional":true }, "max-cache-size":{ "type":"number", "format":"number", "minimum":1, "maximum":4096, "default":80, "partition-visibility":"shared", "description":"Specify maximum cache size in megabytes, default is 80MB (RAM cache size in megabytes (default 80MB))", "optional":true }, "min-content-size":{ "type":"number", "format":"number", "minimum":0, "maximum":268435455, "default":512, "partition-visibility":"shared", "description":"Minimum size (bytes) of response that can be cached - default 512", "optional":true }, "max-content-size":{ "type":"number", "format":"number", "minimum":0, "maximum":268435455, "default":81920, "partition-visibility":"shared", "description":"Maximum size (bytes) of response that can be cached - default 81920 (80KB)", "optional":true }, "local-uri-policy":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "local-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify Local URI for caching (Specify URI pattern that the policy should be applied to, maximum 63 charaters)" } } } ] }, "uri-policy":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify URI for cache policy (Specify URI pattern that the policy should be applied to, maximum 63 charaters)" }, "cache-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'cache': Specify if certain URIs should be cached; 'nocache': Specify if certain URIs should not be cached; ", "enum":[ "cache", "nocache" ] }, "cache-value":{ "type":"number", "format":"number", "minimum":1, "maximum":999999, "partition-visibility":"shared", "description":"Specify seconds that content should be cached, default is age specified in cache template" }, "invalidate":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Specify if URI should invalidate cache entries matching pattern (pattern that would match entries to be invalidated (64 chars max))" } } } ] }, "remove-cookies":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Remove cookies in response and cache", "optional":true }, "replacement-policy":{ "type":"string", "format":"enum", "default":"LFU", "partition-visibility":"shared", "description":"'LFU': LFU; ", "enum":[ "LFU" ], "optional":true }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/logging", "description":"Specify logging template (Logging Config name)", "optional":true }, "verify-host":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Verify request using host before sending response from RAM cache", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'hits': Cache hits; 'miss': Cache misses; 'bytes_served': Bytes served from cache; 'total_req': Total requests received; 'caching_req': Total requests to cache; 'nc_req_header': slbTemplateCacheNcReqHeader, help nc_req_header; 'nc_res_header': slbTemplateCacheNcResHeader, help nc_res_header; 'rv_success': rv_success; 'rv_failure': slbTemplateCacheRvFailure, help rv_failure; 'ims_request': ims_request; 'nm_response': nm_response; 'rsp_type_CL': rsp_type_CL; 'rsp_type_CE': rsp_type_CE; 'rsp_type_304': rsp_type_304; 'rsp_type_other': rsp_type_other; 'rsp_no_compress': rsp_no_compress; 'rsp_gzip': rsp_gzip; 'rsp_deflate': rsp_deflate; 'rsp_other': rsp_other; 'nocache_match': nocache_match; 'match': match; 'invalidate_match': invalidate_match; 'content_toobig': slbTemplateCacheContentToobig, help content_toobig; 'content_toosmall': slbTemplateCacheContentToosmall, help content_toosmall; 'entry_create_failures': slbTemplateCacheEntryCreateFailures, help entry_create_failures; 'mem_size': mem_size; 'entry_num': entry_num; 'replaced_entry': replaced_entry; 'aging_entry': aging_entry; 'cleaned_entry': cleaned_entry; 'rsp_type_stream': rsp_type_stream; 'header_save_error': header_save_error; 'rsp_br': rsp_br; ", "enum":[ "all", "hits", "miss", "bytes_served", "total_req", "caching_req", "nc_req_header", "nc_res_header", "rv_success", "rv_failure", "ims_request", "nm_response", "rsp_type_CL", "rsp_type_CE", "rsp_type_304", "rsp_type_other", "rsp_no_compress", "rsp_gzip", "rsp_deflate", "rsp_other", "nocache_match", "match", "invalidate_match", "content_toobig", "content_toosmall", "entry_create_failures", "mem_size", "entry_num", "replaced_entry", "aging_entry", "cleaned_entry", "rsp_type_stream", "header_save_error", "rsp_br" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/slb-templ-cache-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true } }, "required":[ "name" ] } ] }, "cipher-list":{ "type":"array", "minItems":1, "items":{ "type":"cipher" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/cipher/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Cipher Template Name", "optional":false }, "cipher13-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "cipher13-suite":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'TLS_AES_256_GCM_SHA384': TLS_AES_256_GCM_SHA384 (0x1302); 'TLS_CHACHA20_POLY1305_SHA256': TLS_CHACHA20_POLY1305_SHA256 (0x1303); 'TLS_AES_128_GCM_SHA256': TLS_AES_128_GCM_SHA256 (0x1301); ", "enum":[ "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", "TLS_AES_128_GCM_SHA256" ] }, "priority":{ "type":"number", "format":"number", "minimum":1, "maximum":100, "default":1, "partition-visibility":"shared", "description":"Cipher priority (Cipher priority (default 1))" } } } ] }, "cipher-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "cipher-suite":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'SSL3_RSA_DES_192_CBC3_SHA': TLS_RSA_WITH_3DES_EDE_CBC_SHA (0x000A); 'SSL3_RSA_RC4_128_MD5': TLS_RSA_WITH_RC4_128_MD5 (0x0004); 'SSL3_RSA_RC4_128_SHA': TLS_RSA_WITH_RC4_128_SHA (0x0005); 'TLS1_RSA_AES_128_SHA': TLS_RSA_WITH_AES_128_CBC_SHA (0x002F); 'TLS1_RSA_AES_256_SHA': TLS_RSA_WITH_AES_256_CBC_SHA (0x0035); 'TLS1_RSA_AES_128_SHA256': TLS_RSA_WITH_AES_128_CBC_SHA256 (0x003C); 'TLS1_RSA_AES_256_SHA256': TLS_RSA_WITH_AES_256_CBC_SHA256 (0x003D); 'TLS1_DHE_RSA_AES_128_GCM_SHA256': TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 (0x009E); 'TLS1_DHE_RSA_AES_128_SHA': TLS_DHE_RSA_WITH_AES_128_CBC_SHA (0x0033); 'TLS1_DHE_RSA_AES_128_SHA256': TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 (0x0067); 'TLS1_DHE_RSA_AES_256_GCM_SHA384': TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 (0x009F); 'TLS1_DHE_RSA_AES_256_SHA': TLS_DHE_RSA_WITH_AES_256_CBC_SHA (0x0039); 'TLS1_DHE_RSA_AES_256_SHA256': TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 (0x006B); 'TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 (0xC02B); 'TLS1_ECDHE_ECDSA_AES_128_SHA': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA (0xC009); 'TLS1_ECDHE_ECDSA_AES_128_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 (0xC023); 'TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 (0xC02C); 'TLS1_ECDHE_ECDSA_AES_256_SHA': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA (0xC00A); 'TLS1_ECDHE_RSA_AES_128_GCM_SHA256': TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (0xC02F); 'TLS1_ECDHE_RSA_AES_128_SHA': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (0xC013); 'TLS1_ECDHE_RSA_AES_128_SHA256': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (0xC027); 'TLS1_ECDHE_RSA_AES_256_GCM_SHA384': TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xC030); 'TLS1_ECDHE_RSA_AES_256_SHA': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (0xC014); 'TLS1_RSA_AES_128_GCM_SHA256': TLS_RSA_WITH_AES_128_GCM_SHA256 (0x009C); 'TLS1_RSA_AES_256_GCM_SHA384': TLS_RSA_WITH_AES_256_GCM_SHA384 (0x009D); 'TLS1_ECDHE_RSA_AES_256_SHA384': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (0xC028); 'TLS1_ECDHE_ECDSA_AES_256_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 (0xC024); 'TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA8); 'TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA9); 'TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256': TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCAA); 'TLS1_ECDHE_SM2_WITH_SMS4_SM3': TLS_ECDHE_SM2_WITH_SMS4_SM3 (0xE102); 'TLS1_ECDHE_SM2_WITH_SMS4_SHA256': TLS_ECDHE_SM2_WITH_SMS4_SHA256 (0xE105); 'TLS1_ECDHE_SM2_WITH_SMS4_GCM_SM3': TLS_ECDHE_SM2_WITH_SMS4_GCM_SM3 (0xE107); ", "enum":[ "SSL3_RSA_DES_192_CBC3_SHA", "SSL3_RSA_RC4_128_MD5", "SSL3_RSA_RC4_128_SHA", "TLS1_RSA_AES_128_SHA", "TLS1_RSA_AES_256_SHA", "TLS1_RSA_AES_128_SHA256", "TLS1_RSA_AES_256_SHA256", "TLS1_DHE_RSA_AES_128_GCM_SHA256", "TLS1_DHE_RSA_AES_128_SHA", "TLS1_DHE_RSA_AES_128_SHA256", "TLS1_DHE_RSA_AES_256_GCM_SHA384", "TLS1_DHE_RSA_AES_256_SHA", "TLS1_DHE_RSA_AES_256_SHA256", "TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256", "TLS1_ECDHE_ECDSA_AES_128_SHA", "TLS1_ECDHE_ECDSA_AES_128_SHA256", "TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384", "TLS1_ECDHE_ECDSA_AES_256_SHA", "TLS1_ECDHE_RSA_AES_128_GCM_SHA256", "TLS1_ECDHE_RSA_AES_128_SHA", "TLS1_ECDHE_RSA_AES_128_SHA256", "TLS1_ECDHE_RSA_AES_256_GCM_SHA384", "TLS1_ECDHE_RSA_AES_256_SHA", "TLS1_RSA_AES_128_GCM_SHA256", "TLS1_RSA_AES_256_GCM_SHA384", "TLS1_ECDHE_RSA_AES_256_SHA384", "TLS1_ECDHE_ECDSA_AES_256_SHA384", "TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256", "TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256", "TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256", "TLS1_ECDHE_SM2_WITH_SMS4_SM3", "TLS1_ECDHE_SM2_WITH_SMS4_SHA256", "TLS1_ECDHE_SM2_WITH_SMS4_GCM_SM3" ] }, "priority":{ "type":"number", "format":"number", "minimum":1, "maximum":100, "default":1, "partition-visibility":"shared", "description":"Cipher priority (Cipher priority (default 1))" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "client-ssl-list":{ "type":"array", "minItems":1, "items":{ "type":"client-ssl" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/client-ssl/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Client SSL Template Name", "optional":false }, "auth-username":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify the Username Field in the Client Certificate(If multi-fields are specificed, prior one has higher priority)", "optional":true }, "ca-certs":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ca-cert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"CA Certificate (CA Certificate Name)" }, "ca-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "description":"CA Certificate Partition Shared" }, "client-ocsp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify ocsp authentication server(s) for client certificate verification" }, "client-ocsp-srvr":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/server/ocsp/instance", "description":"Specify authentication server" }, "client-ocsp-sg":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/service-group", "description":"Specify service-group (Service group name)" } } } ] }, "chain-cert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "not":"chain-cert-shared-str", "description":"Chain Certificate Name", "optional":true }, "chain-cert-shared-str":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"private", "not":"chain-cert", "description":"Chain Certificate Name", "optional":true }, "dh-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'1024': 1024; '1024-dsa': 1024-dsa; '2048': 2048; ", "enum":[ "1024", "1024-dsa", "2048" ], "optional":true }, "ec-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ec":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'secp256r1': X9_62_prime256v1; 'secp384r1': secp384r1; ", "enum":[ "secp256r1", "secp384r1" ] } } } ] }, "local-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable local logging", "optional":true }, "ocsp-stapling":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Config OCSP stapling support", "optional":true }, "ocspst-ca-cert":{ "type":"string", "format":"string", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"CA certificate", "optional":true }, "ocspst-ocsp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify OCSP Authentication", "optional":true }, "ocspst-srvr":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/server/ocsp", "not":"ocspst-sg", "description":"Specify OCSP authentication server", "optional":true }, "ocspst-srvr-days":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "not-list":[ "ocspst-srvr-hours", "ocspst-srvr-minutes" ], "description":"Specify update period, in days", "optional":true }, "ocspst-srvr-hours":{ "type":"number", "format":"number", "minimum":1, "maximum":23, "default":1, "partition-visibility":"shared", "not-list":[ "ocspst-srvr-days", "ocspst-srvr-minutes" ], "description":"Specify update period, in hours", "optional":true }, "ocspst-srvr-minutes":{ "type":"number", "format":"number", "minimum":1, "maximum":59, "partition-visibility":"shared", "not-list":[ "ocspst-srvr-days", "ocspst-srvr-hours" ], "description":"Specify update period, in minutes", "optional":true }, "ocspst-srvr-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":44640, "default":30, "partition-visibility":"shared", "description":"Specify retry timeout (Default is 30 mins)", "optional":true }, "ocspst-sg":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/service-group", "not":"ocspst-srvr", "description":"Specify authentication service group", "optional":true }, "ocspst-sg-days":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "not-list":[ "ocspst-sg-hours", "ocspst-sg-minutes" ], "description":"Specify update period, in days", "optional":true }, "ocspst-sg-hours":{ "type":"number", "format":"number", "minimum":1, "maximum":23, "default":1, "partition-visibility":"shared", "not-list":[ "ocspst-sg-days", "ocspst-sg-minutes" ], "description":"Specify update period, in hours", "optional":true }, "ocspst-sg-minutes":{ "type":"number", "format":"number", "minimum":1, "maximum":59, "partition-visibility":"shared", "not-list":[ "ocspst-sg-days", "ocspst-sg-hours" ], "description":"Specify update period, in minutes", "optional":true }, "ocspst-sg-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":44640, "default":30, "partition-visibility":"shared", "description":"Specify retry timeout (Default is 30 mins)", "optional":true }, "ssli-inbound-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"forward-proxy-enable", "description":"Enable inbound SSLi", "optional":true }, "ssli-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"SSLi logging level, default is error logging only", "optional":true }, "sslilogging":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'disable': Disable all logging; 'all': enable all logging(error, info); ", "enum":[ "disable", "all" ], "optional":true }, "client-certificate":{ "type":"string", "format":"enum", "default":"Ignore", "partition-visibility":"shared", "description":"'Ignore': Don't request client certificate; 'Require': Require client certificate; 'Request': Request client certificate; ", "enum":[ "Ignore", "Require", "Request" ], "optional":true }, "req-ca-lists":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "client-certificate-Request-CA":{ "type":"string", "format":"string", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Send CA lists in certificate request (CA Certificate Name)" }, "client-cert-req-ca-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "description":"CA Certificate Partition Shared" } } } ] }, "close-notify":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send close notification when terminate connection", "optional":true }, "crl-certs":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "crl":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Certificate Revocation Lists (Certificate Revocation Lists file name)" }, "crl-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "description":"Certificate Revocation Lists Partition Shared" } } } ] }, "forward-proxy-ca-cert":{ "type":"string", "format":"string", "minLength":1, "maxLength":245, "partition-visibility":"shared", "not-list":[ "fp-ca-certificate", "fp-ca-key", "fp-ca-key-pass-phrase", "fp-ca-key-passphrase", "fp-ca-key-encrypted", "fp-ca-chain-cert", "fp-ca-certificate-shared" ], "description":"CA Certificate for forward proxy (SSL forward proxy CA Certificate Name)", "optional":true }, "fp-ca-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "not":"fp-ca-certificate", "description":"CA Certificate Partition Shared", "optional":true }, "forward-proxy-ca-key":{ "type":"string", "format":"string", "minLength":1, "maxLength":245, "partition-visibility":"shared", "not-list":[ "fp-ca-certificate", "fp-ca-key", "fp-ca-key-pass-phrase", "fp-ca-key-passphrase", "fp-ca-key-encrypted", "fp-ca-chain-cert", "fp-ca-certificate-shared" ], "description":"CA Private Key for forward proxy (SSL forward proxy CA Key Name)", "optional":true }, "forward-passphrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"fp-ca-certificate", "description":"Password Phrase", "optional":true }, "forward-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "not":"fp-ca-certificate", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)", "optional":true }, "fp-ca-key-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "not":"fp-ca-certificate", "description":"CA Private Key Partition Shared", "optional":true }, "fp-ca-certificate":{ "type":"string", "format":"string", "minLength":1, "maxLength":245, "partition-visibility":"shared", "not-list":[ "forward-proxy-ca-cert", "fp-ca-shared", "forward-proxy-ca-key", "forward-passphrase", "forward-encrypted", "fp-ca-key-shared" ], "description":"CA Certificate for forward proxy (SSL forward proxy CA Certificate Name)", "optional":true }, "fp-ca-key":{ "type":"string", "format":"string", "minLength":1, "maxLength":245, "partition-visibility":"shared", "not-list":[ "forward-proxy-ca-cert", "forward-proxy-ca-key" ], "description":"CA Private Key for forward proxy (SSL forward proxy CA Key Name)", "optional":true }, "fp-ca-key-passphrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not-list":[ "forward-proxy-ca-cert", "forward-proxy-ca-key" ], "description":"Password Phrase", "optional":true }, "fp-ca-key-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "not-list":[ "forward-proxy-ca-cert", "forward-proxy-ca-key" ], "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)", "optional":true }, "fp-ca-chain-cert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "not-list":[ "forward-proxy-ca-cert", "forward-proxy-ca-key" ], "description":"Chain Certificate (Chain Certificate Name)", "optional":true }, "fp-ca-certificate-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "not-list":[ "forward-proxy-ca-cert", "forward-proxy-ca-key" ], "description":"CA Private Key Partition Shared", "optional":true }, "forward-proxy-alt-sign":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Forward proxy alternate signing cert and key", "optional":true }, "fp-alt-cert":{ "type":"string", "format":"string", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"CA Certificate for forward proxy alternate signing (Certificate name)", "optional":true }, "fp-alt-key":{ "type":"string", "format":"string", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"CA Private Key for forward proxy alternate signing (Key name)", "optional":true }, "fp-alt-passphrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Password Phrase", "optional":true }, "fp-alt-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)", "optional":true }, "fp-alt-chain-cert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Chain Certificate (Chain Certificate Name)", "optional":true }, "fp-alt-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "description":"Alternate CA Certificate and Private Key Partition Shared", "optional":true }, "forward-proxy-trusted-ca-lists":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "forward-proxy-trusted-ca":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Forward proxy trusted CA file (CA file name)" }, "fp-trusted-ca-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "description":"Trusted CA Certificate Partition Shared" } } } ] }, "forward-proxy-decrypted-dscp":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "partition-visibility":"shared", "description":"Apply a DSCP to decrypted and bypassed traffic (DSCP to apply to decrypted traffic)", "optional":true }, "forward-proxy-decrypted-dscp-bypass":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "partition-visibility":"shared", "description":"DSCP to apply to bypassed traffic", "optional":true }, "enable-tls-alert-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable TLS alert logging", "optional":true }, "alert-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'fatal': Log fatal alerts; ", "enum":[ "fatal" ], "optional":true }, "forward-proxy-verify-cert-fail-action":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Action taken if certificate verification fails, close the connection by default", "optional":true }, "verify-cert-fail-action":{ "type":"string", "format":"enum", "default":"drop", "partition-visibility":"shared", "description":"'bypass': bypass SSLi processing; 'continue': continue the connection; 'drop': close the connection; 'block': block the connection with a warning page; ", "enum":[ "bypass", "continue", "drop", "block" ], "optional":true }, "forward-proxy-cert-revoke-action":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Action taken if a certificate is irreversibly revoked, bypass SSLi processing by default", "optional":true }, "cert-revoke-action":{ "type":"string", "format":"enum", "default":"bypass", "partition-visibility":"shared", "description":"'bypass': bypass SSLi processing; 'continue': continue the connection; 'drop': close the connection; 'block': block the connection with a warning page; ", "enum":[ "bypass", "continue", "drop", "block" ], "optional":true }, "forward-proxy-no-shared-cipher-action":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Action taken if handshake fails due to no shared ciper, close the connection by default", "optional":true }, "no-shared-cipher-action":{ "type":"string", "format":"enum", "default":"drop", "partition-visibility":"shared", "description":"'bypass': bypass SSLi processing; 'drop': close the connection; ", "enum":[ "bypass", "drop" ], "optional":true }, "forward-proxy-esni-action":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Action taken if receiving encrypted server name indication extension in client hello MSG, bypass the connection by default", "optional":true }, "fp-esni-action":{ "type":"string", "format":"enum", "default":"bypass", "partition-visibility":"shared", "description":"'bypass': bypass SSLi processing; 'drop': close the connection; ", "enum":[ "bypass", "drop" ], "optional":true }, "forward-proxy-cert-unknown-action":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Action taken if a certificate revocation status is unknown, bypass SSLi processing by default", "optional":true }, "cert-unknown-action":{ "type":"string", "format":"enum", "default":"bypass", "partition-visibility":"shared", "description":"'bypass': bypass SSLi processing; 'continue': continue the connection; 'drop': close the connection; 'block': block the connection with a warning page; ", "enum":[ "bypass", "continue", "drop", "block" ], "optional":true }, "forward-proxy-block-message":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1023, "partition-visibility":"shared", "description":"Message to be included on the block page (Message, enclose in quotes if spaces are present)", "optional":true }, "cache-persistence-list-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Class List Name", "optional":true }, "fp-cert-ext-crldp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"CRL Distribution Point (CRL Distribution Point URI)", "optional":true }, "fp-cert-ext-aia-ocsp":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "not":"fp-cert-ext-aia-ca-issuers", "description":"OCSP (Authority Information Access URI)", "optional":true }, "fp-cert-ext-aia-ca-issuers":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "not":"fp-cert-ext-aia-ocsp", "description":"CA Issuers (Authority Information Access URI)", "optional":true }, "notbefore":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"notBefore date", "optional":true }, "notbeforeday":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "description":"Day", "optional":true }, "notbeforemonth":{ "type":"number", "format":"number", "minimum":1, "maximum":12, "partition-visibility":"shared", "description":"Month", "optional":true }, "notbeforeyear":{ "type":"number", "format":"number", "minimum":2005, "maximum":2035, "partition-visibility":"shared", "description":"Year", "optional":true }, "notafter":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"notAfter date", "optional":true }, "notafterday":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "description":"Day", "optional":true }, "notaftermonth":{ "type":"number", "format":"number", "minimum":1, "maximum":12, "partition-visibility":"shared", "description":"Month", "optional":true }, "notafteryear":{ "type":"number", "format":"number", "minimum":2005, "maximum":2035, "partition-visibility":"shared", "description":"Year", "optional":true }, "forward-proxy-hash-persistence-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":720, "default":30, "partition-visibility":"shared", "description":"Set the time interval to save the hash persistence certs (Interval value, in minutes)", "optional":true }, "forward-proxy-ssl-version":{ "type":"number", "format":"number", "minimum":31, "maximum":34, "default":33, "partition-visibility":"shared", "description":"TLS/SSL version, default is TLS1.2 (TLS/SSL version: 31-TLSv1.0, 32-TLSv1.1, 33-TLSv1.2 and 34-TLSv1.3)", "optional":true }, "forward-proxy-ocsp-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable ocsp-stapling for forward proxy", "optional":true }, "forward-proxy-crl-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Certificate Revocation List checking for forward proxy", "optional":true }, "forward-proxy-cert-cache-timeout":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "default":3600, "partition-visibility":"shared", "description":"Certificate cache timeout, default is 1 hour (seconds, set to 0 for never timeout)", "optional":true }, "forward-proxy-cert-cache-limit":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "default":524288, "partition-visibility":"shared", "description":"Certificate cache size limit, default is 524288 (set to 0 for unlimited size)", "optional":true }, "forward-proxy-cert-expiry":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Adjust certificate expiry relative to the time when it is created on the device", "optional":true }, "expire-hours":{ "type":"number", "format":"number", "minimum":1, "maximum":168, "partition-visibility":"shared", "description":"Certificate lifetime in hours", "optional":true }, "forward-proxy-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"ssli-inbound-enable", "description":"Enable SSL forward proxy", "optional":true }, "handshake-logging-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable SSL handshake logging", "optional":true }, "forward-proxy-selfsign-redir":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Redirect connections to pages with self signed certs to a warning page", "optional":true }, "forward-proxy-failsafe-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Failsafe for SSL forward proxy", "optional":true }, "forward-proxy-log-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable SSL forward proxy logging", "optional":true }, "fp-cert-fetch-natpool-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/nat/pool", "not-list":[ "shared-partition-pool", "fp-cert-fetch-autonat" ], "description":"Specify NAT pool or pool group", "optional":true }, "shared-partition-pool":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "not":"fp-cert-fetch-natpool-name", "description":"Reference a NAT pool or pool group from shared partition", "optional":true }, "fp-cert-fetch-natpool-name-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"private", "$ref":"/axapi/v3/ip/nat/pool", "description":"Specify NAT pool or pool group", "optional":true }, "fp-cert-fetch-natpool-precedence":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Set this NAT pool as higher precedence than other source NAT like configued under template policy", "optional":true }, "fp-cert-fetch-autonat":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not":"fp-cert-fetch-natpool-name", "description":"'auto': Configure auto NAT for server certificate fetching; ", "enum":[ "auto" ], "optional":true }, "fp-cert-fetch-autonat-precedence":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Set this NAT pool as higher precedence than other source NAT like configued under template policy", "optional":true }, "forward-proxy-no-sni-action":{ "type":"string", "format":"enum", "default":"intercept", "partition-visibility":"shared", "description":"'intercept': intercept in no SNI case; 'bypass': bypass in no SNI case; 'reset': reset in no SNI case; ", "enum":[ "intercept", "bypass", "reset" ], "optional":true }, "case-insensitive":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Case insensitive forward proxy bypass", "optional":true }, "class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "not":"multi-clist-name", "description":"Class List Name", "optional":true }, "multi-class-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "multi-clist-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "not":"class-list-name", "description":"Class List Name" } } } ] }, "user-name-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Forward proxy bypass if user-name matches class-list", "optional":true }, "ad-group-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Forward proxy bypass if ad-group matches class-list", "optional":true }, "exception-user-name-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Exceptions to forward proxy bypass if user-name matches class-list", "optional":true }, "exception-ad-group-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Exceptions to forward proxy bypass if ad-group matches class-list", "optional":true }, "exception-sni-cl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Exceptions to forward-proxy-bypass", "optional":true }, "inspect-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Class List Name", "optional":true }, "inspect-certificate-subject-cl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Forward proxy Inspect if Certificate Subject matches class-list", "optional":true }, "inspect-certificate-issuer-cl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Forward proxy Inspect if Certificate issuer matches class-list", "optional":true }, "inspect-certificate-san-cl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Forward proxy Inspect if Certificate Subject Alternative Name matches class-list", "optional":true }, "contains-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if SNI string contains another string" } } } ] }, "ends-with-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ends-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if SNI string ends with another string" } } } ] }, "equals-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "equals":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if SNI string equals another string" } } } ] }, "starts-with-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "starts-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if SNI string starts with another string" } } } ] }, "certificate-subject-contains-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-subject-contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate Subject contains another string" } } } ] }, "bypass-cert-subject-class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "not":"bypass-cert-subject-multi-class-list-name", "description":"Class List Name", "optional":true }, "bypass-cert-subject-multi-class-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "bypass-cert-subject-multi-class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "not":"bypass-cert-subject-class-list-name", "description":"Class List Name" } } } ] }, "exception-certificate-subject-cl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Exceptions to forward-proxy-bypass", "optional":true }, "certificate-subject-ends-with-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-subject-ends-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate Subject ends with another string" } } } ] }, "certificate-subject-equals-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-subject-equals":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate Subject equals another string" } } } ] }, "certificate-subject-starts-with-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-subject-starts":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate Subject starts with another string" } } } ] }, "certificate-issuer-contains-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-issuer-contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate issuer contains another string (Certificate issuer)" } } } ] }, "bypass-cert-issuer-class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "not":"bypass-cert-issuer-multi-class-list-name", "description":"Class List Name", "optional":true }, "bypass-cert-issuer-multi-class-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "bypass-cert-issuer-multi-class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "not":"bypass-cert-issuer-class-list-name", "description":"Class List Name" } } } ] }, "exception-certificate-issuer-cl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Exceptions to forward-proxy-bypass", "optional":true }, "certificate-issuer-ends-with-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-issuer-ends-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate issuer ends with another string" } } } ] }, "certificate-issuer-equals-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-issuer-equals":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate issuer equals another string" } } } ] }, "certificate-issuer-starts-with-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-issuer-starts":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate issuer starts with another string" } } } ] }, "certificate-san-contains-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-san-contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate SAN contains another string" } } } ] }, "bypass-cert-san-class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "not":"bypass-cert-san-multi-class-list-name", "description":"Class List Name", "optional":true }, "bypass-cert-san-multi-class-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "bypass-cert-san-multi-class-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "not":"bypass-cert-san-class-list-name", "description":"Class List Name" } } } ] }, "exception-certificate-san-cl-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Exceptions to forward-proxy-bypass", "optional":true }, "certificate-san-ends-with-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-san-ends-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate SAN ends with another string" } } } ] }, "certificate-san-equals-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-san-equals":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate SAN equals another string" } } } ] }, "certificate-san-starts-with-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "certificate-san-starts":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if Certificate SAN starts with another string" } } } ] }, "client-auth-case-insensitive":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Case insensitive forward proxy client auth bypass", "optional":true }, "client-auth-class-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy client auth bypass if SNI string matches class-list (Class List Name)", "optional":true }, "client-auth-contains-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "client-auth-contains":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if SNI string contains another string" } } } ] }, "client-auth-ends-with-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "client-auth-ends-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if SNI string ends with another string" } } } ] }, "client-auth-equals-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "client-auth-equals":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if SNI string equals another string" } } } ] }, "client-auth-starts-with-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "client-auth-starts-with":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Forward proxy bypass if SNI string starts with another string" } } } ] }, "forward-proxy-cert-not-ready-action":{ "type":"string", "format":"enum", "default":"bypass", "partition-visibility":"shared", "description":"'bypass': bypass the connection; 'reset': reset the connection; 'intercept': wait for cert and then inspect the connection; ", "enum":[ "bypass", "reset", "intercept" ], "optional":true }, "web-reputation":{ "type":"object", "properties":{ "bypass-trustworthy":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "bypass-low-risk", "bypass-moderate-risk", "bypass-suspicious", "bypass-malicious", "bypass-threshold" ], "description":"Bypass when reputation score is greater than or equal to 81" }, "bypass-low-risk":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "bypass-trustworthy", "bypass-moderate-risk", "bypass-suspicious", "bypass-malicious", "bypass-threshold" ], "description":"Bypass when reputation score is greater than or equal to 61" }, "bypass-moderate-risk":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "bypass-trustworthy", "bypass-low-risk", "bypass-suspicious", "bypass-malicious", "bypass-threshold" ], "description":"Bypass when reputation score is greater than or equal to 41" }, "bypass-suspicious":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "bypass-trustworthy", "bypass-low-risk", "bypass-moderate-risk", "bypass-malicious", "bypass-threshold" ], "description":"Bypass when reputation score is greater than or equal to 21" }, "bypass-malicious":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "bypass-trustworthy", "bypass-low-risk", "bypass-moderate-risk", "bypass-suspicious", "bypass-threshold" ], "description":"Bypass when reputation score is greater than or equal to 1" }, "bypass-threshold":{ "type":"number", "format":"number", "minimum":1, "maximum":100, "partition-visibility":"shared", "not-list":[ "bypass-trustworthy", "bypass-low-risk", "bypass-moderate-risk", "bypass-suspicious", "bypass-malicious" ], "description":"Bypass when reputation score is greater than or equal to the customized score (1-100)" } } }, "exception-web-reputation":{ "type":"object", "properties":{ "exception-trustworthy":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "exception-low-risk", "exception-moderate-risk", "exception-suspicious", "exception-malicious", "exception-threshold" ], "description":"Intercept when reputation score is less than or equal to 100" }, "exception-low-risk":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "exception-trustworthy", "exception-moderate-risk", "exception-suspicious", "exception-malicious", "exception-threshold" ], "description":"Intercept when reputation score is less than or equal to 80" }, "exception-moderate-risk":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "exception-trustworthy", "exception-low-risk", "exception-suspicious", "exception-malicious", "exception-threshold" ], "description":"Intercept when reputation score is less than or equal to 60" }, "exception-suspicious":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "exception-trustworthy", "exception-low-risk", "exception-moderate-risk", "exception-malicious", "exception-threshold" ], "description":"Intercept when reputation score is less than or equal to 40" }, "exception-malicious":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "exception-trustworthy", "exception-low-risk", "exception-moderate-risk", "exception-suspicious", "exception-threshold" ], "description":"Intercept when reputation score is less than or equal to 20" }, "exception-threshold":{ "type":"number", "format":"number", "minimum":1, "maximum":100, "partition-visibility":"shared", "not-list":[ "exception-trustworthy", "exception-low-risk", "exception-moderate-risk", "exception-suspicious", "exception-malicious" ], "description":"Intercept when reputation score is less than or equal to a customized value (1-100)" } } }, "web-category":{ "type":"object", "properties":{ "uncategorized":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Uncategorized URLs" }, "real-estate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Real Estate" }, "computer-and-internet-security":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Computer and Internet Security" }, "financial-services":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Financial Services" }, "business-and-economy":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Business and Economy" }, "computer-and-internet-info":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Computer and Internet Info" }, "auctions":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Auctions" }, "shopping":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Shopping" }, "cult-and-occult":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Cult and Occult" }, "travel":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Travel" }, "drugs":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Abused Drugs" }, "adult-and-pornography":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Adult and Pornography" }, "home-and-garden":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Home and Garden" }, "military":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Military" }, "social-network":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Social Network" }, "dead-sites":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Dead Sites (db Ops only)" }, "stock-advice-and-tools":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Stock Advice and Tools" }, "training-and-tools":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Training and Tools" }, "dating":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Dating" }, "sex-education":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Sex Education" }, "religion":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Religion" }, "entertainment-and-arts":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Entertainment and Arts" }, "personal-sites-and-blogs":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Personal sites and Blogs" }, "legal":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Legal" }, "local-information":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Local Information" }, "streaming-media":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Streaming Media" }, "job-search":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Job Search" }, "gambling":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Gambling" }, "translation":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Translation" }, "reference-and-research":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Reference and Research" }, "shareware-and-freeware":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Shareware and Freeware" }, "peer-to-peer":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Peer to Peer" }, "marijuana":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Marijuana" }, "hacking":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Hacking" }, "games":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Games" }, "philosophy-and-politics":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Philosophy and Political Advocacy" }, "weapons":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Weapons" }, "pay-to-surf":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Pay to Surf" }, "hunting-and-fishing":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Hunting and Fishing" }, "society":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Society" }, "educational-institutions":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Educational Institutions" }, "online-greeting-cards":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Online Greeting cards" }, "sports":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Sports" }, "swimsuits-and-intimate-apparel":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Swimsuits and Intimate Apparel" }, "questionable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Questionable" }, "kids":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Kids" }, "hate-and-racism":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Hate and Racism" }, "personal-storage":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Personal Storage" }, "violence":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Violence" }, "keyloggers-and-monitoring":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Keyloggers and Monitoring" }, "search-engines":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Search Engines" }, "internet-portals":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Internet Portals" }, "web-advertisements":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Web Advertisements" }, "cheating":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Cheating" }, "gross":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Gross" }, "web-based-email":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Web based email" }, "malware-sites":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Malware Sites" }, "phishing-and-other-fraud":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Phishing and Other Frauds" }, "proxy-avoid-and-anonymizers":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Proxy Avoid and Anonymizers" }, "spyware-and-adware":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Spyware and Adware" }, "music":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Music" }, "government":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Government" }, "nudity":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Nudity" }, "news-and-media":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category News and Media" }, "illegal":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Illegal" }, "cdns":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category CDNs" }, "internet-communications":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Internet Communications" }, "bot-nets":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Bot Nets" }, "abortion":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Abortion" }, "health-and-medicine":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Health and Medicine" }, "spam-urls":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category SPAM URLs" }, "dynamically-generated-content":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Dynamically Generated Content" }, "parked-domains":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Parked Domains" }, "alcohol-and-tobacco":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Alcohol and Tobacco" }, "image-and-video-search":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Image and Video Search" }, "fashion-and-beauty":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Fashion and Beauty" }, "recreation-and-hobbies":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Recreation and Hobbies" }, "motor-vehicles":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Motor Vehicles" }, "web-hosting-sites":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Web Hosting Sites" }, "nudity-artistic":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Nudity join Entertainment and Arts" }, "illegal-pornography":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Illegal join Adult and Pornography" } } }, "exception-web-category":{ "type":"object", "properties":{ "exception-uncategorized":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Uncategorized URLs" }, "exception-real-estate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Real Estate" }, "exception-computer-and-internet-security":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Computer and Internet Security" }, "exception-financial-services":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Financial Services" }, "exception-business-and-economy":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Business and Economy" }, "exception-computer-and-internet-info":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Computer and Internet Info" }, "exception-auctions":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Auctions" }, "exception-shopping":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Shopping" }, "exception-cult-and-occult":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Cult and Occult" }, "exception-travel":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Travel" }, "exception-drugs":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Abused Drugs" }, "exception-adult-and-pornography":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Adult and Pornography" }, "exception-home-and-garden":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Home and Garden" }, "exception-military":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Military" }, "exception-social-network":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Social Network" }, "exception-dead-sites":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Dead Sites (db Ops only)" }, "exception-stock-advice-and-tools":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Stock Advice and Tools" }, "exception-training-and-tools":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Training and Tools" }, "exception-dating":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Dating" }, "exception-sex-education":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Sex Education" }, "exception-religion":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Religion" }, "exception-entertainment-and-arts":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Entertainment and Arts" }, "exception-personal-sites-and-blogs":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Personal sites and Blogs" }, "exception-legal":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Legal" }, "exception-local-information":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Local Information" }, "exception-streaming-media":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Streaming Media" }, "exception-job-search":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Job Search" }, "exception-gambling":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Gambling" }, "exception-translation":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Translation" }, "exception-reference-and-research":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Reference and Research" }, "exception-shareware-and-freeware":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Shareware and Freeware" }, "exception-peer-to-peer":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Peer to Peer" }, "exception-marijuana":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Marijuana" }, "exception-hacking":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Hacking" }, "exception-games":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Games" }, "exception-philosophy-and-politics":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Philosophy and Political Advocacy" }, "exception-weapons":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Weapons" }, "exception-pay-to-surf":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Pay to Surf" }, "exception-hunting-and-fishing":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Hunting and Fishing" }, "exception-society":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Society" }, "exception-educational-institutions":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Educational Institutions" }, "exception-online-greeting-cards":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Online Greeting cards" }, "exception-sports":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Sports" }, "exception-swimsuits-and-intimate-apparel":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Swimsuits and Intimate Apparel" }, "exception-questionable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Questionable" }, "exception-kids":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Kids" }, "exception-hate-and-racism":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Hate and Racism" }, "exception-personal-storage":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Personal Storage" }, "exception-violence":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Violence" }, "exception-keyloggers-and-monitoring":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Keyloggers and Monitoring" }, "exception-search-engines":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Search Engines" }, "exception-internet-portals":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Internet Portals" }, "exception-web-advertisements":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Web Advertisements" }, "exception-cheating":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Cheating" }, "exception-gross":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Gross" }, "exception-web-based-email":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Web based email" }, "exception-malware-sites":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Malware Sites" }, "exception-phishing-and-other-fraud":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Phishing and Other Frauds" }, "exception-proxy-avoid-and-anonymizers":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Proxy Avoid and Anonymizers" }, "exception-spyware-and-adware":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Spyware and Adware" }, "exception-music":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Music" }, "exception-government":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Government" }, "exception-nudity":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Nudity" }, "exception-news-and-media":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category News and Media" }, "exception-illegal":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Illegal" }, "exception-cdns":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category CDNs" }, "exception-internet-communications":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Internet Communications" }, "exception-bot-nets":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Bot Nets" }, "exception-abortion":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Abortion" }, "exception-health-and-medicine":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Health and Medicine" }, "exception-spam-urls":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category SPAM URLs" }, "exception-dynamically-generated-content":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Dynamically Generated Content" }, "exception-parked-domains":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Parked Domains" }, "exception-alcohol-and-tobacco":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Alcohol and Tobacco" }, "exception-image-and-video-search":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Image and Video Search" }, "exception-fashion-and-beauty":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Fashion and Beauty" }, "exception-recreation-and-hobbies":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Recreation and Hobbies" }, "exception-motor-vehicles":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Motor Vehicles" }, "exception-web-hosting-sites":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Web Hosting Sites" }, "exception-nudity-artistic":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Nudity join Entertainment and Arts" }, "exception-illegal-pornography":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Category Illegal join Adult and Pornography" } } }, "require-web-category":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Wait for web category to be resolved before taking bypass decision", "optional":true }, "client-ipv4-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "client-ipv4-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"IPV4 client class-list name" } } } ] }, "client-ipv6-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "client-ipv6-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"IPV6 client class-list name" } } } ] }, "server-ipv4-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "server-ipv4-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"IPV4 server class-list name" } } } ] }, "server-ipv6-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "server-ipv6-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"IPV6 server class-list name" } } } ] }, "exception-client-ipv4-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "exception-client-ipv4-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"IPV4 exception client class-list name" } } } ] }, "exception-client-ipv6-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "exception-client-ipv6-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"IPV6 exception client class-list name" } } } ] }, "exception-server-ipv4-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "exception-server-ipv4-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"IPV4 exception server class-list name" } } } ] }, "exception-server-ipv6-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "exception-server-ipv6-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"IPV6 exception server class-list name" } } } ] }, "local-cert-pin-list":{ "type":"object", "properties":{ "local-cert-pin-list-bypass-fail-count":{ "type":"number", "format":"number", "minimum":1, "maximum":65536, "partition-visibility":"shared", "description":"Set the connection fail count as bypass criteria (Bypass when connection failure count is greater than the criteria (1-65536))" } } }, "central-cert-pin-list":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Forward proxy bypass if SNI string is contained in central updated cert-pinning-candidate list", "optional":true }, "forward-proxy-require-sni-cert-matched":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'no-match-action-inspect': Inspected if not matched; 'no-match-action-drop': Dropped if not matched; ", "enum":[ "no-match-action-inspect", "no-match-action-drop" ], "optional":true }, "template-cipher":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/cipher", "not-list":[ "shared-partition-cipher-template", "cipher-wo-prio" ], "description":"Cipher Template Name", "optional":true }, "shared-partition-cipher-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "template-cipher", "cipher-wo-prio" ], "description":"Reference a cipher template from shared partition", "optional":true }, "template-cipher-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/cipher", "description":"Cipher Template Name", "optional":true }, "template-hsm":{ "type":"string", "format":"string-rlx", "plat-neg-list":["tps"], "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/hsm/template", "description":"HSM Template (HSM Template Name)", "optional":true }, "hsm-type":{ "type":"string", "format":"enum", "plat-neg-list":["tps"], "partition-visibility":"shared", "description":"'thales-embed': Thales embed key; 'thales-hwcrhk': Thales hwcrhk Key; ", "enum":[ "thales-embed", "thales-hwcrhk" ], "optional":true }, "cipher-without-prio-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "cipher-wo-prio":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "template-cipher", "shared-partition-cipher-template" ], "description":"'SSL3_RSA_DES_192_CBC3_SHA': TLS_RSA_WITH_3DES_EDE_CBC_SHA (0x000A); 'SSL3_RSA_RC4_128_MD5': TLS_RSA_WITH_RC4_128_MD5 (0x0004); 'SSL3_RSA_RC4_128_SHA': TLS_RSA_WITH_RC4_128_SHA (0x0005); 'TLS1_RSA_AES_128_SHA': TLS_RSA_WITH_AES_128_CBC_SHA (0x002F); 'TLS1_RSA_AES_256_SHA': TLS_RSA_WITH_AES_256_CBC_SHA (0x0035); 'TLS1_RSA_AES_128_SHA256': TLS_RSA_WITH_AES_128_CBC_SHA256 (0x003C); 'TLS1_RSA_AES_256_SHA256': TLS_RSA_WITH_AES_256_CBC_SHA256 (0x003D); 'TLS1_DHE_RSA_AES_128_GCM_SHA256': TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 (0x009E); 'TLS1_DHE_RSA_AES_128_SHA': TLS_DHE_RSA_WITH_AES_128_CBC_SHA (0x0033); 'TLS1_DHE_RSA_AES_128_SHA256': TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 (0x0067); 'TLS1_DHE_RSA_AES_256_GCM_SHA384': TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 (0x009F); 'TLS1_DHE_RSA_AES_256_SHA': TLS_DHE_RSA_WITH_AES_256_CBC_SHA (0x0039); 'TLS1_DHE_RSA_AES_256_SHA256': TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 (0x006B); 'TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 (0xC02B); 'TLS1_ECDHE_ECDSA_AES_128_SHA': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA (0xC009); 'TLS1_ECDHE_ECDSA_AES_128_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 (0xC023); 'TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 (0xC02C); 'TLS1_ECDHE_ECDSA_AES_256_SHA': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA (0xC00A); 'TLS1_ECDHE_RSA_AES_128_GCM_SHA256': TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (0xC02F); 'TLS1_ECDHE_RSA_AES_128_SHA': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (0xC013); 'TLS1_ECDHE_RSA_AES_128_SHA256': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (0xC027); 'TLS1_ECDHE_RSA_AES_256_GCM_SHA384': TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xC030); 'TLS1_ECDHE_RSA_AES_256_SHA': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (0xC014); 'TLS1_RSA_AES_128_GCM_SHA256': TLS_RSA_WITH_AES_128_GCM_SHA256 (0x009C); 'TLS1_RSA_AES_256_GCM_SHA384': TLS_RSA_WITH_AES_256_GCM_SHA384 (0x009D); 'TLS1_ECDHE_RSA_AES_256_SHA384': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (0xC028); 'TLS1_ECDHE_ECDSA_AES_256_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 (0xC024); 'TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA8); 'TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA9); 'TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256': TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCAA); ", "enum":[ "SSL3_RSA_DES_192_CBC3_SHA", "SSL3_RSA_RC4_128_MD5", "SSL3_RSA_RC4_128_SHA", "TLS1_RSA_AES_128_SHA", "TLS1_RSA_AES_256_SHA", "TLS1_RSA_AES_128_SHA256", "TLS1_RSA_AES_256_SHA256", "TLS1_DHE_RSA_AES_128_GCM_SHA256", "TLS1_DHE_RSA_AES_128_SHA", "TLS1_DHE_RSA_AES_128_SHA256", "TLS1_DHE_RSA_AES_256_GCM_SHA384", "TLS1_DHE_RSA_AES_256_SHA", "TLS1_DHE_RSA_AES_256_SHA256", "TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256", "TLS1_ECDHE_ECDSA_AES_128_SHA", "TLS1_ECDHE_ECDSA_AES_128_SHA256", "TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384", "TLS1_ECDHE_ECDSA_AES_256_SHA", "TLS1_ECDHE_RSA_AES_128_GCM_SHA256", "TLS1_ECDHE_RSA_AES_128_SHA", "TLS1_ECDHE_RSA_AES_128_SHA256", "TLS1_ECDHE_RSA_AES_256_GCM_SHA384", "TLS1_ECDHE_RSA_AES_256_SHA", "TLS1_RSA_AES_128_GCM_SHA256", "TLS1_RSA_AES_256_GCM_SHA384", "TLS1_ECDHE_RSA_AES_256_SHA384", "TLS1_ECDHE_ECDSA_AES_256_SHA384", "TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256", "TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256", "TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256" ] } } } ] }, "server-name-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "server-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Server name indication in Client hello extension (Server name String)" }, "server-cert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Server Certificate associated to SNI (Server Certificate Name)" }, "server-chain":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Server Certificate Chain associated to SNI (Server Certificate Chain Name)" }, "server-key":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Server Private Key associated to SNI (Server Private Key Name)" }, "server-passphrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"help Password Phrase" }, "server-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "server-name-alternate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specific the second certifcate" }, "server-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Server Name Partition Shared" }, "sni-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Template associated to SNI" }, "sni-template-client-ssl":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/client-ssl", "description":"Client SSL Template Name" }, "sni-shared-partition-client-ssl-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Reference a Client SSL template from shared partition" }, "sni-template-client-ssl-shared-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/client-ssl", "description":"Client SSL Template Name" }, "server-name-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Server name indication in Client hello extension with regular expression (Server name String with regex)" }, "server-cert-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Server Certificate associated to SNI regex (Server Certificate Name)" }, "server-chain-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Server Certificate Chain associated to SNI regex (Server Certificate Chain Name)" }, "server-key-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Server Private Key associated to SNI regex (Server Private Key Name)" }, "server-passphrase-regex":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"help Password Phrase" }, "server-encrypted-regex":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "server-name-regex-alternate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specific the second certifcate" }, "server-shared-regex":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Server Name Partition Shared" }, "sni-regex-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Template associated to SNI regex" }, "sni-regex-template-client-ssl":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/client-ssl", "description":"Client SSL Template Name" }, "sni-regex-shared-partition-client-ssl-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Reference a Client SSL template from shared partition" }, "sni-regex-template-client-ssl-shared-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/client-ssl", "description":"Client SSL Template Name" } } } ] }, "server-name-auto-map":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable automatic mapping of server name indication in Client hello extension", "optional":true }, "sni-enable-log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable logging of sni-auto-map failures. Disable by default", "optional":true }, "sni-bypass-missing-cert":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Bypass when missing cert/key", "optional":true }, "sni-bypass-expired-cert":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Bypass when certificate expired", "optional":true }, "sni-bypass-explicit-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Bypass when matched explicit bypass list (Specify class list name)", "optional":true }, "sni-bypass-enable-log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable logging when bypass event happens, disabled by default", "optional":true }, "direct-client-server-auth":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Let backend server does SSL client authentication directly", "optional":true }, "session-cache-size":{ "type":"number", "format":"number", "platform-specific-range":1, "platform-specific-default":1, "partition-visibility":"shared", "description":"Session Cache Size (Maximum cache size. Default value 0 (Session ID reuse disabled))", "optional":true }, "session-cache-timeout":{ "type":"number", "format":"number", "minimum":0, "maximum":604800, "default":0, "partition-visibility":"shared", "description":"Session Cache Timeout (Timeout value, in seconds. Default value 0 (Session cache timeout disabled))", "optional":true }, "session-ticket-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable client side session ticket support", "optional":true }, "session-ticket-lifetime":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "default":0, "partition-visibility":"shared", "description":"Session ticket lifetime in seconds from stateless session resumption (Lifetime value in seconds. Default value 0 (Session ticket lifetime is 7200 seconds))", "optional":true }, "ssl-false-start-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"disable SSL False Start", "optional":true }, "disable-sslv3":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Reject Client requests for SSL version 3", "optional":true }, "version":{ "type":"number", "format":"number", "minimum":1, "maximum":34, "platform-specific-default":1, "partition-visibility":"shared", "description":"TLS/SSL version, default is the highest number supported (TLS/SSL version: 30-SSLv3.0, 31-TLSv1.0, 32-TLSv1.1, 33-TLSv1.2 and 34-TLSv1.3)", "optional":true }, "dgversion":{ "type":"number", "format":"number", "minimum":30, "maximum":34, "default":31, "partition-visibility":"shared", "description":"Lower TLS/SSL version can be downgraded", "optional":true }, "renegotiation-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable SSL renegotiation", "optional":true }, "sslv2-bypass-service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Service Group for Bypass SSLV2 (Service Group Name)", "optional":true }, "authorization":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify LDAP server for client SSL authorizaiton", "optional":true }, "authen-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/server/ldap", "not":"auth-sg", "description":"Specify authorization LDAP server name", "optional":true }, "ldap-base-dn-from-cert":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use Subject DN as LDAP search base DN", "optional":true }, "ldap-search-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Specify LDAP search filter", "optional":true }, "auth-sg":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/service-group", "not":"authen-name", "description":"Specify authorization LDAP service group", "optional":true }, "auth-sg-dn":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use Subject DN as LDAP search base DN", "optional":true }, "auth-sg-filter":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Specify LDAP search filter", "optional":true }, "auth-username-attribute":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify attribute name of username for client SSL authorization", "optional":true }, "non-ssl-bypass-service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Service Group for Bypass non-ssl traffic (Service Group Name)", "optional":true }, "non-ssl-bypass-l4session":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Handle the non-ssl session as L4 for performance optimization", "optional":true }, "enable-ssli-ftp-alg":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Enable SSLi FTP over TLS support at which port", "optional":true }, "early-data":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable TLS 1.3 early data (0-RTT)", "optional":true }, "no-anti-replay":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable anti-replay protection for TLS 1.3 early data (0-RTT data)", "optional":true }, "ja3-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable JA3 features", "optional":true }, "ja3-insert-http-header":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Insert the JA3 hash into this request as a HTTP header (HTTP Header Name)", "optional":true }, "ja3-reject-class-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Drop request if the JA3 hash matches this class-list (type string-case-insensitive) (Class-List Name)", "optional":true }, "ja3-reject-max-number-per-host":{ "type":"number", "format":"number", "minimum":1, "maximum":256, "partition-visibility":"shared", "description":"Drop request if numbers of JA3 of this client address exceeded", "optional":true }, "ja3-ttl":{ "type":"number", "format":"number", "minimum":1, "maximum":86400, "default":600, "partition-visibility":"shared", "description":"seconds to keep each JA3 record", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "certificate-list":{ "type":"array", "minItems":1, "items":{ "type":"certificate" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/client-ssl/{name}/certificate/{cert}", "array":[ { "properties":{ "cert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Certificate Name", "optional":false }, "key":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Server Private Key (Key Name)", "optional":true }, "passphrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Password Phrase", "optional":true }, "key-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)", "optional":true }, "chain-cert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Chain Certificate (Chain Certificate Name)", "optional":true }, "shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "description":"Server Certificate and Key Partition Shared", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "cert" ] } ] } }, "required":[ "name" ] } ] }, "client-ssh-list":{ "type":"array", "minItems":1, "items":{ "type":"client-ssh" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/client-ssh/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Client SSH Template Name", "optional":false }, "forward-proxy-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable SSH forward proxy", "optional":true }, "forward-proxy-hostkey":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Specify private-key (Key Name)", "optional":true }, "passphrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Password Phrase", "optional":true }, "encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "connection-reuse-list":{ "type":"array", "minItems":1, "items":{ "type":"connection-reuse" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/connection-reuse/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Connection Reuse Template Name", "optional":false }, "limit-per-server":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "default":1000, "partition-visibility":"shared", "description":"Max Server Connections allowed (Connections per Server Port (default 1000))", "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":60, "maximum":3600, "default":2400, "partition-visibility":"shared", "description":"Timeout in seconds. Multiple of 60 (default 2400)", "optional":true }, "add-header":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Insert HTTP Connection: keep-alive header", "optional":true }, "keep-alive-conn":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Keep a number of server connections open", "optional":true }, "preopen":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Preopen server connection", "optional":true }, "num-conn-per-port":{ "type":"number", "format":"number", "minimum":1, "maximum":1024, "default":100, "partition-visibility":"shared", "description":"Connections per Server Port (default 100)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "diameter-list":{ "type":"array", "minItems":1, "items":{ "type":"diameter" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/diameter/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"diameter template Name", "optional":false }, "customize-cea":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"customizing cea response", "optional":true }, "avp-code":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"avp code", "optional":true }, "avp-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"pattern to be matched in the avp string name, max length 127 bytes", "optional":true }, "service-group-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"service group name, this is the service group that the message needs to be copied to", "optional":true }, "dwr-time":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "default":100, "partition-visibility":"shared", "description":"dwr health-check timer interval (in 100 milli second unit, default is 100, 0 means unset this option)", "optional":true }, "idle-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":5, "partition-visibility":"shared", "description":"user sesison idle timeout (in minutes, default is 5)", "optional":true }, "multiple-origin-host":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"allowing multiple origin-host to a single server", "optional":true }, "origin-realm":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"origin-realm name avp", "optional":true }, "product-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"product name avp", "optional":true }, "vendor-id":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "default":0, "partition-visibility":"shared", "description":"vendor-id avp (Vendor Id)", "optional":true }, "session-age":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":10, "partition-visibility":"shared", "description":"user session age allowed (default 10), this is not idle-time (in minutes)", "optional":true }, "dwr-up-retry":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"number of successful dwr health-check before declaring target up", "optional":true }, "terminate-on-cca-t":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"remove diameter session when receiving CCA-T message", "optional":true }, "forward-unknown-session-id":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Forward server message even it has unknown session id", "optional":true }, "forward-to-latest-server":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Forward client message to the latest server that sends message with the same session id", "optional":true }, "load-balance-on-session-id":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Load balance based on the session id", "optional":true }, "relaxed-origin-host":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Relaxed Origin-Host Format", "optional":true }, "message-code-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "message-code":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared" } } } ] }, "avp-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "avp":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "partition-visibility":"shared", "description":"customize avps for cer to the server (avp number)" }, "int32":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "partition-visibility":"shared", "not-list":[ "int64", "string" ], "description":"32 bits integer" }, "int64":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "partition-visibility":"shared", "not-list":[ "int32", "string" ], "description":"64 bits integer" }, "string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not-list":[ "int32", "int64" ], "description":"String (string name, max length 127 bytes)" }, "mandatory":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"mandatory avp" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "origin-host":{ "type":"object", "$ref":"/axapi/v3/slb/template/diameter/{name}/origin-host", "properties":{ "origin-host-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"origin-host name avp" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] }, "link-probe-list":{ "type":"array", "minItems":1, "items":{ "type":"link-probe" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/link-probe/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"probe template Name", "optional":false }, "url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1023, "default":"/", "partition-visibility":"shared", "description":"Specify URL to which probes should be sent out. Default is /", "optional":true }, "rtt-method":{ "type":"string", "format":"enum", "default":"http-rtt", "partition-visibility":"shared", "description":"'http-rtt': Calculate Round Trip Time between HTTP request and response; 'tcp-srtt': Use TCP Smoothed round trip time in the HTTP connection; ", "enum":[ "http-rtt", "tcp-srtt" ], "optional":true }, "expected-status-code":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "default":"200", "partition-visibility":"shared", "description":"Specify response code range (e.g. 200,400-430), default is 200 (Format is xx,xx-xx (xx between [100, 899]), default is 200)", "optional":true }, "disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Probe template", "optional":true }, "probe-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":7200, "default":5, "partition-visibility":"shared", "description":"Time between each probe that needs to be sent out (in seconds, default is 5)", "optional":true }, "probes-per-test":{ "type":"number", "format":"number", "minimum":1, "maximum":10, "default":5, "partition-visibility":"shared", "description":"Total number of probes to be sent out for each test", "optional":true }, "test-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":7200, "default":60, "partition-visibility":"shared", "description":"time interval between subsequent tests (in seconds, default is 60)", "optional":true }, "selection-rule":{ "type":"string", "format":"enum", "default":"fastest-link-always", "partition-visibility":"shared", "description":"'threshold': Use all links below a threshold before selecting the fastest link; 'fastest-link-always': Always use the link with the lowest average latency; ", "enum":[ "threshold", "fastest-link-always" ], "optional":true }, "threshold-value":{ "type":"number", "format":"number", "minimum":0, "maximum":65534, "default":0, "partition-visibility":"shared", "description":"Use all links below a threshold before selecting the fastest link (RTT in milliseconds)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "destination":{ "type":"object", "$ref":"/axapi/v3/slb/template/link-probe/{name}/destination", "properties":{ "hostname":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Target Hostname" }, "resolve-as":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "static-ipv4-addr", "static-ipv6-addr" ], "description":"'resolve-to-ipv4': Use A Query only to resolve the configured hostname; 'resolve-to-ipv6': Use AAAA Query only to resolve the configured hostname; ", "enum":[ "resolve-to-ipv4", "resolve-to-ipv6" ] }, "static-ipv4-addr":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not-list":[ "resolve-as", "static-ipv6-addr" ], "description":"Target IPv4 Address" }, "static-ipv6-addr":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not-list":[ "resolve-as", "static-ipv4-addr" ], "description":"Target IPv6 Address" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] }, "dns-list":{ "type":"array", "minItems":1, "items":{ "type":"dns" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/dns/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"DNS Template Name", "optional":false }, "default-policy":{ "type":"string", "format":"enum", "default":"nocache", "partition-visibility":"shared", "description":"'nocache': Cache disable; 'cache': Cache enable; ", "enum":[ "nocache", "cache" ], "optional":true }, "cache-record-serving-policy":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'global': Follow global cofiguration (Default); 'no-change': No change in record order; 'round-robin': Round-robin; ", "enum":[ "global", "no-change", "round-robin" ], "optional":true }, "remove-aa-flag":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Make answers created from cache non-authoritative", "optional":true }, "disable-dns-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable DNS template", "optional":true }, "period":{ "type":"number", "format":"number", "minimum":1, "maximum":10000, "partition-visibility":"shared", "description":"Period in minutes", "optional":true }, "drop":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"forward", "description":"Drop the malformed query", "optional":true }, "forward":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "not":"drop", "description":"Forward to service group (Service group name)", "optional":true }, "max-query-length":{ "type":"number", "format":"number", "minimum":1, "maximum":4095, "partition-visibility":"shared", "description":"Define Maximum DNS Query Length, default is unlimited (Specify Maximum Length)", "optional":true }, "max-cache-entry-size":{ "type":"number", "format":"number", "minimum":1, "maximum":4096, "default":1024, "partition-visibility":"shared", "description":"Define maximum cache entry size (Maximum cache entry size per VIP (default 1024))", "optional":true }, "max-cache-size":{ "type":"number", "format":"number", "platform-specific-range":1, "platform-specific-default":1, "partition-visibility":"shared", "description":"Define maximum cache size (Maximum cache entry per VIP)", "optional":true }, "enable-cache-sharing":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable DNS cache sharing", "optional":true }, "disable-ra-cached-resp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable DNS recursive available flag in cached response", "optional":true }, "remove-padding-to-server":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Remove EDNS(0) padding to server", "optional":true }, "add-padding-to-client":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'block-length': Block-Length Padding; 'random-block-length': Random-Block-Length Padding; ", "enum":[ "block-length", "random-block-length" ], "optional":true }, "remove-csubnet":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Remove EDNS(0) client subnet from client queries", "optional":true }, "insert-ipv4":{ "type":"number", "format":"number", "minimum":0, "maximum":32, "partition-visibility":"shared", "description":"prefix-length to insert for IPv4", "optional":true }, "insert-ipv6":{ "type":"number", "format":"number", "minimum":0, "maximum":128, "partition-visibility":"shared", "description":"prefix-length to insert for IPv6", "optional":true }, "redirect-to-tcp-port":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Direct the client to retry with TCP for DNS UDP request", "optional":true }, "query-id-switch":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use DNS query ID to create sesion", "optional":true }, "dnssec-service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Use different service group if DNSSEC DO bit set (Service Group Name)", "optional":true }, "disable-rpz-attach-soa":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable attaching SOA due to RPZ", "optional":true }, "cache-ttl-adjustment-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"enable the ttl adjustment for dns cache response", "optional":true }, "dns-logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/dns-logging", "description":"dns logging template (DNS Logging template name)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "dns64":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/dns64", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable DNS64" }, "cache":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use a cached A-query response to provide AAAA query responses for the same hostname" }, "change-query":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Always change incoming AAAA DNS Query to A" }, "parallel-query":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Forward AAAA Query & generate A Query in parallel" }, "retry":{ "type":"number", "format":"number", "minimum":0, "maximum":15, "default":3, "partition-visibility":"shared", "description":"Retry count, default is 3 (Retry Number)" }, "single-response-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Single Response which is used to avoid ambiguity" }, "timeout":{ "type":"number", "format":"number", "minimum":0, "maximum":15, "default":1, "partition-visibility":"shared", "description":"Timeout to send additional Queries, unit: second, default is 1" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "negative-dns-cache":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/negative-dns-cache", "properties":{ "enable-negative-dns-cache":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable DNS negative cache (Need to turn-on the dns-cache for this feature)" }, "bypass-query-threshold":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":100, "partition-visibility":"shared", "description":"the threshold bypass the query, default is 100" }, "max-negative-cache-ttl":{ "type":"number", "format":"number", "minimum":0, "maximum":604800, "default":7200, "partition-visibility":"shared", "description":"Max negative cache ttl, default is 2 hours" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "udp-retransmit":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/udp-retransmit", "properties":{ "retry-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":400, "default":10, "partition-visibility":"shared", "description":"DNS Retry Interval value 1 - 400 in units of 100ms, default is 10 (default is 1000ms) (1 - 400 in units of 100ms, default is 10 (1000ms/1sec))" }, "max-trials":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "default":3, "partition-visibility":"shared", "description":"Total number of times to try DNS query to server before closing client connection, default 3" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "query-type-filter":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/query-type-filter", "properties":{ "query-type-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'allow': Allow only certain DNS query types; 'deny': Deny only certain DNS query types; ", "enum":[ "allow", "deny" ] }, "query-type":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "str-query-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; 'ANY': All cached record; ", "enum":[ "A", "AAAA", "CNAME", "MX", "NS", "SRV", "PTR", "SOA", "TXT", "ANY" ] }, "num-query-type":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Other record type value" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "query-class-filter":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/query-class-filter", "properties":{ "query-class-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'allow': Allow only certain DNS query classes; 'deny': Deny only certain DNS query classes; ", "enum":[ "allow", "deny" ] }, "query-class":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "str-query-class":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'INTERNET': INTERNET query class; 'CHAOS': CHAOS query class; 'HESIOD': HESIOD query class; 'NONE': NONE query class; 'ANY': ANY query class; ", "enum":[ "INTERNET", "CHAOS", "HESIOD", "NONE", "ANY" ] }, "num-query-class":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Other query class value" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "rpz-list":{ "type":"array", "minItems":1, "items":{ "type":"rpz" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/dns/{name}/rpz/{seq-id}", "array":[ { "properties":{ "seq-id":{ "type":"number", "format":"number", "minimum":1, "maximum":8, "partition-visibility":"shared", "description":"sequential id of RPZ", "optional":false }, "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify a Response Policy Zone name", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "logging":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/rpz/{seq-id}/logging", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log RPZ triggered action" }, "rpz-action":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "str-rpz-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Log RPZ due to drop action; 'pass-thru': Log RPZ due to pass-thru action; 'nxdomain': Log RPZ due to nxdomain action; 'nodata': Log RPZ due to nodata action; 'tcp-only': Log RPZ due to tcp-only action; 'local-data': Log RPZ due to local-data action; ", "enum":[ "drop", "pass-thru", "nxdomain", "nodata", "tcp-only", "local-data" ] } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "seq-id" ] } ] }, "class-list":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/class-list", "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify a class list name" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "lid-list":{ "type":"array", "minItems":1, "items":{ "type":"lid" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/dns/{name}/class-list/lid/{lidnum}", "array":[ { "properties":{ "lidnum":{ "type":"number", "format":"number", "minimum":1, "maximum":1023, "partition-visibility":"shared", "description":"Specify a limit ID", "optional":false }, "conn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Connection rate limit", "optional":true }, "per":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Per (Number of 100ms)", "optional":true }, "over-limit-action":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Action when exceeds limit", "optional":true }, "action-value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'dns-cache-disable': Disable DNS cache when it exceeds limit; 'dns-cache-enable': Enable DNS cache when it exceeds limit; 'forward': Forward the traffic even it exceeds limit; ", "enum":[ "dns-cache-disable", "dns-cache-enable", "forward" ], "optional":true }, "lockout":{ "type":"number", "format":"number", "minimum":1, "maximum":1023, "partition-visibility":"shared", "description":"Don't accept any new connection for certain time (Lockout duration in minutes)", "optional":true }, "log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log a message", "optional":true }, "log-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"Log interval (minute, by default system will log every over limit instance)", "optional":true }, "dns":{ "type":"object", "properties":{ "cache-action":{ "type":"string", "format":"enum", "default":"cache-disable", "partition-visibility":"shared", "description":"'cache-disable': Disable dns cache; 'cache-enable': Enable dns cache; ", "enum":[ "cache-disable", "cache-enable" ] }, "ttl":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"TTL for cache entry (TTL in seconds)" }, "weight":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "partition-visibility":"shared", "description":"Weight for cache entry" }, "honor-server-response-ttl":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Honor the server reponse TTL" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "lidnum" ] } ] } } }, "response-rate-limiting":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/response-rate-limiting", "properties":{ "response-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":1000, "default":5, "partition-visibility":"shared", "description":"Responses exceeding this rate within the window will be dropped (default 5 per second)" }, "filter-response-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":1000, "default":10, "partition-visibility":"shared", "description":"Maximum allowed request rate for the filter. This should match average traffic. (default 10 per seconds)" }, "slip-rate":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "partition-visibility":"shared", "not":"TC-rate", "description":"Every n'th response that would be rate-limited will be let through instead" }, "TC-rate":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "partition-visibility":"shared", "not":"slip-rate", "description":"Every n'th response that would be rate-limited will respond with TC bit" }, "match-subnet":{ "type":"string", "format":"ipv4-netmask", "default":"255.255.255.255", "partition-visibility":"shared", "description":"IP subnet mask (response rate by IP subnet mask)" }, "match-subnet-v6":{ "type":"number", "format":"number", "minimum":1, "maximum":128, "default":128, "partition-visibility":"shared", "description":"IPV6 subnet mask (response rate by IPv6 subnet mask)" }, "window":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "default":1, "partition-visibility":"shared", "description":"Rate-Limiting Interval in Seconds (default is one)" }, "src-ip-only":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared" }, "enable-log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable logging" }, "action":{ "type":"string", "format":"enum", "default":"rate-limit", "partition-visibility":"shared", "description":"'log-only': Only log rate-limiting, do not actually rate limit. Requires enable-log configuration; 'rate-limit': Rate-Limit based on configuration (Default); 'whitelist': Whitelist, disable rate-limiting; ", "enum":[ "log-only", "rate-limit", "whitelist" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "rrl-class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"rrl-class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/dns/{name}/response-rate-limiting/rrl-class-list/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Class-list name", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "lid-list":{ "type":"array", "minItems":1, "items":{ "type":"lid" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/dns/{name}/response-rate-limiting/rrl-class-list/{name}/lid/{lidnum}", "array":[ { "properties":{ "lidnum":{ "type":"number", "format":"number", "minimum":1, "maximum":1023, "partition-visibility":"shared", "description":"Specify a limit ID", "optional":false }, "lid-response-rate":{ "type":"number", "format":"number", "minimum":1, "maximum":1000, "default":5, "partition-visibility":"shared", "description":"Responses exceeding this rate within the window will be dropped (default 5 per second)", "optional":true }, "lid-slip-rate":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "partition-visibility":"shared", "not":"lid-tc-rate", "description":"Every n'th response that would be rate-limited will be let through instead", "optional":true }, "lid-tc-rate":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "partition-visibility":"shared", "not":"lid-slip-rate", "description":"Every n'th response that would be rate-limited will respond with TC bit", "optional":true }, "lid-match-subnet":{ "type":"string", "format":"ipv4-netmask", "default":"255.255.255.255", "partition-visibility":"shared", "description":"IP subnet mask (response rate by IP subnet mask)", "optional":true }, "lid-match-subnet-v6":{ "type":"number", "format":"number", "minimum":1, "maximum":128, "default":128, "partition-visibility":"shared", "description":"IPV6 subnet mask (response rate by IPv6 subnet mask)", "optional":true }, "lid-window":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "default":1, "partition-visibility":"shared", "description":"Rate-Limiting Interval in Seconds (default is one)", "optional":true }, "lid-src-ip-only":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "optional":true }, "lid-enable-log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable logging", "optional":true }, "lid-action":{ "type":"string", "format":"enum", "default":"rate-limit", "partition-visibility":"shared", "description":"'log-only': Only log rate-limiting, do not actually rate limit. Requires enable-log configuration; 'rate-limit': Rate-Limit based on configuration (Default); 'whitelist': Whitelist, disable rate-limiting; ", "enum":[ "log-only", "rate-limit", "whitelist" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "lidnum" ] } ] } }, "required":[ "name" ] } ] } } }, "local-dns-resolution":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/local-dns-resolution", "properties":{ "host-list-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "hostnames":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Hostnames class-list name (dns type)" } } } ] }, "local-resolver-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "local-resolver":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Local dns servers (address)" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "recursive-dns-resolution":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution", "properties":{ "host-list-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "hostnames":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Hostnames class-list name (dns type), perform resolution while query name matched" } } } ] }, "csubnet-retry":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"retry when server REFUSED AX inserted EDNS(0) subnet, works only when insert-client-subnet is configured" }, "ns-cache-lookup":{ "type":"string", "format":"enum", "default":"enabled", "partition-visibility":"shared", "description":"'disabled': Disable NS Cache Lookup; 'enabled': Enable NS Cache Lookup; ", "enum":[ "disabled", "enabled" ] }, "use-service-group-response":{ "type":"string", "format":"enum", "default":"enabled", "partition-visibility":"shared", "description":"'disabled': Start Recursive Resolver if Server response doesnt have final answer; 'enabled': Forward Backend Server response to client and dont start recursive resolver; ", "enum":[ "disabled", "enabled" ] }, "ipv4-nat-pool":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/nat/pool", "description":"IPv4 Source NAT pool or pool group" }, "ipv6-nat-pool":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/ipv6/nat/pool", "description":"IPv6 Source NAT pool or pool group" }, "retries-per-level":{ "type":"number", "format":"number", "minimum":1, "maximum":6, "default":6, "partition-visibility":"shared", "description":"Number of DNS query retries at each server level before closing client connection, default 6" }, "full-response":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Serve all records (authority and additional) when applicable" }, "max-trials":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "default":255, "partition-visibility":"shared", "description":"Total number of times to try DNS query to server before closing client connection, default 255" }, "request-for-pending-resolution":{ "type":"string", "format":"enum", "default":"respond-with-servfail", "partition-visibility":"shared", "description":"'drop': Drop of the request during ongoing; 'respond-with-servfail': Respond with SERVFAIL of the request during ongoing; 'start-new-resolution': Start new resolution of the request during ongoing; ", "enum":[ "drop", "respond-with-servfail", "start-new-resolution" ] }, "udp-retry-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":6, "default":1, "partition-visibility":"shared", "description":"UDP DNS Retry Interval value 1-6, default is 1 sec (1-6 , default is 1 sec)" }, "udp-initial-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":6, "default":5, "partition-visibility":"shared", "description":"UDP DNS Retry Interval value 1-6, default is 5 sec (1-6, default is 5sec)" }, "use-client-qid":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use client side query id for recursive query" }, "default-recursive":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Default recursive mode, forward query to bound service-group if hostnames matched" }, "force-cname-resolution":{ "type":"string", "format":"enum", "default":"enabled", "partition-visibility":"shared", "description":"'enabled': Force CNAME resolution always; 'disabled': Use answer record in CNAME response if it exists, else resolve; ", "enum":[ "enabled", "disabled" ] }, "fast-ns-selection":{ "type":"string", "format":"enum", "default":"enabled", "partition-visibility":"shared", "description":"'enabled': Enable fast NS selection; 'disabled': Disable fast NS selection; ", "enum":[ "enabled", "disabled" ] }, "dnssec-validation":{ "type":"string", "format":"enum", "default":"disabled", "partition-visibility":"shared", "description":"'enabled': Enable DNSSEC validation; 'disabled': Disable DNSSEC validation; ", "enum":[ "enabled", "disabled" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "lookup-order":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/lookup-order", "properties":{ "query-type":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "str-query-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; 'ANY': All cached record; ", "enum":[ "A", "AAAA", "CNAME", "MX", "NS", "SRV", "PTR", "SOA", "TXT", "ANY" ] }, "num-query-type":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Other query type value" }, "order":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'ipv4-precede-ipv6': Recursive lookup via IPv4 then IPv6; 'ipv6-precede-ipv4': Recursive lookup via IPv6 then IPv4; ", "enum":[ "ipv4-precede-ipv6", "ipv6-precede-ipv4" ] } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "gateway-health-check":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check", "properties":{ "query-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "default":"a10networks.com", "partition-visibility":"shared", "description":"Specify the query name used in probe queries, default \"a10networks.com\"" }, "retry":{ "type":"number", "format":"number", "minimum":1, "maximum":6, "default":6, "partition-visibility":"shared", "description":"Maximum number of DNS query retries at each server level before health check fails, default 6 (Retry count (default 6))" }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":6, "default":5, "partition-visibility":"shared", "description":"Specify the health check timeout before retrying or finish, default is 5 sec (Timeout value, in seconds (default 5))" }, "interval":{ "type":"number", "format":"number", "minimum":1, "maximum":300, "default":10, "partition-visibility":"shared", "description":"Specify the health check interval, default is 10 sec (Interval value, in seconds (default 10))" }, "up-retry":{ "type":"number", "format":"number", "minimum":1, "maximum":10, "default":1, "partition-visibility":"shared", "description":"Specify number of times that health check consecutively passes before declaring gateway UP, default 1 (up-retry count (default 1))" }, "retry-multi":{ "type":"number", "format":"number", "minimum":1, "maximum":10, "default":1, "partition-visibility":"shared", "description":"Specify number of times that health check consecutively fails before declaring gateway DOWN, default 1 (retry-multi count (default 1))" }, "gwhc-ns-cache-lookup":{ "type":"string", "format":"enum", "default":"disabled", "partition-visibility":"shared", "description":"'disabled': Disable NS Cache Lookup; 'enabled': Enable NS Cache Lookup; ", "enum":[ "disabled", "enabled" ] }, "str-query-type":{ "type":"string", "format":"enum", "default":"A", "partition-visibility":"shared", "not":"num-query-type", "description":"'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; ", "enum":[ "A", "AAAA", "CNAME", "MX", "NS", "SRV", "PTR", "SOA", "TXT" ] }, "num-query-type":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "not":"str-query-type", "description":"Other record type value" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } } }, "required":[ "name" ] } ] }, "ftp-list":{ "type":"array", "minItems":1, "items":{ "type":"ftp" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/ftp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"FTP template name", "optional":false }, "active-mode-port":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Non-Standard FTP Active mode port", "optional":true }, "active-mode-port-val":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "partition-visibility":"shared", "not":"any", "description":"Non-Standard FTP Active mode port", "optional":true }, "to":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "partition-visibility":"shared", "description":"End range of FTP Active mode port", "optional":true }, "any":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"active-mode-port-val", "description":"Allow any FTP Active mode port", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "imap-pop3-list":{ "type":"array", "minItems":1, "items":{ "type":"imap-pop3" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/imap-pop3/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"IMAP-POP3 Template Name", "optional":false }, "starttls":{ "type":"string", "format":"enum", "default":"disabled", "partition-visibility":"shared", "description":"'disabled': Disable STARTTLS; 'optional': STARTTLS is optional requirement; 'enforced': Must issue STARTTLS command before imap transaction; ", "enum":[ "disabled", "optional", "enforced" ], "optional":true }, "logindisabled":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Login before STARTTLS.Works only for imap", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "logging-list":{ "type":"array", "minItems":1, "items":{ "type":"logging" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/logging/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Logging Template Name", "optional":false }, "format":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":250, "partition-visibility":"shared", "description":"Specify a format string for web logging (format string(less than 250 characters) for web logging)", "optional":true }, "local-logging":{ "type":"number", "format":"number", "minimum":0, "maximum":1, "default":0, "partition-visibility":"shared", "description":"1 to enable local logging (1 to enable local logging, default 0)", "optional":true }, "service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Bind a Service Group to the logging template (Service Group Name)", "optional":true }, "pcre-mask":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Mask matched PCRE pattern in the log", "optional":true }, "mask":{ "type":"string", "format":"string", "minLength":1, "maxLength":1, "default":"X", "partition-visibility":"shared", "description":"Character to mask the matched pattern (default: X)", "optional":true }, "keep-end":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "default":0, "partition-visibility":"shared", "description":"Number of unmasked characters at the end (default: 0)", "optional":true }, "keep-start":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "default":0, "partition-visibility":"shared", "description":"Number of unmasked characters at the beginning (default: 0)", "optional":true }, "tcp-proxy":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/tcp-proxy", "not":"shared-partition-tcp-proxy-template", "description":"TCP Proxy Template Name", "optional":true }, "shared-partition-tcp-proxy-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"tcp-proxy", "description":"Reference a TCP Proxy template from shared partition", "optional":true }, "template-tcp-proxy-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/tcp-proxy", "description":"TCP Proxy Template name", "optional":true }, "pool":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/nat/pool", "not-list":[ "shared-partition-pool", "auto" ], "description":"Specify NAT pool or pool group", "optional":true }, "shared-partition-pool":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"pool", "description":"Reference a NAT pool or pool group from shared partition", "optional":true }, "pool-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/nat/pool", "description":"Specify NAT pool or pool group", "optional":true }, "auto":{ "type":"string", "format":"enum", "default":"auto", "partition-visibility":"shared", "not":"pool", "description":"'auto': Configure auto NAT for logging, default is auto enabled; ", "enum":[ "auto" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "dns-logging-list":{ "type":"array", "minItems":1, "items":{ "type":"dns-logging" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/dns-logging/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"DNS Logging Template Name", "optional":false }, "disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable DNS Logging template", "optional":true }, "dns-logging-protocol":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'both': Log DNS over tcp and udp; 'tcp': Log DNS over tcp; 'udp': Log DNS over udp; ", "enum":[ "both", "tcp", "udp" ], "optional":true }, "dns-logging-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'query': DNS Query Logging; 'response': DNS Response Logging; 'both': DNS Query and Response Logging; ", "enum":[ "query", "response", "both" ], "optional":true }, "dns-logging-request-section":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': Log DNS header and question section; 'header': Log DNS header information; 'question': Log DNS question section; ", "enum":[ "all", "header", "question" ], "optional":true }, "dns-logging-response-section":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': Log DNS header information, answer, authority, additional section content; 'header': Log DNS header information; 'answer': Log DNS header information and answer section content; ", "enum":[ "all", "header", "answer" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "response-type":{ "type":"object", "$ref":"/axapi/v3/slb/template/dns-logging/{name}/response-type", "properties":{ "config":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"start config the response type detail" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "type-list":{ "type":"array", "minItems":1, "items":{ "type":"type" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/dns-logging/{name}/response-type/type/{response-type-name}", "array":[ { "properties":{ "response-type-name":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'TXT': TXT; 'RRSIG': RRSIG; 'TSIG': TSIG; 'DNSKEY': DNSKEY; 'DS': DS; 'CAA': CAA; 'NAPTR': NAPTR; 'OPT': OPT; ", "enum":[ "TXT", "RRSIG", "TSIG", "DNSKEY", "DS", "CAA", "NAPTR", "OPT" ], "optional":false }, "length-limit-flag":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "optional":true }, "txt-data":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "optional":true }, "txt-type-limit-num":{ "type":"number", "format":"number", "minimum":0, "maximum":256, "default":0, "partition-visibility":"shared", "not":"txt-type-no-limit", "description":"Limit the field length", "optional":true }, "txt-type-no-limit":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"txt-type-limit-num", "description":"Print the field as much as possible", "optional":true }, "signature":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "optional":true }, "rrsig-type-limit-num":{ "type":"number", "format":"number", "minimum":0, "maximum":256, "default":0, "partition-visibility":"shared", "not":"rrsig-type-no-limit", "description":"Limit the field length", "optional":true }, "rrsig-type-no-limit":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"rrsig-type-limit-num", "description":"Print the field as much as possible", "optional":true }, "other-data":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "optional":true }, "tsig-type-limit-num":{ "type":"number", "format":"number", "minimum":0, "maximum":256, "default":0, "partition-visibility":"shared", "not":"tsig-type-no-limit", "description":"Limit the field length", "optional":true }, "tsig-type-no-limit":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"tsig-type-limit-num", "description":"Print the field as much as possible", "optional":true }, "public-key":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "optional":true }, "dnskey-type-limit-num":{ "type":"number", "format":"number", "minimum":0, "maximum":256, "default":0, "partition-visibility":"shared", "not":"dnskey-type-no-limit", "description":"Limit the field length", "optional":true }, "dnskey-type-no-limit":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"dnskey-type-limit-num", "description":"Print the field as much as possible", "optional":true }, "digest":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "optional":true }, "ds-type-limit-num":{ "type":"number", "format":"number", "minimum":0, "maximum":256, "default":0, "partition-visibility":"shared", "not":"ds-type-no-limit", "description":"Limit the field length", "optional":true }, "ds-type-no-limit":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"ds-type-limit-num", "description":"Print the field as much as possible", "optional":true }, "value-field":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "optional":true }, "caa-type-limit-num":{ "type":"number", "format":"number", "minimum":0, "maximum":256, "default":0, "partition-visibility":"shared", "not":"caa-type-no-limit", "description":"Limit the field length", "optional":true }, "caa-type-no-limit":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"caa-type-limit-num", "description":"Print the field as much as possible", "optional":true }, "service-field":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "optional":true }, "naptr-type-limit-num":{ "type":"number", "format":"number", "minimum":0, "maximum":256, "default":0, "partition-visibility":"shared", "not":"naptr-type-no-limit", "description":"Limit the field length", "optional":true }, "naptr-type-no-limit":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"naptr-type-limit-num", "description":"Print the field as much as possible", "optional":true }, "rdata-field":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "optional":true }, "opt-type-limit-num":{ "type":"number", "format":"number", "minimum":0, "maximum":256, "default":0, "partition-visibility":"shared", "not":"opt-type-no-limit", "description":"Limit the field length", "optional":true }, "opt-type-no-limit":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"opt-type-limit-num", "description":"Print the field as much as possible", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "response-type-name" ] } ] } } } }, "required":[ "name" ] } ] }, "persist":{ "type":"object", "$ref":"/axapi/v3/slb/template/persist", "properties":{ "cookie-list":{ "type":"array", "minItems":1, "items":{ "type":"cookie" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/persist/cookie/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Cookie persistence (Cookie persistence template name)", "optional":false }, "dont-honor-conn-rules":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not observe connection rate rules", "optional":true }, "expire":{ "type":"number", "format":"number", "minimum":0, "maximum":31536000, "default":31536000, "partition-visibility":"shared", "description":"Set cookie expiration time (Expiration in seconds)", "optional":true }, "use-attribute":{ "type":"string", "format":"enum", "default":"expires", "partition-visibility":"shared", "description":"'max-age': Use the Max-Age attribute; 'expires': Use the Expires attribute; 'all': Use all attributes; ", "enum":[ "max-age", "expires", "all" ], "optional":true }, "insert-always":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Insert persist cookie to every reponse", "optional":true }, "encrypt-level":{ "type":"number", "format":"number", "minimum":0, "maximum":1, "default":1, "partition-visibility":"shared", "description":"Encryption level for cookie name / value", "optional":true }, "pass-phrase":{ "type":"string", "format":"password", "minLength":8, "maxLength":8, "default":"ACOS4KEY", "partition-visibility":"shared", "description":"Set passphrase for encryption", "optional":true }, "encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)", "optional":true }, "cookie-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "default":"sto-id", "partition-visibility":"shared", "description":"Set cookie name", "optional":true }, "prefix":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'host': the cookie will have been set with a Secure attribute, a Path attribute with a value of /, and no Domain attribute; 'secure': the cookie will have been set with a Secure attribute; ", "enum":[ "host", "secure" ], "optional":true }, "domain":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Set cookie domain", "optional":true }, "samesite":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'none': none; 'lax': lax; 'strict': strict; ", "enum":[ "none", "lax", "strict" ], "optional":true }, "path":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "default":"/", "partition-visibility":"shared", "description":"Set cookie path (Cookie path, default is \"/\")", "optional":true }, "pass-thru":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Pass thru mode - Server sends the persist cookie", "optional":true }, "secure":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable secure attribute", "optional":true }, "httponly":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable HttpOnly attribute", "optional":true }, "match-type":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Persist for server, default is port", "optional":true }, "server":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"service-group", "description":"Persist to the same server, default is port", "optional":true }, "server-service-group":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Persist to the same server and within the same service group", "optional":true }, "scan-all-members":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Persist within the same server SCAN", "optional":true }, "service-group":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"server", "description":"Persist within the same service group", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "destination-ip-list":{ "type":"array", "minItems":1, "items":{ "type":"destination-ip" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/persist/destination-ip/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Destination IP persistence template name", "optional":false }, "dont-honor-conn-rules":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not observe connection rate rules", "optional":true }, "hash-persist":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use hash value of destination IP address", "optional":true }, "match-type":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Persistence type", "optional":true }, "server":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"service-group", "description":"Persist to the same server, default is port", "optional":true }, "service-group":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"server", "description":"Persist within the same service group", "optional":true }, "scan-all-members":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Persist with SCAN of all members", "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":2000, "default":5, "partition-visibility":"shared", "description":"Persistence timeout (in minutes)", "optional":true }, "netmask":{ "type":"string", "format":"ipv4-netmask", "default":"255.255.255.255", "partition-visibility":"shared", "description":"IP subnet mask", "optional":true }, "netmask6":{ "type":"number", "format":"number", "minimum":1, "maximum":128, "default":128, "partition-visibility":"shared", "description":"IPV6 subnet mask", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "source-ip-list":{ "type":"array", "minItems":1, "items":{ "type":"source-ip" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/persist/source-ip/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Source IP persistence template name", "optional":false }, "dont-honor-conn-rules":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not observe connection rate rules", "optional":true }, "enforce-higher-priority":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enforce to use high priority node if available", "optional":true }, "hash-persist":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use hash value of source IP address", "optional":true }, "incl-dst-ip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include destination IP on the persist", "optional":true }, "incl-sport":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include source port on the persist", "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":4321, "default":5, "partition-visibility":"shared", "description":"Persistence timeout (in minutes)", "optional":true }, "netmask":{ "type":"string", "format":"ipv4-netmask", "default":"255.255.255.255", "partition-visibility":"shared", "description":"IP subnet mask", "optional":true }, "netmask6":{ "type":"number", "format":"number", "minimum":1, "maximum":128, "default":128, "partition-visibility":"shared", "description":"IPV6 subnet mask", "optional":true }, "match-type":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Persistence type", "optional":true }, "server":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"service-group", "description":"Persist to the same server, default is port", "optional":true }, "primary-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "partition-visibility":"shared", "description":"Primary port to create the persist session", "optional":true }, "service-group":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"server", "description":"Persist within the same service group", "optional":true }, "scan-all-members":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Persist with SCAN of all members", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "ssl-sid-list":{ "type":"array", "minItems":1, "items":{ "type":"ssl-sid" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/persist/ssl-sid/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"SSL session ID persistence template name", "optional":false }, "dont-honor-conn-rules":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not observe connection rate rules", "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":2000, "default":5, "partition-visibility":"shared", "description":"Persistence timeout (in minutes)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] } } }, "policy-list":{ "type":"array", "minItems":1, "items":{ "type":"policy" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/policy/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Policy template name", "optional":false }, "bw-list-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify a blacklist/whitelist name", "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":127, "default":5, "partition-visibility":"shared", "description":"Define timeout value of PBSLB dynamic entry (Timeout value (minute, default is 5))", "optional":true }, "use-destination-ip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use destination IP to match the policy", "optional":true }, "over-limit":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify operation in case over limit", "optional":true }, "over-limit-reset":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Reset the connection when it exceeds limit", "optional":true }, "over-limit-lockup":{ "type":"number", "format":"number", "minimum":1, "maximum":127, "partition-visibility":"shared", "description":"Don't accept any new connection for certain time (Lockup duration (minute))", "optional":true }, "over-limit-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log a message", "optional":true }, "interval":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"Log interval (minute)", "optional":true }, "bw-list-id":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "id":{ "type":"number", "format":"number", "minimum":0, "maximum":1023, "partition-visibility":"shared", "description":"Specify id that maps to service group (The id number)" }, "service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "not":"bw-list-action", "description":"Specify a service group (Specify the service group name)" }, "pbslb-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure PBSLB logging" }, "pbslb-interval":{ "type":"number", "format":"number", "minimum":0, "maximum":60, "default":3, "partition-visibility":"shared", "description":"Specify logging interval in minutes" }, "fail":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Only log unsuccessful connections" }, "bw-list-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not":"service-group", "description":"'drop': drop the packet; 'reset': Send reset back; ", "enum":[ "drop", "reset" ] }, "logging-drp-rst":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure PBSLB logging" }, "action-interval":{ "type":"number", "format":"number", "minimum":0, "maximum":60, "default":3, "partition-visibility":"shared", "description":"Specify logging interval in minute (default is 3)" } } } ] }, "overlap":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use overlap mode for geo-location to do longest match", "optional":true }, "share":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Share counters between virtual ports and virtual servers", "optional":true }, "full-domain-tree":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Share counters between geo-location and sub regions", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'fwd-policy-dns-unresolved': Forward-policy unresolved DNS queries; 'fwd-policy-dns-outstanding': Forward-policy current DNS outstanding requests; 'fwd-policy-snat-fail': Forward-policy source-nat translation failure; 'fwd-policy-hits': Number of forward-policy requests for this policy template; 'fwd-policy-forward-to-internet': Number of forward-policy requests forwarded to internet; 'fwd-policy-forward-to-service-group': Number of forward-policy requests forwarded to service group; 'fwd-policy-forward-to-proxy': Number of forward-policy requests forwarded to proxy; 'fwd-policy-policy-drop': Number of forward-policy requests dropped; 'fwd-policy-source-match-not-found': Forward-policy requests without matching source rule; 'exp-client-hello-not-found': Expected Client HELLO requests not found; ", "enum":[ "all", "fwd-policy-dns-unresolved", "fwd-policy-dns-outstanding", "fwd-policy-snat-fail", "fwd-policy-hits", "fwd-policy-forward-to-internet", "fwd-policy-forward-to-service-group", "fwd-policy-forward-to-proxy", "fwd-policy-policy-drop", "fwd-policy-source-match-not-found", "exp-client-hello-not-found" ] } } } ] }, "class-list":{ "type":"object", "$ref":"/axapi/v3/slb/template/policy/{name}/class-list", "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Class list name or geo-location-class-list name" }, "client-ip-l3-dest":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"client-ip-l7-header", "description":"Use destination IP as client IP address" }, "client-ip-l7-header":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"client-ip-l3-dest", "description":"Use extract client IP address from L7 header" }, "header-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify L7 header name" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "lid-list":{ "type":"array", "minItems":1, "items":{ "type":"lid" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/policy/{name}/class-list/lid/{lidnum}", "array":[ { "properties":{ "lidnum":{ "type":"number", "format":"number", "minimum":1, "maximum":1023, "partition-visibility":"shared", "description":"Specify a limit ID", "optional":false }, "conn-limit":{ "type":"number", "format":"number", "minimum":0, "maximum":1048575, "partition-visibility":"shared", "description":"Connection limit", "optional":true }, "conn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Specify connection rate limit", "optional":true }, "conn-per":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Per (Specify interval in number of 100ms)", "optional":true }, "request-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":1048575, "partition-visibility":"shared", "description":"Request limit (Specify request limit)", "optional":true }, "request-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":4294967295, "partition-visibility":"shared", "description":"Request rate limit (Specify request rate limit)", "optional":true }, "request-per":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Per (Specify interval in number of 100ms)", "optional":true }, "bw-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Specify bandwidth rate limit (Bandwidth rate limit in bytes)", "optional":true }, "bw-per":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Per (Specify interval in number of 100ms)", "optional":true }, "over-limit-action":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Set action when exceeds limit", "optional":true }, "action-value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'forward': Forward the traffic even it exceeds limit; 'reset': Reset the connection when it exceeds limit; ", "enum":[ "forward", "reset" ], "optional":true }, "lockout":{ "type":"number", "format":"number", "minimum":1, "maximum":1023, "partition-visibility":"shared", "description":"Don't accept any new connection for certain time (Lockout duration in minutes)", "optional":true }, "log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log a message", "optional":true }, "interval":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"Specify log interval in minutes, by default system will log every over limit instance", "optional":true }, "direct-action":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Set action when match the lid", "optional":true }, "direct-service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "not":"direct-action-value", "description":"Specify a service group (Specify the service group name)", "optional":true }, "direct-pbslb-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure PBSLB logging", "optional":true }, "direct-pbslb-interval":{ "type":"number", "format":"number", "minimum":0, "maximum":60, "default":3, "partition-visibility":"shared", "description":"Specify logging interval in minutes(default is 3)", "optional":true }, "direct-fail":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Only log unsuccessful connections", "optional":true }, "direct-action-value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not":"direct-service-group", "description":"'drop': drop the packet; 'reset': Send reset back; ", "enum":[ "drop", "reset" ], "optional":true }, "direct-logging-drp-rst":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure PBSLB logging", "optional":true }, "direct-action-interval":{ "type":"number", "format":"number", "minimum":0, "maximum":60, "default":3, "partition-visibility":"shared", "description":"Specify logging interval in minute (default is 3)", "optional":true }, "response-code-rate-limit":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "code-range-start":{ "type":"number", "format":"number", "minimum":100, "maximum":600, "partition-visibility":"shared", "description":"server response code range start" }, "code-range-end":{ "type":"number", "format":"number", "minimum":100, "maximum":600, "partition-visibility":"shared", "description":"server response code range end" }, "threshold":{ "type":"number", "format":"number", "minimum":1, "maximum":15, "partition-visibility":"shared", "description":"the times of getting the response code" }, "period":{ "type":"number", "format":"number", "minimum":1, "maximum":127, "partition-visibility":"shared", "description":"seconds" } } } ] }, "dns64":{ "type":"object", "properties":{ "disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable" }, "exclusive-answer":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Exclusive Answer in DNS Response" }, "prefix":{ "type":"string", "format":"ipv6-address-plen", "partition-visibility":"shared", "description":"IPv6 prefix" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "lidnum" ] } ] } } }, "forward-policy":{ "type":"object", "$ref":"/axapi/v3/slb/template/policy/{name}/forward-policy", "properties":{ "no-client-conn-reuse":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Inspects only first request of a connection" }, "acos-event-log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable acos event logging" }, "local-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable local logging" }, "require-web-category":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Wait for web category to be resolved before taking proxy decision" }, "forward-http-connect-to-icap":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Forward HTTP CONNECT request to ICAP server" }, "reqmod-icap":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/reqmod-icap", "description":"ICAP reqmod template (Reqmod ICAP Template Name)" }, "filtering":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ssli-url-filtering":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'bypassed-sni-disable': Disable SNI filtering for bypassed URL's(enabled by default); 'intercepted-sni-enable': Enable SNI filtering for intercepted URL's(disabled by default); 'intercepted-http-disable': Disable HTTP(host/URL) filtering for intercepted URL's(enabled by default); 'no-sni-allow': Allow connection if SNI filtering is enabled and SNI header is not present(Drop by default); ", "enum":[ "bypassed-sni-disable", "intercepted-sni-enable", "intercepted-http-disable", "no-sni-allow" ] } } } ] }, "san-filtering":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ssli-url-filtering-san":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'enable-san': Enable SAN filtering(disabled by default); 'bypassed-san-disable': Disable SAN filtering for bypassed URL's(enabled by default); 'intercepted-san-enable': Enable SAN filtering for intercepted URL's(disabled by default); 'no-san-allow': Allow connection if SAN filtering is enabled and SAN field is not present(Drop by default); ", "enum":[ "enable-san", "bypassed-san-disable", "intercepted-san-enable", "no-san-allow" ] } } } ] }, "enable-adv-match":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable adv-match rules and deactive all the other kinds of destination rules" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "action-list":{ "type":"array", "minItems":1, "items":{ "type":"action" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/policy/{name}/forward-policy/action/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Action policy name", "optional":false }, "action1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'forward-to-internet': Forward request to Internet; 'forward-to-service-group': Forward request to service group; 'forward-to-proxy': Forward request to HTTP proxy server; 'drop': Drop request; ", "enum":[ "forward-to-internet", "forward-to-service-group", "forward-to-proxy", "drop" ], "optional":true }, "fake-sg":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"service group to forward the packets to Internet", "optional":true }, "real-sg":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"service group to forward the packets", "optional":true }, "forward-snat":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"forward-snat-pt-only", "description":"Source NAT pool or pool group", "optional":true }, "forward-snat-pt-only":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"forward-snat", "description":"Source port translation only", "optional":true }, "fall-back":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Fallback service group for Internet", "optional":true }, "fall-back-snat":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"fall-back-snat-pt-only", "description":"Source NAT pool or pool group for fallback server", "optional":true }, "fall-back-snat-pt-only":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"fall-back-snat", "description":"Source port translation only for fallback server", "optional":true }, "proxy-chaining":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable proxy chaining feature", "optional":true }, "proxy-chaining-bypass":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Forward all https packets to upstream proxy", "optional":true }, "support-cert-fetch":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Fetch server certificate by upstream proxy", "optional":true }, "log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"enable logging", "optional":true }, "drop-response-code":{ "type":"number", "format":"number", "minimum":100, "maximum":599, "partition-visibility":"shared", "not":"drop-redirect-url", "description":"Specify response code for drop action", "optional":true }, "drop-message":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1023, "partition-visibility":"shared", "not":"drop-redirect-url", "description":"drop-message sent to the client as webpage(html tags are included and quotation marks are required for white spaces)", "optional":true }, "drop-redirect-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1023, "partition-visibility":"shared", "not-list":[ "drop-response-code", "drop-message" ], "description":"Specify URL to which client request is redirected upon being dropped", "optional":true }, "http-status-code":{ "type":"string", "format":"enum", "default":"302", "partition-visibility":"shared", "description":"'301': Moved permanently; '302': Found; ", "enum":[ "301", "302" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'hits': Number of requests matching this destination rule; ", "enum":[ "all", "hits" ] } } } ] } }, "required":[ "name" ] } ] }, "dual-stack-action-list":{ "type":"array", "minItems":1, "items":{ "type":"dual-stack-action" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/policy/{name}/forward-policy/dual-stack-action/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Action name", "optional":false }, "ipv4":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"IPv4 service group to forward", "optional":true }, "ipv4-snat":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/nat/pool", "description":"IPv4 source NAT pool or pool group", "optional":true }, "ipv6":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"IPv6 service group to forward", "optional":true }, "ipv6-snat":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/ipv6/nat/pool", "description":"IPv6 source NAT pool or pool group", "optional":true }, "fall-back":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Fallback service group", "optional":true }, "fall-back-snat":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/nat/pool", "description":"Source NAT pool or pool group for fallback", "optional":true }, "log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"enable logging", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'hits': Number of requests forward by this action; ", "enum":[ "all", "hits" ] } } } ] } }, "required":[ "name" ] } ] }, "source-list":{ "type":"array", "minItems":1, "items":{ "type":"source" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"source destination match rule name", "optional":false }, "match-class-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"match-any", "description":"Class List Name", "optional":true }, "match-any":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"match-class-list", "description":"Match any source", "optional":true }, "match-authorize-policy":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authorization/policy", "description":"Authorize-policy for user and group based policy", "optional":true }, "priority":{ "type":"number", "format":"number", "minimum":1, "maximum":2000, "partition-visibility":"shared", "description":"Priority of the source(higher the number higher the priority, default 0)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'hits': Number of requests matching this source rule; 'destination-match-not-found': Number of requests without matching destination rule; 'no-host-info': Failed to parse ip or host information from request; ", "enum":[ "all", "hits", "destination-match-not-found", "no-host-info" ] } } } ] }, "destination":{ "type":"object", "$ref":"/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination", "properties":{ "adv-match-list":{ "type":"array", "minItems":1, "items":{ "type":"adv-match" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/adv-match/{priority}", "array":[ { "properties":{ "priority":{ "type":"number", "format":"number", "minimum":1, "maximum":1000, "partition-visibility":"shared", "description":"Rule priority (1000 is highest)", "optional":false }, "match-host":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Match request host (HTTP stage) or SNI/SAN (SSL stage)", "optional":true }, "match-http-content-encoding":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Match the value of HTTP header \"Content-Encoding\"", "optional":true }, "match-http-content-length-range-begin":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "partition-visibility":"shared", "description":"Match the value of HTTP header \"Content-Length\" with an inclusive range", "optional":true }, "match-http-content-length-range-end":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "partition-visibility":"shared", "description":"End of the \"Content-Length\" range", "optional":true }, "match-http-content-type":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Match the value of HTTP header \"Content-Type\"", "optional":true }, "match-http-header":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Matching the name of all request headers", "optional":true }, "match-http-method-connect":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Match HTTP request method CONNECT", "optional":true }, "match-http-method-delete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Match HTTP request method DELETE", "optional":true }, "match-http-method-get":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Match HTTP request method GET", "optional":true }, "match-http-method-head":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Match HTTP request method HEAD", "optional":true }, "match-http-method-options":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Match HTTP request method OPTIONS", "optional":true }, "match-http-method-patch":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Match HTTP request method PATCH", "optional":true }, "match-http-method-post":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Match HTTP request method POST", "optional":true }, "match-http-method-put":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Match HTTP request method PUT", "optional":true }, "match-http-method-trace":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Match HTTP request method TRACE", "optional":true }, "match-http-request-file-extension":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Match file extension of URL in HTTP request line", "optional":true }, "match-http-url-regex":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Match URI in HTTP request line by given regular expression", "optional":true }, "match-http-url":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Match URL in HTTP request line", "optional":true }, "match-http-user-agent":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Matching the value of HTTP header \"User-Agent\"", "optional":true }, "match-server-address":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/class-list", "description":"Match target server IP address", "optional":true }, "match-server-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "not":"match-server-port-range-begin", "description":"Match target server port number", "optional":true }, "match-server-port-range-begin":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "not":"match-server-port", "description":"Math targer server port range inclusively", "optional":true }, "match-server-port-range-end":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"End of port range", "optional":true }, "match-time-range":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/forward-proxy/time-range", "description":"Enable rule in this time-range", "optional":true }, "match-web-category-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/web-category/category-list", "description":"Match web-category list", "optional":true }, "match-web-reputation-scope":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/web-category/reputation-scope", "description":"Match web-reputation scope", "optional":true }, "disable-reqmod-icap":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable REQMOD ICAP template", "optional":true }, "disable-respmod-icap":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable RESPMOD ICAP template", "optional":true }, "notify-page":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/forward-proxy/notify-page", "description":"Send notify-page to client", "optional":true }, "action":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"dual-stack-action", "description":"Forwading action of this rule", "optional":true }, "dual-stack-action":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"action", "description":"Forwarding action of this rule", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'hits': Number of requests hit this rule; ", "enum":[ "all", "hits" ] } } } ] } }, "required":[ "priority" ] } ] }, "class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/class-list/{dest-class-list}", "array":[ { "properties":{ "dest-class-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Destination Class List Name", "optional":false }, "action":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Action to be performed", "optional":true }, "dual-stack-action":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Dual-stack action to be performed", "optional":true }, "type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'host': Match hostname; 'url': Match URL; 'ip': Match destination IP address; ", "enum":[ "host", "url", "ip" ], "optional":true }, "priority":{ "type":"number", "format":"number", "minimum":1, "maximum":1024, "partition-visibility":"shared", "description":"Priority value of the action(higher the number higher the priority)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "dest-class-list" ] } ] }, "web-reputation-scope-list":{ "type":"array", "minItems":1, "items":{ "type":"web-reputation-scope" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/web-reputation-scope/{web-reputation-scope}", "array":[ { "properties":{ "web-reputation-scope":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/web-category/reputation-scope", "description":"Destination Web Reputation Scope Name", "optional":false }, "action":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Action to be performed", "optional":true }, "dual-stack-action":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Dual-stack action to be performed", "optional":true }, "type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'host': Match hostname; 'url': match URL; ", "enum":[ "host", "url" ], "optional":true }, "priority":{ "type":"number", "format":"number", "minimum":1, "maximum":1024, "partition-visibility":"shared", "description":"Priority value of the action(higher the number higher the priority)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "web-reputation-scope" ] } ] }, "web-category-list-list":{ "type":"array", "minItems":1, "items":{ "type":"web-category-list" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/web-category-list/{web-category-list}", "array":[ { "properties":{ "web-category-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/web-category/category-list", "description":"Destination Web Category List Name", "optional":false }, "action":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Action to be performed", "optional":true }, "dual-stack-action":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Dual-stack action to be performed", "optional":true }, "type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'host': Match hostname; 'url': match URL; ", "enum":[ "host", "url" ], "optional":true }, "priority":{ "type":"number", "format":"number", "minimum":1, "maximum":1024, "partition-visibility":"shared", "description":"Priority value of the action(higher the number higher the priority)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "web-category-list" ] } ] }, "any":{ "type":"object", "$ref":"/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/any", "properties":{ "action":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"dual-stack-action", "description":"Action to be performed" }, "dual-stack-action":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"action", "description":"Dual-stack action to be performed" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'hits': Number of requests matching this destination rule; ", "enum":[ "all", "hits" ] } } } ] } } } } } }, "required":[ "name" ] } ] } } } }, "required":[ "name" ] } ] }, "port-list":{ "type":"array", "minItems":1, "items":{ "type":"port" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/port/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"default", "partition-visibility":"shared", "description":"Port template name", "optional":false }, "conn-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":64000000, "default":64000000, "partition-visibility":"shared", "description":"Connection limit", "optional":true }, "resume":{ "type":"number", "format":"number", "minimum":1, "maximum":1048575, "partition-visibility":"shared", "description":"Resume accepting new connection after connection number drops below threshold (Connection resume threshold)", "optional":true }, "conn-limit-no-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not log connection over limit event", "optional":true }, "conn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":1048575, "partition-visibility":"shared", "description":"Connection rate limit", "optional":true }, "rate-interval":{ "type":"string", "format":"enum", "default":"second", "partition-visibility":"shared", "description":"'100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; ", "enum":[ "100ms", "second" ], "optional":true }, "conn-rate-limit-no-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not log connection over limit event", "optional":true }, "request-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":1048575, "partition-visibility":"shared", "description":"Request rate limit", "optional":true }, "request-rate-interval":{ "type":"string", "format":"enum", "default":"second", "partition-visibility":"shared", "description":"'100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; ", "enum":[ "100ms", "second" ], "optional":true }, "reset":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send client reset when connection rate over limit", "optional":true }, "request-rate-no-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not log connection over limit event", "optional":true }, "dest-nat":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Destination NAT", "optional":true }, "down-grace-period":{ "type":"number", "format":"number", "minimum":1, "maximum":86400, "partition-visibility":"shared", "description":"Port down grace period (Down grace period in seconds)", "optional":true }, "del-session-on-server-down":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete session if the server/port goes down (either disabled/hm down)", "optional":true }, "dscp":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "partition-visibility":"shared", "description":"Differentiated Services Code Point (DSCP to Real Server IP Mapping Value)", "optional":true }, "dynamic-member-priority":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "default":16, "partition-visibility":"shared", "description":"Set dynamic member's priority (Initial priority (default is 16))", "optional":true }, "decrement":{ "type":"number", "format":"number", "minimum":0, "maximum":7, "default":0, "partition-visibility":"shared", "description":"Decrease after every round of DNS query (default is 0)", "optional":true }, "extended-stats":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable extended statistics on real server port", "optional":true }, "no-ssl":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"No SSL", "optional":true }, "stats-data-action":{ "type":"string", "format":"enum", "default":"stats-data-enable", "partition-visibility":"shared", "description":"'stats-data-enable': Enable statistical data collection for real server port; 'stats-data-disable': Disable statistical data collection for real server port; ", "enum":[ "stats-data-enable", "stats-data-disable" ], "optional":true }, "health-check":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "not":"health-check-disable", "description":"Health Check Monitor (Health monitor name)", "optional":true }, "health-check-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check", "description":"Disable configured health check configuration", "optional":true }, "inband-health-check":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use inband traffic to detect port's health status", "optional":true }, "retry":{ "type":"number", "format":"number", "minimum":0, "maximum":7, "default":2, "partition-visibility":"shared", "description":"Maximum retry times before reassign this connection to another server/port (default is 2) (The maximum retry number)", "optional":true }, "reassign":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "default":25, "partition-visibility":"shared", "description":"Maximum reassign times before declear the server/port down (default is 25) (The maximum reassign number)", "optional":true }, "down-timer":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "default":0, "partition-visibility":"shared", "description":"The timer to bring the marked down server/port to up (default is 0, never bring up) (The timer to bring up server (in second, default is 0))", "optional":true }, "resel-on-reset":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"When receiving reset from server, do the server/port reselection (default is 0, don't do reselection)", "optional":true }, "source-nat":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/nat/pool", "not":"shared-partition-pool", "description":"Source NAT (IP NAT Pool or pool group name)", "optional":true }, "shared-partition-pool":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"source-nat", "description":"Reference a NAT pool or pool-group from shared partition", "optional":true }, "template-port-pool-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/nat/pool", "description":"Source NAT (IP NAT Pool or pool group name)", "optional":true }, "weight":{ "type":"number", "format":"number", "minimum":1, "maximum":1000, "default":1, "partition-visibility":"shared", "description":"Weight (port weight)", "optional":true }, "dampening-flaps":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"service dampening flaps count (max-flaps allowed in flap period)", "optional":true }, "flap-period":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"take service out of rotation if max-flaps exceeded within time in seconds", "optional":true }, "restore-svc-time":{ "type":"number", "format":"number", "minimum":1, "maximum":4095, "partition-visibility":"shared", "description":"put the service back to the rotation after time in seconds", "optional":true }, "sub-group":{ "type":"number", "format":"number", "minimum":0, "maximum":15, "default":0, "partition-visibility":"shared", "description":"Divide service group members into different sub groups (Sub group ID (default is 0))", "optional":true }, "slow-start":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Slowly ramp up the connection number after port is up", "optional":true }, "initial-slow-start":{ "type":"number", "format":"number", "minimum":1, "maximum":4095, "default":128, "partition-visibility":"shared", "description":"Initial slow start connection limit (default 128)", "optional":true }, "add":{ "type":"number", "format":"number", "minimum":1, "maximum":4095, "partition-visibility":"shared", "not":"times", "description":"Slow start connection limit add by a number every interval (Add by this number every interval)", "optional":true }, "times":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "default":2, "partition-visibility":"shared", "not":"add", "description":"Slow start connection limit multiply by a number every interval (default 2) (Multiply by this number every interval)", "optional":true }, "every":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "default":10, "partition-visibility":"shared", "description":"Slow start connection limit increment interval (default 10)", "optional":true }, "till":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":4096, "partition-visibility":"shared", "description":"Slow start ends when slow start connection limit reaches a number (default 4096) (Slow start ends when connection limit reaches this number)", "optional":true }, "bw-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16777216, "partition-visibility":"shared", "description":"Configure bandwidth rate limit on real server port (Bandwidth rate limit in Kbps)", "optional":true }, "bw-rate-limit-resume":{ "type":"number", "format":"number", "minimum":1, "maximum":16777216, "partition-visibility":"shared", "description":"Resume server selection after bandwidth drops below this threshold (in Kbps) (Bandwidth rate limit resume threshold (in Kbps))", "optional":true }, "bw-rate-limit-duration":{ "type":"number", "format":"number", "minimum":1, "maximum":250, "partition-visibility":"shared", "description":"Duration in seconds the observed rate needs to honor", "optional":true }, "bw-rate-limit-no-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not log bandwidth rate limit related state transitions", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "server-list":{ "type":"array", "minItems":1, "items":{ "type":"server" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/server/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"default", "partition-visibility":"shared", "description":"Server template name", "optional":false }, "conn-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":64000000, "default":64000000, "partition-visibility":"shared", "description":"Connection limit", "optional":true }, "resume":{ "type":"number", "format":"number", "minimum":1, "maximum":1048575, "partition-visibility":"shared", "description":"Resume accepting new connection after connection number drops below threshold (Connection resume threshold)", "optional":true }, "conn-limit-no-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not log connection over limit event", "optional":true }, "conn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":1048575, "partition-visibility":"shared", "description":"Connection rate limit", "optional":true }, "rate-interval":{ "type":"string", "format":"enum", "default":"second", "partition-visibility":"shared", "description":"'100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; ", "enum":[ "100ms", "second" ], "optional":true }, "conn-rate-limit-no-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not log connection over limit event", "optional":true }, "dns-query-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":1440, "default":10, "partition-visibility":"shared", "description":"The interval to query DNS server for the hostname (DNS query interval (in minute, default is 10))", "optional":true }, "dns-fail-interval":{ "type":"number", "format":"number", "minimum":0, "maximum":1800, "default":30, "partition-visibility":"shared", "description":"The interval to retry when DNS failed to query (DNS failure interval (in second, default is 30))", "optional":true }, "dynamic-server-prefix":{ "type":"string", "format":"string", "minLength":1, "maxLength":3, "default":"DRS", "partition-visibility":"shared", "description":"Prefix of dynamic server (Prefix of dynamic server (default is \"DRS\"))", "optional":true }, "extended-stats":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable extended statistics on real server", "optional":true }, "log-selection-failure":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable real-time logging for server selection failure event", "optional":true }, "health-check":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "not":"health-check-disable", "description":"Health Check Monitor (Health monitor name)", "optional":true }, "health-check-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check", "description":"Disable configured health check configuration", "optional":true }, "max-dynamic-server":{ "type":"number", "format":"number", "minimum":1, "maximum":1023, "default":255, "partition-visibility":"shared", "description":"Maximum dynamic server number (Maximum dynamic server number (default is 255))", "optional":true }, "min-ttl-ratio":{ "type":"number", "format":"number", "minimum":1, "maximum":15, "default":2, "partition-visibility":"shared", "description":"Minimum TTL to DNS query interval ratio (Minimum TTL ratio (default is 2))", "optional":true }, "weight":{ "type":"number", "format":"number", "minimum":1, "maximum":1000, "default":1, "partition-visibility":"shared", "description":"Weight for the Real Servers (Connection Weight (default is 1))", "optional":true }, "spoofing-cache":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Servers under the template are spoofing cache", "optional":true }, "stats-data-action":{ "type":"string", "format":"enum", "default":"stats-data-enable", "partition-visibility":"shared", "description":"'stats-data-enable': Enable statistical data collection for real server; 'stats-data-disable': Disable statistical data collection for real server; ", "enum":[ "stats-data-enable", "stats-data-disable" ], "optional":true }, "slow-start":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Slowly ramp up the connection number after server is up", "optional":true }, "initial-slow-start":{ "type":"number", "format":"number", "minimum":1, "maximum":4095, "default":128, "partition-visibility":"shared", "description":"Initial slow start connection limit (default 128)", "optional":true }, "add":{ "type":"number", "format":"number", "minimum":1, "maximum":4095, "partition-visibility":"shared", "not":"times", "description":"Slow start connection limit add by a number every interval (Add by this number every interval)", "optional":true }, "times":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "default":2, "partition-visibility":"shared", "not":"add", "description":"Slow start connection limit multiply by a number every interval (default 2) (Multiply by this number every interval)", "optional":true }, "every":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "default":10, "partition-visibility":"shared", "description":"Slow start connection limit increment interval (default 10)", "optional":true }, "till":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":4096, "partition-visibility":"shared", "description":"Slow start ends when slow start connection limit reaches a number (default 4096) (Slow start ends when connection limit reaches this number)", "optional":true }, "bw-rate-limit-acct":{ "type":"string", "format":"enum", "default":"all", "partition-visibility":"shared", "description":"'to-server-only': Only account for traffic sent to server; 'from-server-only': Only account for traffic received from server; 'all': Account for all traffic sent to and received from server; ", "enum":[ "to-server-only", "from-server-only", "all" ], "optional":true }, "bw-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":16777216, "partition-visibility":"shared", "description":"Configure bandwidth rate limit on real server (Bandwidth rate limit in Kbps)", "optional":true }, "bw-rate-limit-resume":{ "type":"number", "format":"number", "minimum":1, "maximum":16777216, "partition-visibility":"shared", "description":"Resume server selection after bandwidth drops below this threshold (in Kbps) (Bandwidth rate limit resume threshold (in Kbps))", "optional":true }, "bw-rate-limit-duration":{ "type":"number", "format":"number", "minimum":1, "maximum":250, "partition-visibility":"shared", "description":"Duration in seconds the observed rate needs to honor", "optional":true }, "bw-rate-limit-no-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not log bandwidth rate limit related state transitions", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "server-ssl-list":{ "type":"array", "minItems":1, "items":{ "type":"server-ssl" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/server-ssl/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Server SSL Template Name", "optional":false }, "ca-certs":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ca-cert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Specify CA certificate" }, "ca-cert-partition-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "description":"CA Certificate Partition Shared" }, "server-ocsp-srvr":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/server/ocsp", "description":"Specify authentication server" }, "server-ocsp-sg":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/service-group", "description":"Specify service-group (Service group name)" } } } ] }, "server-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify Server Name", "optional":true }, "crl-certs":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "crl":{ "type":"string", "format":"string", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Certificate Revocation Lists (Certificate Revocation Lists file name)" }, "crl-partition-shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "description":"Certificate Revocation Lists Partition Shared" } } } ] }, "cipher-without-prio-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "cipher-wo-prio":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "cipher-template", "shared-partition-cipher-template" ], "description":"'SSL3_RSA_DES_192_CBC3_SHA': TLS_RSA_WITH_3DES_EDE_CBC_SHA (0x000A); 'SSL3_RSA_RC4_128_MD5': TLS_RSA_WITH_RC4_128_MD5 (0x0004); 'SSL3_RSA_RC4_128_SHA': TLS_RSA_WITH_RC4_128_SHA (0x0005); 'TLS1_RSA_AES_128_SHA': TLS_RSA_WITH_AES_128_CBC_SHA (0x002F); 'TLS1_RSA_AES_256_SHA': TLS_RSA_WITH_AES_256_CBC_SHA (0x0035); 'TLS1_RSA_AES_128_SHA256': TLS_RSA_WITH_AES_128_CBC_SHA256 (0x003C); 'TLS1_RSA_AES_256_SHA256': TLS_RSA_WITH_AES_256_CBC_SHA256 (0x003D); 'TLS1_DHE_RSA_AES_128_GCM_SHA256': TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 (0x009E); 'TLS1_DHE_RSA_AES_128_SHA': TLS_DHE_RSA_WITH_AES_128_CBC_SHA (0x0033); 'TLS1_DHE_RSA_AES_128_SHA256': TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 (0x0067); 'TLS1_DHE_RSA_AES_256_GCM_SHA384': TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 (0x009F); 'TLS1_DHE_RSA_AES_256_SHA': TLS_DHE_RSA_WITH_AES_256_CBC_SHA (0x0039); 'TLS1_DHE_RSA_AES_256_SHA256': TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 (0x006B); 'TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 (0xC02B); 'TLS1_ECDHE_ECDSA_AES_128_SHA': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA (0xC009); 'TLS1_ECDHE_ECDSA_AES_128_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 (0xC023); 'TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 (0xC02C); 'TLS1_ECDHE_ECDSA_AES_256_SHA': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA (0xC00A); 'TLS1_ECDHE_RSA_AES_128_GCM_SHA256': TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (0xC02F); 'TLS1_ECDHE_RSA_AES_128_SHA': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (0xC013); 'TLS1_ECDHE_RSA_AES_128_SHA256': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (0xC027); 'TLS1_ECDHE_RSA_AES_256_GCM_SHA384': TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xC030); 'TLS1_ECDHE_RSA_AES_256_SHA': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (0xC014); 'TLS1_RSA_AES_128_GCM_SHA256': TLS_RSA_WITH_AES_128_GCM_SHA256 (0x009C); 'TLS1_RSA_AES_256_GCM_SHA384': TLS_RSA_WITH_AES_256_GCM_SHA384 (0x009D); 'TLS1_ECDHE_RSA_AES_256_SHA384': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (0xC028); 'TLS1_ECDHE_ECDSA_AES_256_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 (0xC024); 'TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA8); 'TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA9); 'TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256': TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCAA); ", "enum":[ "SSL3_RSA_DES_192_CBC3_SHA", "SSL3_RSA_RC4_128_MD5", "SSL3_RSA_RC4_128_SHA", "TLS1_RSA_AES_128_SHA", "TLS1_RSA_AES_256_SHA", "TLS1_RSA_AES_128_SHA256", "TLS1_RSA_AES_256_SHA256", "TLS1_DHE_RSA_AES_128_GCM_SHA256", "TLS1_DHE_RSA_AES_128_SHA", "TLS1_DHE_RSA_AES_128_SHA256", "TLS1_DHE_RSA_AES_256_GCM_SHA384", "TLS1_DHE_RSA_AES_256_SHA", "TLS1_DHE_RSA_AES_256_SHA256", "TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256", "TLS1_ECDHE_ECDSA_AES_128_SHA", "TLS1_ECDHE_ECDSA_AES_128_SHA256", "TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384", "TLS1_ECDHE_ECDSA_AES_256_SHA", "TLS1_ECDHE_RSA_AES_128_GCM_SHA256", "TLS1_ECDHE_RSA_AES_128_SHA", "TLS1_ECDHE_RSA_AES_128_SHA256", "TLS1_ECDHE_RSA_AES_256_GCM_SHA384", "TLS1_ECDHE_RSA_AES_256_SHA", "TLS1_RSA_AES_128_GCM_SHA256", "TLS1_RSA_AES_256_GCM_SHA384", "TLS1_ECDHE_RSA_AES_256_SHA384", "TLS1_ECDHE_ECDSA_AES_256_SHA384", "TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256", "TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256", "TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256" ] } } } ] }, "dh-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'1024': 1024; '1024-dsa': 1024-dsa; '2048': 2048; ", "enum":[ "1024", "1024-dsa", "2048" ], "optional":true }, "ec-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ec":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'secp256r1': X9_62_prime256v1; 'secp384r1': secp384r1; ", "enum":[ "secp256r1", "secp384r1" ] } } } ] }, "enable-tls-alert-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable TLS alert logging", "optional":true }, "alert-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'fatal': Log fatal alerts; ", "enum":[ "fatal" ], "optional":true }, "handshake-logging-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable SSL handshake logging", "optional":true }, "close-notify":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send close notification when terminate connection", "optional":true }, "forward-proxy-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable SSL forward proxy", "optional":true }, "session-ticket-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable server side session ticket support", "optional":true }, "version":{ "type":"number", "format":"number", "minimum":30, "maximum":34, "default":33, "partition-visibility":"shared", "description":"TLS/SSL version, default is the highest number supported (TLS/SSL version: 30-SSLv3.0, 31-TLSv1.0, 32-TLSv1.1, 33-TLSv1.2 and 34-TLSv1.3)", "optional":true }, "dgversion":{ "type":"number", "format":"number", "minimum":30, "maximum":34, "default":31, "partition-visibility":"shared", "description":"Lower TLS/SSL version can be downgraded", "optional":true }, "server-certificate-error":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "error-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'email': Notify the error via email; 'ignore': Ignore the error, which mean the connection can continue; 'logging': Log the error; 'trap': Notify the error by SNMP trap; ", "enum":[ "email", "ignore", "logging", "trap" ] } } } ] }, "ssli-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"SSLi logging level, default is error logging only", "optional":true }, "sslilogging":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'disable': Disable all logging; 'all': enable all logging(error, info); ", "enum":[ "disable", "all" ], "optional":true }, "ocsp-stapling":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable ocsp-stapling support", "optional":true }, "use-client-sni":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"use client SNI", "optional":true }, "renegotiation-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable SSL renegotiation", "optional":true }, "session-cache-size":{ "type":"number", "format":"number", "minimum":0, "maximum":128, "default":0, "partition-visibility":"shared", "description":"Session Cache Size (Maximum cache size. Default value 0 (Session ID reuse disabled))", "optional":true }, "session-cache-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":7200, "partition-visibility":"shared", "description":"Session Cache Timeout (Timeout value, in seconds. Default no timeout.)", "optional":true }, "cipher-template":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/cipher", "not-list":[ "cipher-wo-prio", "shared-partition-cipher-template" ], "description":"Cipher Template Name", "optional":true }, "shared-partition-cipher-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "cipher-wo-prio", "cipher-template" ], "description":"Reference a cipher template from shared partition", "optional":true }, "template-cipher-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/cipher", "description":"Cipher Template Name", "optional":true }, "enable-ssli-ftp-alg":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Enable SSLi FTP over TLS support at which port", "optional":true }, "early-data":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable TLS 1.3 early data (0-RTT)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "certificate":{ "type":"object", "$ref":"/axapi/v3/slb/template/server-ssl/{name}/certificate", "properties":{ "cert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Certificate Name" }, "key":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Client private-key (Key Name)" }, "passphrase":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Password Phrase" }, "encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)" }, "shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "description":"Client Certificate and Key Partition Shared" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] }, "server-ssh-list":{ "type":"array", "minItems":1, "items":{ "type":"server-ssh" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/server-ssh/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Server SSH Template Name", "optional":false }, "forward-proxy-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable SSH forward proxy", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "link-cost-list":{ "type":"array", "minItems":1, "items":{ "type":"link-cost" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/link-cost/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Server Link-Cost Template Name", "optional":false }, "prepaid-bandwidth":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "default":0, "partition-visibility":"shared", "description":"Configure prepaid bandwidth on real server (Prepaid Bandwidth in Mbpi)", "optional":true }, "overage-bandwidth-cost":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "default":0, "partition-visibility":"shared", "description":"Configure overage bandwidth cost on real server (Overage bandwidth cost per Mbpi)", "optional":true }, "bandwidth-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "default":5, "partition-visibility":"shared", "description":"Interval duration in seconds", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'link_total_fwd_bytes': Total bytes fwd for link; 'interval_fwd_bytes': Link Cost bytes processed in forward direction per interval; 'link_total_conn': Link Cost total connection; 'interval_avg_throughput': Link Cost average throughput per interval; 'interval_max_throughput': Link Cost max throughput per interval; ", "enum":[ "all", "link_total_fwd_bytes", "interval_fwd_bytes", "link_total_conn", "interval_avg_throughput", "interval_max_throughput" ] } } } ] } }, "required":[ "name" ] } ] }, "sip-list":{ "type":"array", "minItems":1, "items":{ "type":"sip" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/sip/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"SIP Template Name", "optional":false }, "alg-source-nat":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Translate source IP to NAT IP in SIP message when source NAT is used", "optional":true }, "alg-dest-nat":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Translate VIP to real server IP in SIP message when destination NAT is used", "optional":true }, "call-id-persist-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable call-ID persistence", "optional":true }, "client-keep-alive":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Respond client keep-alive packet directly instead of forwarding to server", "optional":true }, "pstn-gw":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "default":"pstn", "partition-visibility":"shared", "description":"configure pstn gw host name for tel: uri translate to sip: uri (Hostname String, default is \"pstn\")", "optional":true }, "client-request-header":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "client-request-header-erase":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Erase a SIP header (Header Name)" }, "client-request-erase-all":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Erase all headers" }, "client-request-header-insert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Insert a SIP header (Header Content (Format: \"name:value\"))" }, "insert-condition-client-request":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; ", "enum":[ "insert-if-not-exist", "insert-always" ] } } } ] }, "client-response-header":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "client-response-header-erase":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Erase a SIP header (Header Name)" }, "client-response-erase-all":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Erase all headers" }, "client-response-header-insert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Insert a SIP header (Header Content (Format: \"name:value\"))" }, "insert-condition-client-response":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; ", "enum":[ "insert-if-not-exist", "insert-always" ] } } } ] }, "exclude-translation":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "translation-value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'start-line': SIP request line or status line; 'header': SIP message headers; 'body': SIP message body; ", "enum":[ "start-line", "header", "body" ] }, "header-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"SIP header name" } } } ] }, "failed-client-selection":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Define action when select client fail", "optional":true }, "drop-when-client-fail":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"failed-client-selection-message", "description":"Drop current SIP message when select client fail", "optional":true }, "failed-client-selection-message":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"drop-when-client-fail", "description":"Send SIP message (includs status code) to server when select client fail(Format: 3 digits(1XX~6XX) space reason)", "optional":true }, "failed-server-selection":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Define action when select server fail", "optional":true }, "drop-when-server-fail":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"failed-server-selection-message", "description":"Drop current SIP message when select server fail", "optional":true }, "failed-server-selection-message":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"drop-when-server-fail", "description":"Send SIP message (includs status code) to client when select server fail(Format: 3 digits(1XX~6XX) space reason)", "optional":true }, "insert-client-ip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Insert Client IP address into SIP header", "optional":true }, "keep-server-ip-if-match-acl":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use Real Server IP for addresses matching the ACL for a Call-Id", "optional":true }, "acl-id":{ "type":"number", "format":"number", "minimum":100, "maximum":199, "partition-visibility":"shared", "$ref":"/axapi/v3/access-list/standard", "not":"acl-name-value", "description":"ACL id", "optional":true }, "acl-name-value":{ "type":"string", "format":"string", "minLength":1, "maxLength":16, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/access-list", "not":"acl-id", "description":"IPv4 Access List Name", "optional":true }, "service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"service group name", "optional":true }, "server-keep-alive":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send server keep-alive packet for every persist connection when enable conn-reuse", "optional":true }, "interval":{ "type":"number", "format":"number", "minimum":5, "maximum":300, "default":30, "partition-visibility":"shared", "description":"The interval of keep-alive packet for each persist connection (second)", "optional":true }, "server-request-header":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "server-request-header-erase":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Erase a SIP header (Header Name)" }, "server-request-erase-all":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Erase all headers" }, "server-request-header-insert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Insert a SIP header (Header Content (Format: \"name:value\"))" }, "insert-condition-server-request":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; ", "enum":[ "insert-if-not-exist", "insert-always" ] } } } ] }, "server-response-header":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "server-response-header-erase":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Erase a SIP header (Header Name)" }, "server-response-erase-all":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Erase all headers" }, "server-response-header-insert":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Insert a SIP header (Header Content (Format: \"name:value\"))" }, "insert-condition-server-response":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; ", "enum":[ "insert-if-not-exist", "insert-always" ] } } } ] }, "smp-call-id-rtp-session":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Create the across cpu call-id rtp session", "optional":true }, "server-selection-per-request":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Force server selection on every SIP request", "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":250, "default":30, "partition-visibility":"shared", "description":"Time in minutes", "optional":true }, "dialog-aware":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Permit system processes dialog session", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "smtp-list":{ "type":"array", "minItems":1, "items":{ "type":"smtp" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/smtp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"SMTP Template Name", "optional":false }, "server-domain":{ "type":"string", "format":"host", "minLength":1, "maxLength":254, "default":"mail-server-domain", "partition-visibility":"shared", "description":"Config the domain of the email servers (Server's domain, default is \"mail-server-domain\")", "optional":true }, "service-ready-msg":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"ESMTP mail service ready", "partition-visibility":"shared", "description":"Set SMTP service ready message (SMTP service ready message, default is \"ESMTP mail service ready\")", "optional":true }, "client-starttls-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'optional': STARTTLS is optional requirement; 'enforced': Must issue STARTTLS command before mail transaction; ", "enum":[ "optional", "enforced" ], "optional":true }, "server-starttls-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'optional': STARTTLS is optional requirement; 'enforced': Must issue STARTTLS command before mail transaction; ", "enum":[ "optional", "enforced" ], "optional":true }, "command-disable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "disable-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'expn': Disable SMTP EXPN commands; 'turn': Disable SMTP TURN commands; 'vrfy': Disable SMTP VRFY commands; ", "enum":[ "expn", "turn", "vrfy" ] } } } ] }, "LF-to-CRLF":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Change the LF to CRLF for smtp end of line", "optional":true }, "error-code-to-client":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Would transfer error code(554) to client, when getting it from connection establishing with real-server", "optional":true }, "client-domain-switching":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "switching-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'contains': Specify domain name string if domain contains another string; 'ends-with': Specify domain name string if domain ends with another string; 'starts-with': Specify domain string if domain starts with another string; ", "enum":[ "contains", "ends-with", "starts-with" ] }, "match-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Domain name string" }, "service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Select service group (Service group name)" } } } ] }, "template":{ "type":"object", "properties":{ "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/logging", "description":"Logging template (Logging Config name)" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "tcp-list":{ "type":"array", "minItems":1, "items":{ "type":"tcp" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/tcp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"default", "partition-visibility":"shared", "description":"Fast TCP Template Name", "optional":false }, "logging":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'init': init only log; 'term': termination only log; 'both': both initial and termination log; ", "enum":[ "init", "term", "both" ], "optional":true }, "idle-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":2097151, "default":120, "partition-visibility":"shared", "description":"Idle Timeout value (Interval of 60 seconds), default 120 seconds (idle timeout in second, default 120)", "optional":true }, "half-open-idle-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "partition-visibility":"shared", "description":"TCP Half Open Idle Timeout (sec), default off (half open idle timeout in second, default off)", "optional":true }, "half-close-idle-timeout":{ "type":"number", "format":"number", "minimum":60, "maximum":120, "partition-visibility":"shared", "description":"TCP Half Close Idle Timeout (sec), default off (half close idle timeout in second, default off)", "optional":true }, "initial-window-size":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Set the initial window size (number)", "optional":true }, "force-delete-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "not":"force-delete-timeout-100ms", "description":"The maximum time that a session can stay in the system before being delete (number (second))", "optional":true }, "force-delete-timeout-100ms":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "not":"force-delete-timeout", "description":"The maximum time that a session can stay in the system before being delete (number in 100ms)", "optional":true }, "alive-if-active":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"keep connection alive if active traffic", "optional":true }, "qos":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "partition-visibility":"shared", "description":"QOS level (number)", "optional":true }, "insert-client-ip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Insert client ip into TCP option", "optional":true }, "lan-fast-ack":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable fast TCP ack on LAN", "optional":true }, "reset-fwd":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"send reset to server if error happens", "optional":true }, "reset-rev":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"send reset to client if error happens", "optional":true }, "reset-follow-fin":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"send reset to client or server upon receiving first fin", "optional":true }, "disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"down", "description":"send reset to client when server is disabled", "optional":true }, "down":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"disable", "description":"send reset to client when server is down", "optional":true }, "re-select-if-server-down":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"re-select another server if service port is down", "optional":true }, "del-session-on-server-down":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete session if the server/port goes down (either disabled/hm down)", "optional":true }, "proxy-header":{ "type":"object", "properties":{ "proxy-header-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'insert': Insert proxy header; ", "enum":[ "insert" ] }, "proxy-header-version":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'v1': version 1; 'v2': version 2; ", "enum":[ "v1", "v2" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "tcp-proxy-list":{ "type":"array", "minItems":1, "items":{ "type":"tcp-proxy" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/tcp-proxy/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"default", "partition-visibility":"shared", "description":"TCP Proxy Template Name", "optional":false }, "ack-aggressiveness":{ "type":"string", "format":"enum", "default":"low", "partition-visibility":"shared", "description":"'low': Delayed ACK; 'medium': Delayed ACK, with ACK on each packet with PUSH flag; 'high': ACK on each packet; ", "enum":[ "low", "medium", "high" ], "optional":true }, "backend-wscale":{ "type":"number", "format":"number", "minimum":1, "maximum":14, "partition-visibility":"shared", "description":"The TCP window scale used for the server side, default is off (number)", "optional":true }, "dynamic-buffer-allocation":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Optimally adjust the transmit and receive buffer sizes of TCP proxy while keeping their sum constant", "optional":true }, "fin-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "partition-visibility":"shared", "description":"FIN timeout (sec), default is disabled (number)", "optional":true }, "force-delete-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "not":"force-delete-timeout-100ms", "description":"The maximum time that a session can stay in the system before being deleted, default is off (number (second))", "optional":true }, "force-delete-timeout-100ms":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "not":"force-delete-timeout", "description":"The maximum time that a session can stay in the system before being deleted, default is off (number in 100ms)", "optional":true }, "alive-if-active":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"keep connection alive if active traffic", "optional":true }, "idle-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":2097151, "default":600, "partition-visibility":"shared", "description":"Idle Timeout (Interval of 60 seconds), default is 600 (idle timeout in second, default 600)", "optional":true }, "server-down-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'FIN': FIN Connection; 'RST': Reset Connection; ", "enum":[ "FIN", "RST" ], "optional":true }, "half-open-idle-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "partition-visibility":"shared", "description":"TCP Half Open Idle Timeout (sec), default is off (number)", "optional":true }, "half-close-idle-timeout":{ "type":"number", "format":"number", "minimum":60, "maximum":120, "partition-visibility":"shared", "description":"TCP Half Close Idle Timeout (sec), default is off (cmd is deprecated, use fin-timeout instead) (number)", "optional":true }, "init-cwnd":{ "type":"number", "format":"number", "minimum":1, "maximum":15, "default":10, "partition-visibility":"shared", "description":"The initial congestion control window size (packets), default is 10 (init-cwnd in packets, default 10)", "optional":true }, "initial-window-size":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Set the initial window size, default is off (number)", "optional":true }, "keepalive-interval":{ "type":"number", "format":"number", "minimum":60, "maximum":12000, "partition-visibility":"shared", "description":"Interval between keepalive probes (sec), default is off (number (seconds))", "optional":true }, "keepalive-probes":{ "type":"number", "format":"number", "minimum":2, "maximum":10, "partition-visibility":"shared", "description":"Number of keepalive probes sent, default is off", "optional":true }, "mss":{ "type":"number", "format":"number", "minimum":128, "maximum":9000, "default":1460, "partition-visibility":"shared", "description":"Responding MSS to use if client MSS is large, default is off (number)", "optional":true }, "psh-flag-optimization":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable Optimized PSH Flag Use", "optional":true }, "nagle":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable Nagle Algorithm", "optional":true }, "naked-ack-on-handshake":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send naked ack before data during 3-way handshake", "optional":true }, "qos":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "partition-visibility":"shared", "description":"QOS level (number)", "optional":true }, "receive-buffer":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "default":200000, "partition-visibility":"shared", "description":"TCP Receive Buffer (default 200k) (number default 200000 bytes)", "optional":true }, "reno":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable Reno Congestion Control Algorithm", "optional":true }, "transmit-buffer":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "default":200000, "partition-visibility":"shared", "description":"TCP Transmit Buffer (default 200k) (number default 200000 bytes)", "optional":true }, "reset-fwd":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"send reset to server if error happens", "optional":true }, "reset-rev":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"send reset to client if error happens", "optional":true }, "disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"down", "description":"send reset to client when server is disabled", "optional":true }, "down":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"disable", "description":"send reset to client when server is down", "optional":true }, "del-session-on-server-down":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete session if the server/port goes down (either disabled/hm down)", "optional":true }, "retransmit-retries":{ "type":"number", "format":"number", "minimum":1, "maximum":20, "default":5, "partition-visibility":"shared", "description":"Number of Retries for Retransmit, default is 5", "optional":true }, "insert-client-ip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Insert client ip into TCP option", "optional":true }, "syn-retries":{ "type":"number", "format":"number", "minimum":1, "maximum":20, "default":5, "partition-visibility":"shared", "description":"SYN Retry Numbers, default is 5", "optional":true }, "timewait":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "default":5, "partition-visibility":"shared", "description":"Timewait Threshold (sec), default 5 (number)", "optional":true }, "disable-tcp-timestamps":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"disable TCP Timestamps Option", "optional":true }, "disable-window-scale":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"disable TCP Window-Scale Option", "optional":true }, "disable-sack":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"disable Selective Ack Option", "optional":true }, "invalid-rate-limit":{ "type":"number", "format":"number", "minimum":0, "maximum":60000000, "default":500, "partition-visibility":"shared", "description":"Invalid Packet Response Rate Limit (ms), default is 500 (number default 500 challenges)", "optional":true }, "disable-abc":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Appropriate Byte Counting RFC 3465 Disabled, default is enabled (Appropriate Byte Counting (ABC) is enabled by default)", "optional":true }, "reassembly-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":300, "default":30, "partition-visibility":"shared", "description":"The reassembly timeout, default is 30sec (number)", "optional":true }, "reassembly-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":500, "default":25, "partition-visibility":"shared", "description":"The reassembly queuing limit, default is 25 segments (number)", "optional":true }, "min-rto":{ "type":"number", "format":"number", "minimum":100, "maximum":1000, "default":200, "partition-visibility":"shared", "description":"The minmum retransmission timeout, default is 200ms (number)", "optional":true }, "limited-slowstart":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "default":0, "partition-visibility":"shared", "description":"RFC 3742 Limited Slow-Start for TCP with Large Congestion Windows (number)", "optional":true }, "early-retransmit":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure the Early-Retransmit Algorithm (RFC 5827) (Early-Retransmit is disabled by default)", "optional":true }, "maxburst":{ "type":"number", "format":"number", "minimum":1, "maximum":100, "default":25, "partition-visibility":"shared", "description":"The max packet count sent per transmission event (number)", "optional":true }, "proxy-header":{ "type":"object", "properties":{ "proxy-header-action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'insert': Insert proxy header; ", "enum":[ "insert" ] }, "version":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'v1': version 1; 'v2': version 2; ", "enum":[ "v1", "v2" ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "udp-list":{ "type":"array", "minItems":1, "items":{ "type":"udp" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/udp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"default", "partition-visibility":"shared", "description":"Fast UDP Template Name", "optional":false }, "idle-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":2097151, "default":120, "partition-visibility":"shared", "description":"Idle Timeout value (Interval of 60 seconds), default 120 seconds (idle timeout in second, default 120)", "optional":true }, "qos":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "partition-visibility":"shared", "description":"QOS level (number)", "optional":true }, "stateless-conn-timeout":{ "type":"number", "format":"number", "minimum":5, "maximum":120, "default":120, "partition-visibility":"shared", "description":"Stateless Current Connection Timeout value (5 - 120 seconds) (idle timeout in second, default 120)", "optional":true }, "immediate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"short", "description":"Immediate Removal after Transaction", "optional":true }, "short":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"immediate", "description":"Short lived session", "optional":true }, "age":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "description":"short age (in sec), default is 31", "optional":true }, "re-select-if-server-down":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"re-select another server if service port is down", "optional":true }, "disable-clear-session":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable immediate clearing of session", "optional":true }, "radius-lb-method-hash-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'ip': IP-Hash; 'ipv6': IPv6-Hash; ", "enum":[ "ip", "ipv6" ], "optional":true }, "avp":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'4': NAS-IP-address; '8': Framed-IP-Address; ", "enum":[ "4", "8" ], "optional":true }, "v6avp":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'168': Framed-IPv6-Address; '97': Framed-IPv6-PrefixFramed-IPv6-Prefix; ", "enum":[ "168", "97" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "virtual-port-list":{ "type":"array", "minItems":1, "items":{ "type":"virtual-port" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/virtual-port/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"default", "partition-visibility":"shared", "description":"Virtual port template name", "optional":false }, "aflow":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use aFlow to eliminate the traffic surge", "optional":true }, "allow-syn-otherflags":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Allow initial SYN packet with other flags", "optional":true }, "conn-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":64000000, "default":64000000, "partition-visibility":"shared", "description":"Connection limit", "optional":true }, "conn-limit-reset":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send client reset when connection over limit", "optional":true }, "conn-limit-no-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not log connection over limit event", "optional":true }, "conn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":1048575, "partition-visibility":"shared", "description":"Connection rate limit", "optional":true }, "rate-interval":{ "type":"string", "format":"enum", "default":"second", "partition-visibility":"shared", "description":"'100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; ", "enum":[ "100ms", "second" ], "optional":true }, "conn-rate-limit-reset":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send client reset when connection rate over limit", "optional":true }, "conn-rate-limit-no-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not log connection over limit event", "optional":true }, "pkt-rate-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'src-ip-port': Source IP and port rate limit; 'src-port': Source port rate limit; ", "enum":[ "src-ip-port", "src-port" ], "optional":true }, "rate":{ "type":"number", "format":"number", "minimum":1, "maximum":1048575, "partition-visibility":"shared", "description":"Source IP and port rate limit (Packet rate limit)", "optional":true }, "pkt-rate-interval":{ "type":"string", "format":"enum", "default":"second", "partition-visibility":"shared", "description":"'100ms': Source IP and port rate limit per 100ms; 'second': Source IP and port rate limit per second (default); ", "enum":[ "100ms", "second" ], "optional":true }, "pkt-rate-limit-reset":{ "type":"number", "format":"number", "minimum":0, "maximum":1048575, "default":0, "partition-visibility":"shared", "description":"send client-side reset (reset after packet limit)", "optional":true }, "log-options":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'no-logging': Do not log over limit event; 'no-repeat-logging': log once for over limit event. Default is log once per minute; ", "enum":[ "no-logging", "no-repeat-logging" ], "optional":true }, "when-rr-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Only do rate limit if CPU RR triggered", "optional":true }, "allow-vip-to-rport-mapping":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Allow mapping of VIP to real port", "optional":true }, "dscp":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "partition-visibility":"shared", "description":"Differentiated Services Code Point (DSCP to Real Server IP Mapping Value)", "optional":true }, "drop-unknown-conn":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Drop conection if receives TCP packet without SYN or RST flag and it does not belong to any existing connections", "optional":true }, "reset-unknown-conn":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send reset back if receives TCP packet without SYN or RST flag and it does not belong to any existing connections", "optional":true }, "reset-l7-on-failover":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send reset to L7 client and server connection upon a failover", "optional":true }, "ignore-tcp-msl":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"reclaim TCP resource immediately without MSL", "optional":true }, "snat-msl":{ "type":"number", "format":"number", "minimum":1, "maximum":1800, "partition-visibility":"shared", "description":"Source NAT MSL (Source NAT MSL value (seconds))", "optional":true }, "snat-port-preserve":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Source NAT Port Preservation", "optional":true }, "non-syn-initiation":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Allow initial TCP packet to be non-SYN", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "virtual-server-list":{ "type":"array", "minItems":1, "items":{ "type":"virtual-server" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/virtual-server/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"default", "partition-visibility":"shared", "description":"Virtual server template name", "optional":false }, "conn-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":64000000, "default":64000000, "partition-visibility":"shared", "description":"Connection limit", "optional":true }, "conn-limit-reset":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send client reset when connection over limit", "optional":true }, "conn-limit-no-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not log connection over limit event", "optional":true }, "conn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":1048575, "partition-visibility":"shared", "description":"Connection rate limit", "optional":true }, "rate-interval":{ "type":"string", "format":"enum", "default":"second", "partition-visibility":"shared", "description":"'100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; ", "enum":[ "100ms", "second" ], "optional":true }, "conn-rate-limit-reset":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send client reset when connection rate over limit", "optional":true }, "conn-rate-limit-no-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not log connection over limit event", "optional":true }, "icmp-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"ICMP rate limit (Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit)", "optional":true }, "icmp-lockup":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period)", "optional":true }, "icmp-lockup-period":{ "type":"number", "format":"number", "minimum":1, "maximum":16383, "partition-visibility":"shared", "description":"Lockup period (second)", "optional":true }, "icmpv6-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"ICMPv6 rate limit (Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit)", "optional":true }, "icmpv6-lockup":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period)", "optional":true }, "icmpv6-lockup-period":{ "type":"number", "format":"number", "minimum":1, "maximum":16383, "partition-visibility":"shared", "description":"Lockup period (second)", "optional":true }, "tcp-stack-tfo-active-conn-limit":{ "type":"number", "format":"number", "minimum":0, "maximum":10000, "default":0, "partition-visibility":"shared", "description":"The allowed active layer 7 tcp fast-open connection limit, default is zero (number)", "optional":true }, "tcp-stack-tfo-cookie-time-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":14400, "default":60, "partition-visibility":"shared", "description":"The time limit (in seconds) that a layer 7 tcp fast-open cookie is valid, default is 60 seconds (number)", "optional":true }, "tcp-stack-tfo-backoff-time":{ "type":"number", "format":"number", "minimum":1, "maximum":14400, "default":600, "partition-visibility":"shared", "description":"The time tcp stack will wait before allowing new fast-open requests after security condition, default 600 seconds (number)", "optional":true }, "subnet-gratuitous-arp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send gratuitous ARP for every IP in the subnet virtual server", "optional":true }, "disable-when-all-ports-down":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"disable-when-any-port-down", "description":"Disable Virtual Server when all member ports are down", "optional":true }, "disable-when-any-port-down":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"disable-when-all-ports-down", "description":"Disable Virtual Server when any member port is down", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "dblb-list":{ "type":"array", "minItems":1, "items":{ "type":"dblb" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/dblb/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"DBLB template name", "optional":false }, "class-list":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify user/password string class list (Class list name)", "optional":true }, "server-version":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'MSSQL2008': MSSQL server 2008 or 2008 R2; 'MSSQL2012': MSSQL server 2012; 'MySQL': MySQL server (any version); ", "enum":[ "MSSQL2008", "MSSQL2012", "MySQL" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "calc-sha1":{ "type":"object", "$ref":"/axapi/v3/slb/template/dblb/{name}/calc-sha1", "properties":{ "sha1-value":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Cleartext password" } } } }, "required":[ "name" ] } ] }, "external-service-list":{ "type":"array", "minItems":1, "items":{ "type":"external-service" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/external-service/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"External Service Template Name", "optional":false }, "bypass-ip-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "bypass-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"ip address to bypass external service" }, "mask":{ "type":"string", "format":"ipv4-netmask", "partition-visibility":"shared", "description":"IP prefix mask" } } } ] }, "request-header-forward-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "request-header-forward":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Request header to be forwarded to external service (Header Name)" } } } ] }, "failure-action":{ "type":"string", "format":"enum", "default":"continue", "partition-visibility":"shared", "description":"'continue': Continue; 'drop': Drop; 'reset': Reset; ", "enum":[ "continue", "drop", "reset" ], "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":200, "default":5, "partition-visibility":"shared", "description":"Timeout value 1 - 200 in units of 200ms, default is 5 (default is 1000ms) (1 - 200 in units of 200ms, default is 5 (1000ms))", "optional":true }, "action":{ "type":"string", "format":"enum", "default":"continue", "partition-visibility":"shared", "description":"'continue': Continue; 'drop': Drop; 'reset': Reset; ", "enum":[ "continue", "drop", "reset" ], "optional":true }, "service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Bind a Service Group to the template (Service Group Name)", "optional":true }, "type":{ "type":"string", "format":"enum", "default":"url-filter", "partition-visibility":"shared", "description":"'skyfire-icap': Skyfire ICAP service; 'url-filter': URL filtering service; ", "enum":[ "skyfire-icap", "url-filter" ], "optional":true }, "tcp-proxy":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not":"shared-partition-tcp-proxy-template", "description":"TCP Proxy Template Name", "optional":true }, "shared-partition-tcp-proxy-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"tcp-proxy", "description":"Reference a TCP Proxy template from shared partition", "optional":true }, "template-tcp-proxy-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/tcp-proxy", "description":"TCP Proxy Template name", "optional":true }, "source-ip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/persist/source-ip", "not":"shared-partition-persist-source-ip-template", "description":"Source IP persistence template (Source IP persistence template name)", "optional":true }, "shared-partition-persist-source-ip-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"source-ip", "description":"Reference a persist source ip template from shared partition", "optional":true }, "template-persist-source-ip-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/persist/source-ip", "description":"Source IP Persistence Template Name", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "doh-list":{ "type":"array", "minItems":1, "items":{ "type":"doh" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/doh/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"DNS over HTTP(s) Template Name", "optional":false }, "non-dns-request":{ "type":"string", "format":"enum", "default":"reject", "partition-visibility":"shared", "description":"'allow': Forward Non-DoH request to http server bound to vport; 'reject': Reject Non-DoH requests with HTTP 400 Bad Request (Default); ", "enum":[ "allow", "reject" ], "optional":true }, "reject-status-code":{ "type":"string", "format":"enum", "default":"400", "partition-visibility":"shared", "description":"'400': Status Code 400 BAD Request (Default); '500': Status Code 500 Internal Server Error; '501': Status Code 501 Not Implemented; ", "enum":[ "400", "500", "501" ], "optional":true }, "source-nat":{ "type":"string", "format":"enum", "default":"auto", "partition-visibility":"shared", "description":"'auto': Perform Source NAT Auto for service-group(Default) (Not supported with forwarding-ip); 'disable': Don't perform source-nat for server side DNS queries; 'pool': Perform Source NAT with specific pool; ", "enum":[ "auto", "disable", "pool" ], "optional":true }, "snat-pool":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/ip/nat/pool", "description":"Source NAT pool or pool group", "optional":true }, "tcp-proxy":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"default", "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/tcp-proxy", "not":"shared-partition-tcp-proxy-template", "description":"TCP Proxy Template Name", "optional":true }, "shared-partition-tcp-proxy-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"tcp-proxy", "description":"Reference a TCP Proxy template from shared partition", "optional":true }, "template-tcp-proxy-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/tcp-proxy", "description":"TCP Proxy Template name", "optional":true }, "dns":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"default", "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/dns", "not":"shared-partition-dns-template", "description":"DNS Template Name", "optional":true }, "shared-partition-dns-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"dns", "description":"Reference a DNS template from shared partition", "optional":true }, "template-dns-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/dns", "description":"DNS Template name", "optional":true }, "conn-reuse":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'enable': Enable Connection Reuse; 'disable': Disable Connection-Reuse (Default); ", "enum":[ "enable", "disable" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "forwarder":{ "type":"object", "$ref":"/axapi/v3/slb/template/doh/{name}/forwarder", "properties":{ "forwarding-ipv4":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not-list":[ "forwarding-ipv6", "tcp-service-group", "udp-service-group", "bypass-doh" ], "description":"SLB VIP IPv4 address to forward DOH query (IP address)" }, "v4-internal":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Try to find this IP as a VIP in this L3v Partition and forward it internally to the VIP" }, "v4-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":53, "partition-visibility":"shared", "description":"Forwarding port number, Default is 53" }, "v4-l4-proto":{ "type":"string", "format":"enum", "default":"both", "partition-visibility":"shared", "description":"'tcp': Use TCP only when forwarding DNS traffic; 'udp': Use UDP only when forwarding DNS traffic; 'both': Use UDP 1st and if unreachable, retry with TCP when forwarding DNS traffic; ", "enum":[ "tcp", "udp", "both" ] }, "forwarding-ipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not-list":[ "forwarding-ipv4", "tcp-service-group", "udp-service-group", "bypass-doh" ], "description":"SLB VIP IPv6 address to forward DOH query (IP address)" }, "v6-internal":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Try to find this IP as a VIP in this L3v Partition and forward it internally to the VIP" }, "v6-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":53, "partition-visibility":"shared", "description":"Forwarding port number, Default is 53" }, "v6-l4-proto":{ "type":"string", "format":"enum", "default":"both", "partition-visibility":"shared", "description":"'tcp': Use TCP only when forwarding DNS traffic; 'udp': Use UDP only when forwarding DNS traffic; 'both': Use UDP 1st and if unreachable, retry with TCP when forwarding DNS traffic; ", "enum":[ "tcp", "udp", "both" ] }, "tcp-service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "not-list":[ "forwarding-ipv4", "forwarding-ipv6", "bypass-doh" ], "description":"Bind a TCP Service Group to the template (Service Group Name)" }, "udp-service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "not-list":[ "forwarding-ipv4", "forwarding-ipv6", "bypass-doh" ], "description":"Bind a UDP Service Group to the template (Service Group Name)" }, "bypass-doh":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "forwarding-ipv4", "forwarding-ipv6", "tcp-service-group", "udp-service-group" ], "description":"Forward valid DoH HTTP request as is, no DNS packet extraction (Bypass DoH)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "dns-retry":{ "type":"object", "$ref":"/axapi/v3/slb/template/doh/{name}/dns-retry", "properties":{ "retry-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":400, "default":10, "partition-visibility":"shared", "description":"DNS Retry Interval value 1 - 400 in units of 100ms, default is 10 (default is 1000ms) (1 - 400 in units of 100ms, default is 10 (1000ms/1sec))" }, "after-timeout":{ "type":"string", "format":"enum", "default":"close", "partition-visibility":"shared", "description":"'close': Close client side connection; 'retry-with-tcp': Retry DNS query to server using TCP (If UDP was tried initially. Close after.); ", "enum":[ "close", "retry-with-tcp" ] }, "max-trials":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "default":3, "partition-visibility":"shared", "description":"Total number of times to try DNS query to server before closing client connection, default 3" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] }, "fix-list":{ "type":"array", "minItems":1, "items":{ "type":"fix" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/fix/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"FIX Template Name", "optional":false }, "logging":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'init': init only log; 'term': termination only log; 'both': both initial and termination log; ", "enum":[ "init", "term", "both" ], "optional":true }, "insert-client-ip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Insert client ip to tag 11447", "optional":true }, "tag-switching":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "switching-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'sender-comp-id': Select service group based on SenderCompID; 'target-comp-id': Select service group based on TargetCompID; ", "enum":[ "sender-comp-id", "target-comp-id" ] }, "equals":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Equals (Tag String)" }, "service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Create a Service Group comprising Servers (Service Group Name)" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "http-policy-list":{ "type":"array", "minItems":1, "items":{ "type":"http-policy" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/http-policy/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"http-policy template name", "optional":false }, "cookie-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"name of cookie to match (Cookie Name)", "optional":true }, "http-policy-match":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'cookie': cookie value match; 'host': hostname match; 'url': URL match; 'header-name': header name match; 'header-value': header value match; 'query-param-name': query parameter name; 'query-param-value': query parameter value; ", "enum":[ "cookie", "host", "url", "header-name", "header-value", "query-param-name", "query-param-value" ] }, "match-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'contains': Select service group if URL string contains another string; 'ends-with': Select service group if URL string ends with another string; 'equals': Select service group if URL string equals another string; 'starts-with': Select service group if URL string starts with another string; ", "enum":[ "contains", "ends-with", "equals", "starts-with" ] }, "match-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"URL String, use \"[no-name]\" for empty query-param-name match, use \"[no-value]\" for empty query-param-value match" }, "service-group":{ "type":"string", "format":"string", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Service Group to be used (Service Group Name)" } } } ] }, "geo-location-match":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "geo-location":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Geolocation name" }, "geo-location-service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Service Group to be used (Service Group Name)" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "multi-match-rule-list":{ "type":"array", "minItems":1, "items":{ "type":"multi-match-rule" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/http-policy/{name}/multi-match-rule/{multi-match}", "array":[ { "properties":{ "multi-match":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":64, "partition-visibility":"shared", "description":"Specify a multi-match-rule name", "optional":false }, "seq-num":{ "type":"number", "format":"number", "minimum":1, "maximum":8192, "partition-visibility":"shared", "description":"Specify a sequence number", "optional":true }, "host-equals-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "host-contains-type", "host-starts-with-type", "host-ends-with-type" ], "description":"'equals': Host equals to string; ", "enum":[ "equals" ], "optional":true }, "host-equals-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Host string", "optional":true }, "host-contains-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "host-equals-type", "host-starts-with-type", "host-ends-with-type" ], "description":"'contains': Host contains string; ", "enum":[ "contains" ], "optional":true }, "host-contains-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Host string", "optional":true }, "host-starts-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "host-equals-type", "host-contains-type", "host-ends-with-type" ], "description":"'starts-with': Host starts-with string; ", "enum":[ "starts-with" ], "optional":true }, "host-starts-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Host string", "optional":true }, "host-ends-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "host-equals-type", "host-contains-type", "host-starts-with-type" ], "description":"'ends-with': Host ends-with string; ", "enum":[ "ends-with" ], "optional":true }, "host-ends-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Host string", "optional":true }, "cookie-name-equals-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "cookie-name-contains-type", "cookie-name-starts-with-type", "cookie-name-ends-with-type" ], "description":"'equals': Cookie name equals to string; ", "enum":[ "equals" ], "optional":true }, "cookie-name-equals-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Cookie name string", "optional":true }, "cookie-name-contains-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "cookie-name-equals-type", "cookie-name-starts-with-type", "cookie-name-ends-with-type" ], "description":"'contains': Cookie name contains string; ", "enum":[ "contains" ], "optional":true }, "cookie-name-contains-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Cookie value string", "optional":true }, "cookie-name-starts-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "cookie-name-equals-type", "cookie-name-contains-type", "cookie-name-ends-with-type" ], "description":"'starts-with': Cookie name starts-with string; ", "enum":[ "starts-with" ], "optional":true }, "cookie-name-starts-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Cookie name string", "optional":true }, "cookie-name-ends-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "cookie-name-equals-type", "cookie-name-contains-type", "cookie-name-starts-with-type" ], "description":"'ends-with': Cookie name ends-with string; ", "enum":[ "ends-with" ], "optional":true }, "cookie-name-ends-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Cookie name string", "optional":true }, "cookie-value-equals-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "cookie-value-contains-type", "cookie-value-starts-with-type", "cookie-value-ends-with-type" ], "description":"'equals': Cookie value equals to string; ", "enum":[ "equals" ], "optional":true }, "cookie-value-equals-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Cookie value string", "optional":true }, "cookie-value-contains-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "cookie-value-equals-type", "cookie-value-starts-with-type", "cookie-value-ends-with-type" ], "description":"'contains': Cookie value contains string; ", "enum":[ "contains" ], "optional":true }, "cookie-value-contains-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Cookie value string", "optional":true }, "cookie-value-starts-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "cookie-value-equals-type", "cookie-value-contains-type", "cookie-value-ends-with-type" ], "description":"'starts-with': Cookie value starts-with string; ", "enum":[ "starts-with" ], "optional":true }, "cookie-value-starts-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Cookie value string", "optional":true }, "cookie-value-ends-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "cookie-value-equals-type", "cookie-value-contains-type", "cookie-value-starts-with-type" ], "description":"'ends-with': Cookie value ends-with string; ", "enum":[ "ends-with" ], "optional":true }, "cookie-value-ends-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Cookie value string", "optional":true }, "url-equals-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "url-contains-type", "url-starts-with-type", "url-ends-with-type" ], "description":"'equals': URL equals to string; ", "enum":[ "equals" ], "optional":true }, "url-equals-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"URL string", "optional":true }, "url-contains-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "url-equals-type", "url-starts-with-type", "url-ends-with-type" ], "description":"'contains': URL contains string; ", "enum":[ "contains" ], "optional":true }, "url-contains-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"URL string", "optional":true }, "url-starts-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "url-equals-type", "url-contains-type", "url-ends-with-type" ], "description":"'starts-with': URL starts-with string; ", "enum":[ "starts-with" ], "optional":true }, "url-starts-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"URL string", "optional":true }, "url-ends-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "url-equals-type", "url-contains-type", "url-starts-with-type" ], "description":"'ends-with': URL ends-with string; ", "enum":[ "ends-with" ], "optional":true }, "url-ends-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"URL string", "optional":true }, "header-name-equals-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "header-name-contains-type", "header-name-starts-with-type", "header-name-ends-with-type" ], "description":"'equals': Header name equals to string; ", "enum":[ "equals" ], "optional":true }, "header-name-equals-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Header name string", "optional":true }, "header-name-contains-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "header-name-equals-type", "header-name-starts-with-type", "header-name-ends-with-type" ], "description":"'contains': Header name contains string; ", "enum":[ "contains" ], "optional":true }, "header-name-contains-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Header name string", "optional":true }, "header-name-starts-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "header-name-equals-type", "header-name-contains-type", "header-name-ends-with-type" ], "description":"'starts-with': Header name starts-with string; ", "enum":[ "starts-with" ], "optional":true }, "header-name-starts-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Header name string", "optional":true }, "header-name-ends-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "header-name-equals-type", "header-name-contains-type", "header-name-starts-with-type" ], "description":"'ends-with': Header name ends-with string; ", "enum":[ "ends-with" ], "optional":true }, "header-name-ends-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Header name string", "optional":true }, "header-value-equals-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "header-value-contains-type", "header-value-starts-with-type", "header-value-ends-with-type" ], "description":"'equals': Header value equals to string; ", "enum":[ "equals" ], "optional":true }, "header-value-equals-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Header value string", "optional":true }, "header-value-contains-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "header-value-equals-type", "header-value-starts-with-type", "header-value-ends-with-type" ], "description":"'contains': Header value contains string; ", "enum":[ "contains" ], "optional":true }, "header-value-contains-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Header value string", "optional":true }, "header-value-starts-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "header-value-equals-type", "header-value-contains-type", "header-value-ends-with-type" ], "description":"'starts-with': Header value starts-with string; ", "enum":[ "starts-with" ], "optional":true }, "header-value-starts-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Header value string", "optional":true }, "header-value-ends-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "header-value-equals-type", "header-value-contains-type", "header-value-starts-with-type" ], "description":"'ends-with': Header value ends-with string; ", "enum":[ "ends-with" ], "optional":true }, "header-value-ends-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Header value string", "optional":true }, "query-param-name-equals-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "query-param-name-contains-type", "query-param-name-starts-with-type", "query-param-name-ends-with-type" ], "description":"'equals': query parameter name equals to string; ", "enum":[ "equals" ], "optional":true }, "query-param-name-equals-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"query parameter name string, use \"[no-name]\" for empty query-param-name match", "optional":true }, "query-param-name-contains-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "query-param-name-equals-type", "query-param-name-starts-with-type", "query-param-name-ends-with-type" ], "description":"'contains': query parameter name contains string; ", "enum":[ "contains" ], "optional":true }, "query-param-name-contains-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"query parameter name string", "optional":true }, "query-param-name-starts-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "query-param-name-equals-type", "query-param-name-contains-type", "query-param-name-ends-with-type" ], "description":"'starts-with': query parameter name starts-with string; ", "enum":[ "starts-with" ], "optional":true }, "query-param-name-starts-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"query parameter name string", "optional":true }, "query-param-name-ends-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "query-param-name-equals-type", "query-param-name-contains-type", "query-param-name-starts-with-type" ], "description":"'ends-with': query parameter name ends-with string; ", "enum":[ "ends-with" ], "optional":true }, "query-param-name-ends-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"query parameter name string", "optional":true }, "query-param-value-equals-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "query-param-value-contains-type", "query-param-value-starts-with-type", "query-param-value-ends-with-type" ], "description":"'equals': query parameter value equals to string; ", "enum":[ "equals" ], "optional":true }, "query-param-value-equals-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"query parameter value string, use \"[no-value]\" for empty query-param-value match", "optional":true }, "query-param-value-contains-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "query-param-value-equals-type", "query-param-value-starts-with-type", "query-param-value-ends-with-type" ], "description":"'contains': query parameter value contains string; ", "enum":[ "contains" ], "optional":true }, "query-param-value-contains-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"query parameter value string", "optional":true }, "query-param-value-starts-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "query-param-value-equals-type", "query-param-value-contains-type", "query-param-value-ends-with-type" ], "description":"'starts-with': query parameter value starts-with string; ", "enum":[ "starts-with" ], "optional":true }, "query-param-value-starts-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"query parameter value string", "optional":true }, "query-param-value-ends-with-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "query-param-value-equals-type", "query-param-value-contains-type", "query-param-value-starts-with-type" ], "description":"'ends-with': query parameter value ends-with string; ", "enum":[ "ends-with" ], "optional":true }, "query-param-value-ends-with-string":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"query parameter value string", "optional":true }, "service-group":{ "type":"string", "format":"string", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Service Group to be used (Service Group Name)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "multi-match" ] } ] } }, "required":[ "name" ] } ] }, "monitor-list":{ "type":"array", "minItems":1, "items":{ "type":"monitor" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/monitor/{id}", "array":[ { "properties":{ "id":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Monitor template ID Number", "optional":false }, "clear-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "sessions":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': Clear all sessions; 'sequence': Sequence number; ", "enum":[ "all", "sequence" ] }, "clear-all-sequence":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Sequence number (Specify the port physical port number)" }, "clear-sequence":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Specify the port physical port number" } } } ] }, "link-disable-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "diseth":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Specify the physical port number (Ethernet interface number)" }, "dis-sequence":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Sequence number (Specify the physical port number)" } } } ] }, "link-enable-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "enaeth":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Specify the physical port number (Ethernet interface number)" }, "ena-sequence":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Sequence number (Specify the physical port number)" } } } ] }, "monitor-relation":{ "type":"string", "format":"enum", "default":"monitor-and", "partition-visibility":"shared", "description":"'monitor-and': Configures the monitors in current template to work with AND logic; 'monitor-or': Configures the monitors in current template to work with OR logic; ", "enum":[ "monitor-and", "monitor-or" ], "optional":true }, "link-up-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "linkup-ethernet1":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Specify the port physical port number (Ethernet interface number)" }, "link-up-sequence1":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Sequence number (Specify the port physical port number)" }, "linkup-ethernet2":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Specify the port physical port number (Ethernet interface number)" }, "link-up-sequence2":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Sequence number (Specify the port physical port number)" }, "linkup-ethernet3":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Specify the port physical port number (Ethernet interface number)" }, "link-up-sequence3":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Sequence number (Specify the port physical port number)" } } } ] }, "link-down-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "linkdown-ethernet1":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Specify the port physical port number (Ethernet interface number)" }, "link-down-sequence1":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Sequence number (Specify the port physical port number)" }, "linkdown-ethernet2":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Specify the port physical port number (Ethernet interface number)" }, "link-down-sequence2":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Sequence number (Specify the port physical port number)" }, "linkdown-ethernet3":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Specify the port physical port number (Ethernet interface number)" }, "link-down-sequence3":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Sequence number (Specify the port physical port number)" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "id" ] } ] }, "link-block-as-down":{ "type":"object", "$ref":"/axapi/v3/slb/template/link-block-as-down", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "link-down-on-restart":{ "type":"object", "$ref":"/axapi/v3/slb/template/link-down-on-restart", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "reqmod-icap-list":{ "type":"array", "minItems":1, "items":{ "type":"reqmod-icap" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/reqmod-icap/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Reqmod ICAP Template Name", "optional":false }, "allowed-http-methods":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"List of allowed HTTP methods. Default is \"Allow All\". (List of HTTP methods allowed (default \"Allow All\"))", "optional":true }, "include-protocol-in-uri":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include protocol and port in HTTP URI", "optional":true }, "fail-close":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"When template sg is down mark vport down", "optional":true }, "bypass-ip-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "bypass-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"ip address to bypass reqmod-icap service" }, "mask":{ "type":"string", "format":"ipv4-netmask", "partition-visibility":"shared", "description":"IP prefix mask" } } } ] }, "failure-action":{ "type":"string", "format":"enum", "default":"continue", "partition-visibility":"shared", "description":"'continue': Continue; 'drop': Drop; 'reset': Reset; ", "enum":[ "continue", "drop", "reset" ], "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":200, "default":5, "partition-visibility":"shared", "description":"Timeout value 1 - 200 in units of 200ms, default is 5 (default is 1000ms) (1 - 200 in units of 200ms, default is 5 (1000ms))", "optional":true }, "action":{ "type":"string", "format":"enum", "default":"continue", "partition-visibility":"shared", "description":"'continue': Continue; 'drop': Drop; 'reset': Reset; ", "enum":[ "continue", "drop", "reset" ], "optional":true }, "min-payload-size":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "default":0, "partition-visibility":"shared", "description":"min-payload-size value 0 - 65535, default is 0", "optional":true }, "preview":{ "type":"number", "format":"number", "minimum":1, "maximum":32768, "default":32768, "partition-visibility":"shared", "description":"Preview value 1 - 32768, default is 32768", "optional":true }, "service-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"URL to send to ICAP server (Service URL Name)", "optional":true }, "service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Bind a Service Group to the template (Service Group Name)", "optional":true }, "tcp-proxy":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/tcp-proxy", "not":"shared-partition-tcp-proxy-template", "description":"TCP Proxy Template Name", "optional":true }, "shared-partition-tcp-proxy-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"tcp-proxy", "description":"Reference a TCP Proxy template from shared partition", "optional":true }, "template-tcp-proxy-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/tcp-proxy", "description":"TCP Proxy Template name", "optional":true }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/logging", "description":"logging template (Logging template name)", "optional":true }, "server-ssl":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/server-ssl", "description":"Server SSL template (Server SSL template name)", "optional":true }, "source-ip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/persist/source-ip", "not":"shared-partition-persist-source-ip-template", "description":"Source IP persistence template (Source IP persistence template name)", "optional":true }, "shared-partition-persist-source-ip-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"source-ip", "description":"Reference a persist source ip template from shared partition", "optional":true }, "template-persist-source-ip-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/persist/source-ip", "description":"Source IP Persistence Template Name", "optional":true }, "disable-http-server-reset":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Don't reset http server", "optional":true }, "x-auth-url":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use URL format for authentication", "optional":true }, "log-only-allowed-method":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Only log allowed HTTP method", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "respmod-icap-list":{ "type":"array", "minItems":1, "items":{ "type":"respmod-icap" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/respmod-icap/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Reqmod ICAP Template Name", "optional":false }, "include-protocol-in-uri":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include protocol and port in HTTP URI", "optional":true }, "fail-close":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"When template sg is down mark vport down", "optional":true }, "bypass-ip-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "bypass-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"ip address to bypass respmod-icap service" }, "mask":{ "type":"string", "format":"ipv4-netmask", "partition-visibility":"shared", "description":"IP prefix mask" } } } ] }, "failure-action":{ "type":"string", "format":"enum", "default":"continue", "partition-visibility":"shared", "description":"'continue': Continue; 'drop': Drop; 'reset': Reset; ", "enum":[ "continue", "drop", "reset" ], "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":200, "default":5, "partition-visibility":"shared", "description":"Timeout value 1 - 200 in units of 200ms, default is 5 (default is 1000ms) (1 - 200 in units of 200ms, default is 5 (1000ms))", "optional":true }, "action":{ "type":"string", "format":"enum", "default":"continue", "partition-visibility":"shared", "description":"'continue': Continue; 'drop': Drop; 'reset': Reset; ", "enum":[ "continue", "drop", "reset" ], "optional":true }, "min-payload-size":{ "type":"number", "format":"number", "minimum":0, "maximum":65535, "default":0, "partition-visibility":"shared", "description":"min-payload-size value 0 - 65535, default is 0", "optional":true }, "preview":{ "type":"number", "format":"number", "minimum":1, "maximum":32768, "default":32768, "partition-visibility":"shared", "description":"Preview value 1 - 32768, default is 32768", "optional":true }, "service-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"URL to send to ICAP server (Service URL Name)", "optional":true }, "service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/service-group", "description":"Bind a Service Group to the template (Service Group Name)", "optional":true }, "tcp-proxy":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/tcp-proxy", "not":"shared-partition-tcp-proxy-template", "description":"TCP Proxy Template Name", "optional":true }, "shared-partition-tcp-proxy-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"tcp-proxy", "description":"Reference a TCP Proxy template from shared partition", "optional":true }, "template-tcp-proxy-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/tcp-proxy", "description":"TCP Proxy Template name", "optional":true }, "logging":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/logging", "description":"logging template (Logging template name)", "optional":true }, "server-ssl":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/server-ssl", "description":"Server SSL template (Server SSL template name)", "optional":true }, "source-ip":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/persist/source-ip", "not":"shared-partition-persist-source-ip-template", "description":"Source IP persistence template (Source IP persistence template name)", "optional":true }, "shared-partition-persist-source-ip-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"source-ip", "description":"Reference a persist source ip template from shared partition", "optional":true }, "template-persist-source-ip-shared":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/template/persist/source-ip", "description":"Source IP Persistence Template Name", "optional":true }, "disable-http-server-reset":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Don't reset http server", "optional":true }, "x-auth-url":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use URL format for authentication", "optional":true }, "log-only-allowed-method":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Only log allowed HTTP method", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "smpp-list":{ "type":"array", "minItems":1, "items":{ "type":"smpp" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/smpp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"SMPP Template Name", "optional":false }, "client-enquire-link":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Respond client ENQUIRE_LINK packet directly instead of forwarding to server", "optional":true }, "server-enquire-link":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send server ENQUIRE_LINK packet for every persist connection when enable conn-reuse", "optional":true }, "server-enquire-link-val":{ "type":"number", "format":"number", "minimum":5, "maximum":300, "default":30, "partition-visibility":"shared", "description":"Set interval of keep-alive packet for each persistent connection (second, default is 30)", "optional":true }, "user":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Configure the user to bind (The name used to bind)", "optional":true }, "password":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Configure the password used to bind", "optional":true }, "server-selection-per-request":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Force server selection on every SMPP request when enable conn-reuse", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "dynamic-service-list":{ "type":"array", "minItems":1, "items":{ "type":"dynamic-service" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/dynamic-service/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Dynamic Service Template Name", "optional":false }, "dns-server":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ipv4-dns-server":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"DNS Server IPv4 Address" }, "ipv6-dns-server":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"DNS Server IPv6 Address" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "class-list-list":{ "type":"array", "minItems":1, "items":{ "type":"class-list" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/dynamic-service/{name}/class-list/{dns-class-list}", "array":[ { "properties":{ "dns-class-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Name of Aho-Corasick class-list", "optional":false }, "priority":{ "type":"number", "format":"number", "minimum":1, "maximum":64, "partition-visibility":"shared", "description":"Priority of the class-list(the larger number, the higher priority)", "optional":true }, "dns-server":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ipv4-dns-server":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"DNS Server IPv4 Address" }, "ipv6-dns-server":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"DNS Server IPv6 Address" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "dns-class-list" ] } ] } }, "required":[ "name" ] } ] }, "ssli-list":{ "type":"array", "minItems":1, "items":{ "type":"ssli" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/ssli/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"SSLi Template Name", "optional":false }, "type":{ "type":"string", "format":"enum", "default":"http", "partition-visibility":"shared", "description":"'http': HTTP service; 'xmpp': XMPP service; 'smtp': SMTP service; 'pop': POP service; 'ldap': LDAP service; 'ftp': FTP service; ", "enum":[ "http", "xmpp", "smtp", "pop", "ldap", "ftp" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "mqtt-list":{ "type":"array", "minItems":1, "items":{ "type":"mqtt" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/mqtt/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"MQTT Template Name", "optional":false }, "clientid-hash-persist":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use Client ID's hash value to select server", "optional":true }, "clientid-hash-offset":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "partition-visibility":"shared", "description":"Skip part of Client ID to calculate hash value (Offset of the Client ID)", "optional":true }, "clientid-hash-first":{ "type":"number", "format":"number", "minimum":4, "maximum":128, "partition-visibility":"shared", "description":"Use the begining part of client ID to calculate hash value (client ID string length to calculate hash value)", "optional":true }, "clientid-hash-last":{ "type":"number", "format":"number", "minimum":4, "maximum":128, "partition-visibility":"shared", "description":"Use the end part of Client ID to calculate hash value (Client ID length to calculate hash value)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "quic-list":{ "type":"array", "minItems":1, "items":{ "type":"quic" }, "uniqueItems":true, "$ref":"/axapi/v3/slb/template/quic/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"QUIC Template Name", "optional":false }, "idle-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":3600, "partition-visibility":"shared", "description":"Idle Timeout (interval of 60 seconds), default 120 seconds (idle timeout in second, default 120)", "optional":true }, "connection-id-length":{ "type":"number", "format":"number", "minimum":1, "maximum":20, "partition-visibility":"shared", "description":"Connection id length in byte, default 8 bytes", "optional":true }, "initial-wnd":{ "type":"number", "format":"number", "minimum":10000, "maximum":100000, "partition-visibility":"shared", "description":"Initial window size in byte, default 10000 (Initial window size, default 10000)", "optional":true }, "receive-buffer":{ "type":"number", "format":"number", "minimum":30000, "maximum":400000, "partition-visibility":"shared", "description":"Receive buffer size in byte, default 200000 (Receive buffer size, default 200000)", "optional":true }, "server-retry":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable server retry", "optional":true }, "burst-len":{ "type":"number", "format":"number", "minimum":16, "maximum":360, "partition-visibility":"shared", "description":"Number of burst packet, default 16", "optional":true }, "key-update-to-client":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Initiate key update on the client-side", "optional":true }, "key-update-to-server":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Initiate key update on the server-side", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] } } }