slb template policy forward-policy source¶
proxy source list
source Specification¶
Parameter Value Type Collection Object Key(s) name Collection Name source-list Collection URI /axapi/v3/slb/template/policy/{name}/forward-policy/source Element Name source Element URI /axapi/v3/slb/template/policy/{name}/forward-policy/source/{name} Element Attributes source_attributes Partition Visibility shared Schema source schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/template/policy/{name}/forward-policy/source | ||
Create List | POST | /axapi/v3/slb/template/policy/{name}/forward-policy/source | ||
Get Object | GET | /axapi/v3/slb/template/policy/{name}/forward-policy/source/{name} | ||
Get List | GET | /axapi/v3/slb/template/policy/{name}/forward-policy/source | ||
Modify Object | POST | /axapi/v3/slb/template/policy/{name}/forward-policy/source/{name} | ||
Replace Object | PUT | /axapi/v3/slb/template/policy/{name}/forward-policy/source/{name} | ||
Replace List | PUT | /axapi/v3/slb/template/policy/{name}/forward-policy/source | ||
Delete Object | DELETE | /axapi/v3/slb/template/policy/{name}/forward-policy/source/{name} |
source-list¶
source-list is JSON List of source attributes
source-list : [
]
source attributes¶
destination
Description: destination is a JSON Block. Please see below for destination
Type: Object
Reference Object: /axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination
match-any
Description Match any source
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: match-any and match-class-list are mutually exclusive
match-authorize-policy
Description Authorize-policy for user and group based policy
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/aam/authorization/policy
match-class-list
Description Class List Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: match-class-list and match-any are mutually exclusive
name
Description source destination match rule name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
priority
Description Priority of the source(higher the number higher the priority, default 0)
Type: number
Range: 1-2000
sampling-enable
Type: Listuser-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
destination¶
Specification Value Type object adv-match-list
Type: List
Reference Object: /axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/adv-match/{priority}
any
Description: any is a JSON Block. Please see below for destination_any
Type: Object
Reference Object: /axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/any
class-list-list
Type: List
Reference Object: /axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/class-list/{dest-class-list}
web-category-list-list
Type: List
Reference Object: /axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/web-category-list/{web-category-list}
web-reputation-scope-list
destination_class-list-list¶
Specification Value Type list Block object keys action
Description Action to be performed
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
dest-class-list
Description Destination Class List Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
dual-stack-action
Description Dual-stack action to be performed
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
priority
Description Priority value of the action(higher the number higher the priority)
Type: number
Range: 1-1024
type
Description ‘host’: Match hostname; ‘url’: Match URL; ‘ip’: Match destination IP address;
Type: string
Supported Values: host, url, ip
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
destination_web-category-list-list¶
Specification Value Type list Block object keys action
Description Action to be performed
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
dual-stack-action
Description Dual-stack action to be performed
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
priority
Description Priority value of the action(higher the number higher the priority)
Type: number
Range: 1-1024
type
Description ‘host’: Match hostname; ‘url’: match URL;
Type: string
Supported Values: host, url
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
web-category-list
Description Destination Web Category List Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/web-category/category-list
destination_any¶
Specification Value Type object action
Description Action to be performed
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: action and dual-stack-action are mutually exclusive
dual-stack-action
Description Dual-stack action to be performed
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: dual-stack-action and action are mutually exclusive
sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
destination_any_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘hits’: Number of requests matching this destination rule;
Type: string
Supported Values: all, hits
destination_adv-match-list¶
Specification Value Type list Block object keys action
Description Forwading action of this rule
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: action and dual-stack-action are mutually exclusive
disable-reqmod-icap
Description Disable REQMOD ICAP template
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable-respmod-icap
Description Disable RESPMOD ICAP template
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dual-stack-action
Description Forwarding action of this rule
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: dual-stack-action and action are mutually exclusive
match-host
Description Match request host (HTTP stage) or SNI/SAN (SSL stage)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
match-http-content-encoding
Description Match the value of HTTP header “Content-Encoding”
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
match-http-content-length-range-begin
Description Match the value of HTTP header “Content-Length” with an inclusive range
Type: number
Range: 0-2147483647
match-http-content-length-range-end
Description End of the “Content-Length” range
Type: number
Range: 0-2147483647
match-http-content-type
Description Match the value of HTTP header “Content-Type”
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
match-http-header
Description Matching the name of all request headers
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
match-http-method-connect
Description Match HTTP request method CONNECT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
match-http-method-delete
Description Match HTTP request method DELETE
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
match-http-method-get
Description Match HTTP request method GET
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
match-http-method-head
Description Match HTTP request method HEAD
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
match-http-method-options
Description Match HTTP request method OPTIONS
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
match-http-method-patch
Description Match HTTP request method PATCH
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
match-http-method-post
Description Match HTTP request method POST
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
match-http-method-put
Description Match HTTP request method PUT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
match-http-method-trace
Description Match HTTP request method TRACE
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
match-http-request-file-extension
Description Match file extension of URL in HTTP request line
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
match-http-url
Description Match URL in HTTP request line
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
match-http-url-regex
Description Match URI in HTTP request line by given regular expression
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
match-http-user-agent
Description Matching the value of HTTP header “User-Agent”
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
match-server-address
Description Match target server IP address
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
match-server-port
Description Match target server port number
Type: number
Range: 1-65535
Mutual Exclusion: match-server-port and match-server-port-range-begin are mutually exclusive
match-server-port-range-begin
Description Math targer server port range inclusively
Type: number
Range: 1-65535
Mutual Exclusion: match-server-port-range-begin and match-server-port are mutually exclusive
match-server-port-range-end
Description End of port range
Type: number
Range: 1-65535
match-time-range
Description Enable rule in this time-range
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/forward-proxy/time-range
match-web-category-list
Description Match web-category list
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/web-category/category-list
match-web-reputation-scope
Description Match web-reputation scope
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/web-category/reputation-scope
notify-page
Description Send notify-page to client
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/forward-proxy/notify-page
priority
Description Rule priority (1000 is highest)
Type: number
Range: 1-1000
sampling-enable
Type: Listuser-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
destination_adv-match-list_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘hits’: Number of requests hit this rule;
Type: string
Supported Values: all, hits
destination_web-reputation-scope-list¶
Specification Value Type list Block object keys action
Description Action to be performed
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
dual-stack-action
Description Dual-stack action to be performed
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
priority
Description Priority value of the action(higher the number higher the priority)
Type: number
Range: 1-1024
type
Description ‘host’: Match hostname; ‘url’: match URL;
Type: string
Supported Values: host, url
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
web-reputation-scope
Description Destination Web Reputation Scope Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/web-category/reputation-scope
sampling-enable¶
Specification Value Type list Block object keys counters1
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;
Type: string
Supported Values: all, hits, destination-match-not-found, no-host-info