{
    "id":"/axapi/v3/slb/template/sip/{name}",
    "type":"object",
    "node-type":"list",
    "title":"sip",
    "partition-visibility":"shared",
    "description":"SIP Template",
    "properties":{
        "name":{
            "type":"string",
            "format":"string-rlx",
            "minLength":1,
            "maxLength":127,
            "partition-visibility":"shared",
            "description":"SIP Template Name",
            "optional":false
        },
        "alg-source-nat":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Translate source IP to NAT IP in SIP message when source NAT is used",
            "optional":true
        },
        "alg-dest-nat":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Translate VIP to real server IP in SIP message when destination NAT is used",
            "optional":true
        },
        "call-id-persist-disable":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Disable call-ID persistence",
            "optional":true
        },
        "client-keep-alive":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Respond client keep-alive packet directly instead of forwarding to server",
            "optional":true
        },
        "pstn-gw":{
            "type":"string",
            "format":"string-rlx",
            "minLength":1,
            "maxLength":63,
            "default":"pstn",
            "partition-visibility":"shared",
            "description":"configure pstn gw host name for tel: uri translate to sip: uri (Hostname String, default is \"pstn\")",
            "optional":true
        },
        "client-request-header":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object"
            },
            "uniqueItems":true,
            "array":[
                {
                    "properties":{
                        "client-request-header-erase":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"Erase a SIP header (Header Name)"
                        },
                        "client-request-erase-all":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Erase all headers"
                        },
                        "client-request-header-insert":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"Insert a SIP header (Header Content (Format: \"name:value\"))"
                        },
                        "insert-condition-client-request":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; ",
                            "enum":[
                                "insert-if-not-exist",
                                "insert-always"
                            ]
                        }
                    }
                }
            ]
        },
        "client-response-header":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object"
            },
            "uniqueItems":true,
            "array":[
                {
                    "properties":{
                        "client-response-header-erase":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"Erase a SIP header (Header Name)"
                        },
                        "client-response-erase-all":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Erase all headers"
                        },
                        "client-response-header-insert":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"Insert a SIP header (Header Content (Format: \"name:value\"))"
                        },
                        "insert-condition-client-response":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; ",
                            "enum":[
                                "insert-if-not-exist",
                                "insert-always"
                            ]
                        }
                    }
                }
            ]
        },
        "exclude-translation":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object"
            },
            "uniqueItems":true,
            "array":[
                {
                    "properties":{
                        "translation-value":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'start-line': SIP request line or status line; 'header': SIP message headers; 'body': SIP message body; ",
                            "enum":[
                                "start-line",
                                "header",
                                "body"
                            ]
                        },
                        "header-string":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"SIP header name"
                        }
                    }
                }
            ]
        },
        "failed-client-selection":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Define action when select client fail",
            "optional":true
        },
        "drop-when-client-fail":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "not":"failed-client-selection-message",
            "description":"Drop current SIP message when select client fail",
            "optional":true
        },
        "failed-client-selection-message":{
            "type":"string",
            "format":"string-rlx",
            "minLength":1,
            "maxLength":63,
            "partition-visibility":"shared",
            "not":"drop-when-client-fail",
            "description":"Send SIP message (includs status code) to server when select client fail(Format: 3 digits(1XX~6XX) space reason)",
            "optional":true
        },
        "failed-server-selection":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Define action when select server fail",
            "optional":true
        },
        "drop-when-server-fail":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "not":"failed-server-selection-message",
            "description":"Drop current SIP message when select server fail",
            "optional":true
        },
        "failed-server-selection-message":{
            "type":"string",
            "format":"string-rlx",
            "minLength":1,
            "maxLength":63,
            "partition-visibility":"shared",
            "not":"drop-when-server-fail",
            "description":"Send SIP message (includs status code) to client when select server fail(Format: 3 digits(1XX~6XX) space reason)",
            "optional":true
        },
        "insert-client-ip":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Insert Client IP address into SIP header",
            "optional":true
        },
        "keep-server-ip-if-match-acl":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Use Real Server IP for addresses matching the ACL for a Call-Id",
            "optional":true
        },
        "acl-id":{
            "type":"number",
            "format":"number",
            "minimum":100,
            "maximum":199,
            "partition-visibility":"shared",
            "$ref":"/axapi/v3/access-list/standard",
            "not":"acl-name-value",
            "description":"ACL id",
            "optional":true
        },
        "acl-name-value":{
            "type":"string",
            "format":"string",
            "minLength":1,
            "maxLength":16,
            "partition-visibility":"shared",
            "$ref":"/axapi/v3/ip/access-list",
            "not":"acl-id",
            "description":"IPv4 Access List Name",
            "optional":true
        },
        "service-group":{
            "type":"string",
            "format":"string-rlx",
            "minLength":1,
            "maxLength":127,
            "partition-visibility":"shared",
            "$ref":"/axapi/v3/slb/service-group",
            "description":"service group name",
            "optional":true
        },
        "server-keep-alive":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Send server keep-alive packet for every persist connection when enable conn-reuse",
            "optional":true
        },
        "interval":{
            "type":"number",
            "format":"number",
            "minimum":5,
            "maximum":300,
            "default":30,
            "partition-visibility":"shared",
            "description":"The interval of keep-alive packet for each persist connection (second)",
            "optional":true
        },
        "server-request-header":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object"
            },
            "uniqueItems":true,
            "array":[
                {
                    "properties":{
                        "server-request-header-erase":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"Erase a SIP header (Header Name)"
                        },
                        "server-request-erase-all":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Erase all headers"
                        },
                        "server-request-header-insert":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"Insert a SIP header (Header Content (Format: \"name:value\"))"
                        },
                        "insert-condition-server-request":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; ",
                            "enum":[
                                "insert-if-not-exist",
                                "insert-always"
                            ]
                        }
                    }
                }
            ]
        },
        "server-response-header":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object"
            },
            "uniqueItems":true,
            "array":[
                {
                    "properties":{
                        "server-response-header-erase":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"Erase a SIP header (Header Name)"
                        },
                        "server-response-erase-all":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Erase all headers"
                        },
                        "server-response-header-insert":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"Insert a SIP header (Header Content (Format: \"name:value\"))"
                        },
                        "insert-condition-server-response":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; ",
                            "enum":[
                                "insert-if-not-exist",
                                "insert-always"
                            ]
                        }
                    }
                }
            ]
        },
        "smp-call-id-rtp-session":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Create the across cpu call-id rtp session",
            "optional":true
        },
        "server-selection-per-request":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Force server selection on every SIP request",
            "optional":true
        },
        "timeout":{
            "type":"number",
            "format":"number",
            "minimum":1,
            "maximum":250,
            "default":30,
            "partition-visibility":"shared",
            "description":"Time in minutes",
            "optional":true
        },
        "dialog-aware":{
            "type":"number",
            "format":"flag",
            "default":0,
            "partition-visibility":"shared",
            "description":"Permit system processes dialog session",
            "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
        }
    },
    "object-keys":[
        "name"
    ],
    "required":[
        "name"
    ]
}