slb template external-service

Configure external-service templates. External-service templates are used for steering traffic to external servers for additional processing, based on application. For example, external-service template enable deployment of ACOS for the following solutions:

  • Redirection of Internet Content Adaptation Protocol (ICAP) traffic, such as Skyfire Rocket Optimizer traffic
  • Redirection of traffic to external URL filtering servers

external-service Specification

Type Collection
Object Key(s) name
Collection Name external-service-list
Collection URI /axapi/v3/slb/template/external-service/
Element Name external-service
Element URI /axapi/v3/slb/template/external-service/{name}
Element Attributes external-service_attributes
Schema external-service schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/slb/template/external-service/

external-service Attributes

Create List

POST

/axapi/v3/slb/template/external-service/

external-service Attributes

Get Object

GET

/axapi/v3/slb/template/external-service/{name}

external-service Attributes

Get List

GET

/axapi/v3/slb/template/external-service/

external-service-list

Modify Object

POST

/axapi/v3/slb/template/external-service/{name}

external-service Attributes

Replace Object

PUT

/axapi/v3/slb/template/external-service/{name}

external-service Attributes

Replace List

PUT

/axapi/v3/slb/template/external-service/

external-service-list

Delete Object

DELETE

/axapi/v3/slb/template/external-service/{name}

external-service Attributes

external-service-list

external-service-list is JSON List of external-service Attributes

external-service-list : [

external-service Attributes

action

Description: If the server does not reply before the timeout expires, ACOS takes the configured action, which can be one of the following:

  • Continue – Allows the client’s request to go to the content server.
  • Drop – ACOS silently drops the connection and does not send a reset to the client.
  • Reset – ACOS sends a connection reset to the client.

Type: string

Supported Values: continue, drop, reset

Default: continue

bypass-ip-cfg

Description: bypass-ip-cfg is a JSON List . Please see below for bypass-ip-cfg

Type: List

failure-action

Description: Specifies the action performed by ACOS when any of the following types of events occur:

  • ACOS fails to select an external-service server.
  • Failure occurs during creation of a new connection to the external-service server.
  • The response from the external-service server does not contain HTTP status code 200 or 403.
  • Exhaustion of memory when creating a request to the external-service server.

The Failure Action can be one of the following:

  • Continue – Allows the client’s request to go to the content server
  • ** Drop –* Silently drops the connection and does not send a reset to the client.
  • ** Reset –* Sends a connection reset to the client.

Note: If a TCP error occurs while ACOS is waiting for a response, ACOS resets the connection. For example, this occurs in the case of a connection reset by a URL filtering server.

Type: string

Supported Values: continue, drop, reset

Default: continue

name

Description: Name of the template.

Type: string

Format: string-rlx

Required: Yes

service-group

Description: Name of a service group. Binds the service group that contains the external service servers to this template.

  • Select the service group that contains the external-service server (for example, Skyfire server or URL-filtering servers). Do not select the service group containing the content service group containing the content servers (HTTP servers).
  • If configuring for Skyfire, specify the group of Skyfire servers.

Type: string

Format: string-rlx

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

source-ip

Description: Specify a source-IP persistence.

Type: string

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

tcp-proxy

Description: Applies a custom TCP-proxy template to use for managing the TCP connections with the servers.

Type: string

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

timeout

Description: Sets the maximum number of seconds ACOS waits for a response from the server.

Type: number

Range: 1-200

Default: 5

type

Description: Specifies the traffic type to redirect:
  • URL Filter – Steers HTTP requests from clients to external URL-filtering servers.
  • Skyfire ICAP – Steers Internet Content Adaptation Protocol (ICAP) to external SKYfire controllers.

Type: string

Supported Values: skyfire-icap, url-filter

Default: url-filter

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

bypass-ip-cfg

Specification
Type list
Block object keys

bypass-ip

Description: ip address to bypass external service

Type: string

Format: ipv4-address

mask

Description: IP prefix mask

Type: string

Format: ipv4-netmask