Configuring the IMS Software
To configure the IMS software:
- Configure initial properties, including the connection to the directory and directory monitoring properties.
See Configuring Initial Properties for IMS.
See Configuring Directory Connection Properties for IMS.
See Configuring Initial Directory Eventing Properties for IMS.
See Configuring the Local Diameter Peer.
See Configuring the Remote Diameter Peer.
See Configuring Logging Destinations.
See Configuring the Subscriber Type.
See Configuring a NIC Proxy for IMS.
You must restart the IMS process after you commit a configuration change. To restart IMS, see Restarting the IMS Process.
Configuring Initial Properties for IMS
Use the following configuration statements to configure initial properties for IMS:
slot number ims initial {static-dn static-dn;dynamic-dn dynamic-dn;}To configure initial local properties:
- From configuration mode, access the configuration statement that configures the initial properties.
user@host# edit slot 0 ims initial- Specify the properties for IMS.
[edit slot 0 ims initial]user@host# set ?For more information about configuring local properties for SRC components, see SRC-PE Getting Started Guide, Chapter 30, Configuring Local Properties with the SRC CLI.
Configuring Directory Connection Properties for IMS
Use the following configuration statements to configure directory connection properties for IMS:
slot number ims initial directory-connection {url url;backup-urls [backup-urls...];principal principal;credentials credentials;protocol (ldaps);timeout timeout;check-interval check-interval;blacklist;snmp-agent;}To configure directory connection properties:
- From configuration mode, access the configuration statement that configures the directory connection properties.
user@host# edit slot 0 ims initial directory-connection- Specify the properties for IMS.
[edit slot 0 ims initial directory-connection]user@host# set ?For more information about configuring local properties for the SRC components, see SRC-PE Getting Started Guide, Chapter 30, Configuring Local Properties with the SRC CLI.
- (Optional) Verify your configuration.
[edit slot 0 ims initial directory-connection]user@host#show
url ldap://127.0.0.1:389/;principal cn=conf,o=Operators,<base>;credentials ********;Configuring Initial Directory Eventing Properties for IMS
Use the following configuration statements to configure directory eventing properties for IMS:
slot number ims initial directory-eventing {eventing;signature-dn signature-dn;polling-interval polling-interval;event-base-dn event-base-dn;dispatcher-pool-size dispatcher-pool-size;}To configure initial directory eventing properties:
- From configuration mode, access the configuration statement that configures the local properties.
user@host# edit slot 0 ims initial eventing- Specify the initial directory eventing properties for IMS.
[edit slot 0 ims initial directory-eventing]user@host# set ?For more information about configuring local properties for the SRC components, see SRC-PE Getting Started Guide, Chapter 30, Configuring Local Properties with the SRC CLI.
- (Optional) Verify your configuration.
[edit slot 0 ims initial directory-eventing]user@host#show
eventing;polling-interval 30;Configuring the Local Diameter Peer
Use the following configuration statements to configure the local Diameter peer:
slot number ims aracf-rq {protocol protocol;port port;address address;origin-host origin-host;origin-realm origin-realm;}To configure the local Diameter peer:
- From configuration mode, access the configuration statement that configures the Diameter peer.
user@host# edit slot 0 ims aracf-rq- (Optional) Specify the protocol used for the transport layer.
[edit slot 0 ims aracf-rq]user@host# set protocol protocol- (Optional) Specify the port used for incoming connections.
[edit slot 0 ims aracf-rq]user@host# set port port- (Optional) Specify the IP address of the local peer.
[edit slot 0 ims aracf-rq]user@host# set address address- (Optional) Specify the Diameter identifier for the local endpoint that is the originator of the Diameter message.
[edit slot 0 ims aracf-rq]user@host# set origin-host origin-host- (Optional) Specify the Diameter identifier for the realm of the local endpoint that is the originator of the Diameter message.
[edit slot 0 ims aracf-rq]user@host# set origin-realm origin-realm- (Optional) Verify your configuration.
[edit slot 0 ims aracf-rq]user@host#show
protocol tcp;port 3868;address 127.0.0.1;origin-host testserver;origin-realm testrealm;peer 1 {address 127.0.0.1;origin-host testclient;}Configuring the Remote Diameter Peer
Use the following configuration statements to configure the remote Diameter peer:
slot number ims aracf-rq peer primary-spdf {address address;origin-host origin-host;}To configure the remote Diameter peer:
- From configuration mode, access the configuration statement that configures the Diameter peer. In this sample procedure, the remote SPDF peer called primary-spdf is configured.
user@host# edit slot 0 ims aracf-rq peer primary-spdf- (Optional) Specify the IP address of the remote peer.
[edit slot 0 ims aracf-rq peer primary-spdf]user@host# set address address- (Optional) Specify the Diameter identifier for the remote endpoint that is the originator of the Diameter message.
[edit slot 0 ims aracf-rq peer primary-spdf]user@host# set origin-host origin-host- (Optional) Verify your configuration.
[edit slot 0 ims aracf-rq peer primary-spdf]user@host#show
address 127.0.0.1;origin-host testclient;Configuring Logging Destinations
By default, IMS has three logging destinations.
Use the following configuration statements to configure logging destinations for IMS:
slot number ims logger name ...slot number ims logger name file {filter filter;filename filename;rollover-filename rollover-filename;maximum-file-size maximum-file-size;}slot number ims logger name syslog {filter filter;host host;facility facility;format format;}Configuring Logging Destinations to Store Messages in a File
To configure logging destinations to store log messages in a file:
- From configuration mode, access the configuration statement that configures the name and type of logging destination. In this sample procedure, the logging destination called log1 is configured.
user@host# edit slot 0 ims logger log1 file- Specify the properties for the logging destination.
[edit slot 0 ims logger log1 file]user@host# set ?For more information about configuring properties for the logging destination, see SRC-PE Monitoring and Troubleshooting Guide, Chapter 3, Configuring Logging for SRC Components with the CLI.
- (Optional) Verify your configuration.
[edit slot 0 ims logger log1 file]user@host#show
filter /info-;filename var/log/ims-a-racf-rq-info.log;rollover-filename var/log/ims-a-racf-rq-info.alt;maximum-file-size 2000000000;Configuring Logging Destinations to Send Messages to the System Logging Facility
To configure logging destinations to send log messages to the system logging facility:
- From configuration mode, access the configuration statement that configures the name and type of logging destination. In this sample procedure, the logging destination called log2 is configured.
user@host# edit slot 0 ims logger log2 syslog- Specify the properties for the logging destination.
[edit slot 0 ims logger log2 syslog]user@host# set ?For more information about configuring properties for the logging destination, see SRC-PE Monitoring and Troubleshooting Guide, Chapter 3, Configuring Logging for SRC Components with the CLI.
Configuring the Subscriber Type
Use the following configuration statements to configure the subscriber type:
shared ims aracf-rq configuration subscriber-type-configuration nameshared ims aracf-rq configuration subscriber-type-configuration name {nic-proxy-namespace nic-proxy-namespace;subscriber-id-type subscriber-id-type;}To configure the subscriber type:
- From configuration mode, access the configuration statement that configures the subscriber type. In this sample procedure, the subscriber type called ip is configured.
user@host# edit shared ims aracf-rq configuration subscriber-type-configuration ip- Specify the namespace that defines the properties for the NIC proxy operations for the specified subscriber ID type. Each subscriber type must use a different NIC proxy. All NIC proxies for IMS are stored in the /nicProxies directory. In this sample procedure, the namespace for the NIC proxy called ip is configured.
[edit shared ims aracf-rq configuration subscriber-type-configuration ip]user@host# set nic-proxy-namespace /nicProxies/ip- (Optional) Specify the type of information used to identify the subscriber. In this sample procedure, the subscriber ID type is specified as the subscriber IP address.
[edit shared ims aracf-rq configuration subscriber-type-configuration ip]user@host# set subscriber-id-type SIT_ADDRESS- (Optional) Verify your configuration.
[edit shared ims aracf-rq configuration subscriber-type-configuration ip]user@host#show
subscriber-id-type SIT_ADDRESS;nic-proxy-namespace /nicProxies/ip;Configuring a NIC Proxy for IMS
Before you configure a NIC proxy, you should have a good understanding of:
See SRC-PE Network Guide, Chapter 9, Locating Subscriber Information with the NIC; SRC-PE Network Guide, Chapter 13, Configuring Applications to Communicate with an SAE; and SRC-PE Network Guide, Chapter 14, Configuring SRC Applications to Communicate with an SAE with the SRC CLI.
To configure the NIC proxy, perform these tasks:
- Configuring Resolution Information for a NIC Proxy
- Changing the Configuration for the NIC Proxy Cache
- Configuring Resolution Information for a NIC Proxy
- Configuring NIC Test Data
Configuring Resolution Information for a NIC Proxy
You create a NIC proxy for each subscriber type to be configured. Subscriber types that have different subscriber ID types can use the same NIC proxy.
Use the following configuration statements to configure the NIC proxy:
shared ims aracf-rq configuration nic-proxy-configuration nameshared ims aracf-rq configuration nic-proxy-configuration name resolution {resolver-nameresolver-name
;key-typekey-type
;value-typevalue-type
;expect-multiple-values;constraintsconstraints
;}To configure resolution information for a NIC proxy:
- From configuration mode, access the configuration statement that configures the NIC proxy configuration. In this sample procedure, the NIC proxy called ip is configured.
user@host# edit shared ims aracf-rq configuration nic-proxy-configuration ip resolution- Specify the NIC resolver that this NIC proxy uses. This resolver must be the same as one that is configured on the NIC host.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip resolution]user@host# set resolver-name resolver-name- Specify the NIC data type that the key provides for the NIC resolution.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip resolution]user@host# set key-type key-typeTo qualify data types, enter a qualifier within parentheses after the data type; for example, to specify username as a qualifier for the key LoginName:
[edit shared ims aracf-rq configuration nic-proxy-configuration ip resolution]user@host#set key-type LoginName
(username)
- Specify the type of value to be returned in the resolution for the application that uses the NIC proxy.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip resolution]user@host# set value-type value-type- (Optional) If the key can have more than one value, specify that the key can have multiple corresponding values.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip resolution]user@host# set expect-multiple-values- (Optional. Available at the Advanced editing level.) If the application provides a constraint in the resolution request, specify the data type for the constraint. The constraint represents a condition that must or may be satisfied before the next stage of the resolution process can proceed.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip resolution]user@host#set constraints
constraints- (Optional) Verify your configuration.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip resolution]user@host#show
resolver-name /realms/ip/A1;key-type Ip;value-type SaeId;Changing the Configuration for the NIC Proxy Cache
You can modify cache properties for the NIC proxy to optimize the resolution performance for your network configuration and system resources. Typically, you can use the default settings for the cache properties. The configuration statements are available at the Advanced editing level.
Use the following configuration statements to change values for the NIC proxy cache:
shared ims aracf-rq configuration nic-proxy-configurationname
cache { cache-sizecache-size
; cache-cleanup-intervalcache-cleanup-interval
; cache-entry-agecache-entry-age
; }To configure the cache for a NIC proxy:
- From configuration mode, access the configuration statement that specifies the NIC proxy configuration. In this sample procedure, the NIC proxy called ip is configured.
user@host#edit shared ims aracf-rq configuration nic-proxy-configuration ip cache
- (Optional) Specify the maximum number of keys for which the NIC proxy retains data.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip cache]user@host#set cache-size
cache-sizeIf you decrease the cache size or disable the cache while the NIC proxy is running, the NIC proxy removes entries in order of descending age until the cache size meets the new limit.
- Specify the time interval at which the NIC proxy removes expired entries from its cache.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip cache]user@host#set cache-cleanup-interval
cache-cleanup-interval- (Optional) Specify how long an entry remains in the cache.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip cache]user@host#set cache-entry-age
cache-entry-age- (Optional) Verify your configuration.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip cache]user@host#show
cache-size 10000;cache-cleanup-interval 15;Configuring a NIC Proxy for NIC Replication
Typically, you configure NIC replication to keep the NIC highly available. You configure NIC host selection to specify the groups of NIC hosts to be contacted to resolve a request, and to define how the NIC proxy handles NIC hosts that the proxy is unable to contact. The configuration statements are available at the Advanced editing level.
Use the following configuration statements to configure NIC host selection for a NIC proxy:
shared ims aracf-rq configuration nic-proxy-configurationname
nic-host-selection {groupsgroups
;selection-criteria (roundRobin | randomPick | priorityList);}shared ims aracf-rq configuration nic-proxy-configurationname
nic-host-selection blacklisting {try-next-system-on-error;number-of-retries-before-blacklistingnumber-of-retries-before-blacklisting
;blacklist-retry-intervalblacklist-retry-interval
;}To configure a NIC proxy to use NIC replication:
- From configuration mode, access the configuration statement that specifies the NIC proxy configuration. In this sample procedure, the NIC proxy called ip is configured.
user@host# edit shared ims aracf-rq configuration nic-proxy-configurationip
nic-host-selection- (Optional) Specify the list of groups of NIC hosts that the NIC proxy can contact for resolution requests.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip nic-host-selection]user@host#set groups
groups
- (Optional) If you configure more than one group, specify the selection criteria that the NIC proxy uses to determine which NIC host to contact.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip nic-host-selection]user@host#set selection-criteria
(roundRobin | randomPick | priorityList)
- roundRobin—NIC proxy selects NIC hosts in a fixed, cyclic order. The NIC proxy always selects the next host in the list.
- randomPick—NIC proxy selects NIC hosts randomly from the list.
- priorityList—NIC proxy selects NIC hosts according to their assigned priorities in the list. If the host with the highest priority in the list is not available, the NIC proxy tries the host with the next-highest priority, and so on.
Priorities are defined by the order in which you specify the groups. You can change the order of NIC hosts in the list by using the
insert
command.
- (Optional) Verify your configuration.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip nic-host-selection]user@host#show
groups ;selection-criteria round-;- Access the configuration statement that specifies the NIC proxy configuration for blacklisting—the process of handling nonresponsive NIC hosts.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip nic-host-selection]user@host#edit blacklisting
[edit shared ims aracf-rq configuration nic-proxy-configuration ip nic-host-selection blacklisting]- (Optional) Specify whether or not the NIC proxy should contact the next specified NIC host if a NIC host is determined to be unavailable.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip nic-host-selection blacklisting]user@host#set try-next-system-on-error
- (Optional) Change the number of times the NIC proxy tries to communicate with a NIC host before the NIC proxy stops communicating with the NIC host for a period of time. The default is 3.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip nic-host-selection blacklisting]user@host#set number-of-retries-before-blacklisting
number-of-retries-before-blacklisting- (Optional) Change the interval at which the NIC proxy attempts to connect to an unavailable NIC host. The default is 15 seconds.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip nic-host-selection blacklisting]user@host#set blacklist-retry-interval
blacklist-retry-interval- (Optional) Verify your configuration.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip nic-host-selection blacklisting]user@host#show
try-next-system-on-error;number-of-retries-before-blacklisting 3;blacklist-retry-interval 15;Configuring NIC Test Data
To test a resolution without NIC, you can configure a NIC proxy stub to take the place of the NIC. The NIC proxy stub comprises a set of explicit mappings of data keys and values in the NIC proxy configuration. When the SRC component configured to use a NIC proxy stub passes a specified key to the NIC proxy stub, the NIC proxy stub returns the corresponding value. When you use a NIC proxy stub, no NIC infrastructure is required.
Use the following configuration statements to configure a NIC proxy stub from the
[edit]
hierarchy level.shared ims aracf-rq configuration nic-proxy-configuration name test-nic-bindings {use-test-bindings;}shared ims aracf-rq configuration nic-proxy-configurationname
test-nic-bindingskey-values
name {value
;}To use the NIC proxy stub for IMS:
- In configuration mode, navigate to the NIC proxy configuration and specify the data type of the key you want to map to a value. In this sample procedure, the key ip is specified for the NIC proxy called ip.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip]user@host#set resolution key-type ip
- Enable a NIC proxy stub for a resolution.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip]user@host#set test-nic-bindings use-test-bindings
- Specify the values of the keys for testing. These statements are available at the Advanced CLI editing level.
[edit shared ims aracf-rq configuration nic-proxy-configuration ip]user@host#set test-nic-bindings key-values
name
valueFor example, to set up a login name to IP mapping for login name jane@virneo.com to the IP address 192.0.2.30:
[edit shared ims aracf-rq configuration nic-proxy-configuration ip]user@host#set test-nic-bindings key-values jane@virneo.com 192.0.2.30