template

Define a Template

template Specification

Parameter Value
Type Intermediate Resource
Element Name template
Element URI /axapi/v3/template
Element Attributes template_attributes
Partition Visibility shared
Schema template schema

Operations Allowed:

OperationMethodURIPayload

Get Object

GET

/axapi/v3/template

template_attributes

template attributes

apps

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

Type: Object

Reference Object: /axapi/v3/template/apps

csv-list

Type: List

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

gtp

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

Type: Object

Reference Object: /axapi/v3/template/gtp

gtp-policy-list

Type: List

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

ip-threat-action-list

lid-list

Type: List

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

limit-policy-list

sctp-list

Type: List

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

syslog-over-tls

Description: syslog-over-tls is a JSON Block. Please see below for syslog-over-tls

Type: Object

Reference Object: /axapi/v3/template/syslog-over-tls

gtp-policy-list

Specification Value
Type list
Block object keys  

filtering-policy-name

Description Specify GTP Filtering Policy

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/template/gtp/filtering-policy

general-policy-name

Description Specify GTP General Policy

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/template/gtp/general-policy

logging-policy-name

Description Specify GTP Logging Policy

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/template/gtp/logging-policy

name

Description Configure the GTP Policy Name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

packet-capture-template

Description Name of the packet capture template to be bind with this object

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/visibility/packet-capture/object-templates/templ-gtp-plcy-tmpl

rate-limit-policy-name

Description Specify Rate Limit Policy

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/template/gtp/rate-limit-policy

sampling-enable

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

validation-policy-name

Description Specify GTP Validation Policy

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/template/gtp/validation-policy

gtp-policy-list_sampling-enable

Specification Value
Type list
Block object keys  

counters1

