{ "id":"/axapi/v3/template", "type":"object", "node-type":"intermediate", "title":"template", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "description":"Define a Template", "properties":{ "sctp-list":{ "type":"array", "minItems":1, "items":{ "type":"sctp" }, "uniqueItems":true, "$ref":"/axapi/v3/template/sctp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "default":"default", "partition-visibility":"shared", "description":"SCTP Template Name", "optional":false }, "sctp-half-open-idle-timeout":{ "type":"number", "format":"number", "minimum":2, "maximum":30, "default":4, "partition-visibility":"shared", "description":"Set SCTP half-open timeout (SCTP half-open timeout in seconds (default 4))", "optional":true }, "sctp-idle-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "default":5, "partition-visibility":"shared", "description":"SCTP idle timeout in minutes (default 5)", "optional":true }, "permit-payload-protocol":{ "type":"object", "properties":{ "permit-config-id":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "protocol-id":{ "type":"number", "format":"number", "minimum":1, "maximum":63, "partition-visibility":"shared", "description":"Specify SCTP permitted payload protocol IDs" }, "optional":true } } ] }, "permit-config-name":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "protocol-name":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'iua': IUA; 'm2ua': M2UA; 'm3ua': M3UA; 'sua': SUA; 'm2pa': M2PA; 'h.323': H.323; ", "enum":[ "iua", "m2ua", "m3ua", "sua", "m2pa", "h.323" ] }, "optional":true } } ] } } }, "checksum-check":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'enable': Enable Checksum check; ", "enum":[ "enable" ], "optional":true }, "log":{ "type":"object", "properties":{ "payload-proto-filtering":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log Payload Protocol IDs Filtered" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "gtp-filter-list-list":{ "type":"array", "minItems":1, "items":{ "type":"gtp-filter-list" }, "uniqueItems":true, "$ref":"/axapi/v3/template/gtp-filter-list/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify name of the filter list", "optional":false }, "str-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "apn":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify the APN" }, "selection-mode":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not":"imsi", "description":"'mobilestation': MS provided APN, subscription not verified; 'network': Network provided APN, subscription not verified; 'verified': MS or Network provided APN, subscription verified; ", "enum":[ "mobilestation", "network", "verified" ] }, "imsi-selection":{ "type":"string", "format":"string", "minLength":1, "maxLength":15, "partition-visibility":"shared", "description":"Specify the IMSI number" }, "imsi":{ "type":"string", "format":"string", "minLength":1, "maxLength":15, "partition-visibility":"shared", "not":"selection-mode", "description":"Set the IMSI number" }, "optional":true } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "gtp-list":{ "type":"array", "minItems":1, "items":{ "type":"gtp" }, "uniqueItems":true, "$ref":"/axapi/v3/template/gtp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "default":"default", "partition-visibility":"shared", "description":"GTP Template Name", "optional":false }, "log":{ "type":"object", "properties":{ "message-filtering":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log Packet Drop due to Message Filtering" }, "information-filtering":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log Packet Drop due to Information Filtering" }, "invalid-teid":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log Packet Drop due to Invalid Tunnel Endpoint Identifier" }, "reserved-ie-present":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log Packet Drop due to Presence of Reserved Information Element" }, "mandatory-ie-missing":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log Packet Drop due to Missing Mandatory Information Element" } } }, "protocol-anomaly-filtering":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'disable': Disable Anomaly Filtering; ", "enum":[ "disable" ], "optional":true }, "mandatory-ie-filtering":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'disable': Disable Mandatory Information Element Filtering; ", "enum":[ "disable" ], "optional":true }, "tunnel-timeout":{ "type":"number", "format":"number", "minimum":5, "maximum":34952, "default":60, "partition-visibility":"shared", "description":"Idle Timeout in minutes (default: 60 mins)", "optional":true }, "maximum-message-length":{ "type":"number", "format":"number", "minimum":64, "maximum":1500, "default":1500, "partition-visibility":"shared", "description":"Maximum message length for a GTP message", "optional":true }, "message-type":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "message-type-v2":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "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" ] }, "message-type-v1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "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-v0":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "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" ] }, "drop-value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'drop': Drop the Message Type; ", "enum":[ "drop" ] }, "optional":true } } ] }, "gtp-filter-list":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/template/gtp-filter-list", "description":"Specify a GTP Filter-List (GTP Filter-List Value)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] }, "lid-list":{ "type":"array", "minItems":1, "items":{ "type":"lid" }, "uniqueItems":true, "$ref":"/axapi/v3/template/lid/{lid-number}", "array":[ { "properties":{ "lid-number":{ "type":"number", "format":"number", "minimum":1, "maximum":1023, "partition-visibility":"shared", "description":"Lid Number", "optional":false }, "respond-to-user-mac":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use the user's source MAC for the next hop rather than the routing table (default:off)", "optional":true }, "pps":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"PPS limit per Rule (Number of Packets per second)", "optional":true }, "throughput":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Throughput limit per Rule (Throughput in bytes per second)", "optional":true }, "src-ip":{ "type":"object", "properties":{ "concurrent-sessions":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Concurrent Session Limit per Source IP Address (Number of Concurrent Sessions)" }, "log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log when Session Limit is exceeded" }, "prefix-length":{ "type":"number", "format":"number", "minimum":1, "maximum":128, "partition-visibility":"shared", "description":"Source prefix length" }, "enable-high-perf":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable High Perf" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "lid-number" ] } ] }, "csv-list":{ "type":"array", "minItems":1, "items":{ "type":"csv" }, "uniqueItems":true, "$ref":"/axapi/v3/template/csv/{csv-name}", "array":[ { "properties":{ "csv-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify name of csv template", "optional":false }, "delim-num":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "default":44, "partition-visibility":"shared", "not":"delim-char", "description":"enter a delimiter number, default 44 (\",\")", "optional":true }, "delim-char":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1, "default":",", "partition-visibility":"shared", "not":"delim-num", "description":"enter a delimiter character, default \",\"", "optional":true }, "ipv6-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Support IPv6 IP ranges", "optional":true }, "multiple-fields":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "field":{ "type":"number", "format":"number", "minimum":1, "maximum":64, "partition-visibility":"shared", "description":"Field index number (Index of Field)" }, "csv-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "ip-from", "ip-to-mask", "continent", "country", "state", "city" ] }, "optional":true } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "csv-name" ] } ] } } }