1. REST API for Oracle Cloud Native Session Border Controller, Release 1.25.1
  2. Tasks
  3. Configuration Management: Admin

Replace the entire configuration on topic: SD

put

https://cloud-native-SBC-IP/config/v1/sd

Replace the entire configuration on topic: SD

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Topic SD configurations
Show Source
Nested Schema : access-control
Type: array
Show Source
Nested Schema : AccountingConfig
Type: object
configure Quality of Service accounting
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • cdr-attribute-include-list
    list of cdr attributes to be included in accounting file
  • activate writing of comma delimited records
  • Minimum Value: 0
    Maximum Value: 2147483647
    file rotation/push interval (minutes) (0 disables)
  • append 9-digit sequence number to CDR file names
  • generate-event
    list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)
  • generate-interim
    list of events to collect during a session
  • Allowed Values: [ "None", "Invite", "OK" ]
  • Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$
    hostname of this system
  • Minimum Value: 0
    Maximum Value: 2147483647
    periodic interim record interval (seconds)
  • Minimum Value: 1048576
    Maximum Value: 1073741824
    maximum file size (bytes), should be >= 1048576 bytes and <= 1073741824 bytes
  • administrative state
  • transmit data at session close
Nested Schema : AdministrativeConfig
Type: object
Configure parameters which controls administrative flow
Show Source
Nested Schema : allowed-elements-profile
Type: array
Show Source
Nested Schema : authentication-profile
Type: array
Show Source
Nested Schema : codec-policy
Type: array
Show Source
Nested Schema : enforcement-profile
Type: array
Show Source
Nested Schema : enum-config
Type: array
Show Source
Nested Schema : hmr-test-message
Type: array
Show Source
Nested Schema : hmr-test-profile
Type: array
Show Source
Nested Schema : http-client
Type: array
Show Source
Nested Schema : HttpConfig
Type: object
modifying tcp Connections settings
Show Source
Nested Schema : local-policy
Type: array
Show Source
Nested Schema : SipLocalMap
Type: object
configure Local SIP response maps
Show Source
Nested Schema : local-routing-config
Type: array
Show Source
Nested Schema : MediaRouter
Type: object
configure media policy, attributes, and settings
Show Source
Nested Schema : media-policy
Type: array
Show Source
Nested Schema : media-profile
Type: array
Show Source
Nested Schema : media-sec-policy
Type: array
Show Source
Nested Schema : Q850SipMap
Type: object
configure q850 to sip maps
Show Source
Nested Schema : qos-constraints
Type: array
Show Source
Nested Schema : realm-config
Type: array
Show Source
Nested Schema : realm-group
Type: array
Show Source
Nested Schema : response-map
Type: array
Show Source
Nested Schema : rtcp-policy
Type: array
Show Source
Nested Schema : sdes-profile
Type: array
Show Source
Nested Schema : SecurityConfig
Type: object
configure security configurations
Show Source
Nested Schema : session-agent
Type: array
Show Source
Nested Schema : session-agent-id-rule
Type: array
Show Source
Nested Schema : session-constraints
Type: array
Show Source
Nested Schema : session-group
Type: array
Show Source
Nested Schema : SessionRouter
Type: object
configure session router
Show Source
Nested Schema : session-timer-profile
Type: array
Show Source
Nested Schema : session-translation
Type: array
Show Source
Nested Schema : sip-adv-log-trace
Type: array
Show Source
Nested Schema : SipConfig
Type: object
configure signaling and session management
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • add Reason header to CANCEL/BYE
  • enable adding of UCID header to messages
  • Allowed Values: [ "inherit", "disabled", "enabled" ]
  • If enabled, HistoryInfo and Diversion headers will be anonymized for untrusted peer
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    auto config realm identifier
  • creation of dynamic Session Agents for Service-Route
  • preserve Call-IDs and tags
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    default egress realm identifier
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of enforcement profile
  • state
  • track enum stats per server address
  • track method stats for more entities
  • Allowed Values: [ "inherit", "disabled", "enabled" ]
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    home realm identifier
  • Minimum Value: 0
    Maximum Value: 4294967295
    inactive dynamic disconnect value (seconds), 0 to disable
  • Minimum Value: 0
    Maximum Value: 4294967295
    initial request retransmission timer (TIMER_T1) (milliseconds)
  • Minimum Value: 0
    Maximum Value: 999999999
    Transaction expiration time <TIMER_B> for initial INVITE (0 = Fall back to sip-config initial-inv-trans-expire)
  • Minimum Value: 0
    Maximum Value: 4294967295
    INVITE transaction expiration timer (TIMER_C) (seconds)
  • Minimum Value: 0
    Maximum Value: 4294967295
    maximum request retransmission timer (TIMER_T2) (milliseconds)
  • Allowed Values: [ "None", "Public", "Private" ]
  • Allowed Values: [ "disabled", "stateless", "transaction", "session", "dialog" ]
  • optional features/parameters
  • enable GRUU contact pass through
  • proxy-sub-events
    Unique Items Required: true
    subscription events to do in proxy mode
  • Set this value to enabled for the SBC to not include SDP in the reINVITE to the transfer target. This is used in REFER with Replace scenarios
  • enable refer source realm routing
  • Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\*?)$
    domain name of SIP registrar server
  • Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\*?)$
    hostname of SIP registrar server
  • Minimum Value: 0
    Maximum Value: 65535
    port number of SIP registrar server
  • Map Rx disconnect events to SIP reason header
  • track SA stats for DNS-resolved routes
  • enable lookup of SAG name on a redirect
  • Minimum Value: 1
    Maximum Value: 2073600
    maximum life limit a SIP session can stay active (secs). Range 1-2073600.
  • enable if disconnect time is set on receiving BYE request
  • Minimum Value: 0
    Maximum Value: 65535
    max sip message length
  • Minimum Value: 0
    Maximum Value: 999999999
    transaction expiration timer (TIMER_B,D,F,H,J) (seconds)
  • user-agent string to be added to SIP User-Agent header
Nested Schema : sip-feature
Type: array
Show Source
Nested Schema : sip-interface
Type: array
Show Source
Nested Schema : sip-manipulation
Type: array
Show Source
Nested Schema : sip-nat
Type: array
Show Source
Nested Schema : sip-profile
Type: array
Show Source
Nested Schema : SipQ850Map
Type: object
configure sip to q850 maps
Show Source
Nested Schema : sip-recursion-policy
Type: array
Show Source
Nested Schema : SplConfig
Type: object
add or modify an SPL plug-in
Show Source
Nested Schema : steering-pool
Type: array
Show Source
Nested Schema : steering-pool-ip-list
Type: array
Show Source
Nested Schema : StiConfig
Type: object
configure global parameters for STIR/SHAKEN
Show Source
Nested Schema : sti-header-mapping-ruleset
Type: array
Show Source
Nested Schema : StiHeartbeatConfig
Type: object
configure global parameters for STIR/SHAKEN heartbeat message
Show Source
Nested Schema : sti-response-treatment-config
Type: array
Show Source
Nested Schema : sti-server
Type: array
Show Source
Nested Schema : sti-server-group
Type: array
Show Source
Nested Schema : te-steering-pool-ip-list
Type: array
Show Source
Nested Schema : TLSGlobal
Type: object
configure session caching for all TLS functions
Show Source
Nested Schema : tls-profile
Type: array
Show Source
Nested Schema : translation-rules
Type: array
Show Source
Nested Schema : xcode-me-steering-pool
Type: array
Show Source
Nested Schema : xcode-te-steering-pool
Type: array
Show Source
Nested Schema : AccessControl
Type: object
configure a static or dynamic access control list
Show Source
Nested Schema : FlowAddress
Type: object
destination ip address
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Minimum Length: 1
  • Minimum Value: 0
    Maximum Value: 65535
    Enter a number in the range 0..65535. This will be an optional port number for both IPv4 and IPv6 addresses, (range: 0-65535 for both IPv4 and IPv6), e.g. 5000
  • Minimum Value: 0
    Maximum Value: 128
    Enter a number in the range 0..128. This will be an optional CIDR prefix for an IPv4 or IPv6 address (range: 0-32 for an IPv4 address) (range: 0-128 for an IPv6 address), e.g. 16(for IPv4) and 64(for IPv6)
  • Minimum Value: 0
    Maximum Value: 16
    Enter a number in the range 0..16. This will be an optional CIDR prefix for the port, (range: 0-16 for both IPv4 and IPv6), e.g. 14
Nested Schema : cdr-attribute-include-list
Type: array
list of cdr attributes to be included in accounting file
Show Source
  • Allowed Values: [ "Access_Network_Information", "Accounting_Session_ID", "Accounting_Session_Time", "Accounting_Status", "Accounting_Termination_Cause", "ApplicationId", "Associated_URI", "Called_Asserted_Identity", "Called_MOS", "Called_R_Factor", "Called_Station_ID", "Calling_MOS", "Calling_R_Factor", "Calling_Station_ID", "Cause_Code", "CDR_Sequence_Number", "Charging_Function_Address", "Charging_Vector_ICID", "Cisco_Connect_Time", "Cisco_Disconnect_Cause", "Cisco_Disconnect_Time", "Cisco_Setup_Time", "Content_Disposition", "Custom_VSA_200", "Custom_VSA_201", "Custom_VSA_202", "Custom_VSA_203", "Custom_VSA_204", "Custom_VSA_205", "Custom_VSA_206", "Custom_VSA_207", "Custom_VSA_208", "Custom_VSA_209", "Custom_VSA_210", "Custom_VSA_211", "Custom_VSA_212", "Custom_VSA_213", "Custom_VSA_214", "Custom_VSA_215", "Custom_VSA_216", "Custom_VSA_217", "Custom_VSA_218", "Custom_VSA_219", "Custom_VSA_220", "Custom_VSA_221", "Custom_VSA_222", "Custom_VSA_223", "Custom_VSA_224", "Custom_VSA_225", "Custom_VSA_226", "Custom_VSA_227", "Custom_VSA_228", "Custom_VSA_229", "Custom_VSA_230", "Destination_Host", "Destination_Realm", "Diam_Session_Id", "Disconnect_Cause", "Disconnect_Initiator", "Early_SDP_Media", "Early_SDP_Type", "Egress_Local_Address", "Egress_Network_Interface_ID", "Egress_Realm", "Egress_Remote_Address", "Egress_Routing_Number", "Egress_RPH", "Egress_Session_ID", "Egress_Vlan_Tag_Value", "Event", "Event_Time", "Expires", "Firmware_Version", "FS1_Called_Media_Stop_Time", "FS1_Calling_Media_Stop_Time", "FS1_F_Flow_Identifier", "FS1_F_Flow_Input_Dest_Address", "FS1_F_Flow_Input_Dest_Port", "FS1_F_Flow_Input_Realm", "FS1_F_Flow_Input_Src_Addr", "FS1_F_Flow_Input_Src_Port", "FS1_F_Flow_Media_Type", "FS1_F_Flow_Output_Dest_Addr", "FS1_F_Flow_Output_Dest_Port", "FS1_F_Flow_Output_Realm", "FS1_F_Flow_Output_Src_Address", "FS1_F_Flow_Output_Src_Port", "FS1_F_Flow_Type", "FS1_R_Flow_Identifier", "FS1_R_Flow_Input_Dest_Address", "FS1_R_Flow_Input_Dest_Port", "FS1_R_Flow_Input_Realm", "FS1_R_Flow_Input_Src_Addr", "FS1_R_Flow_Input_Src_Port", "FS1_R_Flow_Media_Type", "FS1_R_Flow_Output_Dest_Addr", "FS1_R_Flow_Output_Dest_Port", "FS1_R_Flow_Output_Realm", "FS1_R_Flow_Output_Src_Address", "FS1_R_Flow_Output_Src_Port", "FS1_R_Flow_Type", "FS1_RTCP_Called_Avg_Jitter", "FS1_RTCP_Called_Avg_Latency", "FS1_RTCP_Called_Max_Jitter", "FS1_RTCP_Called_Max_Latency", "FS1_RTCP_Called_Packets_Lost", "FS1_RTCP_Calling_Avg_Jitter", "FS1_RTCP_Calling_Avg_Latency", "FS1_RTCP_Calling_Max_Jitter", "FS1_RTCP_Calling_Max_Latency", "FS1_RTCP_Calling_Packets_Lost", "FS1_RTP_Called_Avg_Jitter", "FS1_RTP_Called_Max_Jitter", "FS1_RTP_Called_Octets", "FS1_RTP_Called_Octets_Transmitted", "FS1_RTP_Called_Packets", "FS1_RTP_Called_Packets_Lost", "FS1_RTP_Called_Packets_Transmitted", "FS1_RTP_Calling_Avg_Jitter", "FS1_RTP_Calling_Max_Jitter", "FS1_RTP_Calling_Octets", "FS1_RTP_Calling_Octets_Transmitted", "FS1_RTP_Calling_Packets", "FS1_RTP_Calling_Packets_Lost", "FS1_RTP_Calling_Packets_Transmitted", "FS2_Called_Media_Stop_Time", "FS2_Calling_Media_Stop_Time", "FS2_F_Flow_Identifier", "FS2_F_Flow_Input_Dest_Address", "FS2_F_Flow_Input_Dest_Port", "FS2_F_Flow_Input_Realm", "FS2_F_Flow_Input_Src_Addr", "FS2_F_Flow_Input_Src_Port", "FS2_F_Flow_Media_Type", "FS2_F_Flow_Output_Dest_Addr", "FS2_F_Flow_Output_Dest_Port", "FS2_F_Flow_Output_Realm", "FS2_F_Flow_Output_Src_Address", "FS2_F_Flow_Output_Src_Port", "FS2_F_Flow_Type", "FS2_R_Flow_Identifier", "FS2_R_Flow_Input_Dest_Address", "FS2_R_Flow_Input_Dest_Port", "FS2_R_Flow_Input_Realm", "FS2_R_Flow_Input_Src_Addr", "FS2_R_Flow_Input_Src_Port", "FS2_R_Flow_Media_Type", "FS2_R_Flow_Output_Dest_Addr", "FS2_R_Flow_Output_Dest_Port", "FS2_R_Flow_Output_Realm", "FS2_R_Flow_Output_Src_Address", "FS2_R_Flow_Output_Src_Port", "FS2_R_Flow_Type", "FS2_RTCP_Called_Avg_Jitter", "FS2_RTCP_Called_Avg_Latency", "FS2_RTCP_Called_Max_Jitter", "FS2_RTCP_Called_Max_Latency", "FS2_RTCP_Called_Packets_Lost", "FS2_RTCP_Calling_Avg_Jitter", "FS2_RTCP_Calling_Avg_Latency", "FS2_RTCP_Calling_Max_Jitter", "FS2_RTCP_Calling_Max_Latency", "FS2_RTCP_Calling_Packets_Lost", "FS2_RTP_Called_Avg_Jitter", "FS2_RTP_Called_Max_Jitter", "FS2_RTP_Called_Octets", "FS2_RTP_Called_Octets_Transmitted", "FS2_RTP_Called_Packets", "FS2_RTP_Called_Packets_Lost", "FS2_RTP_Called_Packets_Transmitted", "FS2_RTP_Calling_Avg_Jitter", "FS2_RTP_Calling_Max_Jitter", "FS2_RTP_Calling_Octets", "FS2_RTP_Calling_Octets_Transmitted", "FS2_RTP_Calling_Packets", "FS2_RTP_Calling_Packets_Lost", "FS2_RTP_Calling_Packets_Transmitted", "Generic_ID", "History_Info", "IMEI", "IMSI", "Ingress_Local_Address", "Ingress_Network_Interface_ID", "Ingress_Realm", "Ingress_Remote_Address", "Ingress_RPH", "Ingress_Session_ID", "Ingress_Vlan_Tag_Value", "Intermediate_Time", "Local_timezone", "MSRP_Called_Octets", "MSRP_Called_Octets_Transmitted", "MSRP_Called_Packets", "MSRP_Called_Packets_Transmitted", "MSRP_Calling_Octets", "MSRP_Calling_Octets_Transmitted", "MSRP_Calling_Packets", "MSRP_Calling_Packets_Transmitted", "NAS_IP_Address", "NAS_Port", "Node_Func", "Node_Functionality", "ORIG_IOI", "Origin_Host", "Origin_Realm", "Originating_Trunk_Context", "Originating_Trunk_Group", "Originator", "P_Asserted_ID", "P_Visited_Network_ID", "PGW_IP_Address", "Post_Dial_Delay", "Primary_routing_Number", "refer_call_transfer_ID", "Role_Of_Node", "SDP_Answer_Timestamp", "SDP_Media", "SDP_Offer_Timestamp", "SDP_Type", "Served_Party_IP", "Service_Context_ID", "Session_Disposition", "Session_Forked_Call_Id", "Session_Protocol_Type", "SGW_IP_Address", "SIP_DIVERSION", "Sip_Method", "Sip_Status_Code", "Sms_Called_Party_Number", "Sms_Calling_Party_Number", "Sms_Msg_length", "Sms_Msg_Type", "Stir_Div_Signed_Request", "Stir_Div_Verified_Request", "Stir_Signed_Request", "Stir_Signed_Request_Exception_Id", "Stir_TN_Used_For_AS_VS_Request", "Stir_Verified_Request", "Stir_Verified_Request_Exception_Id", "Stir_VS_Invite_State", "Stir_VS_Reason", "Stir_VS_Verstat", "Subscription_ID_Data", "Subscription_ID_Type", "TERM_IOI", "Terminating_Trunk_Context", "Terminating_Trunk_Group", "User_Name" ]