Description ‘all’: all; ‘gtp-v0-c-tunnel-created’: GTPv0-C Tunnel Created; ‘gtp-v0-c-tunnel-half-open’: GTPv0-C Half open tunnel created; ‘gtp-v0-c-tunnel-half-closed’: GTPv0-C Tunnel Delete Request; ‘gtp-v0-c-tunnel-closed’: GTPv0-C Tunnel Marked Deleted; ‘gtp-v0-c-tunnel-deleted’: GTPv0-C Tunnel Deleted; ‘gtp-v0-c-half-open-tunnel-closed’: GTPv0-C Half open tunnel closed; ‘gtp-v1-c-tunnel-created’: GTPv1-C Tunnel Created; ‘gtp-v1-c-tunnel-half-open’: GTPv1-C Half open tunnel created; ‘gtp-v1-c-tunnel-half-closed’: GTPv1-C Tunnel Delete Request; ‘gtp-v1-c-tunnel-closed’: GTPv1-C Tunnel Marked Deleted; ‘gtp-v1-c-tunnel-deleted’: GTPv1-C Tunnel Deleted; ‘gtp-v1-c-half-open-tunnel-closed’: GTPv1-C Half open tunnel closed; ‘gtp-v2-c-tunnel-created’: GTPv2-C Tunnel Created; ‘gtp-v2-c-tunnel-half-open’: GTPv2-C Half open tunnel created; ‘gtp-v2-c-tunnel-half-closed’: GTPv2-C Tunnel Delete Request; ‘gtp-v2-c-tunnel-closed’: GTPv2-C Tunnel Marked Deleted; ‘gtp-v2-c-tunnel-deleted’: GTPv2-C Tunnel Deleted; ‘gtp-v2-c-half-open-tunnel-closed’: GTPv2-C Half open tunnel closed; ‘gtp-u-tunnel-created’: GTP-U Tunnel Created; ‘gtp-u-tunnel-deleted’: GTP-U Tunnel Deleted; ‘gtp-v0-c-update-pdp-resp-unsuccess’: GTPv0-C Update PDP Context Response Unsuccessful; ‘gtp-v1-c-update-pdp-resp-unsuccess’: GTPv1-C Update PDP Context Response Unsuccessful; ‘gtp-v2-c-mod_bearer-resp-unsuccess’: GTPv2-C Modify Bearer Response Unsuccessful; ‘gtp-v0-c-create-pdp-resp-unsuccess’: GTPv0-C Create PDP Context Response Unsuccessful; ‘gtp-v1-c-create-pdp-resp-unsuccess’: GTPv1-C Create PDP Context Response Unsuccessful; ‘gtp-v2-c-create-sess-resp-unsuccess’: GTPv2-C Create Session Response Unsuccessful; ‘gtp-v2-c-piggyback-message’: GTPv2-C Piggyback Message; ‘gtp-path-management-message’: GTP Path Management Messages Received; ‘gtp-v0-c-tunnel-deleted-restart’: GTPv0-C Tunnel Deleted with Restart/failure; ‘gtp-v1-c-tunnel-deleted-restart’: GTPv1-C Tunnel Deleted with Restart/failure; ‘gtp-v2-c-tunnel-deleted-restart’: GTPv2-C Tunnel Deleted with Restart/failure; ‘gtp-v0-c-reserved-message-allow’: Permit GTPv0-C Reserved Messages; ‘gtp-v1-c-reserved-message-allow’: Permit GTPv1-C Reserved Messages; ‘gtp-v2-c-reserved-message-allow’: Permit GTPv2-C Reserved Messages; ‘gtp-v2-c-load-contr-info-exceed’: GTPv2-C Load Control Info IEs in message exceeded 2; ‘gtp-v1-c-pdu-notification-request-forward’: GTPv1-C PDU Notification Request Forward; ‘gtp-v1-c-pdu-notification-reject-request-forward’: GTPv1-C PDU Notification Reject Request Forward; ‘gtp-v0-c-pdu-notification-request-forward’: GTPv0-C PDU Notification Request Forward; ‘gtp-v0-c-pdu-notification-reject-request-forward’: GTPv0-C PDU Notification Reject Request Forward; ‘gtp-v0-c-message-skipped-apn-filtering-no-imsi’: GTPv0-C APN/IMSI Filtering Skipped (No IMSI); ‘gtp-v1-c-message-skipped-apn-filtering-no-imsi’: GTPv1-C APN/IMSI Filtering Skipped (No IMSI); ‘gtp-v2-c-message-skipped-apn-filtering-no-imsi’: GTPv2-C APN/IMSI Filtering Skipped (No IMSI); ‘gtp-v0-c-message-skipped-msisdn-filtering-no-imsi’: GTPv0-C MSISDN Filtering Skipped (No MSISDN); ‘gtp-v1-c-message-skipped-msisdn-filtering-no-imsi’: GTPv1-C MSISDN Filtering Skipped (No MSISDN); ‘gtp-v2-c-message-skipped-msisdn-filtering-no-imsi’: GTPv2-C MSISDN Filtering Skipped (No MSISDN); ‘gtp-v0-c-packet-dummy-msisdn’: GTPv0-C Packet With Dummy MSISDN Forwarded; ‘gtp-v1-c-packet-dummy-msisdn’: GTPv1-C Packet With Dummy MSISDN Forwarded; ‘gtp-v2-c-packet-dummy-msisdn’: GTPv2-C Packet With Dummy MSISDN Forwarded; ‘drop-vld-sanity-gtp-v2-c-message-with-teid-zero-expected’: Validation Drop: GTPv2-C Create Session Request with TEID; ‘drop-vld-sanity-gtp-v1-c-message-with-teid-zero-expected’: Validation Drop: GTPv1-C PDU Notification Request with TEID; ‘drop-vld-sanity-gtp-v0-c-message-with-teid-zero-expected’: Validation Drop: GTPv0-C PDU Notification Request with TEID; ‘drop-vld-gtp-ie-repeat-count-exceed’: Validation Drop: GTP repeated IE count exceeded; ‘drop-vld-reserved-field-set’: Validation Drop: Reserved Header Field Set; ‘drop-vld-tunnel-id-flag’: Validation Drop: Tunnel Header Flag Not Set; ‘drop-vld-invalid-flow-label-v0’: Validation Drop: Invalid Flow Label in GTPv0-C Header; ‘drop-vld-invalid-teid’: Validation Drop: Invalid TEID Value; ‘drop-vld-out-of-state’: Validation Drop: Out Of State GTP Message; ‘drop-vld-mandatory-information-element’: Validation Drop: Mandatory IE Not Present; ‘drop-vld-mandatory-ie-in-grouped-ie’: Validation Drop: Mandatory IE in Grouped IE Not Present; ‘drop-vld-out-of-order-ie’: Validation Drop: GTPv1-C Message Out of Order IE; ‘drop-vld-out-of-state-ie’: Validation Drop: Unexpected IE Present in Message; ‘drop-vld-reserved-information-element’: Validation Drop: Reserved IE Field Present; ‘drop-vld-version-not-supported’: Validation Drop: Invalid GTP version; ‘drop-vld-message-length’: Validation Drop: Message Length Exceeded; ‘drop-vld-cross-layer-correlation’: Validation Drop: Cross Layer IP Address Mismatch; ‘drop-vld-country-code-mismatch’: Validation Drop: Country Code Mismatch in IMSI and MSISDN; ‘drop-vld-gtp-u-spoofed-source-address’: Validation Drop: GTP-U IP Address Spoofed; ‘drop-vld-gtp-bearer-count-exceed’: Validation Drop: GTP Bearer count exceeded max (11); ‘drop-vld-gtp-v2-wrong-lbi-create-bearer-req’: Validation Drop: GTPV2-C Wrong LBI in Create Bearer Request; ‘gtp-c-handover-in-progress-with-conn’: GTP-C matching a conn with Handover In Progress; ‘drop-vld-v0-reserved-message-drop’: Validation Drop: GTPv0-C Reserved Message Drop; ‘drop-vld-v1-reserved-message-drop’: Validation Drop: GTPv1-C Reserved Message Drop; ‘drop-vld-v2-reserved-message-drop’: Validation Drop: GTPv2-C Reserved Message Drop; ‘drop-vld-invalid-pkt-len-piggyback’: Validation Drop: Piggyback message invalid packet length; ‘drop-vld-sanity-failed-piggyback’: Validation Drop: piggyback message anomaly failed; ‘drop-vld-sequence-num-correlation’: Validation Drop: GTP-C Sequence number Mismatch; ‘drop-vld-gtpv0-seqnum-buffer-full’: Validation Drop: GTPV0-C conn Sequence number Buffer Full; ‘drop-vld-gtpv1-seqnum-buffer-full’: Validation Drop: GTPV1-C conn Sequence number Buffer Full; ‘drop-vld-gtpv2-seqnum-buffer-full’: Validation Drop: GTPV2-C conn Sequence number Buffer Full; ‘drop-vld-gtp-invalid-imsi-len-drop’: Validation Drop: GTP-C Invalid IMSI Length Drop; ‘drop-vld-gtp-invalid-apn-len-drop’: Validation Drop: GTP-C Invalid APN Length Drop; ‘drop-vld-protocol-flag-unset’: Validation Drop: Protocol flag in Header Field not Set; ‘drop-vld-gtpv0-subscriber-attr-miss’: Validation Drop: GTPV0-c Subscriber Attributes Missing; ‘drop-vld-gtpv1-subscriber-attr-miss’: Validation Drop: GTPV1-c Subscriber Attributes Missing; ‘drop-vld-gtpv2-subscriber-attr-miss’: Validation Drop: GTPV2-c Subscriber Attributes Missing; ‘drop-vld-gtp-v0-c-ie-len-exceed-msg-len’: GTPv0-C IE Length Exceeds Message Length; ‘drop-vld-gtp-v1-c-ie-len-exceed-msg-len’: GTPv1-C IE Length Exceeds Message Length; ‘drop-vld-gtp-v2-c-ie-len-exceed-msg-len’: GTPv2-C IE Length Exceeds Message Length; ‘drop-vld-gtp-v0-c-message-length-mismatch’: GTPv0-C Message Length Mismatch Across Layers; ‘drop-vld-gtp-v1-c-message-length-mismatch’: GTPv1-C Message Length Mismatch Across Layers; ‘drop-vld-gtp-v2-c-message-length-mismatch’: GTPv2-C Message Length Mismatch Across Layers; ‘drop-vld-gtp-v0-c-message-skipped-apn-filtering-no-apn’: Validation Drop: GTPv0-C APN/IMSI Filtering Dropped (No APN); ‘drop-vld-gtp-v1-c-message-skipped-apn-filtering-no-apn’: Validation Drop: GTPv1-C APN/IMSI Filtering Dropped (No APN); ‘drop-vld-gtp-v2-c-message-skipped-apn-filtering-no-apn’: Validation Drop: GTPv2-C APN/IMSI Filtering Dropped (No APN);

