slb template reqmod-icap

REQMOD ICAP template

reqmod-icap Specification

Parameter Value
Type Collection
Object Key(s) name
Collection Name reqmod-icap-list
Collection URI /axapi/v3/slb/template/reqmod-icap
Element Name reqmod-icap
Element URI /axapi/v3/slb/template/reqmod-icap/{name}
Element Attributes reqmod-icap_attributes
Partition Visibility shared
Schema reqmod-icap schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/slb/template/reqmod-icap

reqmod-icap attributes

Create List

POST

/axapi/v3/slb/template/reqmod-icap

reqmod-icap attributes

Get Object

GET

/axapi/v3/slb/template/reqmod-icap/{name}

reqmod-icap attributes

Get List

GET

/axapi/v3/slb/template/reqmod-icap

reqmod-icap-list

Modify Object

POST

/axapi/v3/slb/template/reqmod-icap/{name}

reqmod-icap attributes

Replace Object

PUT

/axapi/v3/slb/template/reqmod-icap/{name}

reqmod-icap attributes

Replace List

PUT

/axapi/v3/slb/template/reqmod-icap

reqmod-icap-list

Delete Object

DELETE

/axapi/v3/slb/template/reqmod-icap/{name}

reqmod-icap attributes

reqmod-icap-list

reqmod-icap-list is JSON List of reqmod-icap attributes

reqmod-icap-list : [

reqmod-icap attributes

action

Description ‘continue’: Continue; ‘drop’: Drop; ‘reset’: Reset;

Type: string

Supported Values: continue, drop, reset

Default: continue

allowed-http-methods

Description List of allowed HTTP methods. Default is “Allow All”. (List of HTTP methods allowed (default “Allow All”))

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

bypass-ip-cfg

Type: List

disable-http-server-reset

Description Don’t reset http server

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-close

Description When template sg is down mark vport down

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

failure-action

Description ‘continue’: Continue; ‘drop’: Drop; ‘reset’: Reset;

Type: string

Supported Values: continue, drop, reset

Default: continue

include-protocol-in-uri

Description Include protocol and port in HTTP URI

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log-only-allowed-method

Description Only log allowed HTTP method

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

logging

Description logging template (Logging template name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/template/logging

min-payload-size

Description min-payload-size value 0 - 65535, default is 0

Type: number

Range: 0-65535

Default: 0

name

Description Reqmod ICAP Template Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

preview

Description Preview value 1 - 32768, default is 32768

Type: number

Range: 1-32768

Default: 32768

server-ssl

Description Server SSL template (Server SSL template name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/template/server-ssl

service-group

Description Bind a Service Group to the template (Service Group Name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/service-group

service-url

Description URL to send to ICAP server (Service URL Name)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

shared-partition-persist-source-ip-template

Description Reference a persist source ip template from shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared-partition-persist-source-ip-template and source-ip are mutually exclusive

shared-partition-tcp-proxy-template

Description Reference a TCP Proxy template from shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared-partition-tcp-proxy-template and tcp-proxy are mutually exclusive

source-ip

Description Source IP persistence template (Source IP persistence template name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Mutual Exclusion: source-ip and shared-partition-persist-source-ip-template are mutually exclusive

Reference Object: /axapi/v3/slb/template/persist/source-ip

tcp-proxy

Description TCP Proxy Template Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Mutual Exclusion: tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive

Reference Object: /axapi/v3/slb/template/tcp-proxy

template-persist-source-ip-shared

Description Source IP Persistence Template Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/template/persist/source-ip

template-tcp-proxy-shared

Description TCP Proxy Template name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/template/tcp-proxy

timeout

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))

Type: number

Range: 1-200

Default: 5

user-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

x-auth-url

Description Use URL format for authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

bypass-ip-cfg

Specification Value
Type list
Block object keys  

bypass-ip

Description ip address to bypass reqmod-icap service

Type: string

Format: ipv4-address

mask

Description IP prefix mask

Type: string

Format: ipv4-netmask