Nested Schema : generate-event
Type: array
list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)
Show Source
Nested Schema : generate-interim
Type: array
list of events to collect during a session
Show Source
  • Allowed Values: [ "OK", "Reinvite", "Reinvite-Response", "Reinvite-Cancel", "Unsuccessful-Attempt", "Redirect", "Egress-Invite" ]
Nested Schema : icmp-config
Type: array
Control ICMP ping by setting up an ICMP config object
Show Source
Nested Schema : IcmpConfig
Type: object
Configure this object to enable ping on the ip's selected
Show Source
Nested Schema : allowed-ip-list
Type: array
Add IPs to enable ping, Must be within the service network CIDR range
Show Source
Nested Schema : AllowlistConfig
Type: object
configure allowed elements profiles
Show Source
Nested Schema : allow-any
Type: array
Unique Items Required: true
set of default headers
Show Source
Nested Schema : rule-sets
Type: array
Unique Items Required: true
list of rule-sets
Show Source
Nested Schema : WLRuleSetConfig
Type: object
list of rule-sets
Show Source
Nested Schema : header-rules
Type: array
list of header-rules
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods to which the rule applies (applies to all methods when none are specified)
Show Source
Nested Schema : WLHeaderRuleConfig
Type: object
list of header-rules
Show Source
Nested Schema : allow-header-param
Type: array
Unique Items Required: true
the list of header parameters which are allowed, where * implies all are allowed
Show Source
Nested Schema : allow-uri-header-name
Type: array
Unique Items Required: true
the list of URI header names which are allowed, where * implies all are allowed
Show Source
Nested Schema : allow-uri-param
Type: array
Unique Items Required: true
the list of URI parameters which are allowed, where * implies all are allowed
Show Source
Nested Schema : allow-uri-user-param
Type: array
Unique Items Required: true
the list of URI user parameters which are allowed, where * implies all are allowed
Show Source
Nested Schema : AuthenticationProfile
Type: object
configure authentication profile
Show Source
Nested Schema : preshared-key
authentication password
Match All
authentication password
Show Source
Nested Schema : CodecPolicyConfig
Type: object
create and apply a codec policy to a realm and an agent
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • add-codecs-on-egress
    Specify which codecs to add. The add-codecs are only processed by the outgoing policy. Only codecs that can be transcoded may be specified. No transcodable codecs available with current system configuration.
  • allow-codecs
    Specify which codecs to allow. Specify exceptions with the :no tag. Two special type exceptions are accepted: video:no and audio:no. For example, to allow all codecs except iLBC and video: allow-codecs * iLBC:no video:no. If a codec is given a :force tag, it indicates that if the specified codec is present in the incoming offer, all non-force codecs are stripped out.
  • Allowed Values: [ "disabled", "preferred", "dual" ]
  • Enable transcode of EVRC TTY TDD to BAUDOT in EVRC-G.711 transcoded calls
  • Allowed Values: [ "disabled", "image_first", "audio_first" ]
  • Force a specific ptime on the egress offer. Enable this to ensure the ptime specified in 'packetization-time' is used.
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of the codec-policy
  • order-codecs
    Specify the order of the codecs. Matching codecs will be arranged in the SDP media description according to the specified order. Any remaining codecs will be subsequently added to the list, maintaining their original relative order as in the incoming media offer. A wildcard (*) anchors the ordering to either the start or the end of the list. For example - A B C * specifies the relative ordering of the first three codecs. * A B C specifies the relative ordering of the last three codecs. A B * C D indicates a sort of head and tail of the codec list, with everything else placed in between.
  • Minimum Value: 0
    Maximum Value: 4294967295
    This specifies the packetization time (ptime) to use in outgoing SDP offers when 'force-ptime' is enabled. The valid ptime values for each codec are as follows: PCMU 10 20 30 40 50 60, PCMA 10 20 30 40 50 60, G729 10 20 30 40 50 60, G729A 10 20 30 40 50 60, iLBC 20 30 40 60, G726 10 20 30 40 50, G726-16 10 20 30 40 50, G726-24 10 20 30 40 50, G726-32 10 20 30 40 50, G726-40 10 20 30 40 50, G723 30 60 90, G722 20 40, AMR 20 40 60, AMR-WB 20 40 60, opus 10 20 40 60, EVS 20 40 60, EVS AMR-WB IO 20 40 60, SILK 20 40 60.
  • Enable this flag to force the Cloud Native SBC to send a re-invite to a realm other than the one on which fax tone detection is enabled.
  • Removes inband DTMF tones and mutes audio completely to suppress any DTMF tone bleed-through that may accompany incoming telephone-events toward egress.
  • Minimum Value: 50
    Maximum Value: 32000
    A timer is set after a tone is detected. Upon the expiry of this timer, a re-invite will be sent if the SD has not received a re-invite from the terminating endpoint.
  • tone-detection
    Enable tone detect