Type: string

Supported Values: all, gtp-v0-c-tunnel-created, gtp-v0-c-tunnel-half-open, gtp-v0-c-tunnel-half-closed, gtp-v0-c-tunnel-closed, gtp-v0-c-tunnel-deleted, gtp-v0-c-half-open-tunnel-closed, gtp-v1-c-tunnel-created, gtp-v1-c-tunnel-half-open, gtp-v1-c-tunnel-half-closed, gtp-v1-c-tunnel-closed, gtp-v1-c-tunnel-deleted, gtp-v1-c-half-open-tunnel-closed, gtp-v2-c-tunnel-created, gtp-v2-c-tunnel-half-open, gtp-v2-c-tunnel-half-closed, gtp-v2-c-tunnel-closed, gtp-v2-c-tunnel-deleted, gtp-v2-c-half-open-tunnel-closed, gtp-u-tunnel-created, gtp-u-tunnel-deleted, gtp-v0-c-update-pdp-resp-unsuccess, gtp-v1-c-update-pdp-resp-unsuccess, gtp-v2-c-mod_bearer-resp-unsuccess, gtp-v0-c-create-pdp-resp-unsuccess, gtp-v1-c-create-pdp-resp-unsuccess, gtp-v2-c-create-sess-resp-unsuccess, gtp-v2-c-piggyback-message, gtp-path-management-message, gtp-v0-c-tunnel-deleted-restart, gtp-v1-c-tunnel-deleted-restart, gtp-v2-c-tunnel-deleted-restart, gtp-v0-c-reserved-message-allow, gtp-v1-c-reserved-message-allow, gtp-v2-c-reserved-message-allow, gtp-v2-c-load-contr-info-exceed, gtp-v1-c-pdu-notification-request-forward, gtp-v1-c-pdu-notification-reject-request-forward, gtp-v0-c-pdu-notification-request-forward, gtp-v0-c-pdu-notification-reject-request-forward, gtp-v0-c-message-skipped-apn-filtering-no-imsi, gtp-v1-c-message-skipped-apn-filtering-no-imsi, gtp-v2-c-message-skipped-apn-filtering-no-imsi, gtp-v0-c-message-skipped-msisdn-filtering-no-imsi, gtp-v1-c-message-skipped-msisdn-filtering-no-imsi, gtp-v2-c-message-skipped-msisdn-filtering-no-imsi, gtp-v0-c-packet-dummy-msisdn, gtp-v1-c-packet-dummy-msisdn, gtp-v2-c-packet-dummy-msisdn, drop-vld-sanity-gtp-v2-c-message-with-teid-zero-expected, drop-vld-sanity-gtp-v1-c-message-with-teid-zero-expected, drop-vld-sanity-gtp-v0-c-message-with-teid-zero-expected, drop-vld-gtp-ie-repeat-count-exceed, drop-vld-reserved-field-set, drop-vld-tunnel-id-flag, drop-vld-invalid-flow-label-v0, drop-vld-invalid-teid, drop-vld-out-of-state, drop-vld-mandatory-information-element, drop-vld-mandatory-ie-in-grouped-ie, drop-vld-out-of-order-ie, drop-vld-out-of-state-ie, drop-vld-reserved-information-element, drop-vld-version-not-supported, drop-vld-message-length, drop-vld-cross-layer-correlation, drop-vld-country-code-mismatch, drop-vld-gtp-u-spoofed-source-address, drop-vld-gtp-bearer-count-exceed, drop-vld-gtp-v2-wrong-lbi-create-bearer-req, gtp-c-handover-in-progress-with-conn, drop-vld-v0-reserved-message-drop, drop-vld-v1-reserved-message-drop, drop-vld-v2-reserved-message-drop, drop-vld-invalid-pkt-len-piggyback, drop-vld-sanity-failed-piggyback, drop-vld-sequence-num-correlation, drop-vld-gtpv0-seqnum-buffer-full, drop-vld-gtpv1-seqnum-buffer-full, drop-vld-gtpv2-seqnum-buffer-full, drop-vld-gtp-invalid-imsi-len-drop, drop-vld-gtp-invalid-apn-len-drop, drop-vld-protocol-flag-unset, drop-vld-gtpv0-subscriber-attr-miss, drop-vld-gtpv1-subscriber-attr-miss, drop-vld-gtpv2-subscriber-attr-miss, drop-vld-gtp-v0-c-ie-len-exceed-msg-len, drop-vld-gtp-v1-c-ie-len-exceed-msg-len, drop-vld-gtp-v2-c-ie-len-exceed-msg-len, drop-vld-gtp-v0-c-message-length-mismatch, drop-vld-gtp-v1-c-message-length-mismatch, drop-vld-gtp-v2-c-message-length-mismatch, drop-vld-gtp-v0-c-message-skipped-apn-filtering-no-apn, drop-vld-gtp-v1-c-message-skipped-apn-filtering-no-apn, drop-vld-gtp-v2-c-message-skipped-apn-filtering-no-apn

