slb template sip

Configure separate load balancing of Session Initiation Protocol (SIP) registration traffic and non-registration traffic for SIP clients. You can bind only one SIP template to a virtual port. However, you can bind the same SIP template to multiple ports.

sip Specification

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

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/slb/template/sip/

sip Attributes

Create List

POST

/axapi/v3/slb/template/sip/

sip Attributes

Get Object

GET

/axapi/v3/slb/template/sip/{name}

sip Attributes

Get List

GET

/axapi/v3/slb/template/sip/

sip-list

Modify Object

POST

/axapi/v3/slb/template/sip/{name}

sip Attributes

Replace Object

PUT

/axapi/v3/slb/template/sip/{name}

sip Attributes

Replace List

PUT

/axapi/v3/slb/template/sip/

sip-list

Delete Object

DELETE

/axapi/v3/slb/template/sip/{name}

sip Attributes

sip-list

sip-list is JSON List of sip Attributes

sip-list : [

sip Attributes

acl-id

Description: Specifies an ACL ID.

Type: number

Range: 100-199

Mutual Exclusion: acl-id and acl-name-value are mutually exclusive

Reference Object: /axapi/v3/access-list/standard

acl-name-value

Description: Specifies IPv4 access list name.

Type: string

Mutual Exclusion: acl-name-value and acl-id are mutually exclusive

Reference Object: /axapi/v3/ip/access-list

alg-dest-nat

Description: Translates the VIP address into the real server IP address in SIP messages, when destination NAT is used.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

alg-source-nat

Description: Translates source IP address in to the NAT IP address in SIP messages, when source NAT is used.

The status of ALG support does not affect address translation at the IP layer. Address translation at the IP layer is still performed, if applicable, even if ALG support is disabled.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

call-id-persist-disable

Description: Disables call-ID persistence which sends all SIP requests with a given call ID to the same server.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

client-keep-alive

Description: Enables the ACOS device to respond to SIP pings from clients on behalf of SIP servers. When this option is enabled, the ACOS device responds to a SIP ping from a client with a “pong”.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

client-request-header

Description: client-request-header is a JSON List . Please see below for client-request-header

Type: List

client-response-header

Description: client-response-header is a JSON List . Please see below for client-response-header

Type: List

dialog-aware

Description: Permit system processes dialog session

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

drop-when-client-fail

Description: Drops the traffic.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: drop-when-client-fail and failed-client-selection-message are mutually exclusive

drop-when-server-fail

Description: Drops the traffic.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: drop-when-server-fail and failed-server-selection-message are mutually exclusive

exclude-translation

Description: exclude-translation is a JSON List . Please see below for exclude-translation

Type: List

failed-client-selection

Description: Specifies the response when selection of a SIP client fails. This option is applicable only if the configuration includes a connection-reuse template.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

failed-client-selection-message

Description: Message string to send to the server; for example: “480 Temporarily Unavailable”. If the message string contains a blank, use double quotation marks around the string.

Type: string

Format: string-rlx

Mutual Exclusion: failed-client-selection-message and drop-when-client-fail are mutually exclusive

failed-server-selection

Description: Specifies the response when selection of a SIP server fails.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

failed-server-selection-message

Description: Message string to send to the client; for example: “504 Server Time-out”. If the message string contains a blank, use double quotation marks around the string.

Type: string

Format: string-rlx

Mutual Exclusion: failed-server-selection-message and drop-when-server-fail are mutually exclusive

insert-client-ip

Description: Inserts an “X-Forwarded-For: IP-address:port” header into SIP packets from the client to the SIP server. The header contains the client IP address and source protocol port number. The ACOS device uses the header to identify the client when forwarding a server reply.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

interval

Description: Specify in seconds how often the ACOS device sends a SIP ping on each reusable connection with the SIP server. The ACOS device silently drops the server’s pong reply.

Type: number

Range: 5-300

Default: 30

keep-server-ip-if-match-acl

Description: This option uses the real server’s IP for addresses that match the ACL for a call ID.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

name

Description: Name of template.

Type: string

Format: string-rlx

Required: Yes

server-keep-alive

Description: For configurations that use a connection-reuse template, this option specifies how often the ACOS device sends a SIP ping on each persistent connection. The ACOS device silently drops the server’s reply. If the server does not reply to a SIP ping within the connection-reuse timeout, the ACOS device closes the persistent connection. You can specify 5-300 seconds.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-request-header

Description: server-request-header is a JSON List . Please see below for server-request-header

Type: List

server-response-header

Description: server-response-header is a JSON List . Please see below for server-response-header

Type: List

server-selection-per-request

Description: Reperforms load balancing for every SIP request.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

service-group

Description: Specifies name of service group.

Type: string

Format: string-rlx

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

smp-call-id-rtp-session

Description: Create the across cpu call-id rtp session

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

timeout

Description: Specifies number of minutes a call can remain idle before the device terminates it.

Type: number

Range: 1-250

Default: 30

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

server-request-header

Specification
Type list
Block object keys

insert-condition-server-request

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;

Type: string

Supported Values: insert-if-not-exist, insert-always

server-request-erase-all

Description: Erase all headers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-request-header-erase

Description: Erase a SIP header (Header Name)

Type: string

Format: string-rlx

server-request-header-insert

Description: Insert a SIP header (Header Content (Format: “name: value”))

Type: string

Format: string-rlx

server-response-header

Specification
Type list
Block object keys

insert-condition-server-response

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;

Type: string

Supported Values: insert-if-not-exist, insert-always

server-response-erase-all

Description: Erase all headers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-response-header-erase

Description: Erase a SIP header (Header Name)

Type: string

Format: string-rlx

server-response-header-insert

Description: Insert a SIP header (Header Content (Format: “name: value”))

Type: string

Format: string-rlx

client-request-header

Specification
Type list
Block object keys

client-request-erase-all

Description: Erase all headers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

client-request-header-erase

Description: Erase a SIP header (Header Name)

Type: string

Format: string-rlx

client-request-header-insert

Description: Insert a SIP header (Header Content (Format: “name: value”))

Type: string

Format: string-rlx

insert-condition-client-request

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;

Type: string

Supported Values: insert-if-not-exist, insert-always

client-response-header

Specification
Type list
Block object keys

client-response-erase-all

Description: Erase all headers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

client-response-header-erase

Description: Erase a SIP header (Header Name)

Type: string

Format: string-rlx

client-response-header-insert

Description: Insert a SIP header (Header Content (Format: “name: value”))

Type: string

Format: string-rlx

insert-condition-client-response

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;

Type: string

Supported Values: insert-if-not-exist, insert-always

exclude-translation

Specification
Type list
Block object keys

header-string

Description: SIP header name

Type: string

Format: string-rlx

translation-value

Description: ‘start-line’: SIP request line or status line; ‘header’: SIP message headers; ‘body’: SIP message body;

Type: string

Supported Values: start-line, header, body