template sctp¶

Define a SCTP template

sctp Specification¶

Type Collection

Object Key(s) name

Collection Name sctp-list

Collection URI /axapi/v3/template/sctp

Element Name sctp

Element URI /axapi/v3/template/sctp/{name}

Element Attributes sctp_attributes

Schema sctp schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/template/sctp	sctp attributes
Create List	POST	/axapi/v3/template/sctp	sctp attributes
Get Object	GET	/axapi/v3/template/sctp/{name}	sctp attributes
Get List	GET	/axapi/v3/template/sctp	sctp-list
Modify Object	POST	/axapi/v3/template/sctp/{name}	sctp attributes
Replace Object	PUT	/axapi/v3/template/sctp/{name}	sctp attributes
Replace List	PUT	/axapi/v3/template/sctp	sctp-list
Delete Object	DELETE	/axapi/v3/template/sctp/{name}	sctp attributes

sctp-list¶

sctp-list is JSON List of sctp attributes

sctp-list : [

{ sctp attributes },

{ sctp attributes },

…

]

sctp attributes¶

checksum-check

Description ‘enable’: Enable Checksum check;

Type: string

Supported Values: enable

log

Description: log is a JSON Block. Please see below for log

Type: Object

name

Description SCTP Template Name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Default: default

permit-payload-protocol

Description: permit-payload-protocol is a JSON Block. Please see below for permit-payload-protocol

Type: Object

sctp-half-open-idle-timeout

Description Set SCTP half-open timeout (SCTP half-open timeout in seconds (default 4))

Type: number

Range: 2-30

Default: 4

sctp-idle-timeout

Description SCTP idle timeout in minutes (default 5)

Type: number

Range: 1-63

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

log¶

Specification

Type object

payload-proto-filtering

Description Log Payload Protocol IDs Filtered

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

permit-payload-protocol¶

Specification

Type object

permit-config-id

Type: List

permit-config-name

Type: List

permit-payload-protocol_permit-config-id¶

Specification

Type list

Block object keys

protocol-id

Description Specify SCTP permitted payload protocol IDs

Type: number

Range: 1-63

permit-payload-protocol_permit-config-name¶

Specification

Type list

Block object keys

protocol-name

Description ‘iua’: IUA; ‘m2ua’: M2UA; ‘m3ua’: M3UA; ‘sua’: SUA; ‘m2pa’: M2PA; ‘h.323’: H.323;

Type: string

Supported Values: iua, m2ua, m3ua, sua, m2pa, h.323