counters2

Description ‘drop-flt-message-filtering’: Filtering Drop: Message Type Not Permitted on Interface; ‘drop-flt-apn-filtering’: Filtering Drop: APN IMSI Filtering; ‘drop-flt-msisdn-filtering’: Filtering Drop: MSISDN Filtering; ‘drop-flt-rat-type-filtering’: Filtering Drop: RAT Type Filtering; ‘drop-flt-gtp-in-gtp’: Filtering Drop: GTP in GTP Tunnel Present; ‘drop-rl-gtp-v0-c-agg’: Rate-limit Drop: Maximum GTPv0-C Message rate; ‘drop-rl-gtp-v1-c-agg’: Rate-limit Drop: Maximum GTPv1-C Message rate; ‘drop-rl-gtp-v2-c-agg’: Rate-limit Drop: Maximum GTPv2-C Message rate; ‘drop-rl-gtp-v1-c-create-pdp-request’: Rate-limit Drop: GTPv1-C Create PDP Request rate; ‘drop-rl-gtp-v2-c-create-session-request’: Rate-limit Drop: GTPv2-C Create Session Request rate; ‘drop-rl-gtp-v1-c-update-pdp-request’: Rate-limit Drop: GTPv1-C Update PDP Request rate; ‘drop-rl-gtp-v2-c-modify-bearer-request’: Rate-limit Drop: GTPv2-C Modify Bearer Request rate; ‘drop-rl-gtp-u-tunnel-create’: Rate-limit Drop: GTP-U Tunnel Creation rate; ‘drop-rl-gtp-u-uplink-byte’: Rate-limit Drop: GTP-U Uplink byte rate; ‘drop-rl-gtp-u-uplink-packet’: Rate-limit Drop: GTP-U Uplink packet rate; ‘drop-rl-gtp-u-downlink-byte’: Rate-limit Drop: GTP-U Downlink byte rate; ‘drop-rl-gtp-u-downlink-packet’: Rate-limit Drop: GTP-U Downlink packet rate; ‘drop-rl-gtp-u-total-byte’: Rate-limit Drop: GTP-U Total byte rate; ‘drop-rl-gtp-u-total-packet’: Rate-limit Drop: GTP-U Total packet rate; ‘drop-rl-gtp-u-max-concurrent-tunnels’: Rate-limit Drop: GTP-U Concurrent Tunnels;

Type: string

Supported Values: drop-flt-message-filtering, drop-flt-apn-filtering, drop-flt-msisdn-filtering, drop-flt-rat-type-filtering, drop-flt-gtp-in-gtp, drop-rl-gtp-v0-c-agg, drop-rl-gtp-v1-c-agg, drop-rl-gtp-v2-c-agg, drop-rl-gtp-v1-c-create-pdp-request, drop-rl-gtp-v2-c-create-session-request, drop-rl-gtp-v1-c-update-pdp-request, drop-rl-gtp-v2-c-modify-bearer-request, drop-rl-gtp-u-tunnel-create, drop-rl-gtp-u-uplink-byte, drop-rl-gtp-u-uplink-packet, drop-rl-gtp-u-downlink-byte, drop-rl-gtp-u-downlink-packet, drop-rl-gtp-u-total-byte, drop-rl-gtp-u-total-packet, drop-rl-gtp-u-max-concurrent-tunnels

lid-list

Specification Value
Type list
Block object keys  

ddos-protection-factor

Description Enable DDoS Protection (Multiplier of the downlink PPS)

Type: number

Range: 1-50

downlink-pps

Description Downlink PPS limit (Number of Packets per second)

Type: number

Range: 1-2147483647

downlink-throughput

Description Downlink Throughput limit (Mega Bits per second)

Type: number

Range: 1-100000

lid-number

Description Lid Number

Type: number

Range: 1-1023

limit-cps

