Provisioning for all elements of the IMS can be completed through the web UI or the API. This chapter provides a reference of all the objects that can be provisioned and the acceptable values that can be assigned. For more information about how to access and provision these objects, see Application Programming Interface or Web-Based User Interface.
The Platform Owner must first define the IMS domains to be served and one or more configuration keys for Service Providers. The configuration key represents an IMS domain or set of IMS domains that is assigned to a particular Service Provider. The configuration key then determines the data that is accessible for provisioning by the Service Provider.
It is recommended that a configuration key be human-identifiable, contain only alphanumeric characters, underscores, or hyphens, and be less than 30 characters in length.
Cluster Configuration with etcd
The IMS Suite uses etcd version 3.3.10 for data storage.
The etcd component can initially establish the configuration for a cluster, and if there is no host IP address renumbering or alteration, nothing needs to be changed for proper functionality. Adding an AS or NIU is expected to work if the cluster is healthy with a normal install or synchronize operation. Both changing the IP address of an existing node and removing an existing node are not handled automatically and would require manual intervention.
Note
We recommend contacting Customer Support for assistance with removing or changing the IP address of an existing node.
It is also important to note that etcd is a coherent clustering system that requires a quorum, meaning that the resiliency of the system is dependent on enough of the nodes remaining running and being able to communicate.
For more information about etcd and cluster reconfiguration options, see the etcd Operations Guides.
IMS domains can be created or modified using the Domains tab in the web UI or the domain endpoint in the API.
A shared object between Platform Owners and all Service Providers. These are the IMS domains created by Platform Owners and assigned to Service Providers. Platform Owners are able to create array entries, while Service Providers are only able to modify the IMS domains that are provisioned as available to them.
Once the IMS domains and Service Providers are provisioned, the Service Providers can provision each element using the objects defined below. The configuration key previously created by the Platform Owner is represented by <key> in the syntax of each object name. If <key> is not present in the name, that object can only be modified by the Platform Owner.
An integer that defines the time, in seconds, to wait for a response from Drop-to-Java calls.
Note
This object can be modified by the Platform Owner only.
A string representing a full domain name that resolves to the I-CSCF. This value can be anything resolvable by DNS and is used to populate the Record-Route header field. For example, icscf.ims.example.com.
An array of strings specifying potential internal S-CSCFs (overrides) to match against candidate S-CSCFs (returned from the HSS).
A boolean value that determines whether the P-Profile-Key header field is supported.
A boolean value that determines whether the P-User-Database header field is supported.
domain - A string specifying which domain is being redirected to the subdomain.
addr - A string, resolvable by DNS, specifying the address of the subdomain.
A boolean value that determines whether elevated priority for sessions is supported.
regex - A regex string to match against the incoming public identity.
scscfAddress - A string, resolvable by DNS, defining the address of the static S-CSCF.
An array of strings, resolvable by DNS, specifying each realm to be used when requests with a tel URI have an unknown realm. For example, ims.example.com.
An array of strings, resolvable by DNS, specifying each address to send unknown tel URIs to if tel-uri-forwarding-supported is set to TRUE.
A boolean value that determines whether forwarding of unknown tel URIs to specified locations is supported. If set to TRUE, the tel-uri-forwarding-locations must be specified.
An integer that defines the time, in seconds, to wait for a response from the S-CSCF or the HSS.
A numeric ID for this set of preloaded IFC XML.
Note
This object can be modified only by the Platform Owner. A Service Provider can view these IFCs and apply them to their S-CSCF domains in a configuration key.
Note
IFC rules strictly follow specifications in Annex E “XML schema for the Cx interface user profile” of TS 129.228.
An integer that defines the time, in seconds, for contacting an individual host when DNS-based load balancing is in use.
An integer that defines the time, in seconds, for contacting an application server before continuing or terminating a session.
name - A required string representing the name of the authorization method.
reauth-every-register - A boolean value that determines whether a user is re-authenticated on every register request.
An array of strings specifying domain suffixes to use for E.164 Number Mapping (ENUM).
A boolean value that determines whether the HSS is enabled and therefore contacted. This value has no effect on the REGISTER call flow.
A boolean value that determines whether the IFCs can be overridden.
regex - A POSIX extended regex string specifying override behavior.
ifc - An array of integers representing IDs of the IFCs being overridden.
An integer that defines the maximum number of DNS records from host lookup to use before returning a failure response.
An integer that defines the maximum chain of Name Authority Pointer (NAPTR) records to traverse for ENUM.
An integer that defines the maximum duration, in seconds, for a REGISTER.
An integer that defines the maximum duration, in seconds, for a SUBSCRIBE.
An integer that defines the minimum duration, in seconds, for a REGISTER. Any non-zero duration lower than this value will be sent a 423 Interval too brief.
A boolean value that determines whether, when looking up a destination for an IFC target using DNS, the order of returned records is randomized before attempting to contact them.
A string representing a full domain name that resolves to the S-CSCF. This value can be anything resolvable by DNS and is used to populate the Record-Route header field. For example, scscf.ims.example.com.
A string representing the SIP URI for the S-CSCF that will be sent to the HSS via the Server Name field.
A string representing the SIP URI for the S-CSCF that will be sent via the Service-Route header.
A comma-separated list of SIP response codes that will invoke the same behavior as a timeout.
A string representing the URI to use as the public-safety answering point (PSAP) destination to forward to.
Regex match against the To header to determine if a call is to an emergency number/URI.
Regex to match against the P-Asserted-Identity header to determine if a call is anonymous.
The XML payload to return in a 380 Alternative Service response when a non-emergency call is received at the E-CSCF.
The XML payload to return in a 380 Alternative Service response when an emergency registration is required.
A string representing the URI for the E-CSCF to use for itself when signaling to other elements.
A string representing the Advanced Message Queuing Protocol (AMQP) exchange type. The default exchange is a direct exchange, which delivers messages to queues based on the routing key.
A string representing the name of the AMQP inbound queue.
A string representing the routing key of the AMQP inbound queue. The purpose of the routing key is to act like a filter and select certain messages published to an exchange to be routed to the bound queue.
A string representing the name of the AMQP outbound queue.
A string representing the routing key of the AMQP outbound queue. The purpose of the routing key is to act like a filter and select certain messages published to an exchange to be routed to the bound queue.
An array of strings representing the URI parameters used by a client to establish and negotiate an AMQP connection.
A string representing the data coding byte to be applied to all outbound messages.
A string representing the destination Numbering Plan Indicator (NPI) to use for all outbound messages.
A string representing the destination Type Of Numbering (TON) to use for all outbound messages.
A string representing the Evolved Packet System (EPS) Session Management (ESM) Class byte to use for all destination numbers.
A string representing the name of character set to use for all outbound messages.
A set of integers that define the 5-minute, 1-hour, and 24-hour destination rate limits and source rate limits for the sender rewrite feature.
A string representing the source NPI to use for all outbound messages.
A string representing the source TON to use for all outbound messages.