{ "id":"/axapi/v3/cgnv6/template", "type":"object", "node-type":"intermediate", "title":"template", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "auto-created-object":1, "description":"Define a CGNv6 template", "properties":{ "dns-list":{ "type":"array", "minItems":1, "items":{ "type":"dns" }, "uniqueItems":true, "$ref":"/axapi/v3/cgnv6/template/dns/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"DNS Template Name", "optional":false }, "default-policy":{ "type":"string", "format":"enum", "default":"nocache", "partition-visibility":"shared", "description":"'nocache': Cache disable; 'cache': Cache enable; ", "enum":[ "nocache", "cache" ], "optional":true }, "disable-dns-template":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable DNS template", "optional":true }, "period":{ "type":"number", "format":"number", "minimum":1, "maximum":10000, "partition-visibility":"shared", "description":"Period in minutes", "optional":true }, "drop":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"forward", "description":"Drop the malformed query", "optional":true }, "forward":{ "type":"string", "format":"string", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not":"drop", "description":"Forward to service group (Service group name)", "optional":true }, "max-cache-size":{ "type":"number", "format":"number", "platform-specific-range":1, "platform-specific-default":1, "partition-visibility":"shared", "description":"Define maximum cache size (Maximum cache entry per VIP)", "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 }, "class-list":{ "type":"object", "$ref":"/axapi/v3/cgnv6/template/dns/{name}/class-list", "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify a class list name" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "lid-list":{ "type":"array", "minItems":1, "items":{ "type":"lid" }, "uniqueItems":true, "$ref":"/axapi/v3/cgnv6/template/dns/{name}/class-list/lid/{lidnum}", "array":[ { "properties":{ "lidnum":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "description":"Specify a limit ID", "optional":false }, "conn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Connection rate limit", "optional":true }, "per":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Per (Number of 100ms)", "optional":true }, "over-limit-action":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Action when exceeds limit", "optional":true }, "action-value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'dns-cache-disable': Disable DNS cache when it exceeds limit; 'dns-cache-enable': Enable DNS cache when it exceeds limit; 'forward': Forward the traffic even it exceeds limit; ", "enum":[ "dns-cache-disable", "dns-cache-enable", "forward" ], "optional":true }, "lockout":{ "type":"number", "format":"number", "minimum":1, "maximum":1023, "partition-visibility":"shared", "description":"Don't accept any new connection for certain time (Lockout duration in minutes)", "optional":true }, "log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log a message", "optional":true }, "log-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"Log interval (minute, by default system will log every over limit instance)", "optional":true }, "dns":{ "type":"object", "properties":{ "cache-action":{ "type":"string", "format":"enum", "default":"cache-disable", "partition-visibility":"shared", "description":"'cache-disable': Disable dns cache; 'cache-enable': Enable dns cache; ", "enum":[ "cache-disable", "cache-enable" ] }, "ttl":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"TTL for cache entry (TTL in seconds)" }, "weight":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "partition-visibility":"shared", "description":"Weight for cache entry" } } }, "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":[ "lidnum" ] } ] } } }, "dns64":{ "type":"object", "$ref":"/axapi/v3/cgnv6/template/dns/{name}/dns64", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable DNS64 (Need to config this option before config any other dns64 options)" }, "answer-only-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Only translate the Answer Section" }, "auth-data":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Set AA flag in DNS Response" }, "cache":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use a cached A-query response to provide AAAA query responses for the same hostname" }, "change-query":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Always change incoming AAAA DNS Query to A" }, "compress-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Always try DNS Compression" }, "deep-check-qr":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Check DNS Question Record" }, "deep-check-rr-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Check DNS Response Records" }, "drop-cname-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Drop DNS CNAME Response" }, "edns-append":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Append EDNS Record when send A Query to server" }, "fast-append":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Append translated Records when original Response only has Answer Section" }, "ignore-rcode3-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Ignore DNS error Response with rcode 3" }, "max-qr-length":{ "type":"number", "format":"number", "minimum":1, "maximum":1023, "default":128, "partition-visibility":"shared", "description":"Max Question Record Length, default is 128" }, "parallel-query":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Forward AAAA Query & generate A Query in parallel" }, "passive-query-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Generate A query upon empty or error Response" }, "retry":{ "type":"number", "format":"number", "minimum":0, "maximum":15, "default":3, "partition-visibility":"shared", "description":"Retry count, default is 3 (Retry Number)" }, "single-response-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Single Response which is used to avoid ambiguity" }, "timeout":{ "type":"number", "format":"number", "minimum":0, "maximum":15, "default":1, "partition-visibility":"shared", "description":"Timeout to send additional Queries, unit: second, default is 1" }, "trans-ptr":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Translate DNS PTR Records" }, "trans-ptr-query":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Translate DNS PTR Query" }, "ttl":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000000, "partition-visibility":"shared", "description":"Specify Max TTL in DNS Response, unit: second" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] }, "policy-list":{ "type":"array", "minItems":1, "items":{ "type":"policy" }, "uniqueItems":true, "$ref":"/axapi/v3/cgnv6/template/policy/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Policy template name", "optional":false }, "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 }, "class-list":{ "type":"object", "$ref":"/axapi/v3/cgnv6/template/policy/{name}/class-list", "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Class list name" }, "client-ip-l3-dest":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"client-ip-l7-header", "description":"Use destination IP as client IP address" }, "client-ip-l7-header":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"client-ip-l3-dest", "description":"Use extract client IP address from L7 header" }, "header-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify L7 header name" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "lid-list":{ "type":"array", "minItems":1, "items":{ "type":"lid" }, "uniqueItems":true, "$ref":"/axapi/v3/cgnv6/template/policy/{name}/class-list/lid/{lidnum}", "array":[ { "properties":{ "lidnum":{ "type":"number", "format":"number", "minimum":1, "maximum":31, "partition-visibility":"shared", "description":"Specify a limit ID", "optional":false }, "conn-limit":{ "type":"number", "format":"number", "minimum":0, "maximum":1048575, "partition-visibility":"shared", "description":"Connection limit", "optional":true }, "conn-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":2147483647, "partition-visibility":"shared", "description":"Specify connection rate limit", "optional":true }, "conn-per":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Per (Specify interval in number of 100ms)", "optional":true }, "request-limit":{ "type":"number", "format":"number", "minimum":0, "maximum":1048575, "partition-visibility":"shared", "description":"Request limit (Specify request limit)", "optional":true }, "request-rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":4294967295, "partition-visibility":"shared", "description":"Request rate limit (Specify request rate limit)", "optional":true }, "request-per":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Per (Specify interval in number of 100ms)", "optional":true }, "over-limit-action":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Set action when exceeds limit", "optional":true }, "action-value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'forward': Forward the traffic even it exceeds limit; 'reset': Reset the connection when it exceeds limit; ", "enum":[ "forward", "reset" ], "optional":true }, "lockout":{ "type":"number", "format":"number", "minimum":1, "maximum":1023, "partition-visibility":"shared", "description":"Don't accept any new connection for certain time (Lockout duration in minutes)", "optional":true }, "log":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log a message", "optional":true }, "interval":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"Specify log interval in minutes, by default system will log every over limit instance", "optional":true }, "dns64":{ "type":"object", "properties":{ "disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable" }, "exclusive-answer":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Exclusive Answer in DNS Response" }, "prefix":{ "type":"string", "format":"ipv6-address-plen", "partition-visibility":"shared", "description":"IPv6 prefix" } } }, "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":[ "lidnum" ] } ] } } } }, "required":[ "name" ] } ] }, "logging-list":{ "type":"array", "minItems":1, "items":{ "type":"logging" }, "uniqueItems":true, "$ref":"/axapi/v3/cgnv6/template/logging/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Logging template name", "optional":false }, "resolution":{ "type":"string", "format":"enum", "default":"seconds", "partition-visibility":"shared", "description":"'seconds': Logging timestamp resolution in seconds (default); '10-milliseconds': Logging timestamp resolution in 10s of milli-seconds; ", "enum":[ "seconds", "10-milliseconds" ], "optional":true }, "log":{ "type":"object", "properties":{ "fixed-nat":{ "type":"object", "properties":{ "fixed-nat-http-requests":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'host': Log the HTTP Host Header; 'url': Log the HTTP Request URL; ", "enum":[ "host", "url" ] }, "fixed-nat-port-mappings":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'both': Log creation and deletion of NAT mappings; 'creation': Log creation of NAT mappings; ", "enum":[ "both", "creation" ] }, "fixed-nat-sessions":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log all Fixed NAT sessions" }, "fixed-nat-merged-style":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Merge creation and deletion of session logs to one" }, "user-ports":{ "type":"object", "properties":{ "user-ports":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log Fixed NAT User Ports Configured" }, "days":{ "type":"number", "format":"number", "minimum":1, "maximum":30, "partition-visibility":"shared", "description":"Specify period in days" }, "start-time":{ "type":"string", "format":"time-hhmm", "partition-visibility":"shared", "description":"Time when periodic logging starts (Specify start time(hh:mm))" } } } } }, "one-to-one-nat":{ "type":"object", "properties":{ "one-to-one-nat-sessions":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log all One-to-One NAT sessions" }, "one-to-one-merged-style":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Merge creation and deletion of session logs to one" } } }, "map-dhcpv6":{ "type":"object", "properties":{ "map-dhcpv6-prefix-all":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"map-dhcpv6-msg-type", "description":"Log MAP DHCPv6 prefix assignment/renewal/release" }, "map-dhcpv6-msg-type":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "map-dhcpv6-msg-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not":"map-dhcpv6-prefix-all", "description":"'prefix-assignment': Log MAP DHCPv6 prefix assignment; 'prefix-renewal': Log MAP DHCPv6 prefix renewal; 'prefix-release': Log MAP DHCPv6 prefix release; ", "enum":[ "prefix-assignment", "prefix-renewal", "prefix-release" ] } } } ] } } }, "http-requests":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'host': Log the HTTP Host Header; 'url': Log the HTTP Request URL; ", "enum":[ "host", "url" ] }, "port-mappings":{ "type":"string", "format":"enum", "default":"both", "partition-visibility":"shared", "description":"'creation': Log only creation of NAT mappings; 'disable': Disable Log creation and deletion of NAT mappings; 'both': Log creation and deletion of NAT mappings; ", "enum":[ "creation", "disable", "both" ] }, "port-overloading":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Force logging of all port-overloading sessions" }, "user-data":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log LSN Subscriber Information" }, "sessions":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log all data sessions created using NAT" }, "merged-style":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Merge creation and deletion of session logs to one" } } }, "include-destination":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include the destination IP and port in logs", "optional":true }, "include-inside-user-mac":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include the inside user MAC address in logs", "optional":true }, "include-partition-name":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include partition name in logging events", "optional":true }, "include-session-byte-count":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"include byte count in session deletion logs", "optional":true }, "include-port-block-account":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"include bytes accounting information in port-batch-v2 port-mapping and fixed-nat user-ports messages", "optional":true }, "include-radius-attribute":{ "type":"object", "properties":{ "attr-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "attr":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'imei': Include IMEI; 'imsi': Include IMSI; 'msisdn': Include MSISDN; 'custom1': Customized attribute 1; 'custom2': Customized attribute 2; 'custom3': Customized attribute 3; 'custom4': Customized attribute 4; 'custom5': Customized attribute 5; 'custom6': Customized attribute 6; ", "enum":[ "imei", "imsi", "msisdn", "custom1", "custom2", "custom3", "custom4", "custom5", "custom6" ] }, "attr-event":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'http-requests': Include in HTTP request logs; 'port-mappings': Include in port-mapping logs; 'sessions': Include in session logs; 'user-data': Include in user-data logs; ", "enum":[ "http-requests", "port-mappings", "sessions", "user-data" ] } } } ] }, "no-quote":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"No quotation marks for RADIUS attributes in logs" }, "insert-if-not-existing":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure what string is to be inserted for custom RADIUS attributes" }, "zero-in-custom-attr":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Insert 0000 for standard and custom attributes in log string" }, "framed-ipv6-prefix":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include radius attributes for the prefix" }, "prefix-length":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'32': Prefix length 32; '48': Prefix length 48; '64': Prefix length 64; '80': Prefix length 80; '96': Prefix length 96; '112': Prefix length 112; ", "enum":[ "32", "48", "64", "80", "96", "112" ] } } }, "include-http":{ "type":"object", "properties":{ "header-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "http-header":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'cookie': Log HTTP Cookie Header; 'referer': Log HTTP Referer Header; 'user-agent': Log HTTP User-Agent Header; 'header1': Log HTTP Header 1; 'header2': Log HTTP Header 2; 'header3': Log HTTP Header 3; ", "enum":[ "cookie", "referer", "user-agent", "header1", "header2", "header3" ] }, "max-length":{ "type":"number", "format":"number", "minimum":100, "maximum":1000, "default":100, "partition-visibility":"shared", "description":"Max length for a HTTP request log (Max header length (Default: 100 char))" }, "custom-header-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Header name" }, "custom-max-length":{ "type":"number", "format":"number", "minimum":100, "maximum":1000, "default":100, "partition-visibility":"shared", "description":"Max length for a HTTP request log (Max header length (Default: 100 char))" } } } ] }, "l4-session-info":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log the L4 session information of the HTTP request" }, "method":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log the HTTP Request Method" }, "request-number":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"HTTP Request Number" }, "file-extension":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"HTTP file extension" } } }, "rule":{ "type":"object", "properties":{ "rule-http-requests":{ "type":"object", "properties":{ "dest-port":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "dest-port-number":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared" }, "include-byte-count":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include the byte count of HTTP Request/Response in CGN session deletion logs" } } } ] }, "log-every-http-request":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log every HTTP request in an HTTP 1.1 session (Default: Log the first HTTP request in a session)" }, "max-url-len":{ "type":"number", "format":"number", "minimum":100, "maximum":1000, "default":128, "partition-visibility":"shared", "description":"Max length of URL log (Max URL length (Default: 128 char))" }, "include-all-headers":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include all configured headers despite of absence in HTTP request" }, "disable-sequence-check":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable http packet sequence check and don't drop out of order packets" } } }, "interim-update-interval":{ "type":"number", "format":"number", "minimum":15, "maximum":120, "partition-visibility":"shared", "description":"Log interim update of NAT mappings (Interim update interval in minutes(Interval is floored to a multiple of 5))" } } }, "facility":{ "type":"string", "format":"enum", "default":"local0", "partition-visibility":"shared", "description":"'kernel': 0: Kernel; 'user': 1: User-level; 'mail': 2: Mail; 'daemon': 3: System daemons; 'security-authorization': 4: Security/authorization; 'syslog': 5: Syslog internal; 'line-printer': 6: Line printer; 'news': 7: Network news; 'uucp': 8: UUCP subsystem; 'cron': 9: Time-related; 'security-authorization-private': 10: Private security/authorization; 'ftp': 11: FTP; 'ntp': 12: NTP; 'audit': 13: Audit; 'alert': 14: Alert; 'clock': 15: Clock-related; 'local0': 16: Local use 0; 'local1': 17: Local use 1; 'local2': 18: Local use 2; 'local3': 19: Local use 3; 'local4': 20: Local use 4; 'local5': 21: Local use 5; 'local6': 22: Local use 6; 'local7': 23: Local use 7; ", "enum":[ "kernel", "user", "mail", "daemon", "security-authorization", "syslog", "line-printer", "news", "uucp", "cron", "security-authorization-private", "ftp", "ntp", "audit", "alert", "clock", "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7" ], "optional":true }, "severity":{ "type":"object", "properties":{ "severity-string":{ "type":"string", "format":"enum", "default":"debug", "partition-visibility":"shared", "not":"severity-val", "description":"'emergency': 0: Emergency; 'alert': 1: Alert; 'critical': 2: Critical; 'error': 3: Error; 'warning': 4: Warning; 'notice': 5: Notice; 'informational': 6: Informational; 'debug': 7: Debug; ", "enum":[ "emergency", "alert", "critical", "error", "warning", "notice", "informational", "debug" ] }, "severity-val":{ "type":"number", "format":"number", "minimum":0, "maximum":7, "default":7, "partition-visibility":"shared", "not":"severity-string", "description":"Logging severity level" } } }, "format":{ "type":"string", "format":"enum", "default":"default", "partition-visibility":"shared", "description":"'binary': Binary logging format; 'compact': Compact ASCII logging format (Hex format with compact representation); 'custom': Arbitrary custom logging format; 'default': Default A10 logging format (ASCII); 'rfc5424': RFC5424 compliant logging format; 'cef': Common Event Format for logging; ", "enum":[ "binary", "compact", "custom", "default", "rfc5424", "cef" ], "optional":true }, "batched-logging-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable multiple logs per packet", "optional":true }, "log-receiver":{ "type":"object", "properties":{ "radius":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use RADIUS server for NAT logging" }, "secret-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"The RADIUS server's secret" }, "encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)" } } }, "service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Set NAT logging service-group", "optional":true }, "shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "description":"Service group is in shared patition", "optional":true }, "source-port":{ "type":"object", "properties":{ "source-port-num":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":514, "partition-visibility":"shared", "not":"any", "description":"Set source port for sending NAT syslogs (default: 514)" }, "any":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"source-port-num", "description":"Use any source port" } } }, "rfc-custom":{ "type":"object", "properties":{ "header":{ "type":"object", "properties":{ "use-alternate-timestamp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use alternate non-RFC5424 compliant timestamp. Ex: 1990 Jan 15 12:30:30" } } }, "message":{ "type":"object", "properties":{ "ipv6-tech":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "tech-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'lsn': LSN; 'nat64': NAT64; 'ds-lite': DS-Lite; 'sixrd-nat64': 6rd-NAT64; ", "enum":[ "lsn", "nat64", "ds-lite", "sixrd-nat64" ] }, "fixed-nat-allocated":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Fixed-NAT allocated (Custom message string. Should be in the format of \"MSGID [STRUCTURED-DATA] MSG\")" }, "fixed-nat-freed":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Fixed-NAT freed (Custom message string. Should be in the format of \"MSGID [STRUCTURED-DATA] MSG\")" }, "port-allocated":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port allocated (Custom message string. Should be in the format of \"MSGID [STRUCTURED-DATA] MSG\")" }, "port-freed":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port freed (Custom message string. Should be in the format of \"MSGID [STRUCTURED-DATA] MSG\")" }, "port-batch-allocated":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port Batch allocated (Custom message string. Should be in the format of \"MSGID [STRUCTURED-DATA] MSG\")" }, "port-batch-freed":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port Batch freed (Custom message string. Should be in the format of \"MSGID [STRUCTURED-DATA] MSG\")" }, "port-batch-v2-allocated":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port Batch v2 allocated (Custom message string. Should be in the format of \"MSGID [STRUCTURED-DATA] MSG\")" }, "port-batch-v2-freed":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port Batch v2 freed (Custom message string. Should be in the format of \"MSGID [STRUCTURED-DATA] MSG\")" } } } ] }, "dhcpv6-map-prefix-assigned":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"MAP DHCPv6 prefix assigned" }, "dhcpv6-map-prefix-released":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"MAP DHCPv6 prefix released" }, "dhcpv6-map-prefix-renewed":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"MAP DHCPv6 prefix renewed" }, "http-request-got":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"HTTP request got (Custom message string. Should be in the format of \"MSGID [STRUCTURED-DATA] MSG\")" }, "session-created":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Session created (Custom message string. Should be in the format of \"MSGID [STRUCTURED-DATA] MSG\")" }, "session-deleted":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Session deleted (Custom message string. Should be in the format of \"MSGID [STRUCTURED-DATA] MSG\")" } } } } }, "custom":{ "type":"object", "properties":{ "custom-header":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'use-syslog-header': Use syslog header as custom log header; ", "enum":[ "use-syslog-header" ] }, "custom-message":{ "type":"object", "properties":{ "custom-dhcpv6-map-prefix-assigned":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"MAP DHCPv6 prefix assigned" }, "custom-dhcpv6-map-prefix-released":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"MAP DHCPv6 prefix released" }, "custom-dhcpv6-map-prefix-renewed":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"MAP DHCPv6 prefix renewed" }, "custom-fixed-nat-allocated":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Fixed-NAT allocated (Custom message string)" }, "custom-fixed-nat-interim-update":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Fixed-NAT interim update (Custom message string)" }, "custom-fixed-nat-freed":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Fixed-NAT freed (Custom message string)" }, "custom-http-request-got":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"HTTP request got (Custom message string)" }, "custom-port-allocated":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port allocated (Custom message string)" }, "custom-port-batch-allocated":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port Batch allocated (Custom message string)" }, "custom-port-batch-freed":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port Batch freed (Custom message string)" }, "custom-port-batch-v2-allocated":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port Batch v2 allocated (Custom message string)" }, "custom-port-batch-v2-freed":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port Batch v2 freed (Custom message string)" }, "custom-port-batch-v2-interim-update":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port Batch v2 interim update (Custom message string)" }, "custom-port-freed":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Port freed (Custom message string)" }, "custom-session-created":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Session created (Custom message string)" }, "custom-session-deleted":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Session deleted (Custom message string)" } } }, "custom-time-stamp-format":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Customize the time stamp format (Customize the time-stamp format. Default:%Y%m%d%H%M%S)" } } }, "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 }, "source-address":{ "type":"object", "$ref":"/axapi/v3/cgnv6/template/logging/{name}/source-address", "properties":{ "ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Specify source IP address" }, "ipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"Specify source IPv6 address" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "disable-log-by-destination":{ "type":"object", "$ref":"/axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination", "properties":{ "tcp-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "tcp-port-start":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Destination Port (Single Destination Port or Port Range Start)" }, "tcp-port-end":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Port Range End" } } } ] }, "udp-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "udp-port-start":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Destination Port (Single Destination Port or Port Range Start)" }, "udp-port-end":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Port Range End" } } } ] }, "icmp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable logging for icmp traffic" }, "others":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable logging for other L4 protocols" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "ip-list":{ "type":"array", "minItems":1, "items":{ "type":"ip" }, "uniqueItems":true, "$ref":"/axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination/ip/{ipv4-addr}", "array":[ { "properties":{ "ipv4-addr":{ "type":"string", "format":"ipv4-cidr", "partition-visibility":"shared", "description":"Configure an IP subnet", "optional":false }, "tcp-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "tcp-port-start":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Destination Port (Single Destination Port or Port Range Start)" }, "tcp-port-end":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Port Range End" } } } ] }, "udp-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "udp-port-start":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Destination Port (Single Destination Port or Port Range Start)" }, "udp-port-end":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Port Range End" } } } ] }, "icmp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable logging for icmp traffic", "optional":true }, "others":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable logging for other L4 protocols", "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":[ "ipv4-addr" ] } ] }, "ip6-list":{ "type":"array", "minItems":1, "items":{ "type":"ip6" }, "uniqueItems":true, "$ref":"/axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination/ip6/{ipv6-addr}", "array":[ { "properties":{ "ipv6-addr":{ "type":"string", "format":"ipv6-address-plen", "partition-visibility":"shared", "description":"Configure an IPv6 subnet", "optional":false }, "tcp-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "tcp-port-start":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Destination Port (Single Destination Port or Port Range Start)" }, "tcp-port-end":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Port Range End" } } } ] }, "udp-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "udp-port-start":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Destination Port (Single Destination Port or Port Range Start)" }, "udp-port-end":{ "type":"number", "format":"number", "partition-visibility":"shared", "description":"Port Range End" } } } ] }, "icmp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable logging for icmp traffic", "optional":true }, "others":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable logging for other L4 protocols", "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":[ "ipv6-addr" ] } ] } } } }, "required":[ "name" ] } ] }, "pcp-list":{ "type":"array", "minItems":1, "items":{ "type":"pcp" }, "uniqueItems":true, "$ref":"/axapi/v3/cgnv6/template/pcp/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"PCP Template name", "optional":false }, "allow-third-party-from-lan":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Allow third party request coming from LAN (default is disabled)", "optional":true }, "allow-third-party-from-wan":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Allow third party request coming from WAN (default is disabled)", "optional":true }, "check-client-nonce":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"To validate NONCE value in PCP request (default: disabled)", "optional":true }, "disable-map-filter":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"To disable processing of FILTER options in MAP request", "optional":true }, "announce":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"PCP ANNOUNCE Opcode (default is enabled)", "optional":true }, "map":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"PCP MAP Opcode (default is enabled)", "optional":true }, "peer":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"PCP PEER Opcode (default is enabled)", "optional":true }, "maximum":{ "type":"number", "format":"number", "minimum":2, "maximum":1440, "default":1440, "partition-visibility":"shared", "description":"To set maximum lifetime of PCP mappings (default 1440 minutes)", "optional":true }, "minimum":{ "type":"number", "format":"number", "minimum":2, "maximum":1440, "default":2, "partition-visibility":"shared", "description":"To set minimum lifetime of PCP mappings (default 2 minutes)", "optional":true }, "pcp-server-port":{ "type":"number", "format":"number", "minimum":1024, "maximum":65535, "default":5351, "partition-visibility":"shared", "description":"PCP server listening port (default 5351) (PCP UDP destination port)", "optional":true }, "source-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Specify source IP address for IPv4 ANNOUNCE message", "optional":true }, "source-ipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"Specify source IPv6 address for IPv6 ANNOUNCE message", "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" ] } ] }, "http-alg-list":{ "type":"array", "minItems":1, "items":{ "type":"http-alg" }, "uniqueItems":true, "$ref":"/axapi/v3/cgnv6/template/http-alg/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"HTTP-ALG template name", "optional":false }, "request-insert-client-ip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Insert Client IP into HTTP request", "optional":true }, "header-name-client-ip":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "default":"X-Forwarded-For", "partition-visibility":"shared", "description":"Header name (default: X-Forwarded-For)", "optional":true }, "include-tunnel-ip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Include the tunnel IP (applies to DS-Lite and 6RD-NAT64 sessions)", "optional":true }, "method":{ "type":"string", "format":"enum", "default":"append", "partition-visibility":"shared", "description":"'append': Append if there is already a header (default); 'replace': Replace if there is already a header; ", "enum":[ "append", "replace" ], "optional":true }, "request-insert-msisdn":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Insert MSISDN into HTTP request", "optional":true }, "header-name-msisdn":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "default":"X-MSISDN", "partition-visibility":"shared", "description":"Header name (default: X-MSISDN)", "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" ] } ] } } }