Description Enable Connections Per Second Rate Limit (Number of Connections per second)

Type: number

Range: 1-2147483647

limit-rate

Description ‘limit-pps’: Enable Packets Per Second Rate Limit; ‘limit-throughput’: Enable Throughput Rate Limit;

Type: string

Supported Values: limit-pps, limit-throughput

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

total-pps

Description Total PPS limit (Number of Packets per second)

Type: number

Range: 1-2147483647

total-throughput

Description Total Throughput limit (Mega Bits per second)

Type: number

Range: 1-100000

uplink-pps

Description Uplink PPS limit (Number of Packets per second)

Type: number

Range: 1-2147483647

uplink-throughput

Description Uplink Throughput limit (Mega Bits per second)

Type: number

Range: 1-100000

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 Value
Type object

burstsize-cps

Description CPS Token Bucket Size (Must Exceed Configured Rate) (In Connections per second)

Type: number

Range: 1-2147483647

burstsize-downlink-pps

Description Downlink PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)

Type: number

Range: 1-2147483647

burstsize-downlink-throughput

Description Downlink Throughput Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

Type: number

Range: 1-100000

burstsize-total-pps

Description Total PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)

Type: number

Range: 1-2147483647

burstsize-total-throughput

Description Total Throughput Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

Type: number

Range: 1-100000

burstsize-uplink-pps

Description Uplink PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)

Type: number

Range: 1-2147483647

burstsize-uplink-throughput

Description Uplink Throughput Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

Type: number

Range: 1-100000

concurrent-sessions

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

Type: number

Range: 1-2147483647

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

csv-list

Specification Value
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 Value
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

ip-threat-action-list

Specification Value
Type list
Block object keys  

idle-timeout

Description Idle timeout in minutes(default:5)

Type: number

Range: 1-1440

Default: 5

log

Description ‘enable’: Enable logging; ‘disable’: Disable logging (Default);

Type: string

Supported Values: enable, disable

Default: disable

template-number

Description Template Number

Type: number

Range: 1-8

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

apps

Specification Value
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

gtp

Specification Value
Type object

apn-imsi-list-list

Type: List

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

filtering-policy-list

general-policy-list

Type: List

Reference Object: /axapi/v3/template/gtp/general-policy/{name}

logging-policy-list

Type: List

Reference Object: /axapi/v3/template/gtp/logging-policy/{name}

message-filtering-policy-list

msisdn-list-list

Type: List

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

rate-limit-policy-list

validation-policy-list

gtp_message-filtering-policy-list

Specification Value
Type list
Block object keys  

interface-type

Description ‘roaming’: Roaming Interface(S8/Gp); ‘non-roaming’: Non-Roaming Interface(S5/Gn);

Type: string

Supported Values: roaming, non-roaming

name

Description Specify name of the GTP Message Filtering Policy

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

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

version-v0

Description: version-v0 is a JSON Block. Please see below for gtp_message-filtering-policy-list_version-v0

Type: Object

Reference Object: /axapi/v3/template/gtp/message-filtering-policy/{name}/version-v0

version-v1

Description: version-v1 is a JSON Block. Please see below for gtp_message-filtering-policy-list_version-v1

Type: Object

Reference Object: /axapi/v3/template/gtp/message-filtering-policy/{name}/version-v1

version-v2

Description: version-v2 is a JSON Block. Please see below for gtp_message-filtering-policy-list_version-v2

Type: Object

Reference Object: /axapi/v3/template/gtp/message-filtering-policy/{name}/version-v2

gtp_message-filtering-policy-list_version-v1

Specification Value
Type object

create-mbms

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

create-pdp

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

delete-mbms

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

delete-pdp

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

enable-disable-action

Description ‘enable’: Enable Message Filtering on version; ‘disable’: Disable Message Filtering on version;

Type: string

Supported Values: enable, disable

Default: enable

gtp-pdu

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

initiate-pdp

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

mbms-deregistration

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

mbms-notification

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

mbms-registration

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

mbms-session

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

message-type

Description Specify the Message Type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ms-info-change

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

pdu-notification

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

reserved-messages

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

update-mbms

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

update-pdp

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

gtp_message-filtering-policy-list_version-v0

Specification Value
Type object

create-aa-pdp

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

create-pdp

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

delete-aa-pdp

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

delete-pdp

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

enable-disable-action

Description ‘enable’: Enable Message Filtering on version; ‘disable’: Disable Message Filtering on version;

Type: string

Supported Values: enable, disable

Default: enable

gtp-pdu

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

message-type

Description Specify the Message Type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pdu-notification

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

reserved-messages

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

update-pdp

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

gtp_message-filtering-policy-list_version-v2

Specification Value
Type object

bearer-resource

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

change-notification

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

create-bearer

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

create-session

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

delete-bearer

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

delete-command

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

delete-pdn

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

delete-session

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

enable-disable-action

Description ‘enable’: Enable Message Filtering on version; ‘disable’: Disable Message Filtering on version;

Type: string

Supported Values: enable, disable

Default: enable

message-type

Description Specify the Message Type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

modify-bearer

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

modify-command

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

pgw-downlink-trigger

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

remote-ue-report

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

reserved-messages

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

resume

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

suspend

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

trace-session

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: disable

update-bearer

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

update-pdn

Description ‘enable’: Enable the Message Type; ‘disable’: Disable the Message Type;

Type: string

Supported Values: enable, disable

Default: enable

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

