template

Define a Template

template Specification

Type	Intermediate Resource
Element Name	template
Element URI	/axapi/v3/template
Element Attributes	template_attributes
Schema	template schema

Operations Allowed:

Operation	Method	URI	Payload
Get Object	GET	/axapi/v3/template	template_attributes

template attributes

csv-list

Type: List

Reference Object: /axapi/v3/template/csv/{csv-name}

gtp-filter-list-list

Type: List

Reference Object: /axapi/v3/template/gtp-filter-list/{name}

gtp-list

Type: List

Reference Object: /axapi/v3/template/gtp/{name}

lid-list

Type: List

Reference Object: /axapi/v3/template/lid/{lid-number}

sctp-list

Type: List

Reference Object: /axapi/v3/template/sctp/{name}

lid-list

Specification
Type	list
Block object keys

lid-number

Description Lid Number

Type: number

Range: 1-1023

pps

Description PPS limit per Rule (Number of Packets per second)

Type: number

Range: 1-2147483647

respond-to-user-mac

Description Use the user’s source MAC for the next hop rather than the routing table (default:off)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

src-ip

Description: src-ip is a JSON Block. Please see below for lid-list_src-ip

Type: Object

throughput

Description Throughput limit per Rule (Throughput in bytes per second)

Type: number

Range: 1-2147483647

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

lid-list_src-ip

Specification
Type	object

concurrent-sessions

Description Concurrent Session Limit per Source IP Address (Number of Concurrent Sessions)

Type: number

Range: 1-2147483647

enable-high-perf

Description Enable High Perf

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log

Description Log when Session Limit is exceeded

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

prefix-length

Description Source prefix length

Type: number

Range: 1-128

gtp-list

Specification
Type	list
Block object keys

gtp-filter-list

Description Specify a GTP Filter-List (GTP Filter-List Value)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/template/gtp-filter-list

log

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

Type: Object

mandatory-ie-filtering

Description ‘disable’: Disable Mandatory Information Element Filtering;

Type: string

Supported Values: disable

maximum-message-length

Description Maximum message length for a GTP message

Type: number

Range: 64-1500

Default: 1500

message-type

Type: List

name

Description GTP Template Name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Default: default

protocol-anomaly-filtering

Description ‘disable’: Disable Anomaly Filtering;

Type: string

Supported Values: disable

tunnel-timeout

Description Idle Timeout in seconds (default: 5 mins)

Type: number

Range: 5-34952

Default: 60

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

gtp-list_message-type

Specification
Type	list
Block object keys

drop-value

Description ‘drop’: Drop the Message Type;

Type: string

Supported Values: drop

message-type-v0

Description ‘create-pdp’: Create PDP Context Request/Response; ‘data-record’: Data Record Request/Response; ‘delete-pdp’: Delete PDP Context Request/Response; ‘echo’: Echo Request/Response; ‘error-indication’: Error Indication; ‘failure-report’: Failure Report Request/Response; ‘identification’: Identification Request/Response; ‘node-alive’: Node Alive Request/Response; ‘note-ms-present’: Note MS GPRS present Request/Response; ‘pdu-notification’: PDU Notification Request/Response/Reject Request/Reject Response; ‘redirection’: Redirection Request/Response; ‘send-route’: Send Route Info Request/Response; ‘sgsn-context’: Sgsn Context Request/Response/Acknowledge; ‘gtp-pdu’: T-PDU; ‘update-pdp’: Update PDP Context Request/Response; ‘create-aa-pdp’: Create AA PDP Context Request/Response; ‘delete-aa-pdp’: Delete AA PDP Context Request/Response; ‘version-not-supported’: Version Not Supported;

Type: string

Supported Values: create-pdp, data-record, delete-pdp, echo, error-indication, failure-report, identification, node-alive, note-ms-present, pdu-notification, redirection, send-route, sgsn-context, gtp-pdu, update-pdp, create-aa-pdp, delete-aa-pdp, version-not-supported

message-type-v1

Description ‘create-pdp’: Create PDP Context Request/Response; ‘data-record’: Data Record Request/Response; ‘delete-pdp’: Delete PDP Context Request/Response; ‘echo’: Echo Request/Response; ‘error-indication’: Error Indication; ‘failure-report’: Failure Report Request/Response; ‘fwd-relocation’: Forward Relocation Request/Response/Complete/Complete Acknowledge; ‘fwd-srns-context’: Forward Srns Context/Context Acknowlege; ‘identification’: Identification Request/Response; ‘node-alive’: Node Alive Request/Response; ‘note-ms-present’: Note MS GPRS present Request/Response; ‘pdu-notification’: PDU Notification Request/Response/Reject Request/Reject Response; ‘ran-info’: RAN Info Relay; ‘redirection’: Redirection Request/Response; ‘relocation-cancel’: Relocation Cancel Request/Response; ‘send-route’: Send Route Info Request/Response; ‘sgsn-context’: Sgsn Context Request/Response/Acknowledge; ‘supported-extension’: Supported Extension Headers Notification; ‘gtp-pdu’: G-PDU; ‘update-pdp’: Update PDP Context Request/Response; ‘version-not-supported’: Version Not Supported;

Type: string

Supported Values: create-pdp, data-record, delete-pdp, echo, error-indication, failure-report, fwd-relocation, fwd-srns-context, identification, node-alive, note-ms-present, pdu-notification, ran-info, redirection, relocation-cancel, send-route, sgsn-context, supported-extension, gtp-pdu, update-pdp, version-not-supported

