7 Installing IP Service Activator
This chapter describes how to install Oracle Communications IP Service Activator components on one or more host machines.
Note:
You must repeat the steps in this chapter, as well as the “Additional setup tasks after startup" in IP Service Activator System Administrator's Guide, on each server where IP Service Activator is to be installed, selecting the components and settings for each server.
Installing IP Service Activator on an Oracle Solaris or Linux Server
This section describes how to install IP Service Activator components on a Solaris or Linux server. This installation does not include the IP Service Activator client, which must be installed on a Windows platform. For more information, see "Installing the IP Service Activator Client on Windows".
Preparing to Install IP Service Activator
Before running the Oracle Universal Installer, ensure that you:
-
Log in to the server as the ipsaadm user. For information, see "IP Service Activator Administrator UNIX User ID (ipsaadm)".
-
Install the required supplemental software components, as described in "Installing Supplemental Software Components".
-
Log in to the Oracle software delivery Web site and download the IP Service Activator software. See "Downloading the IP Service Activator Software" for more information.
-
Download the Linux Oracle Universal Installer if you are installing onto a Linux 64-bit server.
-
Download the Solaris 64-bit Oracle Universal Installer if you are installing onto a Solaris 64-bit server.
-
-
Un-zip the IP Service Activator software on each server where you want to install IP Service Activator. For example, on a Linux server, run the following command to unzip the file:
unzip IPServiceActivator-7.x.x.x.x-linux.zip
-
Synchronize times across all host machines where IP Service Activator components are installed. For example, by using a Network Time Protocol (NTP) server. If device times are not synchronized, delays and problems are likely to occur.
Running the Oracle Universal Installer for IP Service Activator
-
Log in to the server as the ipsaadm user.
-
Go to the directory software un-zip location/ipsa/Disk1/install.
-
There are two installation methods:
-
Interactive: For an interactive installation, continue with step 4.
-
Silent: For information about silent installations, including recording an installation session for later re-use in a silent installation, see "About Silent Installations".
-
-
Create a directory in which to install IP Service Activator, such as /opt/OracleCommunications. Ensure the ipsaadm user has read/write/execute access to this directory.
-
Run the following command:
./runInstaller
The Welcome window opens.
Note:
Make sure that the display settings are correct. If you cannot use X display, you must run a silent installation.
If you have not run an Oracle product that installs with Oracle Universal Installer on the target system, the Specify Inventory Directory and Credentials window opens.
-
Enter the path of the inventory directory /export/home/oracle/oraInventory when Oracle Universal Installer is run for a new installation on the server. Then enter the UNIX group name. The oraInventory directory contains the following:
-
oraInstaller.properties
-
logs
-
backup
-
install.platform
-
ContentsXML
-
OUI
-
-
Click Next.
The Select Installation Type window opens.
-
Select the components that you want to install.
You can select any of the following installation types:
-
All Components: includes all IP Service Activator components. This is for a complete installation.
-
Policy Server: includes all Policy Server components
-
Cartridges: includes all Cartridges
-
Web Service: allows you to use the web service to integrate IP Service Activator with Oracle Communications Order and Service Management (OSM)
For information about configuring the web service installation, see the web services chapters in IP Service Activator API Developer's Guide.
-
All Except Web Service: Includes all IP Service Activator components except web service.
-
Custom: allows you to select the specific components that you want to install
If you are performing a distributed installation, select the correct components for the host on which you are currently installing. Decisions on which hosts various components are installed on vary depending on the needs of your site. Typically, you might install the Policy Server on one host and the Network Processors on another. For information about distributing components across servers, see "Planning an IP Service Activator Installation".
The Specify Home Details window opens.
-
-
Enter the directory path of the base installation and accept the default name, OracleCommunications.
OracleCommunications identifies the name of the Oracle home on which Oracle services are installed. Click Next.
-
If you selected the installation options All Components or Policy Server in the previous step, the Supplemental Software Location window opens.
-
If you selected the installation option Cartridges in the previous step, the Available Product Components window appears and you must select the specific cartridges that you want to install, and then click Next. The Supplemental Software Location window opens.
-
If you selected the installation option Custom in the previous step, you must select the specific IP Service Activator components you want to install, and then click Next. The Supplemental Software Location window opens.
Note:
The Installer checks for the supplemental software files before proceeding with the installation in step 9.
-
-
Enter the directory path to the location where you placed the supplemental software components. Click Next.
The IP Service Activator Startup window opens.
-
Select whether you want IP Service Activator to start at every reboot. Click Next.
The Summary window opens.
Note:
The list of installed products might show apparently duplicate entries, however the entries refer to distinct products.
-
Verify the component installation list, and then click Install.
The Installation window opens with a progress bar.
The Execute Configuration scripts window opens.
-
Run the configuration scripts by following the steps given in the installation window. The following message appears when you run the scripts:
“Creating symbolic link in path so that IP Service Activator is stopped when the machine is shutdown."
After running the scripts, click OK. The root.sh script is in the Oracle_home directory. By running the root.sh script, you ensure that IP Service Activator automatically starts when you run the server.
The orainstRoot.sh script is in the following directory, under the oraInventory home directory:
inventory_home/orainstRoot.sh
The End of Installation window opens.
-
Click Exit to continue or click Installed Products to see the components that were installed.
When you click Exit, the Configuration Assistants and Execute Configuration scripts dialog boxes open.
-
Click OK.
The IP Service Activator post-install scripts run.
-
When prompted to start the Configuration GUI to configure IP Service Activator, click Yes.
The Configuration GUI starts.
See IP Service Activator System Administrator's Guide for information about using the Configuration GUI.
Continue the configuration of IP Service Activator by performing the tasks detailed in Additional setup tasks to be run prior to initial startup topic in IP Service Activator System Administrator's Guide.
If you are performing a distributed installation across multiple servers, repeat this procedure for each host.
The following IP Service Activator modules are installed using the Oracle Universal Installer:
-
Common
-
Configuration Template Module (CTM)
-
Threshold Activated Configuration Control (TACC)
The Common module is automatically installed during the installation.
You must import and link the appropriate controller scripts before running the installed modules. For more information, see information about importing and linking controller scripts in IP Service Activator System Administrator's Guide.
About Silent Installations
The Oracle Universal Installer supports silent installations using a response file.
A silent installation does not use the Installer GUI and does not display the interactive dialog boxes that you normally see. Instead, installation options are specified in a response file.
Note:
You can record installation details into a response file for use in a future silent installation by running the runInstaller -record -destinationFile Path command.
Complete details on silent installations, the contents of response files, and customizing and creating new response files are available in Oracle Universal Installer documentation.
- Click Start and then select Programs.
- Select Oracle - Oracle_home, and then select Oracle Installation Products, where Oracle_home is the name of the Oracle home on which Oracle services are installed.
- Select Universal Installer Concepts Guide.
Alternatively, you can access Oracle Universal Installer documentation here:
HTML:
http://download.oracle.com/docs/cd/B28359_01/em.111/b31207/toc.htm
PDF:
http://download.oracle.com/docs/cd/B28359_01/em.111/b31207.pdf
Note:
There are some IP Service Activator-specific response parameters that are not mentioned in the Oracle Universal Installer documentation.
IP Service Activator- specific response parameters for Solaris/Linux are as follows:
-
SUPP_SOFTWARE_DIR: the directory where the supplemental software components are located.
-
AUTOMATIC_STARTUP_REQUIRED: specifies whether IP Service Activator should be started automatically on reboot.
IP Service Activator- specific response parameter for Windows is as follows:
-
SUPP_SOFTWARE_DIR: the directory where the supplemental software components are located.
Running a Silent Installation
To run a silent installation:
-
For a Solaris/Linux installation, locate the response template file in software un-zip location/ipsa/Disk1/stage/Response in the IP Service Activator software for the type of installation you require.
The Response folder contains the following response template files for the corresponding installation types:
oracle.communications.ipsa.AllExceptWebService.rsp - All Components except Web Service
oracle.communications.ipsa.AllComponents.rsp - All Components
oracle.communications.ipsa.Cartridges.rsp - Cartridges
oracle.communications.ipsa.Custom.rsp - Custom
oracle.communications.ipsa.PolicyServer.rsp - Policy Server
oracle.communications.ipsa.WebService.rsp - Web Service
For a Custom installation type, open the oracle.communications.ipsa.Custom.rsp file and remove the components that you do not want to install from the DEPENDENCY_LIST parameters. Table 7-1 maps the internal component names in the DEPENDENCY_LIST parameters with the names in the Oracle Universal Installer.
Table 7-1 DEPENDENCY _LIST Parameter Components For Silent Installation
Internal component name Name in the Installer oracle.communications.ipsa.policyserver
Policy Server
oracle.communications.ipsa.cartridges
Cartridges
oracle.communications.ipsa.networkprocessor
Network Processor Framework
oracle.communications.ipsa.webservice
Web Service
oracle.communications.ipsa.oss
OSS Integration
oracle.communications.ipsa.ctm
Configuration Template Module
oracle.communications.ipsa.tools
Tools
oracle.communications.ipsa.tools.configtool
Configuration GUI
oracle.communications.ipsa.tools.dbupgrade
DB Upgrade
oracle.communications.ipsa.tools.yangimporter YANG Importer oracle.communications.ipsa.tools.servicediscovery Service Discovery oracle.communications.ipsa.cartridges.cisco.catos
Cisco CatOS Cartridge
oracle.communications.ipsa.cartridges.cisco.ios
Cisco IOS Cartridge
oracle.communications.ipsa.cartridges.cisco.iosxr
Cisco IOS Cartridge XR
oracle.communications.ipsa.cartridges.huawei.vrp
Huawei VRP Cartridge
oracle.communications.ipsa.cartridges.juniper.junos
Juniper JUNOS Cartridge
oracle.communications.ipsa.cartridges.generic Generic Cartridge oracle.communications.ipsa.cartridges.netconf Netconf Generic Cartridge oracle.communications.ipsa.oss.oim
OSS Integration Manager
Note:
If you do not remove any of the components from the DEPENDENCY_LIST, the Custom installation type is equivalent to AllComponents installation type.
-
(Optional) Open the response template file and modify the following installation parameters:
ORACLE_HOME
ORACLE_HOME_NAME
SUPP_SOFTWARE_DIR
AUTOMATIC_STARTUP_REQUIRED
-
Log in to the server as the admin user.
-
Go to the directory ipsa/Disk1/install and run the Oracle Universal Installer as follows:
./runInstaller -silent -responseFile full path to response template file,including file name
-
After the installation is complete, check the log files, and start the Configuration GUI.
See IP Service Activator System Administrator's Guide for information about using the Configuration GUI.
Installing the IP Service Activator Client on Windows
This section explains how to install the IP Service Activator client on a 64-bit Windows 10 host, or a 64-bit Windows XP Professional host. You can install the client on multiple hosts distributed throughout the network. You can install the client on terminal services hosts and Oracle VM host machines. The installation process installs the client as well as online Help.
Before Running IP Service Activator Client Installer
-
Install the Policy Server on your Solaris or Linux server(s)
-
Obtain the required supplemental software components for the client, as described in "Installing Supplemental Software Components".
-
Log in to the Oracle software delivery website and download the IP Service Activator Windows client-only installer software. See "Downloading the IP Service Activator Software" for more information.
-
Un-zip the IP Service Activator Windows software on each Windows host where you want to install the IP Service Activator client to a folder such as IPSAInstaller_7.x.x.x.x, which will be referred to as software un-zip location in this procedure.
-
Configure the Windows host to prefer IPv4 over IPv6 addresses. See "Configuring the 64-bit Windows Host to Prefer IPv4 Over IPv6 Addresses" for more information.
-
Synchronize times across all host machines where IP Service Activator components are installed, for example, by using a Network Time Protocol (NTP) server. If device times are not synchronized, delays and problems are likely to occur. See "Synchronizing IP Service Activator Host Machines".
Configuring the 64-bit Windows Host to Prefer IPv4 Over IPv6 Addresses
You install the IP Service Activator client on a 64-bit Windows host. The IP Service Activator client communicates with the Policy Server using CORBA through the Naming Service.
This section provides the steps to configure the Windows 64-bit host to prefer and use IPv4 addresses when both IPv4 and IPv6 addresses are available on the host and the IP Service Activator server is configured using IPv4 address.
To configure the Windows host to prefer IPv4 over IPv6 addresses, do one of the following:
-
Add two end points with the same port number to the Configuration GUI. Add the first endpoint with the DNS name and the second endpoint with the IPv4 address, but both the endpoints should use the same port number.
-
Add the endpoints using the -ORBendPoint command line parameter, as follows:
-ORBendPoint giop:tcp:dns:port -ORBendPoint giop:tcp:ipv4address:port
where dns is the DNS name, port is the port number, and ipv4address is the IPV4 address of the Windows host.
The second endpoint (ipv4_address:port) forces the Configuration GUI to listen on the IPv4 port so that the Policy Server can call back.
For example:
-ORBendPoint giop:tcp:ipsahostdnsname@example.com:2909 -ORBendPoint giop:tcp:10.44.32.4:3906
Note:
Do not use the IPv4 loopback IP address as the IP Service Activator server address.
Installing the Client
Before you run the Configuration GUI, make sure all file permissions are set correctly. For more information, see "Setting Permissions for the Installation UNIX User ID".
-
On the Windows host, go to the directory software un-zip location\client\Disk1\install.
-
There are two installation methods:
-
Interactive: continue with step 3.
-
Silent: For information about silent installation, see "To run a silent installation:".
-
-
Double-click setup.exe.
If you are installing on a Windows 10 host and see an error regarding swap space/virtual memory, see "Oracle Universal Installer Error" for a resolution.
The Welcome window opens.
-
Click Next.
The Select Installation Type window opens.
-
Select the components you want to install.
You can select from the following installation types:
-
All Client Components: includes the main IP Service Activator client, the client extensions, and the Configuration GUI
-
Custom: allows you to select the specific components you want to install
Click Next.
The Specify Home Details window opens.
-
-
Enter the directory path of the base installation and accept the default name, Oracle Communications. Click Next.
If you selected the installation option All Client Components in step 5, the Supplemental Software Location window opens.
If you selected the installation option Custom in step 5, the Available Product Components window appears. Select the specific components you wish to install, then click Next. The Supplemental Software Components window opens.
-
Enter the directory path to the location where you placed the supplemental software components. Click Next.
The Summary window opens.
-
Verify the component installation list, and then click Install.
The Installation window opens with a progress bar.
When the Installer is finished running, the End of Installation window opens.
-
Click Exit if you want to start the configuration GUI and configure the installation, or click Installed Products to see the components that were installed.
-
When prompted to start the Configuration GUI to configure IP Service Activator, click Yes.
The Configuration GUI starts.
See IP Service Activator System Administrator's Guide for information about using the Configuration GUI.
The following IP Service Activator modules are installed using the Oracle Universal Installer:
-
Common
-
Configuration Management
-
CTM GUI Extension
-
TACC
The Common module is automatically installed during the installation.
-
-
If you installed the IP Service Activator client on a Windows 10 host, navigate to the folder in which the IP Service Activator client is installed, such as C:\Program Files\OracleCommunications. Right-click OracleCommunications. Click the Security tab and give full read and write permissions to users who will use IP Service Activator.
Running IP Service Activator Client Installer in Silent Mode
To run the client installer in silent mode:
-
For a Windows installation, locate the response template file in client\Disk1\stage\Response in the IP Service Activator Windows software.
The client is supported only on Windows.
The Response folder contains the following response template files for the corresponding installation types:
-
oracle.communications.ipsa.AllClientComponents.rsp: All Client Components
-
oracle.communications.ipsa.Custom.rsp: Custom
In a Custom installation type, open the oracle.communications.ipsa.Custom.rsp file and remove the entries that you do not want to install from the DEPENDENCY_LIST parameters. Table 7-2 maps the internal component names in the DEPENDENCY_LIST parameters with the names in the Oracle Universal Installer.
Table 7-2 DEPENDENCY_LIST Parameter Components For Client Installer
Internal component name Name in the Installer oracle.communications.ipsa.client
Windows GUI Client
oracle.communications.ipsa.servicemodules
Service Module GUI Extensions
oracle.communications.ipsa.oss
OSS Integration GUI Extensions
oracle.communications.ipsa.ctm
Configuration Template Module GUI Extension
oracle.communications.ipsa.configmgmt
Configuration Management Module GUI Extension
oracle.communications.ipsa.tools
Tools
oracle.communications.ipsa.tools.configtool
Configuration GUI
oracle.communications.ipsa.tools.tacc
Threshold Activated Configuration Control GUI Extension
Note:
If you do not remove any of the components from the DEPENDENCY_LIST, the Custom installation type is equivalent to AllClientComponents installation type.
-
-
(Optional) Open the response template file and modify the following installation parameters:
-
ORACLE_HOME
-
ORACLE_HOME_NAME
-
SUPP_SOFTWARE_DIR
If you are installing on Windows 10, navigate to the directory software un-zip locationclient\Disk1\install, right-click on setup.exe, and select Properties. In the Properties dialog box, click the Compatibility tab and select Run this program in compatibility mode for Windows XP Service Pack 3. Click OK.
-
-
Go to the directory client\Disk1\install and run the Oracle Universal Installer as follows:
setup.exe -silent -responseFile file name
where filename is the full path to response template file, including the file name.
-
After the installation is complete, check the log files, and start the Configuration GUI.
See “Using the Configuration GUI" in IP Service Activator System Administrator's Guide for information about using the Configuration GUI.
-
If you installed the IP Service Activator client on a Windows 10 host, navigate to the folder in which the IP Service Activator client is installed, such as C:\Program Files\OracleCommunications. Right-click OracleCommunications and, on the Security tab, give full read and write permissions to users who will use IP Service Activator.
-
If you installed the IP Service Activator client on a Windows 10 host, navigate to the Program folder of IP Service Activator, such as C:\Program Files\OracleCommunications\Service Activator\Program, right-click ipsa_explorer.exe, and select Properties.
The Properties dialog box opens.
-
Click the Compatibility tab and select Run as Administrator.
Oracle Database Connection Considerations for the IP Service Activator Client
When you run the Solaris/Linux-based Installer for IP Service Activator server software, the Oracle Instant Client is automatically installed and a tnsnames.ora file is configured to provide connectivity to the Oracle Database. However, the Windows-based Installer for the IP Service Activator client does not include the Oracle Instant Client.
The IP Service Activator client communicates with the Policy Server using CORBA, through the Naming Service. In general, the Oracle Instant Client is not required for the IP Service Activator client, unless you want to be able to access logs from the client.
Oracle Database Client Requirements to View Logs in the IP Service Activator Client
Logs are stored directly in the Oracle Database. To view audit trail, device configuration, or system message logs in the IP Service Activator client, you must install and configure an Oracle client (such as the Oracle Instant Client) and configure an ODBC Data Source for IP Service Activator on the client host.
For Oracle Client configuration details, see "Manually Configuring Oracle Client Connection: Solaris".
Setting Up an FTP or a TFTP Server
If you want to use the restore functionality of the Configuration Management module, you must set up a valid FTP or TFTP server to which the Configuration Management module can connect to. See the Solaris or Linux documentation for more information about setting up an FTP or a TFTP server on a Solaris or Linux server.
Setting Up the Syslog Server
If you want to use the functionality of the Configuration Management module, you must set up the syslog server, which is used for tracking changes. See the Solaris and Linux documentation for information about setting up the syslog server on a Solaris or Linux server.
Pre-Installation of the Configuration Template Module
Perform the following tasks before you install the Configuration Template Module (CTM):
-
Ensure the Oracle XML Database is installed before installing CTM. For more information, see "Verifying that Oracle XML Database is Installed".
-
Install the CTM Request Server on the same server as the Naming Service, to avoid any reconfiguration.
-
Configure the OSS Integration Manager (OIM) timeout parameter, so that OIM does not close inactive sessions. For more information, see "Configuring OIM to Keep Inactive Sessions Running".
For more information about how to use CTM, see the discussion about Configuration Template Module in IP Service Activator online Help.
Verifying that Oracle XML Database is Installed
CTM uses Oracle Database features for XML document handling, and PL/SQL stored procedures for optimizations.
You must ensure the Oracle XML Database is installed prior to installing the Configuration Template module.
Oracle XML Database is usually installed by default with Oracle Database software. For more information about installing Oracle Database, see "Installing and Configuring Oracle Database Software".
If Oracle XML Database is not installed, see the Oracle Database product documentation for more information.
To verify if the Oracle XML Database is installed, run the following command as user SYSDBA:
select username from dba_users where username like 'X%';
If the XML Database is installed, the response is XDB. If no value is returned, it means that the XML Database is not installed.
Configuring OIM to Keep Inactive Sessions Running
CTM connects to OIM for flow-through provisioning.
By default, OIM has a timeout parameter that is configured to close your session after a period of inactivity. Set the OIM timeout value to 0 to keep inactive sessions from timing out.
To configure OIM to keep inactive sessions running:
-
Open the cman.cfg configuration file from the directory /opt/OracleCommunications/ServiceActivator/Config.
-
Add the following parameter to the OIM line:
-timeout 0
-
Close the cman.cfg configuration file.
Restoring Configuration When the Device Model Contains Configlets
When performing a device restoration operation, if the device model contains one or more configlets that were created and persisted through IP Service Activator, the commands are re-sent to the device even though the restored configuration has the configlets as part of the device model.
To restore a device configuration:
-
Log in to IP Service Activator and display the domain containing the discovered device.
-
Create an archive for the device.
-
Under Archive List, select the row of the newly created archive, and from the Actions list, select View.
The Archive View page appears.
-
Click View Current Config.
The Configuration Editor page appears.
-
Create a configlet and activate it.
-
Click Archive to create an archive.
-
Navigate to the Configuration Archives page.
-
Select the check box for the archive you just created.
-
Click Restore, and select Complete Restore.
The device is restored and restarted, and it is left in Offline Test mode.
-
Right-click a device, select Command Delivery, and then select Online Mode.
The configlet is pushed to the device.
Typically, when you restore the configuration to the device, no configuration commands are sent to the device. This is the only exception.
For complete details, see IP Service Activator online Help.