gtp_msisdn-list-list

Specification Value
Type list
Block object keys  

action

Description ‘permit’: Create a whitelist to permit the packets that match MSISDN filters; ‘deny’: Create a blacklist to deny the packets that match MSISDN filters;

Type: string

Supported Values: permit, deny

Default: deny

name

Description Specify name of the GTP MSISDN 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_msisdn-list-list_str-list

Specification Value
Type list
Block object keys  

msisdn

Description Specify the MSISDN filter

Type: string

Maximum Length: 15 characters

Maximum Length: 1 characters

gtp_general-policy-list

Specification Value
Type list
Block object keys  

handover-timeout

Description Tunnel Inactivity Timeout during Handover in minutes (default: 2 mins)

Type: number

Range: 1-63

Default: 2

max-mesg-length-action

Description ‘monitor’: Forward failed packet; ‘drop’: drop packet failing check(Default);

Type: string

Supported Values: monitor, drop

Default: drop

maximum-message-length

Description Maximum message length for a GTP message in bytes

Type: number

Range: 64-1500

Default: 1500

name

Description Specify name of the GTP General Policy

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

tunnel-timeout

Description Tunnel Inactivity Timeout in minutes (default: 1440 minutes)

Type: number

Range: 5-60000

Default: 1440

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

v0-action

Description ‘permit’: Permit GTP-C version 0; ‘drop’: Drop GTP-C version 0(Default);

Type: string

Supported Values: permit, drop

Default: drop

gtp_filtering-policy-list

Specification Value
Type list
Block object keys  

apn-imsi-filt-action

Description ‘monitor’: Forward packet; ‘drop’: drop packet (default);

Type: string

Supported Values: monitor, drop

Default: drop

apn-imsi-filtering

Description Specify the APN IMSI Inspection Policy

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/template/gtp/apn-imsi-list

gtp-in-gtp-filt-action

Description ‘monitor’: Forward packet; ‘drop’: drop packet (default);

Type: string

Supported Values: monitor, drop

Default: drop

gtp-in-gtp-filtering

Description ‘enable’: Enable GTP-in-GTP Filtering; ‘disable’: Disable GTP-in-GTP Filtering;

Type: string

Supported Values: enable, disable

Default: enable

message-filt-action

Description ‘monitor’: Forward packet; ‘drop’: drop packet (default);

Type: string

Supported Values: monitor, drop

Default: drop

message-filtering-policy-name

Description Specify the Message Filtering Policy

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/template/gtp/message-filtering-policy

msisdn-filt-action

Description ‘monitor’: Forward packet; ‘drop’: drop packet (default);

Type: string

Supported Values: monitor, drop

Default: drop

msisdn-filtering

Description Specify the MSISDN Inspection Policy

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

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

name

Description Specify name of the GTP Filtering Policy

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

rat-type-filtering

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_filtering-policy-list_rat-type-filtering

Specification Value
Type list
Block object keys  

rat-type-filt-action

Description ‘monitor’: Forward packet; ‘drop’: drop packet (default);

Type: string

Supported Values: monitor, drop

Default: drop

rat-type-value

Description ‘utran’: RAT Type for 3G Networks; ‘geran’: RAT Type for 2G Networks; ‘wlan’: RAT Type for WLAN Networks; ‘gan’: RAT Type for GAN Networks; ‘hspa-evolution’: RAT Type for HSPA Networks; ‘eutran’: RAT Type for 4G Networks;

Type: string

Supported Values: utran, geran, wlan, gan, hspa-evolution, eutran

gtp_rate-limit-policy-list

Specification Value
Type list
Block object keys  

gtp-u-downlink-byte-rate

Description Maximum allowed of rate of GTP-U bytes in downlink direction

Type: number

Range: 1-2147483647

gtp-u-downlink-packet-rate

Description Maximum allowed of rate of GTP-U packets in downlink direction

Type: number

Range: 1-2147483647

gtp-u-max-concurrent-tunnels

Description Maximum allowed GTP-U tunnels per Peer/APN Filter

Type: number

Range: 1-2147483647

gtp-u-total-byte-rate

Description Maximum allowed of rate of GTP-U bytes total in both directions

Type: number

Range: 1-2147483647

gtp-u-total-packet-rate

Description Maximum allowed of rate of GTP-U packets total in both directions

Type: number

Range: 1-2147483647

gtp-u-tunnel-create-rate

Description Maximum allowed of rate of GTP-U tunnels

Type: number

Range: 1-2147483647

gtp-u-uplink-byte-rate

Description Maximum allowed of rate of GTP-U bytes in uplink direction

Type: number

Range: 1-2147483647

gtp-u-uplink-packet-rate

Description Maximum allowed of rate of GTP-U packets in uplink direction

Type: number

Range: 1-2147483647

lockout

Description Lockout traffic from the source for a certain time period after rate exceeded (Lockout duration in minutes)

Type: number

Range: 1-1023

name

Description Specify name of the GTP Rate Limit Policy

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

rate-limit-action

Description ‘monitor’: Forward packet exceeding limit; ‘drop’: drop packet exceeding limit(default);

Type: string

Supported Values: monitor, drop

Default: drop

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

v0-agg-message-type-rate

Description Maximum allowed GTPv0-C message rate of all types

Type: number

Range: 1-2147483647

v1-agg-message-type-rate

Description Maximum allowed GTPv1-C message rate of all types

Type: number

Range: 1-2147483647