message-type-v2

Description ‘bearer-resource’: Bearer Resource Command/Failure; ‘change-notification’: Change Notification Request/Response; ‘context’: Context Request/Response/Ack; ‘config-transfer’: Configuration Transfer Tunnel; ‘create-bearer’: Create Bearer Request/Response; ‘create-data-forwarding’: Create Indirect Data Tunnel Request/Response; ‘create-tunnel-forwarding’: Create Forwarding Tunnel Request/Response; ‘create-session’: Create Session Request/Response; ‘cs-paging’: CS Paging Indication; ‘delete-bearer’: Delete Bearer Request/Response; ‘delete-command’: Delete Bearer Command/Failure; ‘delete-data-forwarding’: Delete Indirect Data Tunnel Request/Response; ‘delete-pdn’: Delete PDN Connection Request/Response; ‘delete-session’: Delete Session Request/Response; ‘detach’: Detach Notification/Ack; ‘downlink-notification’: Downlink Data Notification/Ack/Failure; ‘echo’: Echo Request/Response; ‘fwd-access’: Forward Access Context Notification/Ack; ‘fwd-relocation’: Forward Relocation Request/Response/Complete; ‘identification’: Identification Request/Response; ‘mbms-session-start’: MBMS Session Start Request/Response; ‘mbms-session-stop’: MBMS Session Stop Request/Response; ‘mbms-session-update’: MBMS Session Update Request/Response; ‘modify-bearer’: Modify Bearer Request/Response; ‘modify-command’: Modify Bearer Command/Failure; ‘release-access’: Release Access Bearer Request/Response; ‘relocation-cancel’: Relocation Cancel Request/Response; ‘resume’: Resume Notification/Ack; ‘stop-paging’: Stop Paging Indication; ‘suspend’: Suspend Notification/Ack; ‘trace-session’: Trace Session Activation/Deactivation; ‘update-bearer’: Update Bearer Request/Response; ‘update-pdn’: Update PDN Connection Request/Response; ‘version-not-supported’: Version Not Supported;

Type: string

Supported Values: bearer-resource, change-notification, context, config-transfer, create-bearer, create-data-forwarding, create-tunnel-forwarding, create-session, cs-paging, delete-bearer, delete-command, delete-data-forwarding, delete-pdn, delete-session, detach, downlink-notification, echo, fwd-access, fwd-relocation, identification, mbms-session-start, mbms-session-stop, mbms-session-update, modify-bearer, modify-command, release-access, relocation-cancel, resume, stop-paging, suspend, trace-session, update-bearer, update-pdn, version-not-supported

gtp-list_log

Specification
Type	object

information-filtering

Description Log Packet Drop due to Information Filtering

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

invalid-teid

Description Log Packet Drop due to Invalid Tunnel Endpoint Identifier

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

mandatory-ie-missing

Description Log Packet Drop due to Missing Mandatory Information Element

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

message-filtering

Description Log Packet Drop due to Message Filtering

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

reserved-ie-present

Description Log Packet Drop due to Presence of Reserved Information Element

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sctp-list

Specification
Type	list
Block object keys

checksum-check

Description ‘enable’: Enable Checksum check;

Type: string

Supported Values: enable

log

Description: log is a JSON Block. Please see below for sctp-list_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 sctp-list_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

sctp-list_log

Specification
Type	object

payload-proto-filtering

Description Log Payload Protocol IDs Filtered

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sctp-list_permit-payload-protocol

Specification
Type	object

permit-config-id

Type: List

permit-config-name

Type: List

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

sctp-list_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

gtp-filter-list-list

Specification
Type	list
Block object keys

name

Description Specify name of the filter list

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

str-list

Type: List

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

gtp-filter-list-list_str-list

Specification
Type	list
Block object keys

apn

Description Specify the APN

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

imsi

Description Set the IMSI number

Type: string

Maximum Length: 15 characters

Maximum Length: 1 characters

Mutual Exclusion: imsi and selection-mode are mutually exclusive

imsi-selection

Description Specify the IMSI number

Type: string

Maximum Length: 15 characters

Maximum Length: 1 characters

selection-mode

Description ‘mobilestation’: MS provided APN, subscription not verified; ‘network’: Network provided APN, subscription not verified; ‘verified’: MS or Network provided APN, subscription verified;

Type: string

Supported Values: mobilestation, network, verified

Mutual Exclusion: selection-mode and imsi are mutually exclusive

csv-list

Specification
Type	list
Block object keys

csv-name

Description Specify name of csv template

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

delim-char

Description enter a delimiter character, default “,”

Type: string

Format: string-rlx

Maximum Length: 1 characters

Maximum Length: 1 characters

Default: ,

Mutual Exclusion: delim-char and delim-num are mutually exclusive

delim-num

Description enter a delimiter number, default 44 (“,”)

Type: number

Range: 0-255

Default: 44

Mutual Exclusion: delim-num and delim-char are mutually exclusive

ipv6-enable

Description Support IPv6 IP ranges

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

multiple-fields

Type: List

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

csv-list_multiple-fields

Specification
Type	list
Block object keys

csv-type

Description ‘ip-from’: Beginning address of IP range or subnet; ‘ip-to-mask’: Ending address of IP range or Mask; ‘continent’: Continent; ‘country’: Country; ‘state’: State or province; ‘city’: City;

Type: string

Supported Values: ip-from, ip-to-mask, continent, country, state, city

field

Description Field index number (Index of Field)

Type: number

Range: 1-64