Nested Schema : add-codecs-on-egress
Type: array
Specify which codecs to add. The add-codecs are only processed by the outgoing policy. Only codecs that can be transcoded may be specified. No transcodable codecs available with current system configuration.
Show Source
Nested Schema : allow-codecs
Type: array
Specify which codecs to allow. Specify exceptions with the :no tag. Two special type exceptions are accepted: video:no and audio:no. For example, to allow all codecs except iLBC and video: allow-codecs * iLBC:no video:no. If a codec is given a :force tag, it indicates that if the specified codec is present in the incoming offer, all non-force codecs are stripped out.
Show Source
Nested Schema : order-codecs
Type: array
Specify the order of the codecs. Matching codecs will be arranged in the SDP media description according to the specified order. Any remaining codecs will be subsequently added to the list, maintaining their original relative order as in the incoming media offer. A wildcard (*) anchors the ordering to either the start or the end of the list. For example - A B C * specifies the relative ordering of the first three codecs. * A B C specifies the relative ordering of the last three codecs. A B * C D indicates a sort of head and tail of the codec list, with everything else placed in between.
Show Source
Nested Schema : tone-detection
Type: array
Enable tone detect
Show Source
Nested Schema : EnforcementProfile
Type: object
configure enforcement profiles
Show Source
Nested Schema : add-certificate-info
Type: array
list of Certificate attributes to be inserted
Show Source
Nested Schema : EnumConfig
Type: object
configure enum servers
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Cache/use additional DNS records included in received Enum (NAPTR) Responses
  • Minimum Value: 0
    Maximum Value: 4294967295
    Timer interval after which an inactive cache entry is removed (seconds)
  • enum-servers
    List of ENUM servers where the first server is the primary, and the rest serve as backups
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of the enum-config to failover to
  • Minimum Value: 0
    Maximum Value: 65535
    Health query interval (seconds). 0 means health query is disabled
  • Pattern: ^$|^((\+[0-9.()-]+)|([0-9A-F*#.()-]+))(;.*)?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Health query phone number. e.g., +7815556789
  • Include source information in queries
  • Minimum Value: 0
    Maximum Value: 255
    Specifies the length of the ENUM query starting from the most significant bit
  • Minimum Value: 512
    Maximum Value: 65535
    Specifies EDNS0 capability for UDP ENUM responses larger than 512 bytes
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Enum Config name
  • Optional features/parameters
  • Allowed Values: [ "hunt", "round-robin" ]
  • Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Realm in which these enum servers are located
  • Do recursive query if NS record in answer
  • Set RD bit for remote (server) to query recursively
  • Replace Request-URI in forwarded requests
  • Pattern: ^((E2U\+([A-Za-z0-9:+]){1,32})|(([A-Za-z0-9:]){1,32}\+E2U))?(,((E2U\+([A-Za-z0-9:+]){1,32})|(([A-Za-z0-9:+]{1,32})\+E2U)))*$
    List of Enum Service Types. e.g., E2U+sip,sip+E2U,E2U+tel
  • Minimum Value: 0
    Maximum Value: 4294967295
    Maximum waiting time for a Enum response (seconds)
  • Pattern: ^$|^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$
    Top Level Domain to be used for queries using this enum configuration
Nested Schema : enum-servers
Type: array
List of ENUM servers where the first server is the primary, and the rest serve as backups
Show Source
Nested Schema : EnumServer
Type: object
Show Source
Nested Schema : HmrTestMessage
Type: object
configure a hmr test message to use for test-sip-manipulation functionality
Show Source
Nested Schema : HmrTestProfile
Type: object
configure a HMR test profile to use for test-sip-manipulation functionality
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Pattern: ^$|^(?:[1-9][0-9]?|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.(?:[0-9]{1,3})\.(?:[0-9]{1,3})\.(?:[0-9]{1,3})\:(?!0)(\d{1,4}|[1-5]\d{4}|6[0-4]\d{3}|65[0-4]\d{2}|655[0-2]\d|6553[0-5])$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]?\:(?!0)(\d{1,4}|[1-5]\d{4}|6[0-4]\d{3}|65[0-4]\d{2}|655[0-2]\d|6553[0-5])$
    local-ip:port to be used for test-sip-manipulation
  • manipulationPattern to be used for test-sip-manipulation
  • manipulationString to be used for test-sip-manipulation
  • Pattern: ^$|^(?:[1-9][0-9]?|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.(?:[0-9]{1,3})\.(?:[0-9]{1,3})\.(?:[0-9]{1,3})\:(?!0)(\d{1,4}|[1-5]\d{4}|6[0-4]\d{3}|65[0-4]\d{2}|655[0-2]\d|6553[0-5])$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]?\:(?!0)(\d{1,4}|[1-5]\d{4}|6[0-4]\d{3}|65[0-4]\d{2}|655[0-2]\d|6553[0-5])$
    remote-ip:port to be used for test-sip-manipulation
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of the HMR test profile
  • tgrpContext to be used for test-sip-manipulation
Nested Schema : HttpClientConfig
Type: object
configure an HTTP client
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of authentication configuration element
  • Pattern: ^$|^((([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])(/[0-2]?[0-9]|/3[0-2])?$|^([\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}):([\d]{1,5})$|^((([[0-9a-fA-F]]{1,4}:){7}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){6}((:[[0-9a-fA-F]]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){5}:((([[0-9a-fA-F]]{1,4}:)?[[0-9a-fA-F]]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){4}:((([[0-9a-fA-F]]{1,4}:){0,2}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){3}:((([[0-9a-fA-F]]{1,4}:){0,3}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){2}:((([[0-9a-fA-F]]{1,4}:){0,4}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([[0-9a-fA-F]]{1,4}::((([[0-9a-fA-F]]{1,4}:){0,5}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([[0-9a-fA-F]]{1,4}:){0,6}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){1,7}:)|(::))|:(53|(102[5-9]|10[3-9][0-9]{1}|1[1-9][0-9]{2}|[2-9][0-9]{3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\](:[0-9]{0,4})$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$
    IP Address
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of HTTP client configuration element
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of realm to send requests on
  • status of HTTP client configuration element
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    TLS profile name
Nested Schema : LocalPolicy
Type: object
configure a session request routing policy
Show Source
Nested Schema : from-address
Type: array
Minimum Number of Items: 1
Unique Items Required: true
from address list
Show Source
Nested Schema : policy-attributes
Type: array
list of policy attributes
Show Source
Nested Schema : source-realm
Type: array
Unique Items Required: true
A '*' denotes route available from all realms
Show Source
Nested Schema : to-address
Type: array
Minimum Number of Items: 1
Unique Items Required: true
to address list
Show Source
Nested Schema : FromTo
Type: object
Show Source
Nested Schema : LocalPolicyAttribute
Type: object
list of policy attributes
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "replace-uri", "redirect" ]
  • Allowed Values: [ "SIP" ]
  • Pattern: ^[A-Za-z0-9\!"#\$%&'\(\)\*\+-\./:;<=>\?@\[\]\^_\{\|\}~]{0,24}$|^[A-Za-z0-9\!"#\$%&'\(\)\*\+-\./:;<=>\?@\[\]\^_\{\|\}~]{1,24}$
    carrier identifier
  • Minimum Value: 0
    Maximum Value: 999999999
    cost (unitless)
  • Pattern: ^[MTWRFSUH,-]+$
    days of week policy is in effect day characters may be separated by ','s or a '-'\n M=Monday T=Tuesday W=Wednesday R=Thursday F=Friday S=Saturday U=Sunday H=Holidays\n H=holidays as defined in session router config. e.g. U-S,H meaning Saturday through Sunday and holidays
  • enable emergency location string lookup
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$
    string used as key for emergency LRT lookup
  • Pattern: ^(([0-9])|([0-5][0-9])|([0-1]?[0-9][0-5][0-9])|(2[0-3][0-5][0-9])|(2400))$
    daily time policy is no longer in effect <0000..2400>
  • Allowed Values: [ "single", "multi" ]
  • media-profiles
    list of media profiles
  • methods
    Unique Items Required: true
    list of SIP methods for matching with a SIP request method
  • Minimum Length: 1
    Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^(([Ee][Nn][Uu][Mm])|([Ll][Dd][Aa][Pp])):[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}(;key=[A-Za-z$@&][A-Za-z._\-]{0,24})?$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\*)$|^[Ll][Rr][Tt]:[A-Za-z_][A-Za-z0-9._\-]{0,23}(;key=[A-Za-z$@&][A-Za-z._\-]{0,24}(,[A-Za-z$@&][A-Za-z._\-]{0,24})?)?$|^[Ss][Aa][Gg]:[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    next signaling host address
  • next stage key for Multi-Stage Local Policy lookups
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    realm of next signaling. NOTE: does NOT need to be configure if matches the realm of Session Agent configured as next hop.
  • Pattern: ^(([0-9])|([0-5][0-9])|([0-1]?[0-9][0-5][0-9])|(2[0-3][0-5][0-9])|(2400))$
    daily time policy goes into effect <0000..2400>
  • administrative state
  • terminate route recursion with this next hop
Nested Schema : media-profiles
Type: array
list of media profiles
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
list of SIP methods for matching with a SIP request method
Show Source
  • Allowed Values: [ "INVITE", "REGISTER", "PRACK", "OPTIONS", "INFO", "SUBSCRIBE", "NOTIFY", "REFER", "UPDATE", "MESSAGE", "PUBLISH" ]
Nested Schema : entries
Type: array
Minimum Number of Items: 1
Unique Items Required: true
add response map entry
Show Source
Nested Schema : SipLocalMapEntry
Type: object
edit response map entry
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "unknown-error", "invalid-message", "cpu-overload", "media-released", "media-not-allocated", "enum-void-route", "monthly-minutes-exceed", "next-hop-sa-oos", "recv-sa-exc-constraints", "recv-sip-int-exc-constraints", "next-hop-sa-exc-constraints", "next-hop-sip-int-exc-constraints", "realm-bw-exc-poly-serv-reject", "no-steering-pool-ports-available", "no-media-flow-found", "no-media-interface-found-for-realm", "media-recording-failure", "allow-anonymous-rejection", "sdp-address-mismatch", "request-method-throttled", "reg-cache-full", "per-user-cac-exc-sessions", "per-user-nsep-exc-rate", "recv-conditional-cac-reject", "ldap-unavailable", "allowed-elements-profile-rejection", "recording-required", "hss-lir-timeout", "hss-lir-failure", "transcoding-licensed-session-capacity-reached", "dsp-resource-limit-reached", "licensed-session-capacity-reached", "fraud-protection-reject-call", "rx-rar-loss-of-bearer", "rx-rar-release-of-bearer", "rx-rar-out-of-credit", "rx-rar-failed-resources-allocation", "rx-rar-access-network-info-reporting_failure", "rx-asr-bearer-released", "rx-asr-insufficient-server-resources", "rx-asr-insufficient-bearer-resources", "rx-asr-ps-to-cs-handover", "rx-asr-sponsored-data-connectivity-disallowed" ]
  • Allowed Values: [ "REGISTER" ]
  • Minimum Value: 0
    Maximum Value: 2147483647
    Q850 cause code
  • Q850 cause comment
  • Minimum Value: 0
    Maximum Value: 999999999
    register response expires (seconds)
  • SIP response comment(in quotes)
  • Minimum Value: 0
    Maximum Value: 699
    SIP response code
Nested Schema : LocalRoutingConfig
Type: object
configure local routing servers
Show Source
Nested Schema : MediaPolicy
Type: object
configure a media profile and apply it to a realm
Show Source
Nested Schema : tos-settings
Type: array
list of tos settings
Show Source
Nested Schema : TosSetting
Type: object
list of tos settings
Show Source
Nested Schema : media-attributes
Type: array
media attribute to match within SDP
Show Source
Nested Schema : MediaProfile
Type: object
configure a media profile and apply it to a media type
Show Source
Nested Schema : SrtpPolicy
Type: object
configure media security policy
Show Source
Nested Schema : MediaSecProfileInbound
Type: object
inbound
Show Source
Nested Schema : MediaSecProfileOutbound
Type: object
outbound
Show Source
Nested Schema : entries
Type: array
Minimum Number of Items: 1
Unique Items Required: true
add response map entry
Show Source
Nested Schema : Q850SipMapEntry
Type: object
edit response map entry
Show Source
Nested Schema : QoSConstraints
Type: object
configure qos constraints
Show Source
Nested Schema : RealmConfig
Type: object
configure a realm for media management
Show Source
Nested Schema : addr-prefixes
Type: array
address prefixes to match realm. Omit number of bits for exact match. e.g. 10.0.0.0/24 or 2001:DB8:0:56::/64
Show Source
Nested Schema : auth-attribute
Type: array
list of auth-attributes
Show Source
Nested Schema : feature-trfo
Type: array
Enable/disable transcoding free operation
Show Source
Nested Schema : match-media-profiles
Type: array
media profile subtypes for realm. Supports subtypes and name wildcarding (e.g. PCMU::A PCMA:: *::B)
Show Source
Nested Schema : service-networks
Type: array
Minimum Number of Items: 1
service network this realm is available to
Show Source
Nested Schema : sti-as
Type: array
group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
Show Source
Nested Schema : sti-vs
Type: array
group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
Show Source
Nested Schema : RealmConfigAddrPrefixes
Type: object
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$
Nested Schema : SipAuthAttribute
Type: object
list of auth-attributes
Show Source
Nested Schema : in-dialog-methods
Type: array
in dialog methods to add authentication headers to
Show Source
  • Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : password
authentication password
Match All
authentication password
Show Source
Nested Schema : RealmGroup
Type: object
configure realm groups
Show Source
Nested Schema : ResponseMap
Type: object
configure SIP response maps
Show Source
Nested Schema : entries
Type: array
Unique Items Required: true
add response map entry
Show Source
Nested Schema : ResponseMapEntry
Type: object
edit response map entry
Show Source
Nested Schema : RtcpPolicy
Type: object
configure rtcp policy
Show Source
Nested Schema : SDesProfile
Type: object
configure SDES profile
Show Source
Nested Schema : crypto-list
Type: array
list of crypto suites
Show Source
  • Allowed Values: [ "AES_CM_128_HMAC_SHA1_80", "AES_CM_128_HMAC_SHA1_32", "AES_256_CM_HMAC_SHA1_80", "AEAD_AES_256_GCM" ]
Nested Schema : use-ingress-session-params
Type: array
Unique Items Required: true
allowable ingress session parameters (srtcp-encrypt, srtp-auth, srtp-encrypt)
Show Source
Nested Schema : srtp-msm-password
Password to encrypt multi-system SRTP Pass-through info
Match All
Password to encrypt multi-system SRTP Pass-through info
Show Source
Nested Schema : SessionAgent
Type: object
configure session agents
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • allow this session agent to be used as nexthop in local policy
  • Allowed Values: [ "SIP" ]
  • associated-agents
    list of Agents Associated with this session-agent
  • auth-attribute
    list of auth-attributes
  • Minimum Value: 0
    Maximum Value: 999999999
    burst rate window (seconds)
  • Minimum Value: 0
    Maximum Value: 99
    CAC utilization threshold (percent). An alarm will be generated when session utilization or burst-rate utilization exceeds this value.
  • carriers
    list of carriers
  • codec policy to apply
  • apply session constraints to agent
  • description of session agent
  • Allowed Values: [ "both", "reverse", "none" ]
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    default egress realm to use for session agent 'pings' and when multiple egress realms are possible (e.g. realm-id is empty or '*')
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of enforcement profile
  • enable or disables holding re-invite
  • Minimum Length: 1
    Pattern: ^(((((\*)|(\*\.)){0,1})([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1})|(\*?))$|^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$
    hostname at which to contact session agent
  • inbound manipulation ID
  • Minimum Value: 0
    Maximum Value: 999999999
    in service period
  • inbound translation ID
  • Pattern: ^$|^((([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])(/[0-2]?[0-9]|/3[0-2])?$|^([\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}):([\d]{1,5})$|^((([[0-9a-fA-F]]{1,4}:){7}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){6}((:[[0-9a-fA-F]]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){5}:((([[0-9a-fA-F]]{1,4}:)?[[0-9a-fA-F]]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){4}:((([[0-9a-fA-F]]{1,4}:){0,2}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){3}:((([[0-9a-fA-F]]{1,4}:){0,3}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){2}:((([[0-9a-fA-F]]{1,4}:){0,4}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([[0-9a-fA-F]]{1,4}::((([[0-9a-fA-F]]{1,4}:){0,5}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([[0-9a-fA-F]]{1,4}:){0,6}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){1,7}:)|(::))|:(53|(102[5-9]|10[3-9][0-9]{1}|1[1-9][0-9]{2}|[2-9][0-9]{3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\](:[0-9]{0,4})$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$
    IP Address if hostname is FQDN (optional)
  • Allowed Values: [ "inherit", "disabled", "enabled" ]
  • Allowed Values: [ "inherit", "disabled", "enabled" ]
  • session agent is trusted for Lawful Intercept or not
  • Allowed Values: [ "hunt", "round-robin" ]
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of local response map to use for the SA
  • enable loose routing
  • regular expression that can be used in header manipulation rules
  • string that can be used in header manipulation rules
  • match-identifier
    Identification criteria to match this agent
  • Minimum Value: 0
    Maximum Value: 999999999
    max burst rate (invites per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max inbound burst rate (invites per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max inbound sessions allowed to this agent
  • Minimum Value: 0
    Maximum Value: 999999999
    max inbound sustained rate (invites per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max outbound burst rate (invites per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max outbound sessions allowed to this agent
  • Minimum Value: 0
    Maximum Value: 999999999
    max outbound sustained rate (invites per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    maximum reg sustain rate (register per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max sessions allowed to and from this agent
  • Minimum Value: 0
    Maximum Value: 999999999
    max sustained rate (invites per second)
  • media-profiles
    list of media profiles
  • Minimum Value: 0
    Maximum Value: 100
    minimum answer seizure ratio (percentage)
  • Minimum Value: 1
    Maximum Value: 999999999
    minimum number of seizures for a no-answer scenario
  • optional features/parameters
  • Outbound Manipulation Id
  • Pattern: ^$|^[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$|^[2-6][0-9][0-9]-[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$
    Response codes for Any Dialog creating or Ping Request that make the SA OOS
  • Outbound Translation Id
  • p-asserted-id(URI Format) for Session Agent
  • SIP ping all adresses from DNS query
  • ping From User Part
  • Pattern: ^$|^[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$|^[2-6][0-9][0-9]-[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$
    Response codes for PING Resuest that make the SA InService
  • Minimum Value: 0
    Maximum Value: 4294967295
    how often to ping SA (seconds)
  • SIP message/method used for pinging
  • OPTIONS received will be considered as ping and will be locally responded
  • Allowed Values: [ "keep-alive", "continuous" ]
  • ping To User Part
  • Minimum Value: 0
    Maximum Value: 65535
    port to contact session agent
  • Minimum Value: 0
    Maximum Value: 4294967295
    Selection precedence of Session Agents with same IP address
  • Allowed Values: [ "Stateless", "Proxy", "Redirect", "Record-Route" ]
  • rate-constraints
    create a rate constraint for a method
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    realm this session agent resides in
  • Allowed Values: [ "Proxy", "Recurse", "Recurse-305-only" ]
  • Allowed Values: [ "disabled", "enabled", "dynamic" ]
  • Allowed Values: [ "none", "initial", "all" ]
  • Allowed Values: [ "None", "URI-param", "Prefix" ]
  • request-uri-headers
    list of headers which need to be inserted in the RE-INVITE from the contact Header
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    response map name
  • Allowed Values: [ "NONE", "TCP", "SCTP", "TLS" ]
  • Allowed Values: [ "none", "transparent", "preferred", "dual" ]
  • Minimum Value: 0
    Maximum Value: 127
    payload type used by the SA in preferred rfc2833-mode (0,128>x>95)
  • send media session description
  • Enables or disables sending TCP FIN messages when SA is Out of Service
  • Minimum Value: 1
    Maximum Value: 2073600
    maximum life limit a SIP session can stay active (secs). Range 1-2073600.
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of sip-isup profile
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of sip profile
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    SIP Recursion Policy
  • optional features/parameters
  • administrative state
  • sti-as
    group name or list of STI authentication server (up to four allowed). E.g. STG:<STI-group-name> (for STI Server Group), <STI-name> (for single STI Server)
  • Pattern: ^$|^[A-C]$
    Attestation Values can be either A, B, C or Empty. (A: Full Attestation, B: Partial Attestation, C: Gateway Attestation)
  • Pattern: ^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
    UUID4 added to STI-AS requests, if not already present. Leave empty to pick up the UUID from the upstream config object
  • Retrieve attestation value and OrigId from SIP headers, when present. (Attestation-Info: attest [A/B/C], Origination-ID: origId [UUID])
  • sti-vs
    group name or list of STI validation server (up to four allowed). E.g. STG:<STI-group-name> (for STI Server Group), <STI-name> (for single STI Server)
  • Response codes that stop recursion of targets/contacts
  • Minimum Value: 0
    Maximum Value: 999999999
    sustained rate window (seconds)
  • Allowed Values: [ "none", "enabled", "disabled" ]
  • TCP/SCTP Reconnection Interval
  • Minimum Value: 0
    Maximum Value: 999999999
    time to resume
  • Allowed Values: [ "UDP", "UDP+TCP", "DynamicTCP", "StaticTCP", "DynamicTLS", "StaticTLS", "StaticSCTP", "ANY" ]
  • trunk-group
    list of trunk groups and their contexts. To use the default context case, omit : and the context
  • whether this session agent is trusted or not
  • Minimum Value: 0
    Maximum Value: 999999999
    no response time to resume
Nested Schema : associated-agents
Type: array
list of Agents Associated with this session-agent
Show Source
Nested Schema : auth-attribute
Type: array
list of auth-attributes
Show Source
Nested Schema : carriers
Type: array
list of carriers
Show Source
Nested Schema : match-identifier
Type: array
Identification criteria to match this agent
Show Source
Nested Schema : media-profiles
Type: array
list of media profiles
Show Source
Nested Schema : rate-constraints
Type: array
create a rate constraint for a method
Show Source
Nested Schema : request-uri-headers
Type: array
list of headers which need to be inserted in the RE-INVITE from the contact Header
Show Source
Nested Schema : sti-as
Type: array
group name or list of STI authentication server (up to four allowed). E.g. STG:<STI-group-name> (for STI Server Group), <STI-name> (for single STI Server)
Show Source
Nested Schema : sti-vs
Type: array
group name or list of STI validation server (up to four allowed). E.g. STG:<STI-group-name> (for STI Server Group), <STI-name> (for single STI Server)
Show Source
Nested Schema : trunk-group
Type: array
list of trunk groups and their contexts. To use the default context case, omit : and the context
Show Source
Nested Schema : SessionAgentIdentifier
Type: object
Identification criteria to match this agent
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Minimum Length: 1
    Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    specify the session-agent-identifier-rule which will be used to identify this agent if not matching by IP Address
  • Minimum Length: 1
    Pattern: ^.*$
    value to match in sip header field which identifies this Session Agent
Nested Schema : RateConstraints
Type: object
create a rate constraint for a method
Show Source
Nested Schema : SessionAgentIdentifierRule
Type: object
configure alternative session-agent identification rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Minimum Length: 1
    Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    sip header used to identify the Session Agent
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    parameter within the specified sip header field to be used to identify the Session Agent
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of the identification scenario
  • Allowed Values: [ "none", "uri-param", "uri-header", "uri-user", "uri-host", "uri-port", "uri-user-param", "uri-display", "uri-user-only", "uri-phone-number-only" ]
Nested Schema : SessionConstraints
Type: object
configure session constraints
Show Source
Nested Schema : rate-constraints
Type: array
create a rate constraint for a method
Show Source
Nested Schema : SessionAgentGroup
Type: object
configure session agent groups
Show Source
Nested Schema : dest
Type: array
list of destinations for this group
Show Source
Nested Schema : trunk-group
Type: array
list of trunk groups and their contexts for this group. To use the default context case, omit : and the context
Show Source
Nested Schema : holidays
Type: array
list of holidays
Show Source
Nested Schema : Holiday
Type: object
list of holidays
Show Source
Nested Schema : SessionTimerProfile
Type: object
configure session timer profile
Show Source
Nested Schema : SessionTranslation
Type: object
configure translation rules for calling and called numbers
Show Source
Nested Schema : rules-asserted-id
Type: array
Manipulates the SIP P-Asserted-Id header
Show Source
Nested Schema : rules-called
Type: array
list of <called translation rule name>
Show Source
Nested Schema : rules-calling
Type: array
list of <calling translation rule name>
Show Source
Nested Schema : rules-history-info
Type: array
Manipulates the SIP History-Info headers
Show Source
Nested Schema : rules-isup-cdpn
Type: array
Manipulates the ISUP Called Party Number parameter
Show Source
Nested Schema : rules-isup-cgpn
Type: array
Manipulates the ISUP Calling Party Number parameter
Show Source
Nested Schema : rules-isup-gn
Type: array
Manipulates the ISUP Generic Number parameter
Show Source
Nested Schema : rules-isup-ocn
Type: array
list of IsupOcn < translation rule name>
Show Source
Nested Schema : rules-isup-rdn
Type: array
Manipulates the ISUP Redirecting and Original Called Number parameters
Show Source
Nested Schema : rules-redirect
Type: array
Manipulates the SIP Diversion headers
Show Source
Nested Schema : SipAdvancedLogging
Type: object
Configure logging of specific SIP requests/session by criteria
Show Source
Nested Schema : conditions
Type: array
List of conditions to match for logging
Show Source
Nested Schema : SipAdvancedLogCondition
Type: object
Configure conditions for matching SIP requests/sessions
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "exact-match", "regex-match" ]
  • Allowed Values: [ "request-type", "recv-agent", "recv-realm", "request-uri-user", "request-uri-host", "to-header-user", "to-header-host", "from-header-user", "from-header-host", "call-id" ]
  • Exact value to match or regular expression format. For match-type = request-type, Valid Values : REGISTER, INVITE, ACK, BYE, CANCEL, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH
Nested Schema : proxy-sub-events
Type: array
Unique Items Required: true
subscription events to do in proxy mode
Show Source
Nested Schema : SipFeature
Type: object
configure SIP option tag parameters
Show Source
Nested Schema : SipInterface
Type: object
configure SIP interfaces
Show Source
Nested Schema : add-sdp-in-msg
Type: array
Insert SDP in sip message
Show Source
Nested Schema : add-sdp-profiles
Type: array
list of media profiles
Show Source
Nested Schema : add-sdp-profiles-in-msg
Type: array
list of media profiles
Show Source
Nested Schema : carriers
Type: array
list of carriers
Show Source
Nested Schema : p-early-media-direction
Type: array
Configure early-media-direction parameter for P-Early-Media header
Show Source
  • Allowed Values: [ "sendrecv", "sendonly", "recvonly", "inactive" ]
Nested Schema : sip-ports
Type: array
list of SIP ports
Show Source
Nested Schema : sti-as
Type: array
group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
Show Source
Nested Schema : sti-vs
Type: array
group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
Show Source
Nested Schema : SipPort
Type: object
list of sip-ports
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Minimum Length: 1
    Pattern: ^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[1-9][0-9]?|0?[0-9]?[1-9])(\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]?[0-9])){2}\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9][0-9]?|0?[0-9]?[0-9])(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]?(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^(?:[1-9a-fA-F]{1,4}:){7}[1-9a-fA-F]{1,4}$|^(\:\:)?[1-9a-fA-F]{1,4}(\:\:?[0-9a-fA-F]{1,4}){0,7}(\:\:)?$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.|$)){4})$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|[0-9a-fA-F]{0,4}(\:[0-9a-fA-F]{0,4}){0,5}(::?)|[0-9a-fA-F]{1,4}|6[0-5]{2}[0-4]\d|6[0-4]{2}\d{2}|6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]{2}\d{3})$
    IP Address
  • Allowed Values: [ "all", "agents-only", "realm-prefix" ]
  • Minimum Value: 1
    Maximum Value: 65535
    port
  • tls profile name
  • Allowed Values: [ "UDP", "TCP", "TLS", "SCTP" ]
Nested Schema : SipManipulation
Type: object
configure SIP manipulations
Show Source
Nested Schema : SipManipOrderEntry
Type: object
order of sip manipulation rules
Show Source
Nested Schema : header-rules
Type: array
list of header rules
Show Source
Nested Schema : join-headers
Type: array
Unique Items Required: true
list of headers to be joined into a single, comma separated header. Joining of headers occurs after execution of any manipulation rules e.g. Diversion,Route,Via
Show Source
Nested Schema : mime-isup-rules
Type: array
list of mime isup rules
Show Source
Nested Schema : mime-rules
Type: array
list of mime rules
Show Source
Nested Schema : mime-sdp-rules
Type: array
list of mime sdp rules
Show Source
Nested Schema : split-headers
Type: array
Unique Items Required: true
list of headers to be split and treated as separate headers. Splitting of headers occurs prior to the execution of any manipulation rules e.g. Diversion,Route,Via
Show Source
Nested Schema : rules-order
Type: array
list of header,mime,mime-isup and mime-sdp rules
Show Source
Nested Schema : SipHdrRule
Type: object
list of header rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • element-rules
    list of element-rules
  • Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
    header name for which rule needs to be applied
  • value to match against the current object. To clear the match-value, enter an empty string
  • methods
    Unique Items Required: true
    specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL
  • Allowed Values: [ "any", "request", "reply", "out-of-dialog" ]
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : element-rules
Type: array
list of element-rules
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL
Show Source
  • Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : SipElemRule
Type: object
list of element-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete-element", "delete-header", "log", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • Allowed Values: [ "any", "ip", "fqdn" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • element param name for which rule needs to be applied
  • Allowed Values: [ "none", "header-value", "header-param", "uri-param", "uri-header", "uri-user", "uri-host", "uri-port", "uri-user-param", "teluri-param", "uri-display", "uri-param-name", "uri-header-name", "header-param-name", "status-code", "reason-phrase", "mime", "uri-user-only", "uri-phone-number-only" ]
Nested Schema : MimeIsupRule
Type: object
list of mime isup rules
Show Source
Nested Schema : isup-msg-types
Type: array
Unique Items Required: true
specifies a list of isup message types that the mime isup rule applies to (applies to all ISUP messages when none are specified) e.g.: IAM, ACM
Show Source
Nested Schema : isup-param-rules
Type: array
list of isup-param-rules
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to (applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
Nested Schema : mime-header-rules
Type: array
list of mime-header-rules
Show Source
Nested Schema : rules-order
Type: array
list of mime-header and isup-param rules
Show Source
Nested Schema : IsupParamRule
Type: object
list of isup-param-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • Allowed Values: [ "raw-binary", "hex-ascii", "bcd", "binary-ascii", "ascii-string", "number-param" ]
  • value to match against the current object. To clear the match-value, update with an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. To clear the newValue, update with an empty string
  • Pattern: ^((25[0-5])|(2[0-4][0-9])|(1[0-9][0-9])|([0-9]([0-9])?))(\[([*^]|[0-9]+)\])?$
    parameter type specifying which part of the isup body will be manipulated
Nested Schema : MimeHeaderRule
Type: object
list of mime-header-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
    header within mime part for which rule needs to be applied. To change the preamble of a SIP body, use the header name @preamble. To change the epilogue of a SIP body, use the header name @epilogue
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : MimeRule
Type: object
list of mime rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • Pattern: ^[A-Za-z0-9.!%*_+`'~/-]+(;.+)*(\[(([0-9]+)|([*^]))\])?$
    Content-Type header for which rule needs to be applied
  • Allowed Values: [ "ascii-string", "hex-ascii", "binary-ascii" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • methods
    Unique Items Required: true
    specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
  • mime-header-rules
    list of mime-header-rules
  • Allowed Values: [ "any", "request", "reply", "out-of-dialog" ]
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes(e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
  • Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : mime-header-rules
Type: array
list of mime-header-rules
Show Source
Nested Schema : MimeSdpRule
Type: object
list of mime sdp rules
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
Nested Schema : mime-header-rules
Type: array
list of mime-header-rules
Show Source
Nested Schema : rules-order
Type: array
list of mime-header ,sdp-session and sdp-media rules
Show Source
Nested Schema : sdp-media-rules
Type: array
list of sdp-media-rules
Show Source
Nested Schema : sdp-session-rules
Type: array
list of sdp-session-rules
Show Source
Nested Schema : SdpMediaRule
Type: object
list of sdp-media-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
    media type to manipulate (e.g. audio, video, etc.)
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • sdp-line-rules
    list of sdp-line-rules
Nested Schema : sdp-line-rules
Type: array
list of sdp-line-rules
Show Source
Nested Schema : SdpLineRule
Type: object
list of sdp-line-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • Pattern: ^[A-Za-z](\[(([0-9]+)|([*^]))\])?$
    descriptor type specifying which line of the sdp will be manipulated
Nested Schema : SdpSessionRule
Type: object
list of sdp-session-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • sdp-line-rules
    list of sdp-line-rules
Nested Schema : sdp-line-rules
Type: array
list of sdp-line-rules
Show Source
Nested Schema : SipNatConfig
Type: object
configure sip nat across realms
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])(/([0-2]?[0-9]|3[0-2]))?$|^(\*)$
    address prefix subject to SIP-NAT encoding <ipv4>[/<num-bits>] (e.g., 10.0.0.1/24) OR '*' to use the Realm's address prefix OR '0.0.0.0' to use the inverse of Home Realm's prefix
  • Minimum Length: 1
    domain suffix to use in external realm (e.g., '.acme.com')
  • Minimum Length: 1
    Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$
    external realm IPv4 address
  • Minimum Length: 1
    Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$
    external realm proxy IPv4 address
  • Minimum Value: 1025
    Maximum Value: 65535
    external realm proxy port
  • headers
    Unique Items Required: true
    list of SIP Header names to be NAT'd
  • Minimum Length: 1
    Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$
    home realm IPv4 address
  • Pattern: ^$|^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[1-9][0-9]?|0?[0-9]?[1-9])(.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]?[0-9])){2}.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9][0-9]?|0?[0-9]?[0-9])$
    home realm proxy IPv4 address
  • Minimum Value: 0
    Maximum Value: 65535
    home realm proxy port
  • Pattern: ^[A-Za-z0-9-]{1,63}$
    URL host tag for NAT disambiguation. Default: ACME-
  • URL parameter name for NAT encoding
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    external realm identifier
  • Allowed Values: [ "disabled", "enabled", "forced" ]
  • pass back Contact URIs unchanged in redirect response
  • Allowed Values: [ "none", "from-to", "phone", "all" ]
  • URL user tag for NAT disambiguation. Default: -acme-
Nested Schema : headers
Type: array
Unique Items Required: true
list of SIP Header names to be NAT'd
Show Source
Nested Schema : SipProfile
Type: object
configure sip profile
Show Source
Nested Schema : entries
Type: array
Minimum Number of Items: 1
Unique Items Required: true
add response map entry
Show Source
Nested Schema : SipQ850MapEntry
Type: object
edit response map entry
Show Source
Nested Schema : SipRecursionPolicy
Type: object
configure SIP recursion policy
Show Source
Nested Schema : sip-resp-code-attempts
Type: array
list of SIP response code attempts
Show Source
Nested Schema : SipRespCodeAttempts
Type: object
list of SIP response code settings
Show Source
Nested Schema : plugins
Type: array
list of spl plugins
Show Source
Nested Schema : SplPluginConfig
Type: object
list of spl plugins
Show Source
Nested Schema : SteeringPool
Type: object
specify one or more ports for steering media flows
Show Source
Nested Schema : SteeringPoolIpList
Type: object
Create an IP address list that will be referenced in a steering-pool
Show Source
Nested Schema : ip-addr-list
Type: array
Minimum Number of Items: 1
List of media IP addresses for the steering pool
Show Source
Nested Schema : StiHeaderMappingRuleset
Type: object
configure a set of rules for SIP and HTTP header mapping
Show Source
Nested Schema : mapping-rules
Type: array
list of rules required for SIP and HTTP header mapping
Show Source
Nested Schema : StiHeaderMappingRules
Type: object
list of SIP and HTTP header mapping rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "outbound", "inbound" ]
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    unique identifier for the mapping rule
  • Allowed Values: [ "STI-AS", "STI-VS" ]
  • Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([~^]))\])?$
    name of the SIP or HTTP header to be picked from the ingress INVITE or HTTP response
  • Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$
    SIP or HTTP header param based on the source header. If source-header is empty, this should be a key in HTTP body JSON claim
  • Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([~^]))\])?$
    name of the SIP or HTTP header to be added or modified to the egress INVITE or the HTTP request
  • Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$
    SIP or HTTP header param based on target header. If target-header is empty, this should be a key in HTTP body JSON claim
Nested Schema : StiResponseTreatmentConfig
Type: object
configure STI Response treatment config for STIR/SHAKEN
Show Source
Nested Schema : sti-response-treatment-entries
Type: array
verstat and reason code mapping for sti response
Show Source
Nested Schema : StiResponseTreatmentEntries
Type: object
list of entries of sti responses for STI Verification
Show Source
Nested Schema : StiServer
Type: object
configure STIR/SHAKEN STI servers
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Pattern: ^http[s]{0,1}://((([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))|(\[((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))\]))(:((((([0-5]?[0-9]?)|6[0-4])?[0-9]|65[0-4])?[0-9]|655[0-2])?[0-9]|6553[0-5])){0,1}(/[A-Za-z0-9\-\_\.\%]{1,128})*$
    STIR Authentication server (STI-AS) URL should start with http:// or https://. The host can be a hostname, IPv4, or [IPv6], and the port is optional (default: 80 for http, 443 for https).
  • Minimum Value: 0
    Maximum Value: 999999999
    burst rate window (seconds)
  • brief description of the STI server
  • Pattern: ^http[s]{0,1}://((([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))|(\[((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))\]))(:((((([0-5]?[0-9]?)|6[0-4])?[0-9]|65[0-4])?[0-9]|655[0-2])?[0-9]|6553[0-5])){0,1}(/[A-Za-z0-9\-\_\.\%]{1,128})*$
    STIR Div Authentication server (STI-AS) URL should start with http:// or https://. The host can be a hostname, IPv4, or [IPv6], and the port is optional (default: 80 for http, 443 for https).
  • Pattern: ^http[s]{0,1}://((([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))|(\[((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))\]))(:((((([0-5]?[0-9]?)|6[0-4])?[0-9]|65[0-4])?[0-9]|655[0-2])?[0-9]|6553[0-5])){0,1}(/[A-Za-z0-9\-\_\.\%]{1,128})*$
    STIR Div Verification server (STI-AS) URL should start with http:// or https://. The host can be a hostname, IPv4, or [IPv6], and the port is optional (default: 80 for http, 443 for https).
  • Allowed Values: [ "none", "enabled", "disabled" ]
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    HTTP client name
  • Allowed Values: [ "3GPP", "ATIS" ]
  • Minimum Value: 0
    Maximum Value: 999999999
    max burst rate (requests per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max sustained rate (requests per second)
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    STI server name
  • optional features/parameters
  • Pattern: ^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
    UUID4 orig-id is added on originating calls. Enter an empty string or Zero UUID (00000000-0000-0000-0000-000000000000) to auto-generate a UUID4 orig-id.
  • Allowed Values: [ "none", "enabled", "disabled" ]
  • Allowed Values: [ "STI-AS", "STI-VS", "BOTH" ]
  • status of STI server configuration element
  • Minimum Length: 1
    Pattern: ^$|^[A-C]$
    Attestation values can be A, B, or C. A: Full Attestation, B: Partial Attestation, C: Gateway Attestation
  • name of the instance of sti-header-mapping-ruleset
  • Allowed Values: [ "none", "enabled", "disabled" ]
  • if name is valid, it overrides the sti-config settings.
  • Minimum Value: 0
    Maximum Value: 999999999
    sustained rate window (seconds)
  • Minimum Value: 100
    Maximum Value: 30000
    Timeout in milliseconds; if reached, the call continues without a STIR query.
  • Delimiter is used to refine the text of the verstat during verstat retrieval processes
  • Pattern: ^http[s]{0,1}://((([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))|(\[((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))\]))(:((((([0-5]?[0-9]?)|6[0-4])?[0-9]|65[0-4])?[0-9]|655[0-2])?[0-9]|6553[0-5])){0,1}(/[A-Za-z0-9\-\_\.\%]{1,128})*$
    STIR Verification server (STI-AS) URL should start with http:// or https://. The host can be a hostname, IPv4, or [IPv6], and the port is optional (default: 80 for http, 443 for https).
Nested Schema : StiServerGroup
Type: object
configure high availability for STIR/SHAKEN STI servers
Show Source
Nested Schema : sti-servers
Type: array
Minimum Number of Items: 1
list of STI servers
Show Source
Nested Schema : TeSteeringPoolIpList
Type: object
The Transcode Engine Steering Pool IP List creates steering pool IP list at the Transcode Engine
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of steering pool IP list
  • ip-addr-list
    Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of service network this pool is used for
Nested Schema : ip-addr-list
Type: array
Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)
Show Source
Nested Schema : TLSProfile
Type: object
configure the parameters for running SIP over TLS
Show Source
Nested Schema : cipher-list
Type: array
Minimum Number of Items: 1
list of ciphers
Show Source
  • Allowed Values: [ "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384", "TLS_AES_128_GCM_SHA256", "TLS_AES_128_CCM_SHA256", "TLS_CHACHA20_POLY1305_SHA256", "DEFAULT", "NONE" ]
Nested Schema : trusted-ca-certificates
Type: array
list of trusted certificate records
Show Source
Nested Schema : version-list
Type: array
Minimum Number of Items: 1
list of TLS version
Show Source
Nested Schema : TranslationRules
Type: object
configure and apply session translation rules to agents and realms
Show Source
Nested Schema : XcodeMeSteeringPool
Type: object
The Xcode Media Engine Steering Pool creates steering pool at the Media Engine
Show Source
Nested Schema : XcodeTeSteeringPool
Type: object
The Xcode Transcode Engine Steering Pool creates steering pool at the Transcode Engine
Show Source
Back to Top

Response

Supported Media Types

200 Response

return entire configurations on topic: SD
Body ()
Root Schema : schema
Type: object
Topic SD configurations
Show Source
Nested Schema : access-control
Type: array
Show Source
Nested Schema : AccountingConfig
Type: object
configure Quality of Service accounting
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • cdr-attribute-include-list
    list of cdr attributes to be included in accounting file
  • activate writing of comma delimited records
  • Minimum Value: 0
    Maximum Value: 2147483647
    file rotation/push interval (minutes) (0 disables)
  • append 9-digit sequence number to CDR file names
  • generate-event
    list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)
  • generate-interim
    list of events to collect during a session
  • Allowed Values: [ "None", "Invite", "OK" ]
  • Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$
    hostname of this system
  • Minimum Value: 0
    Maximum Value: 2147483647
    periodic interim record interval (seconds)
  • Minimum Value: 1048576
    Maximum Value: 1073741824
    maximum file size (bytes), should be >= 1048576 bytes and <= 1073741824 bytes
  • administrative state
  • transmit data at session close
Nested Schema : AdministrativeConfig
Type: object
Configure parameters which controls administrative flow
Show Source
Nested Schema : allowed-elements-profile
Type: array
Show Source
Nested Schema : authentication-profile
Type: array
Show Source
Nested Schema : codec-policy
Type: array
Show Source
Nested Schema : enforcement-profile
Type: array
Show Source
Nested Schema : enum-config
Type: array
Show Source
Nested Schema : hmr-test-message
Type: array
Show Source
Nested Schema : hmr-test-profile
Type: array
Show Source
Nested Schema : http-client
Type: array
Show Source
Nested Schema : HttpConfig
Type: object
modifying tcp Connections settings
Show Source
Nested Schema : local-policy
Type: array
Show Source
Nested Schema : SipLocalMap
Type: object
configure Local SIP response maps
Show Source
Nested Schema : local-routing-config
Type: array
Show Source
Nested Schema : MediaRouter
Type: object
configure media policy, attributes, and settings
Show Source
Nested Schema : media-policy
Type: array
Show Source
Nested Schema : media-profile
Type: array
Show Source
Nested Schema : media-sec-policy
Type: array
Show Source
Nested Schema : Q850SipMap
Type: object
configure q850 to sip maps
Show Source
Nested Schema : qos-constraints
Type: array
Show Source
Nested Schema : realm-config
Type: array
Show Source
Nested Schema : realm-group
Type: array
Show Source
Nested Schema : response-map
Type: array
Show Source
Nested Schema : rtcp-policy
Type: array
Show Source
Nested Schema : sdes-profile
Type: array
Show Source
Nested Schema : SecurityConfig
Type: object
configure security configurations
Show Source
Nested Schema : session-agent
Type: array
Show Source
Nested Schema : session-agent-id-rule
Type: array
Show Source
Nested Schema : session-constraints
Type: array
Show Source
Nested Schema : session-group
Type: array
Show Source
Nested Schema : SessionRouter
Type: object
configure session router
Show Source
Nested Schema : session-timer-profile
Type: array
Show Source
Nested Schema : session-translation
Type: array
Show Source
Nested Schema : sip-adv-log-trace
Type: array
Show Source
Nested Schema : SipConfig
Type: object
configure signaling and session management
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • add Reason header to CANCEL/BYE
  • enable adding of UCID header to messages
  • Allowed Values: [ "inherit", "disabled", "enabled" ]
  • If enabled, HistoryInfo and Diversion headers will be anonymized for untrusted peer
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    auto config realm identifier
  • creation of dynamic Session Agents for Service-Route
  • preserve Call-IDs and tags
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    default egress realm identifier
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of enforcement profile
  • state
  • track enum stats per server address
  • track method stats for more entities
  • Allowed Values: [ "inherit", "disabled", "enabled" ]
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    home realm identifier
  • Minimum Value: 0
    Maximum Value: 4294967295
    inactive dynamic disconnect value (seconds), 0 to disable
  • Minimum Value: 0
    Maximum Value: 4294967295
    initial request retransmission timer (TIMER_T1) (milliseconds)
  • Minimum Value: 0
    Maximum Value: 999999999
    Transaction expiration time <TIMER_B> for initial INVITE (0 = Fall back to sip-config initial-inv-trans-expire)
  • Minimum Value: 0
    Maximum Value: 4294967295
    INVITE transaction expiration timer (TIMER_C) (seconds)
  • Minimum Value: 0
    Maximum Value: 4294967295
    maximum request retransmission timer (TIMER_T2) (milliseconds)
  • Allowed Values: [ "None", "Public", "Private" ]
  • Allowed Values: [ "disabled", "stateless", "transaction", "session", "dialog" ]
  • optional features/parameters
  • enable GRUU contact pass through
  • proxy-sub-events
    Unique Items Required: true
    subscription events to do in proxy mode
  • Set this value to enabled for the SBC to not include SDP in the reINVITE to the transfer target. This is used in REFER with Replace scenarios
  • enable refer source realm routing
  • Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\*?)$
    domain name of SIP registrar server
  • Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\*?)$
    hostname of SIP registrar server
  • Minimum Value: 0
    Maximum Value: 65535
    port number of SIP registrar server
  • Map Rx disconnect events to SIP reason header
  • track SA stats for DNS-resolved routes
  • enable lookup of SAG name on a redirect
  • Minimum Value: 1
    Maximum Value: 2073600
    maximum life limit a SIP session can stay active (secs). Range 1-2073600.
  • enable if disconnect time is set on receiving BYE request
  • Minimum Value: 0
    Maximum Value: 65535
    max sip message length
  • Minimum Value: 0
    Maximum Value: 999999999
    transaction expiration timer (TIMER_B,D,F,H,J) (seconds)
  • user-agent string to be added to SIP User-Agent header
Nested Schema : sip-feature
Type: array
Show Source
Nested Schema : sip-interface
Type: array
Show Source
Nested Schema : sip-manipulation
Type: array
Show Source
Nested Schema : sip-nat
Type: array
Show Source
Nested Schema : sip-profile
Type: array
Show Source
Nested Schema : SipQ850Map
Type: object
configure sip to q850 maps
Show Source
Nested Schema : sip-recursion-policy
Type: array
Show Source
Nested Schema : SplConfig
Type: object
add or modify an SPL plug-in
Show Source
Nested Schema : steering-pool
Type: array
Show Source
Nested Schema : steering-pool-ip-list
Type: array
Show Source
Nested Schema : StiConfig
Type: object
configure global parameters for STIR/SHAKEN
Show Source
Nested Schema : sti-header-mapping-ruleset
Type: array
Show Source
Nested Schema : StiHeartbeatConfig
Type: object
configure global parameters for STIR/SHAKEN heartbeat message
Show Source
Nested Schema : sti-response-treatment-config
Type: array
Show Source
Nested Schema : sti-server
Type: array
Show Source
Nested Schema : sti-server-group
Type: array
Show Source
Nested Schema : te-steering-pool-ip-list
Type: array
Show Source
Nested Schema : TLSGlobal
Type: object
configure session caching for all TLS functions
Show Source
Nested Schema : tls-profile
Type: array
Show Source
Nested Schema : translation-rules
Type: array
Show Source
Nested Schema : xcode-me-steering-pool
Type: array
Show Source
Nested Schema : xcode-te-steering-pool
Type: array
Show Source
Nested Schema : AccessControl
Type: object
configure a static or dynamic access control list
Show Source
Nested Schema : FlowAddress
Type: object
destination ip address
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Minimum Length: 1
  • Minimum Value: 0
    Maximum Value: 65535
    Enter a number in the range 0..65535. This will be an optional port number for both IPv4 and IPv6 addresses, (range: 0-65535 for both IPv4 and IPv6), e.g. 5000
  • Minimum Value: 0
    Maximum Value: 128
    Enter a number in the range 0..128. This will be an optional CIDR prefix for an IPv4 or IPv6 address (range: 0-32 for an IPv4 address) (range: 0-128 for an IPv6 address), e.g. 16(for IPv4) and 64(for IPv6)
  • Minimum Value: 0
    Maximum Value: 16
    Enter a number in the range 0..16. This will be an optional CIDR prefix for the port, (range: 0-16 for both IPv4 and IPv6), e.g. 14
Nested Schema : cdr-attribute-include-list
Type: array
list of cdr attributes to be included in accounting file
Show Source
  • Allowed Values: [ "Access_Network_Information", "Accounting_Session_ID", "Accounting_Session_Time", "Accounting_Status", "Accounting_Termination_Cause", "ApplicationId", "Associated_URI", "Called_Asserted_Identity", "Called_MOS", "Called_R_Factor", "Called_Station_ID", "Calling_MOS", "Calling_R_Factor", "Calling_Station_ID", "Cause_Code", "CDR_Sequence_Number", "Charging_Function_Address", "Charging_Vector_ICID", "Cisco_Connect_Time", "Cisco_Disconnect_Cause", "Cisco_Disconnect_Time", "Cisco_Setup_Time", "Content_Disposition", "Custom_VSA_200", "Custom_VSA_201", "Custom_VSA_202", "Custom_VSA_203", "Custom_VSA_204", "Custom_VSA_205", "Custom_VSA_206", "Custom_VSA_207", "Custom_VSA_208", "Custom_VSA_209", "Custom_VSA_210", "Custom_VSA_211", "Custom_VSA_212", "Custom_VSA_213", "Custom_VSA_214", "Custom_VSA_215", "Custom_VSA_216", "Custom_VSA_217", "Custom_VSA_218", "Custom_VSA_219", "Custom_VSA_220", "Custom_VSA_221", "Custom_VSA_222", "Custom_VSA_223", "Custom_VSA_224", "Custom_VSA_225", "Custom_VSA_226", "Custom_VSA_227", "Custom_VSA_228", "Custom_VSA_229", "Custom_VSA_230", "Destination_Host", "Destination_Realm", "Diam_Session_Id", "Disconnect_Cause", "Disconnect_Initiator", "Early_SDP_Media", "Early_SDP_Type", "Egress_Local_Address", "Egress_Network_Interface_ID", "Egress_Realm", "Egress_Remote_Address", "Egress_Routing_Number", "Egress_RPH", "Egress_Session_ID", "Egress_Vlan_Tag_Value", "Event", "Event_Time", "Expires", "Firmware_Version", "FS1_Called_Media_Stop_Time", "FS1_Calling_Media_Stop_Time", "FS1_F_Flow_Identifier", "FS1_F_Flow_Input_Dest_Address", "FS1_F_Flow_Input_Dest_Port", "FS1_F_Flow_Input_Realm", "FS1_F_Flow_Input_Src_Addr", "FS1_F_Flow_Input_Src_Port", "FS1_F_Flow_Media_Type", "FS1_F_Flow_Output_Dest_Addr", "FS1_F_Flow_Output_Dest_Port", "FS1_F_Flow_Output_Realm", "FS1_F_Flow_Output_Src_Address", "FS1_F_Flow_Output_Src_Port", "FS1_F_Flow_Type", "FS1_R_Flow_Identifier", "FS1_R_Flow_Input_Dest_Address", "FS1_R_Flow_Input_Dest_Port", "FS1_R_Flow_Input_Realm", "FS1_R_Flow_Input_Src_Addr", "FS1_R_Flow_Input_Src_Port", "FS1_R_Flow_Media_Type", "FS1_R_Flow_Output_Dest_Addr", "FS1_R_Flow_Output_Dest_Port", "FS1_R_Flow_Output_Realm", "FS1_R_Flow_Output_Src_Address", "FS1_R_Flow_Output_Src_Port", "FS1_R_Flow_Type", "FS1_RTCP_Called_Avg_Jitter", "FS1_RTCP_Called_Avg_Latency", "FS1_RTCP_Called_Max_Jitter", "FS1_RTCP_Called_Max_Latency", "FS1_RTCP_Called_Packets_Lost", "FS1_RTCP_Calling_Avg_Jitter", "FS1_RTCP_Calling_Avg_Latency", "FS1_RTCP_Calling_Max_Jitter", "FS1_RTCP_Calling_Max_Latency", "FS1_RTCP_Calling_Packets_Lost", "FS1_RTP_Called_Avg_Jitter", "FS1_RTP_Called_Max_Jitter", "FS1_RTP_Called_Octets", "FS1_RTP_Called_Octets_Transmitted", "FS1_RTP_Called_Packets", "FS1_RTP_Called_Packets_Lost", "FS1_RTP_Called_Packets_Transmitted", "FS1_RTP_Calling_Avg_Jitter", "FS1_RTP_Calling_Max_Jitter", "FS1_RTP_Calling_Octets", "FS1_RTP_Calling_Octets_Transmitted", "FS1_RTP_Calling_Packets", "FS1_RTP_Calling_Packets_Lost", "FS1_RTP_Calling_Packets_Transmitted", "FS2_Called_Media_Stop_Time", "FS2_Calling_Media_Stop_Time", "FS2_F_Flow_Identifier", "FS2_F_Flow_Input_Dest_Address", "FS2_F_Flow_Input_Dest_Port", "FS2_F_Flow_Input_Realm", "FS2_F_Flow_Input_Src_Addr", "FS2_F_Flow_Input_Src_Port", "FS2_F_Flow_Media_Type", "FS2_F_Flow_Output_Dest_Addr", "FS2_F_Flow_Output_Dest_Port", "FS2_F_Flow_Output_Realm", "FS2_F_Flow_Output_Src_Address", "FS2_F_Flow_Output_Src_Port", "FS2_F_Flow_Type", "FS2_R_Flow_Identifier", "FS2_R_Flow_Input_Dest_Address", "FS2_R_Flow_Input_Dest_Port", "FS2_R_Flow_Input_Realm", "FS2_R_Flow_Input_Src_Addr", "FS2_R_Flow_Input_Src_Port", "FS2_R_Flow_Media_Type", "FS2_R_Flow_Output_Dest_Addr", "FS2_R_Flow_Output_Dest_Port", "FS2_R_Flow_Output_Realm", "FS2_R_Flow_Output_Src_Address", "FS2_R_Flow_Output_Src_Port", "FS2_R_Flow_Type", "FS2_RTCP_Called_Avg_Jitter", "FS2_RTCP_Called_Avg_Latency", "FS2_RTCP_Called_Max_Jitter", "FS2_RTCP_Called_Max_Latency", "FS2_RTCP_Called_Packets_Lost", "FS2_RTCP_Calling_Avg_Jitter", "FS2_RTCP_Calling_Avg_Latency", "FS2_RTCP_Calling_Max_Jitter", "FS2_RTCP_Calling_Max_Latency", "FS2_RTCP_Calling_Packets_Lost", "FS2_RTP_Called_Avg_Jitter", "FS2_RTP_Called_Max_Jitter", "FS2_RTP_Called_Octets", "FS2_RTP_Called_Octets_Transmitted", "FS2_RTP_Called_Packets", "FS2_RTP_Called_Packets_Lost", "FS2_RTP_Called_Packets_Transmitted", "FS2_RTP_Calling_Avg_Jitter", "FS2_RTP_Calling_Max_Jitter", "FS2_RTP_Calling_Octets", "FS2_RTP_Calling_Octets_Transmitted", "FS2_RTP_Calling_Packets", "FS2_RTP_Calling_Packets_Lost", "FS2_RTP_Calling_Packets_Transmitted", "Generic_ID", "History_Info", "IMEI", "IMSI", "Ingress_Local_Address", "Ingress_Network_Interface_ID", "Ingress_Realm", "Ingress_Remote_Address", "Ingress_RPH", "Ingress_Session_ID", "Ingress_Vlan_Tag_Value", "Intermediate_Time", "Local_timezone", "MSRP_Called_Octets", "MSRP_Called_Octets_Transmitted", "MSRP_Called_Packets", "MSRP_Called_Packets_Transmitted", "MSRP_Calling_Octets", "MSRP_Calling_Octets_Transmitted", "MSRP_Calling_Packets", "MSRP_Calling_Packets_Transmitted", "NAS_IP_Address", "NAS_Port", "Node_Func", "Node_Functionality", "ORIG_IOI", "Origin_Host", "Origin_Realm", "Originating_Trunk_Context", "Originating_Trunk_Group", "Originator", "P_Asserted_ID", "P_Visited_Network_ID", "PGW_IP_Address", "Post_Dial_Delay", "Primary_routing_Number", "refer_call_transfer_ID", "Role_Of_Node", "SDP_Answer_Timestamp", "SDP_Media", "SDP_Offer_Timestamp", "SDP_Type", "Served_Party_IP", "Service_Context_ID", "Session_Disposition", "Session_Forked_Call_Id", "Session_Protocol_Type", "SGW_IP_Address", "SIP_DIVERSION", "Sip_Method", "Sip_Status_Code", "Sms_Called_Party_Number", "Sms_Calling_Party_Number", "Sms_Msg_length", "Sms_Msg_Type", "Stir_Div_Signed_Request", "Stir_Div_Verified_Request", "Stir_Signed_Request", "Stir_Signed_Request_Exception_Id", "Stir_TN_Used_For_AS_VS_Request", "Stir_Verified_Request", "Stir_Verified_Request_Exception_Id", "Stir_VS_Invite_State", "Stir_VS_Reason", "Stir_VS_Verstat", "Subscription_ID_Data", "Subscription_ID_Type", "TERM_IOI", "Terminating_Trunk_Context", "Terminating_Trunk_Group", "User_Name" ]
Nested Schema : generate-event
Type: array
list of events like REGISTER, MESSAGE to collect. To disable leave blank (default)
Show Source
Nested Schema : generate-interim
Type: array
list of events to collect during a session
Show Source
  • Allowed Values: [ "OK", "Reinvite", "Reinvite-Response", "Reinvite-Cancel", "Unsuccessful-Attempt", "Redirect", "Egress-Invite" ]
Nested Schema : icmp-config
Type: array
Control ICMP ping by setting up an ICMP config object
Show Source
Nested Schema : IcmpConfig
Type: object
Configure this object to enable ping on the ip's selected
Show Source
Nested Schema : allowed-ip-list
Type: array
Add IPs to enable ping, Must be within the service network CIDR range
Show Source
Nested Schema : AllowlistConfig
Type: object
configure allowed elements profiles
Show Source
Nested Schema : allow-any
Type: array
Unique Items Required: true
set of default headers
Show Source
Nested Schema : rule-sets
Type: array
Unique Items Required: true
list of rule-sets
Show Source
Nested Schema : WLRuleSetConfig
Type: object
list of rule-sets
Show Source
Nested Schema : header-rules
Type: array
list of header-rules
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods to which the rule applies (applies to all methods when none are specified)
Show Source
Nested Schema : WLHeaderRuleConfig
Type: object
list of header-rules
Show Source
Nested Schema : allow-header-param
Type: array
Unique Items Required: true
the list of header parameters which are allowed, where * implies all are allowed
Show Source
Nested Schema : allow-uri-header-name
Type: array
Unique Items Required: true
the list of URI header names which are allowed, where * implies all are allowed
Show Source
Nested Schema : allow-uri-param
Type: array
Unique Items Required: true
the list of URI parameters which are allowed, where * implies all are allowed
Show Source
Nested Schema : allow-uri-user-param
Type: array
Unique Items Required: true
the list of URI user parameters which are allowed, where * implies all are allowed
Show Source
Nested Schema : AuthenticationProfile
Type: object
configure authentication profile
Show Source
Nested Schema : preshared-key
authentication password
Match All
authentication password
Show Source
Nested Schema : CodecPolicyConfig
Type: object
create and apply a codec policy to a realm and an agent
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • add-codecs-on-egress
    Specify which codecs to add. The add-codecs are only processed by the outgoing policy. Only codecs that can be transcoded may be specified. No transcodable codecs available with current system configuration.
  • allow-codecs
    Specify which codecs to allow. Specify exceptions with the :no tag. Two special type exceptions are accepted: video:no and audio:no. For example, to allow all codecs except iLBC and video: allow-codecs * iLBC:no video:no. If a codec is given a :force tag, it indicates that if the specified codec is present in the incoming offer, all non-force codecs are stripped out.
  • Allowed Values: [ "disabled", "preferred", "dual" ]
  • Enable transcode of EVRC TTY TDD to BAUDOT in EVRC-G.711 transcoded calls
  • Allowed Values: [ "disabled", "image_first", "audio_first" ]
  • Force a specific ptime on the egress offer. Enable this to ensure the ptime specified in 'packetization-time' is used.
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of the codec-policy
  • order-codecs
    Specify the order of the codecs. Matching codecs will be arranged in the SDP media description according to the specified order. Any remaining codecs will be subsequently added to the list, maintaining their original relative order as in the incoming media offer. A wildcard (*) anchors the ordering to either the start or the end of the list. For example - A B C * specifies the relative ordering of the first three codecs. * A B C specifies the relative ordering of the last three codecs. A B * C D indicates a sort of head and tail of the codec list, with everything else placed in between.
  • Minimum Value: 0
    Maximum Value: 4294967295
    This specifies the packetization time (ptime) to use in outgoing SDP offers when 'force-ptime' is enabled. The valid ptime values for each codec are as follows: PCMU 10 20 30 40 50 60, PCMA 10 20 30 40 50 60, G729 10 20 30 40 50 60, G729A 10 20 30 40 50 60, iLBC 20 30 40 60, G726 10 20 30 40 50, G726-16 10 20 30 40 50, G726-24 10 20 30 40 50, G726-32 10 20 30 40 50, G726-40 10 20 30 40 50, G723 30 60 90, G722 20 40, AMR 20 40 60, AMR-WB 20 40 60, opus 10 20 40 60, EVS 20 40 60, EVS AMR-WB IO 20 40 60, SILK 20 40 60.
  • Enable this flag to force the Cloud Native SBC to send a re-invite to a realm other than the one on which fax tone detection is enabled.
  • Removes inband DTMF tones and mutes audio completely to suppress any DTMF tone bleed-through that may accompany incoming telephone-events toward egress.
  • Minimum Value: 50
    Maximum Value: 32000
    A timer is set after a tone is detected. Upon the expiry of this timer, a re-invite will be sent if the SD has not received a re-invite from the terminating endpoint.
  • tone-detection
    Enable tone detect
Nested Schema : add-codecs-on-egress
Type: array
Specify which codecs to add. The add-codecs are only processed by the outgoing policy. Only codecs that can be transcoded may be specified. No transcodable codecs available with current system configuration.
Show Source
Nested Schema : allow-codecs
Type: array
Specify which codecs to allow. Specify exceptions with the :no tag. Two special type exceptions are accepted: video:no and audio:no. For example, to allow all codecs except iLBC and video: allow-codecs * iLBC:no video:no. If a codec is given a :force tag, it indicates that if the specified codec is present in the incoming offer, all non-force codecs are stripped out.
Show Source
Nested Schema : order-codecs
Type: array
Specify the order of the codecs. Matching codecs will be arranged in the SDP media description according to the specified order. Any remaining codecs will be subsequently added to the list, maintaining their original relative order as in the incoming media offer. A wildcard (*) anchors the ordering to either the start or the end of the list. For example - A B C * specifies the relative ordering of the first three codecs. * A B C specifies the relative ordering of the last three codecs. A B * C D indicates a sort of head and tail of the codec list, with everything else placed in between.
Show Source
Nested Schema : tone-detection
Type: array
Enable tone detect
Show Source
Nested Schema : EnforcementProfile
Type: object
configure enforcement profiles
Show Source
Nested Schema : add-certificate-info
Type: array
list of Certificate attributes to be inserted
Show Source
Nested Schema : EnumConfig
Type: object
configure enum servers
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Cache/use additional DNS records included in received Enum (NAPTR) Responses
  • Minimum Value: 0
    Maximum Value: 4294967295
    Timer interval after which an inactive cache entry is removed (seconds)
  • enum-servers
    List of ENUM servers where the first server is the primary, and the rest serve as backups
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of the enum-config to failover to
  • Minimum Value: 0
    Maximum Value: 65535
    Health query interval (seconds). 0 means health query is disabled
  • Pattern: ^$|^((\+[0-9.()-]+)|([0-9A-F*#.()-]+))(;.*)?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Health query phone number. e.g., +7815556789
  • Include source information in queries
  • Minimum Value: 0
    Maximum Value: 255
    Specifies the length of the ENUM query starting from the most significant bit
  • Minimum Value: 512
    Maximum Value: 65535
    Specifies EDNS0 capability for UDP ENUM responses larger than 512 bytes
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Enum Config name
  • Optional features/parameters
  • Allowed Values: [ "hunt", "round-robin" ]
  • Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Realm in which these enum servers are located
  • Do recursive query if NS record in answer
  • Set RD bit for remote (server) to query recursively
  • Replace Request-URI in forwarded requests
  • Pattern: ^((E2U\+([A-Za-z0-9:+]){1,32})|(([A-Za-z0-9:]){1,32}\+E2U))?(,((E2U\+([A-Za-z0-9:+]){1,32})|(([A-Za-z0-9:+]{1,32})\+E2U)))*$
    List of Enum Service Types. e.g., E2U+sip,sip+E2U,E2U+tel
  • Minimum Value: 0
    Maximum Value: 4294967295
    Maximum waiting time for a Enum response (seconds)
  • Pattern: ^$|^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$
    Top Level Domain to be used for queries using this enum configuration
Nested Schema : enum-servers
Type: array
List of ENUM servers where the first server is the primary, and the rest serve as backups
Show Source
Nested Schema : EnumServer
Type: object
Show Source
Nested Schema : HmrTestMessage
Type: object
configure a hmr test message to use for test-sip-manipulation functionality
Show Source
Nested Schema : HmrTestProfile
Type: object
configure a HMR test profile to use for test-sip-manipulation functionality
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Pattern: ^$|^(?:[1-9][0-9]?|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.(?:[0-9]{1,3})\.(?:[0-9]{1,3})\.(?:[0-9]{1,3})\:(?!0)(\d{1,4}|[1-5]\d{4}|6[0-4]\d{3}|65[0-4]\d{2}|655[0-2]\d|6553[0-5])$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]?\:(?!0)(\d{1,4}|[1-5]\d{4}|6[0-4]\d{3}|65[0-4]\d{2}|655[0-2]\d|6553[0-5])$
    local-ip:port to be used for test-sip-manipulation
  • manipulationPattern to be used for test-sip-manipulation
  • manipulationString to be used for test-sip-manipulation
  • Pattern: ^$|^(?:[1-9][0-9]?|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.(?:[0-9]{1,3})\.(?:[0-9]{1,3})\.(?:[0-9]{1,3})\:(?!0)(\d{1,4}|[1-5]\d{4}|6[0-4]\d{3}|65[0-4]\d{2}|655[0-2]\d|6553[0-5])$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]?\:(?!0)(\d{1,4}|[1-5]\d{4}|6[0-4]\d{3}|65[0-4]\d{2}|655[0-2]\d|6553[0-5])$
    remote-ip:port to be used for test-sip-manipulation
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of the HMR test profile
  • tgrpContext to be used for test-sip-manipulation
Nested Schema : HttpClientConfig
Type: object
configure an HTTP client
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of authentication configuration element
  • Pattern: ^$|^((([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])(/[0-2]?[0-9]|/3[0-2])?$|^([\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}):([\d]{1,5})$|^((([[0-9a-fA-F]]{1,4}:){7}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){6}((:[[0-9a-fA-F]]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){5}:((([[0-9a-fA-F]]{1,4}:)?[[0-9a-fA-F]]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){4}:((([[0-9a-fA-F]]{1,4}:){0,2}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){3}:((([[0-9a-fA-F]]{1,4}:){0,3}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){2}:((([[0-9a-fA-F]]{1,4}:){0,4}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([[0-9a-fA-F]]{1,4}::((([[0-9a-fA-F]]{1,4}:){0,5}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([[0-9a-fA-F]]{1,4}:){0,6}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){1,7}:)|(::))|:(53|(102[5-9]|10[3-9][0-9]{1}|1[1-9][0-9]{2}|[2-9][0-9]{3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\](:[0-9]{0,4})$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$
    IP Address
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of HTTP client configuration element
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of realm to send requests on
  • status of HTTP client configuration element
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    TLS profile name
Nested Schema : LocalPolicy
Type: object
configure a session request routing policy
Show Source
Nested Schema : from-address
Type: array
Minimum Number of Items: 1
Unique Items Required: true
from address list
Show Source
Nested Schema : policy-attributes
Type: array
list of policy attributes
Show Source
Nested Schema : source-realm
Type: array
Unique Items Required: true
A '*' denotes route available from all realms
Show Source
Nested Schema : to-address
Type: array
Minimum Number of Items: 1
Unique Items Required: true
to address list
Show Source
Nested Schema : FromTo
Type: object
Show Source
Nested Schema : LocalPolicyAttribute
Type: object
list of policy attributes
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "replace-uri", "redirect" ]
  • Allowed Values: [ "SIP" ]
  • Pattern: ^[A-Za-z0-9\!"#\$%&'\(\)\*\+-\./:;<=>\?@\[\]\^_\{\|\}~]{0,24}$|^[A-Za-z0-9\!"#\$%&'\(\)\*\+-\./:;<=>\?@\[\]\^_\{\|\}~]{1,24}$
    carrier identifier
  • Minimum Value: 0
    Maximum Value: 999999999
    cost (unitless)
  • Pattern: ^[MTWRFSUH,-]+$
    days of week policy is in effect day characters may be separated by ','s or a '-'\n M=Monday T=Tuesday W=Wednesday R=Thursday F=Friday S=Saturday U=Sunday H=Holidays\n H=holidays as defined in session router config. e.g. U-S,H meaning Saturday through Sunday and holidays
  • enable emergency location string lookup
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$
    string used as key for emergency LRT lookup
  • Pattern: ^(([0-9])|([0-5][0-9])|([0-1]?[0-9][0-5][0-9])|(2[0-3][0-5][0-9])|(2400))$
    daily time policy is no longer in effect <0000..2400>
  • Allowed Values: [ "single", "multi" ]
  • media-profiles
    list of media profiles
  • methods
    Unique Items Required: true
    list of SIP methods for matching with a SIP request method
  • Minimum Length: 1
    Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^(([Ee][Nn][Uu][Mm])|([Ll][Dd][Aa][Pp])):[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}(;key=[A-Za-z$@&][A-Za-z._\-]{0,24})?$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\*)$|^[Ll][Rr][Tt]:[A-Za-z_][A-Za-z0-9._\-]{0,23}(;key=[A-Za-z$@&][A-Za-z._\-]{0,24}(,[A-Za-z$@&][A-Za-z._\-]{0,24})?)?$|^[Ss][Aa][Gg]:[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    next signaling host address
  • next stage key for Multi-Stage Local Policy lookups
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    realm of next signaling. NOTE: does NOT need to be configure if matches the realm of Session Agent configured as next hop.
  • Pattern: ^(([0-9])|([0-5][0-9])|([0-1]?[0-9][0-5][0-9])|(2[0-3][0-5][0-9])|(2400))$
    daily time policy goes into effect <0000..2400>
  • administrative state
  • terminate route recursion with this next hop
Nested Schema : media-profiles
Type: array
list of media profiles
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
list of SIP methods for matching with a SIP request method
Show Source
  • Allowed Values: [ "INVITE", "REGISTER", "PRACK", "OPTIONS", "INFO", "SUBSCRIBE", "NOTIFY", "REFER", "UPDATE", "MESSAGE", "PUBLISH" ]
Nested Schema : entries
Type: array
Minimum Number of Items: 1
Unique Items Required: true
add response map entry
Show Source
Nested Schema : SipLocalMapEntry
Type: object
edit response map entry
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "unknown-error", "invalid-message", "cpu-overload", "media-released", "media-not-allocated", "enum-void-route", "monthly-minutes-exceed", "next-hop-sa-oos", "recv-sa-exc-constraints", "recv-sip-int-exc-constraints", "next-hop-sa-exc-constraints", "next-hop-sip-int-exc-constraints", "realm-bw-exc-poly-serv-reject", "no-steering-pool-ports-available", "no-media-flow-found", "no-media-interface-found-for-realm", "media-recording-failure", "allow-anonymous-rejection", "sdp-address-mismatch", "request-method-throttled", "reg-cache-full", "per-user-cac-exc-sessions", "per-user-nsep-exc-rate", "recv-conditional-cac-reject", "ldap-unavailable", "allowed-elements-profile-rejection", "recording-required", "hss-lir-timeout", "hss-lir-failure", "transcoding-licensed-session-capacity-reached", "dsp-resource-limit-reached", "licensed-session-capacity-reached", "fraud-protection-reject-call", "rx-rar-loss-of-bearer", "rx-rar-release-of-bearer", "rx-rar-out-of-credit", "rx-rar-failed-resources-allocation", "rx-rar-access-network-info-reporting_failure", "rx-asr-bearer-released", "rx-asr-insufficient-server-resources", "rx-asr-insufficient-bearer-resources", "rx-asr-ps-to-cs-handover", "rx-asr-sponsored-data-connectivity-disallowed" ]
  • Allowed Values: [ "REGISTER" ]
  • Minimum Value: 0
    Maximum Value: 2147483647
    Q850 cause code
  • Q850 cause comment
  • Minimum Value: 0
    Maximum Value: 999999999
    register response expires (seconds)
  • SIP response comment(in quotes)
  • Minimum Value: 0
    Maximum Value: 699
    SIP response code
Nested Schema : LocalRoutingConfig
Type: object
configure local routing servers
Show Source
Nested Schema : MediaPolicy
Type: object
configure a media profile and apply it to a realm
Show Source
Nested Schema : tos-settings
Type: array
list of tos settings
Show Source
Nested Schema : TosSetting
Type: object
list of tos settings
Show Source
Nested Schema : media-attributes
Type: array
media attribute to match within SDP
Show Source
Nested Schema : MediaProfile
Type: object
configure a media profile and apply it to a media type
Show Source
Nested Schema : SrtpPolicy
Type: object
configure media security policy
Show Source
Nested Schema : MediaSecProfileInbound
Type: object
inbound
Show Source
Nested Schema : MediaSecProfileOutbound
Type: object
outbound
Show Source
Nested Schema : entries
Type: array
Minimum Number of Items: 1
Unique Items Required: true
add response map entry
Show Source
Nested Schema : Q850SipMapEntry
Type: object
edit response map entry
Show Source
Nested Schema : QoSConstraints
Type: object
configure qos constraints
Show Source
Nested Schema : RealmConfig
Type: object
configure a realm for media management
Show Source
Nested Schema : addr-prefixes
Type: array
address prefixes to match realm. Omit number of bits for exact match. e.g. 10.0.0.0/24 or 2001:DB8:0:56::/64
Show Source
Nested Schema : auth-attribute
Type: array
list of auth-attributes
Show Source
Nested Schema : feature-trfo
Type: array
Enable/disable transcoding free operation
Show Source
Nested Schema : match-media-profiles
Type: array
media profile subtypes for realm. Supports subtypes and name wildcarding (e.g. PCMU::A PCMA:: *::B)
Show Source
Nested Schema : service-networks
Type: array
Minimum Number of Items: 1
service network this realm is available to
Show Source
Nested Schema : sti-as
Type: array
group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
Show Source
Nested Schema : sti-vs
Type: array
group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
Show Source
Nested Schema : RealmConfigAddrPrefixes
Type: object
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$
Nested Schema : SipAuthAttribute
Type: object
list of auth-attributes
Show Source
Nested Schema : in-dialog-methods
Type: array
in dialog methods to add authentication headers to
Show Source
  • Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : password
authentication password
Match All
authentication password
Show Source
Nested Schema : RealmGroup
Type: object
configure realm groups
Show Source
Nested Schema : ResponseMap
Type: object
configure SIP response maps
Show Source
Nested Schema : entries
Type: array
Unique Items Required: true
add response map entry
Show Source
Nested Schema : ResponseMapEntry
Type: object
edit response map entry
Show Source
Nested Schema : RtcpPolicy
Type: object
configure rtcp policy
Show Source
Nested Schema : SDesProfile
Type: object
configure SDES profile
Show Source
Nested Schema : crypto-list
Type: array
list of crypto suites
Show Source
  • Allowed Values: [ "AES_CM_128_HMAC_SHA1_80", "AES_CM_128_HMAC_SHA1_32", "AES_256_CM_HMAC_SHA1_80", "AEAD_AES_256_GCM" ]
Nested Schema : use-ingress-session-params
Type: array
Unique Items Required: true
allowable ingress session parameters (srtcp-encrypt, srtp-auth, srtp-encrypt)
Show Source
Nested Schema : srtp-msm-password
Password to encrypt multi-system SRTP Pass-through info
Match All
Password to encrypt multi-system SRTP Pass-through info
Show Source
Nested Schema : SessionAgent
Type: object
configure session agents
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • allow this session agent to be used as nexthop in local policy
  • Allowed Values: [ "SIP" ]
  • associated-agents
    list of Agents Associated with this session-agent
  • auth-attribute
    list of auth-attributes
  • Minimum Value: 0
    Maximum Value: 999999999
    burst rate window (seconds)
  • Minimum Value: 0
    Maximum Value: 99
    CAC utilization threshold (percent). An alarm will be generated when session utilization or burst-rate utilization exceeds this value.
  • carriers
    list of carriers
  • codec policy to apply
  • apply session constraints to agent
  • description of session agent
  • Allowed Values: [ "both", "reverse", "none" ]
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    default egress realm to use for session agent 'pings' and when multiple egress realms are possible (e.g. realm-id is empty or '*')
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of enforcement profile
  • enable or disables holding re-invite
  • Minimum Length: 1
    Pattern: ^(((((\*)|(\*\.)){0,1})([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1})|(\*?))$|^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$
    hostname at which to contact session agent
  • inbound manipulation ID
  • Minimum Value: 0
    Maximum Value: 999999999
    in service period
  • inbound translation ID
  • Pattern: ^$|^((([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]?[0-9]?|2[0-4])[0-9]|25[0-5])(/[0-2]?[0-9]|/3[0-2])?$|^([\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}):([\d]{1,5})$|^((([[0-9a-fA-F]]{1,4}:){7}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){6}((:[[0-9a-fA-F]]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){5}:((([[0-9a-fA-F]]{1,4}:)?[[0-9a-fA-F]]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){4}:((([[0-9a-fA-F]]{1,4}:){0,2}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){3}:((([[0-9a-fA-F]]{1,4}:){0,3}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){2}:((([[0-9a-fA-F]]{1,4}:){0,4}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([[0-9a-fA-F]]{1,4}::((([[0-9a-fA-F]]{1,4}:){0,5}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([[0-9a-fA-F]]{1,4}:){0,6}[[0-9a-fA-F]]{1,4})|(([[0-9a-fA-F]]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([[0-9a-fA-F]]{1,4}:){1,7}:)|(::))|:(53|(102[5-9]|10[3-9][0-9]{1}|1[1-9][0-9]{2}|[2-9][0-9]{3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\](:[0-9]{0,4})$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$
    IP Address if hostname is FQDN (optional)
  • Allowed Values: [ "inherit", "disabled", "enabled" ]
  • Allowed Values: [ "inherit", "disabled", "enabled" ]
  • session agent is trusted for Lawful Intercept or not
  • Allowed Values: [ "hunt", "round-robin" ]
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of local response map to use for the SA
  • enable loose routing
  • regular expression that can be used in header manipulation rules
  • string that can be used in header manipulation rules
  • match-identifier
    Identification criteria to match this agent
  • Minimum Value: 0
    Maximum Value: 999999999
    max burst rate (invites per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max inbound burst rate (invites per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max inbound sessions allowed to this agent
  • Minimum Value: 0
    Maximum Value: 999999999
    max inbound sustained rate (invites per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max outbound burst rate (invites per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max outbound sessions allowed to this agent
  • Minimum Value: 0
    Maximum Value: 999999999
    max outbound sustained rate (invites per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    maximum reg sustain rate (register per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max sessions allowed to and from this agent
  • Minimum Value: 0
    Maximum Value: 999999999
    max sustained rate (invites per second)
  • media-profiles
    list of media profiles
  • Minimum Value: 0
    Maximum Value: 100
    minimum answer seizure ratio (percentage)
  • Minimum Value: 1
    Maximum Value: 999999999
    minimum number of seizures for a no-answer scenario
  • optional features/parameters
  • Outbound Manipulation Id
  • Pattern: ^$|^[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$|^[2-6][0-9][0-9]-[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$
    Response codes for Any Dialog creating or Ping Request that make the SA OOS
  • Outbound Translation Id
  • p-asserted-id(URI Format) for Session Agent
  • SIP ping all adresses from DNS query
  • ping From User Part
  • Pattern: ^$|^[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$|^[2-6][0-9][0-9]-[2-6][0-9][0-9]((,[2-6][0-9][0-9])|(,[2-6][0-9][0-9]-[2-6][0-9][0-9]))*$
    Response codes for PING Resuest that make the SA InService
  • Minimum Value: 0
    Maximum Value: 4294967295
    how often to ping SA (seconds)
  • SIP message/method used for pinging
  • OPTIONS received will be considered as ping and will be locally responded
  • Allowed Values: [ "keep-alive", "continuous" ]
  • ping To User Part
  • Minimum Value: 0
    Maximum Value: 65535
    port to contact session agent
  • Minimum Value: 0
    Maximum Value: 4294967295
    Selection precedence of Session Agents with same IP address
  • Allowed Values: [ "Stateless", "Proxy", "Redirect", "Record-Route" ]
  • rate-constraints
    create a rate constraint for a method
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    realm this session agent resides in
  • Allowed Values: [ "Proxy", "Recurse", "Recurse-305-only" ]
  • Allowed Values: [ "disabled", "enabled", "dynamic" ]
  • Allowed Values: [ "none", "initial", "all" ]
  • Allowed Values: [ "None", "URI-param", "Prefix" ]
  • request-uri-headers
    list of headers which need to be inserted in the RE-INVITE from the contact Header
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    response map name
  • Allowed Values: [ "NONE", "TCP", "SCTP", "TLS" ]
  • Allowed Values: [ "none", "transparent", "preferred", "dual" ]
  • Minimum Value: 0
    Maximum Value: 127
    payload type used by the SA in preferred rfc2833-mode (0,128>x>95)
  • send media session description
  • Enables or disables sending TCP FIN messages when SA is Out of Service
  • Minimum Value: 1
    Maximum Value: 2073600
    maximum life limit a SIP session can stay active (secs). Range 1-2073600.
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of sip-isup profile
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of sip profile
  • Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    SIP Recursion Policy
  • optional features/parameters
  • administrative state
  • sti-as
    group name or list of STI authentication server (up to four allowed). E.g. STG:<STI-group-name> (for STI Server Group), <STI-name> (for single STI Server)
  • Pattern: ^$|^[A-C]$
    Attestation Values can be either A, B, C or Empty. (A: Full Attestation, B: Partial Attestation, C: Gateway Attestation)
  • Pattern: ^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
    UUID4 added to STI-AS requests, if not already present. Leave empty to pick up the UUID from the upstream config object
  • Retrieve attestation value and OrigId from SIP headers, when present. (Attestation-Info: attest [A/B/C], Origination-ID: origId [UUID])
  • sti-vs
    group name or list of STI validation server (up to four allowed). E.g. STG:<STI-group-name> (for STI Server Group), <STI-name> (for single STI Server)
  • Response codes that stop recursion of targets/contacts
  • Minimum Value: 0
    Maximum Value: 999999999
    sustained rate window (seconds)
  • Allowed Values: [ "none", "enabled", "disabled" ]
  • TCP/SCTP Reconnection Interval
  • Minimum Value: 0
    Maximum Value: 999999999
    time to resume
  • Allowed Values: [ "UDP", "UDP+TCP", "DynamicTCP", "StaticTCP", "DynamicTLS", "StaticTLS", "StaticSCTP", "ANY" ]
  • trunk-group
    list of trunk groups and their contexts. To use the default context case, omit : and the context
  • whether this session agent is trusted or not
  • Minimum Value: 0
    Maximum Value: 999999999
    no response time to resume
Nested Schema : associated-agents
Type: array
list of Agents Associated with this session-agent
Show Source
Nested Schema : auth-attribute
Type: array
list of auth-attributes
Show Source
Nested Schema : carriers
Type: array
list of carriers
Show Source
Nested Schema : match-identifier
Type: array
Identification criteria to match this agent
Show Source
Nested Schema : media-profiles
Type: array
list of media profiles
Show Source
Nested Schema : rate-constraints
Type: array
create a rate constraint for a method
Show Source
Nested Schema : request-uri-headers
Type: array
list of headers which need to be inserted in the RE-INVITE from the contact Header
Show Source
Nested Schema : sti-as
Type: array
group name or list of STI authentication server (up to four allowed). E.g. STG:<STI-group-name> (for STI Server Group), <STI-name> (for single STI Server)
Show Source
Nested Schema : sti-vs
Type: array
group name or list of STI validation server (up to four allowed). E.g. STG:<STI-group-name> (for STI Server Group), <STI-name> (for single STI Server)
Show Source
Nested Schema : trunk-group
Type: array
list of trunk groups and their contexts. To use the default context case, omit : and the context
Show Source
Nested Schema : SessionAgentIdentifier
Type: object
Identification criteria to match this agent
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Minimum Length: 1
    Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    specify the session-agent-identifier-rule which will be used to identify this agent if not matching by IP Address
  • Minimum Length: 1
    Pattern: ^.*$
    value to match in sip header field which identifies this Session Agent
Nested Schema : RateConstraints
Type: object
create a rate constraint for a method
Show Source
Nested Schema : SessionAgentIdentifierRule
Type: object
configure alternative session-agent identification rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Minimum Length: 1
    Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    sip header used to identify the Session Agent
  • Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    parameter within the specified sip header field to be used to identify the Session Agent
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of the identification scenario
  • Allowed Values: [ "none", "uri-param", "uri-header", "uri-user", "uri-host", "uri-port", "uri-user-param", "uri-display", "uri-user-only", "uri-phone-number-only" ]
Nested Schema : SessionConstraints
Type: object
configure session constraints
Show Source
Nested Schema : rate-constraints
Type: array
create a rate constraint for a method
Show Source
Nested Schema : SessionAgentGroup
Type: object
configure session agent groups
Show Source
Nested Schema : dest
Type: array
list of destinations for this group
Show Source
Nested Schema : trunk-group
Type: array
list of trunk groups and their contexts for this group. To use the default context case, omit : and the context
Show Source
Nested Schema : holidays
Type: array
list of holidays
Show Source
Nested Schema : Holiday
Type: object
list of holidays
Show Source
Nested Schema : SessionTimerProfile
Type: object
configure session timer profile
Show Source
Nested Schema : SessionTranslation
Type: object
configure translation rules for calling and called numbers
Show Source
Nested Schema : rules-asserted-id
Type: array
Manipulates the SIP P-Asserted-Id header
Show Source
Nested Schema : rules-called
Type: array
list of <called translation rule name>
Show Source
Nested Schema : rules-calling
Type: array
list of <calling translation rule name>
Show Source
Nested Schema : rules-history-info
Type: array
Manipulates the SIP History-Info headers
Show Source
Nested Schema : rules-isup-cdpn
Type: array
Manipulates the ISUP Called Party Number parameter
Show Source
Nested Schema : rules-isup-cgpn
Type: array
Manipulates the ISUP Calling Party Number parameter
Show Source
Nested Schema : rules-isup-gn
Type: array
Manipulates the ISUP Generic Number parameter
Show Source
Nested Schema : rules-isup-ocn
Type: array
list of IsupOcn < translation rule name>
Show Source
Nested Schema : rules-isup-rdn
Type: array
Manipulates the ISUP Redirecting and Original Called Number parameters
Show Source
Nested Schema : rules-redirect
Type: array
Manipulates the SIP Diversion headers
Show Source
Nested Schema : SipAdvancedLogging
Type: object
Configure logging of specific SIP requests/session by criteria
Show Source
Nested Schema : conditions
Type: array
List of conditions to match for logging
Show Source
Nested Schema : SipAdvancedLogCondition
Type: object
Configure conditions for matching SIP requests/sessions
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "exact-match", "regex-match" ]
  • Allowed Values: [ "request-type", "recv-agent", "recv-realm", "request-uri-user", "request-uri-host", "to-header-user", "to-header-host", "from-header-user", "from-header-host", "call-id" ]
  • Exact value to match or regular expression format. For match-type = request-type, Valid Values : REGISTER, INVITE, ACK, BYE, CANCEL, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH
Nested Schema : proxy-sub-events
Type: array
Unique Items Required: true
subscription events to do in proxy mode
Show Source
Nested Schema : SipFeature
Type: object
configure SIP option tag parameters
Show Source
Nested Schema : SipInterface
Type: object
configure SIP interfaces
Show Source
Nested Schema : add-sdp-in-msg
Type: array
Insert SDP in sip message
Show Source
Nested Schema : add-sdp-profiles
Type: array
list of media profiles
Show Source
Nested Schema : add-sdp-profiles-in-msg
Type: array
list of media profiles
Show Source
Nested Schema : carriers
Type: array
list of carriers
Show Source
Nested Schema : p-early-media-direction
Type: array
Configure early-media-direction parameter for P-Early-Media header
Show Source
  • Allowed Values: [ "sendrecv", "sendonly", "recvonly", "inactive" ]
Nested Schema : sip-ports
Type: array
list of SIP ports
Show Source
Nested Schema : sti-as
Type: array
group name or list of STI authentication server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
Show Source
Nested Schema : sti-vs
Type: array
group name or list of STI validation server (up to four allowed). STG:<STI-group-name> (for STI Server Group) <STI-name> (for single STI Server)
Show Source
Nested Schema : SipPort
Type: object
list of sip-ports
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Minimum Length: 1
    Pattern: ^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[1-9][0-9]?|0?[0-9]?[1-9])(\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]?[0-9])){2}\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9][0-9]?|0?[0-9]?[0-9])(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^\[(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\]?(:(?:53|102[5-9]|10[3-9][0-9]|[1-9][0-9]{3}|[1-5][0-9]{4}|6[0-5]{2}[0-3][0-5]))?$|^(?:[1-9a-fA-F]{1,4}:){7}[1-9a-fA-F]{1,4}$|^(\:\:)?[1-9a-fA-F]{1,4}(\:\:?[0-9a-fA-F]{1,4}){0,7}(\:\:)?$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.|$)){4})$|^([0-9A-Fa-f]{0,4}:){2,7}([0-9A-Fa-f]{1,4}$|[0-9a-fA-F]{0,4}(\:[0-9a-fA-F]{0,4}){0,5}(::?)|[0-9a-fA-F]{1,4}|6[0-5]{2}[0-4]\d|6[0-4]{2}\d{2}|6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]{2}\d{3})$
    IP Address
  • Allowed Values: [ "all", "agents-only", "realm-prefix" ]
  • Minimum Value: 1
    Maximum Value: 65535
    port
  • tls profile name
  • Allowed Values: [ "UDP", "TCP", "TLS", "SCTP" ]
Nested Schema : SipManipulation
Type: object
configure SIP manipulations
Show Source
Nested Schema : SipManipOrderEntry
Type: object
order of sip manipulation rules
Show Source
Nested Schema : header-rules
Type: array
list of header rules
Show Source
Nested Schema : join-headers
Type: array
Unique Items Required: true
list of headers to be joined into a single, comma separated header. Joining of headers occurs after execution of any manipulation rules e.g. Diversion,Route,Via
Show Source
Nested Schema : mime-isup-rules
Type: array
list of mime isup rules
Show Source
Nested Schema : mime-rules
Type: array
list of mime rules
Show Source
Nested Schema : mime-sdp-rules
Type: array
list of mime sdp rules
Show Source
Nested Schema : split-headers
Type: array
Unique Items Required: true
list of headers to be split and treated as separate headers. Splitting of headers occurs prior to the execution of any manipulation rules e.g. Diversion,Route,Via
Show Source
Nested Schema : rules-order
Type: array
list of header,mime,mime-isup and mime-sdp rules
Show Source
Nested Schema : SipHdrRule
Type: object
list of header rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • element-rules
    list of element-rules
  • Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
    header name for which rule needs to be applied
  • value to match against the current object. To clear the match-value, enter an empty string
  • methods
    Unique Items Required: true
    specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL
  • Allowed Values: [ "any", "request", "reply", "out-of-dialog" ]
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : element-rules
Type: array
list of element-rules
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL
Show Source
  • Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : SipElemRule
Type: object
list of element-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete-element", "delete-header", "log", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • Allowed Values: [ "any", "ip", "fqdn" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • element param name for which rule needs to be applied
  • Allowed Values: [ "none", "header-value", "header-param", "uri-param", "uri-header", "uri-user", "uri-host", "uri-port", "uri-user-param", "teluri-param", "uri-display", "uri-param-name", "uri-header-name", "header-param-name", "status-code", "reason-phrase", "mime", "uri-user-only", "uri-phone-number-only" ]
Nested Schema : MimeIsupRule
Type: object
list of mime isup rules
Show Source
Nested Schema : isup-msg-types
Type: array
Unique Items Required: true
specifies a list of isup message types that the mime isup rule applies to (applies to all ISUP messages when none are specified) e.g.: IAM, ACM
Show Source
Nested Schema : isup-param-rules
Type: array
list of isup-param-rules
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to (applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
Nested Schema : mime-header-rules
Type: array
list of mime-header-rules
Show Source
Nested Schema : rules-order
Type: array
list of mime-header and isup-param rules
Show Source
Nested Schema : IsupParamRule
Type: object
list of isup-param-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • Allowed Values: [ "raw-binary", "hex-ascii", "bcd", "binary-ascii", "ascii-string", "number-param" ]
  • value to match against the current object. To clear the match-value, update with an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. To clear the newValue, update with an empty string
  • Pattern: ^((25[0-5])|(2[0-4][0-9])|(1[0-9][0-9])|([0-9]([0-9])?))(\[([*^]|[0-9]+)\])?$
    parameter type specifying which part of the isup body will be manipulated
Nested Schema : MimeHeaderRule
Type: object
list of mime-header-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
    header within mime part for which rule needs to be applied. To change the preamble of a SIP body, use the header name @preamble. To change the epilogue of a SIP body, use the header name @epilogue
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : MimeRule
Type: object
list of mime rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • Pattern: ^[A-Za-z0-9.!%*_+`'~/-]+(;.+)*(\[(([0-9]+)|([*^]))\])?$
    Content-Type header for which rule needs to be applied
  • Allowed Values: [ "ascii-string", "hex-ascii", "binary-ascii" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • methods
    Unique Items Required: true
    specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
  • mime-header-rules
    list of mime-header-rules
  • Allowed Values: [ "any", "request", "reply", "out-of-dialog" ]
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes(e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
  • Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : mime-header-rules
Type: array
list of mime-header-rules
Show Source
Nested Schema : MimeSdpRule
Type: object
list of mime sdp rules
Show Source
Nested Schema : methods
Type: array
Unique Items Required: true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
Nested Schema : mime-header-rules
Type: array
list of mime-header-rules
Show Source
Nested Schema : rules-order
Type: array
list of mime-header ,sdp-session and sdp-media rules
Show Source
Nested Schema : sdp-media-rules
Type: array
list of sdp-media-rules
Show Source
Nested Schema : sdp-session-rules
Type: array
list of sdp-session-rules
Show Source
Nested Schema : SdpMediaRule
Type: object
list of sdp-media-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
    media type to manipulate (e.g. audio, video, etc.)
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • sdp-line-rules
    list of sdp-line-rules
Nested Schema : sdp-line-rules
Type: array
list of sdp-line-rules
Show Source
Nested Schema : SdpLineRule
Type: object
list of sdp-line-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • Pattern: ^[A-Za-z](\[(([0-9]+)|([*^]))\])?$
    descriptor type specifying which line of the sdp will be manipulated
Nested Schema : SdpSessionRule
Type: object
list of sdp-session-rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "reject" ]
  • Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
  • value to match against the current object. To clear the match-value, enter an empty string
  • Minimum Length: 1
    Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
    unique name for rule
  • new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
  • sdp-line-rules
    list of sdp-line-rules
Nested Schema : sdp-line-rules
Type: array
list of sdp-line-rules
Show Source
Nested Schema : SipNatConfig
Type: object
configure sip nat across realms
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])(/([0-2]?[0-9]|3[0-2]))?$|^(\*)$
    address prefix subject to SIP-NAT encoding <ipv4>[/<num-bits>] (e.g., 10.0.0.1/24) OR '*' to use the Realm's address prefix OR '0.0.0.0' to use the inverse of Home Realm's prefix
  • Minimum Length: 1
    domain suffix to use in external realm (e.g., '.acme.com')
  • Minimum Length: 1
    Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$
    external realm IPv4 address
  • Minimum Length: 1
    Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$
    external realm proxy IPv4 address
  • Minimum Value: 1025
    Maximum Value: 65535
    external realm proxy port
  • headers
    Unique Items Required: true
    list of SIP Header names to be NAT'd
  • Minimum Length: 1
    Pattern: $|^(?:(?:[0-9]{1,3}.){3}[0-9]{1,3}(?:/(?:[0-9]|[12][0-9]|3[0-2]))?|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}|:(?::[0-9a-fA-F]{1,4}){1,7}|::)(?:/(?:[0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$
    home realm IPv4 address
  • Pattern: ^$|^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[1-9][0-9]?|0?[0-9]?[1-9])(.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]?[0-9])){2}.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9][0-9]?|0?[0-9]?[0-9])$
    home realm proxy IPv4 address
  • Minimum Value: 0
    Maximum Value: 65535
    home realm proxy port
  • Pattern: ^[A-Za-z0-9-]{1,63}$
    URL host tag for NAT disambiguation. Default: ACME-
  • URL parameter name for NAT encoding
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    external realm identifier
  • Allowed Values: [ "disabled", "enabled", "forced" ]
  • pass back Contact URIs unchanged in redirect response
  • Allowed Values: [ "none", "from-to", "phone", "all" ]
  • URL user tag for NAT disambiguation. Default: -acme-
Nested Schema : headers
Type: array
Unique Items Required: true
list of SIP Header names to be NAT'd
Show Source
Nested Schema : SipProfile
Type: object
configure sip profile
Show Source
Nested Schema : entries
Type: array
Minimum Number of Items: 1
Unique Items Required: true
add response map entry
Show Source
Nested Schema : SipQ850MapEntry
Type: object
edit response map entry
Show Source
Nested Schema : SipRecursionPolicy
Type: object
configure SIP recursion policy
Show Source
Nested Schema : sip-resp-code-attempts
Type: array
list of SIP response code attempts
Show Source
Nested Schema : SipRespCodeAttempts
Type: object
list of SIP response code settings
Show Source
Nested Schema : plugins
Type: array
list of spl plugins
Show Source
Nested Schema : SplPluginConfig
Type: object
list of spl plugins
Show Source
Nested Schema : SteeringPool
Type: object
specify one or more ports for steering media flows
Show Source
Nested Schema : SteeringPoolIpList
Type: object
Create an IP address list that will be referenced in a steering-pool
Show Source
Nested Schema : ip-addr-list
Type: array
Minimum Number of Items: 1
List of media IP addresses for the steering pool
Show Source
Nested Schema : StiHeaderMappingRuleset
Type: object
configure a set of rules for SIP and HTTP header mapping
Show Source
Nested Schema : mapping-rules
Type: array
list of rules required for SIP and HTTP header mapping
Show Source
Nested Schema : StiHeaderMappingRules
Type: object
list of SIP and HTTP header mapping rules
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Allowed Values: [ "outbound", "inbound" ]
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    unique identifier for the mapping rule
  • Allowed Values: [ "STI-AS", "STI-VS" ]
  • Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([~^]))\])?$
    name of the SIP or HTTP header to be picked from the ingress INVITE or HTTP response
  • Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$
    SIP or HTTP header param based on the source header. If source-header is empty, this should be a key in HTTP body JSON claim
  • Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([~^]))\])?$
    name of the SIP or HTTP header to be added or modified to the egress INVITE or the HTTP request
  • Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$
    SIP or HTTP header param based on target header. If target-header is empty, this should be a key in HTTP body JSON claim
Nested Schema : StiResponseTreatmentConfig
Type: object
configure STI Response treatment config for STIR/SHAKEN
Show Source
Nested Schema : sti-response-treatment-entries
Type: array
verstat and reason code mapping for sti response
Show Source
Nested Schema : StiResponseTreatmentEntries
Type: object
list of entries of sti responses for STI Verification
Show Source
Nested Schema : StiServer
Type: object
configure STIR/SHAKEN STI servers
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Pattern: ^http[s]{0,1}://((([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))|(\[((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))\]))(:((((([0-5]?[0-9]?)|6[0-4])?[0-9]|65[0-4])?[0-9]|655[0-2])?[0-9]|6553[0-5])){0,1}(/[A-Za-z0-9\-\_\.\%]{1,128})*$
    STIR Authentication server (STI-AS) URL should start with http:// or https://. The host can be a hostname, IPv4, or [IPv6], and the port is optional (default: 80 for http, 443 for https).
  • Minimum Value: 0
    Maximum Value: 999999999
    burst rate window (seconds)
  • brief description of the STI server
  • Pattern: ^http[s]{0,1}://((([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))|(\[((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))\]))(:((((([0-5]?[0-9]?)|6[0-4])?[0-9]|65[0-4])?[0-9]|655[0-2])?[0-9]|6553[0-5])){0,1}(/[A-Za-z0-9\-\_\.\%]{1,128})*$
    STIR Div Authentication server (STI-AS) URL should start with http:// or https://. The host can be a hostname, IPv4, or [IPv6], and the port is optional (default: 80 for http, 443 for https).
  • Pattern: ^http[s]{0,1}://((([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))|(\[((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))\]))(:((((([0-5]?[0-9]?)|6[0-4])?[0-9]|65[0-4])?[0-9]|655[0-2])?[0-9]|6553[0-5])){0,1}(/[A-Za-z0-9\-\_\.\%]{1,128})*$
    STIR Div Verification server (STI-AS) URL should start with http:// or https://. The host can be a hostname, IPv4, or [IPv6], and the port is optional (default: 80 for http, 443 for https).
  • Allowed Values: [ "none", "enabled", "disabled" ]
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    HTTP client name
  • Allowed Values: [ "3GPP", "ATIS" ]
  • Minimum Value: 0
    Maximum Value: 999999999
    max burst rate (requests per second)
  • Minimum Value: 0
    Maximum Value: 999999999
    max sustained rate (requests per second)
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    STI server name
  • optional features/parameters
  • Pattern: ^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
    UUID4 orig-id is added on originating calls. Enter an empty string or Zero UUID (00000000-0000-0000-0000-000000000000) to auto-generate a UUID4 orig-id.
  • Allowed Values: [ "none", "enabled", "disabled" ]
  • Allowed Values: [ "STI-AS", "STI-VS", "BOTH" ]
  • status of STI server configuration element
  • Minimum Length: 1
    Pattern: ^$|^[A-C]$
    Attestation values can be A, B, or C. A: Full Attestation, B: Partial Attestation, C: Gateway Attestation
  • name of the instance of sti-header-mapping-ruleset
  • Allowed Values: [ "none", "enabled", "disabled" ]
  • if name is valid, it overrides the sti-config settings.
  • Minimum Value: 0
    Maximum Value: 999999999
    sustained rate window (seconds)
  • Minimum Value: 100
    Maximum Value: 30000
    Timeout in milliseconds; if reached, the call continues without a STIR query.
  • Delimiter is used to refine the text of the verstat during verstat retrieval processes
  • Pattern: ^http[s]{0,1}://((([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))|(\[((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))\]))(:((((([0-5]?[0-9]?)|6[0-4])?[0-9]|65[0-4])?[0-9]|655[0-2])?[0-9]|6553[0-5])){0,1}(/[A-Za-z0-9\-\_\.\%]{1,128})*$
    STIR Verification server (STI-AS) URL should start with http:// or https://. The host can be a hostname, IPv4, or [IPv6], and the port is optional (default: 80 for http, 443 for https).
Nested Schema : StiServerGroup
Type: object
configure high availability for STIR/SHAKEN STI servers
Show Source
Nested Schema : sti-servers
Type: array
Minimum Number of Items: 1
list of STI servers
Show Source
Nested Schema : TeSteeringPoolIpList
Type: object
The Transcode Engine Steering Pool IP List creates steering pool IP list at the Transcode Engine
Show Source
  • Read Only: true
    Identifier for the element or sub-element
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    Name of steering pool IP list
  • ip-addr-list
    Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)
  • Minimum Length: 1
    Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
    name of service network this pool is used for
Nested Schema : ip-addr-list
Type: array
Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)
Show Source
Nested Schema : TLSProfile
Type: object
configure the parameters for running SIP over TLS
Show Source
Nested Schema : cipher-list
Type: array
Minimum Number of Items: 1
list of ciphers
Show Source
  • Allowed Values: [ "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384", "TLS_AES_128_GCM_SHA256", "TLS_AES_128_CCM_SHA256", "TLS_CHACHA20_POLY1305_SHA256", "DEFAULT", "NONE" ]
Nested Schema : trusted-ca-certificates
Type: array
list of trusted certificate records
Show Source
Nested Schema : version-list
Type: array
Minimum Number of Items: 1
list of TLS version
Show Source
Nested Schema : TranslationRules
Type: object
configure and apply session translation rules to agents and realms
Show Source
Nested Schema : XcodeMeSteeringPool
Type: object
The Xcode Media Engine Steering Pool creates steering pool at the Media Engine
Show Source
Nested Schema : XcodeTeSteeringPool
Type: object
The Xcode Transcode Engine Steering Pool creates steering pool at the Transcode Engine
Show Source

404 Response

Not Found
Body ()
Root Schema : ApiValidationError
Type: object
Show Source
Nested Schema : errors
Type: array
Show Source
Nested Schema : Errors
Type: object
Show Source

406 Response

Validation Failure
Body ()
Root Schema : ApiValidationError
Type: object
Show Source
Nested Schema : errors
Type: array
Show Source
Nested Schema : Errors
Type: object
Show Source
Back to Top