v1-create-pdp-request-rate

Description Maximum allowed rate of GTPv1-C Create PDP Request message type

Type: number

Range: 1-2147483647

v1-update-pdp-request-rate

Description Maximum allowed rate of GTPv1-C Update PDP Request message type

Type: number

Range: 1-2147483647

v2-agg-message-type-rate

Description Maximum allowed GTPv2-C message rate of all types

Type: number

Range: 1-2147483647

v2-create-session-request-rate

Description Maximum allowed rate of GTPv2-C Create Session Request message type

Type: number

Range: 1-2147483647

v2-modify-bearer-request-rate

Description Maximum allowed rate of GTPv2-C Modify Bearer Request message type

Type: number

Range: 1-2147483647

gtp_apn-imsi-list-list

Specification Value
Type list
Block object keys  

action

Description ‘permit’: Create a whitelist to permit the packets that match APN IMSI filters; ‘deny’: Create a blacklist to deny the packets that match APN IMSI filters (default);

Type: string

Supported Values: permit, deny

Default: deny

name

Description Specify name of the GTP APN IMSI 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_apn-imsi-list-list_str-list

Specification Value
Type list
Block object keys  

apn

Description Specify the APN filter

Type: string

Format: string-rlx

Maximum Length: 100 characters

Maximum Length: 1 characters

imsi

Description Specify the IMSI filter

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 filter

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

gtp_logging-policy-list

Specification Value
Type list
Block object keys  

log

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

Type: Object

name

Description Specify name of the GTP Logging Policy

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

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_logging-policy-list_log

Specification Value
Type object

anti-spoofing-check

Description Logging Packet Drop due to End User IP Address Spoofing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

apn-imsi-filtering

Description Logging Packet Drop due to APN IMSI filtering

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

crosslayer-correlation

Description Logging Packet Drop due to mismatch in IP address and GTP FTEID/GSN address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

gtp-in-gtp-filtering

Description Logging Packet Drop due to GTP in GTP filtering

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

invalid-header-check

Description Logging Packet Drop due to Invalid Header checks

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

invalid-teid-check

Description Logging Packet Drop due to Invalid Tunnel Endpoint Identifier

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

mandatory-ie-check

Description Logging Packet Drop due to Missing Mandatory Information Element

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

max-message-length-check

Description Logging Packet Drop due to Max Message Length Filtering

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

message-filtering

Description Logging Packet Drop due to Message Filtering

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

msisdn-filtering

Description Logging Packet Drop due to MSISDN Filtering

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

msisdn-imsi-correlation

Description Logging Packet Drop due to mismatch in Country Code and Mobile Country Code

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

out-of-order-ie-check

Description Logging Packet Drop due to Out of Order Information Elements for GTPv1-C

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

out-of-state-ie-check

Description Logging Packet Drop due to Out of State Information Elements

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rat-type-filtering

Description Logging Packet Drop due to RAT type filtering

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

reserved-ie-check

Description Logging Packet Drop due to Presence of Reserved Information Element

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sequence-num-correlation

Description Logging Packet Drop due to mismatch in Sequence number between GTP request and response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

gtp_validation-policy-list

Specification Value
Type list
Block object keys  

anomaly-action

Description ‘monitor’: Forward failed packet; ‘drop’: drop check failed packet(default);

Type: string

Supported Values: monitor, drop

Default: drop

anomaly-checks

Description ‘enable’: Enable Anomaly Checks for GTP Messages; ‘disable’: Disable Anomaly Checks for GTP Messages;

Type: string

Supported Values: enable, disable

Default: enable

anti-spoofing-action

Description ‘monitor’: Forward failed packet; ‘drop’: drop check failed packet(default);

Type: string

Supported Values: monitor, drop

Default: drop

anti-spoofing-check

Description ‘enable’: Enable Spoofed IP Address Check for GTP-U Messages; ‘disable’: Disable Spoofed IP Address Check for GTP Messages;

Type: string

Supported Values: enable, disable

Default: disable

crosslayer-corr-action

Description ‘monitor’: Forward failed packet; ‘drop’: drop check failed packet(default);

Type: string

Supported Values: monitor, drop

Default: drop

crosslayer-correlation

Description ‘enable’: Enable Cross Layer Correlation for GTP Messages; ‘disable’: Disable Cross Layer Correlation for GTP Messages;

Type: string

Supported Values: enable, disable

Default: disable

mandatory-ie-action

Description ‘monitor’: Forward failed packet; ‘drop’: drop check failed packet(default);

Type: string

Supported Values: monitor, drop

Default: drop

mandatory-ie-check

Description ‘enable’: Enable Mandatory IE Check for GTP Messages; ‘disable’: Disable Mandatory IE Check for GTP Messages;

Type: string

Supported Values: enable, disable

Default: enable

msisdn-imsi-corr-action

Description ‘monitor’: Forward failed packet; ‘drop’: drop check failed packet(default);

Type: string

Supported Values: monitor, drop

Default: drop

msisdn-imsi-correlation

Description ‘enable’: Enable Country Code Correlation in MSISDN and IMSI for GTP Messages; ‘disable’: Disable Country Code Correlation in MSISDN and IMSI for GTP Messages;

Type: string

Supported Values: enable, disable

Default: disable

name

Description Specify name of the GTP Validation Policy

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

out-of-order-ie-action

Description ‘monitor’: Forward failed packet; ‘drop’: drop check failed packet(default);

Type: string

Supported Values: monitor, drop

Default: drop

out-of-order-ie-check

Description ‘enable’: Enable Out of Order IE Check for GTP Messages; ‘disable’: Disable Out of Order IE Check for GTP Messages;

Type: string

Supported Values: enable, disable

Default: disable

out-of-state-ie-action

Description ‘monitor’: Forward failed packet; ‘drop’: drop check failed packet(default);

Type: string

Supported Values: monitor, drop

Default: drop

out-of-state-ie-check

Description ‘enable’: Enable Out of State IE Check for GTP Messages; ‘disable’: Disable Out of State IE Check for GTP Messages;

Type: string

Supported Values: enable, disable

Default: disable

reserved-ie-action

Description ‘monitor’: Forward failed packet; ‘drop’: drop check failed packet(default);

Type: string

Supported Values: monitor, drop

Default: drop

reserved-ie-check

Description ‘enable’: Enable Reserved IE Check for GTP Messages; ‘disable’: Disable Reserved IE Check for GTP Messages;

Type: string

Supported Values: enable, disable

Default: enable

sequence-num-corr-action

Description ‘monitor’: Forward failed packet; ‘drop’: drop check failed packet(default);

Type: string

Supported Values: monitor, drop

Default: drop

sequence-num-correlation

Description ‘enable’: Enable Sequence number correlation between GTP Request and Responses; ‘disable’: Disable Sequence number correlation between GTP Request and Responses;

Type: string

Supported Values: enable, disable

Default: disable

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

Specification Value
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 Value
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 Value
Type object

permit-config-id

Type: List

permit-config-name

Type: List

sctp-list_permit-payload-protocol_permit-config-id

Specification Value
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 Value
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

limit-policy-list

Specification Value
Type list
Block object keys  

limit-concurrent-sessions

Description Enable Concurrent Session Limit (Number of Concurrent Sessions)

Type: number

Range: 1-2147483647

limit-cps

Description: limit-cps is a JSON Block. Please see below for limit-policy-list_limit-cps

Type: Object

Reference Object: /axapi/v3/template/limit-policy/{policy-number}/limit-cps

limit-pps

Description: limit-pps is a JSON Block. Please see below for limit-policy-list_limit-pps

Type: Object

Reference Object: /axapi/v3/template/limit-policy/{policy-number}/limit-pps

limit-scope

Description ‘aggregate’: Rule Level; ‘subscriber-ip’: Subscriber IP Level; ‘subscriber-prefix’: Subscriber Prefix Level;

Type: string

Supported Values: aggregate, subscriber-ip, subscriber-prefix

Default: subscriber-ip

limit-throughput

Description: limit-throughput is a JSON Block. Please see below for limit-policy-list_limit-throughput

Type: Object

Reference Object: /axapi/v3/template/limit-policy/{policy-number}/limit-throughput

log

Description Log when Session Limit is exceeded

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

max-min-fair

Description Enable max-min-fairness

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

parent

Description Specify the parent of limit-policy

Type: number

Range: 1-1023

policy-number

Description Limit Policy Number

Type: number

Range: 1-1023

prefix-length

Description Prefix length

Type: number

Range: 1-128

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

limit-policy-list_limit-throughput

Specification Value
Type object

downlink

Description Downlink Throughput limit (Mega Bits per second)

Type: number

Range: 1-100000

downlink-burstsize

Description Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

Type: number

Range: 1-100000

downlink-relaxed

Description Relax the limitation when the policy has more tokens from the parent of policy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

total

Description Total Throughput limit (Mega Bits per second)

Type: number

Range: 1-100000

total-burstsize

Description Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

Type: number

Range: 1-100000

total-relaxed

Description Relax the limitation when the policy has more tokens from the parent of policy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uplink

Description Uplink Throughput limit (Mega Bits per second)

Type: number

Range: 1-100000

uplink-burstsize

Description Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)

Type: number

Range: 1-100000

uplink-relaxed

Description Relax the limitation when the policy has more tokens from the parent of policy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

limit-policy-list_limit-cps

Specification Value
Type object

burstsize

Description CPS Token Bucket Size (Must Exceed Configured Rate) (In Connections per second)

Type: number

Range: 1-2147483647

relaxed

Description Relax the limitation when the policy has more tokens from the parent of policy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description Connections Per Second Rate Limit (Number of Connections per second)

Type: number

Range: 1-2147483647

limit-policy-list_limit-pps

Specification Value
Type object

ddos-protection-factor

Description Enable DDoS Protection (Multiplier of the downlink PPS)

Type: number

Range: 1-50

downlink

Description Downlink PPS limit (Number of Packets per second)

Type: number

Range: 1-2147483647

downlink-burstsize

Description PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)

Type: number

Range: 1-2147483647

downlink-relaxed

Description Relax the limitation when the policy has more tokens from the parent of policy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

total

Description Total PPS limit (Number of Packets per second)

Type: number

Range: 1-2147483647

total-burstsize

Description PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)

Type: number

Range: 1-2147483647

total-relaxed

Description Relax the limitation when the policy has more tokens from the parent of policy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uplink

Description Uplink PPS limit (Number of Packets per second)

Type: number

Range: 1-2147483647

uplink-burstsize

Description PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)

Type: number

Range: 1-2147483647

uplink-relaxed

Description Relax the limitation when the policy has more tokens from the parent of policy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

syslog-over-tls

Specification Value
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters