IPControl 6.0 Install Guide

8/10/2019 IPControl 6.0 Install Guide

1/56

Guide to Installing

IPControlVersion 6.0


2/56

The information in this document is subject to change without notice. Names of individuals and companies, as well as data used inexamples, are fictitious unless otherwise noted. No part of this document may be copied, reproduced, or electronically transmitted inany form without the express written consent of BT Diamond IP.

Adobe and Adobe Acrobat are trademarks of Adobe Systems Incorporated.Microsoft Windows 2000, Windows 2003, Windows 2008, and Internet Explorer are trademarks or registered trademarks ofMicrosoft Corporation in the U.S. and/or other countries.MySQL is a registered trademark of Oracle Corporation.Oracle is a registered trademark of Oracle Corporation.Solaris is a registered trademark of Oracle Corporation.UNIX is a registered trademark of the Open Group.Powered by Cryptzone MindTerm - Copyright 19972013 Cryptzone Group AB (publ). All rights reserved.

July 2013Guide to Installing IPControlDID# IPC6001 Revision 2

Version 6.0

2013 BT Americas, Incorporated

BT Diamond IP801 Springdale Drive, Suite 100Exton, PA 19341

Tel. +1 610.423.4770Fax +1 610.423.4774


3/56

Guide to Installing IPControl i

Contents

Introduction 1

About This Guide ....................................................................................................................... 1

Planning your Installation ............................................................................................ 1

Centralized Deployment .............................................................................................. 2

Distributed Deployment ........... .......... ........... .......... ........... .......... ........... .......... ........... 2

Disaster Recovery Planning ......................................................................................... 2

Prerequisites ................................................................................................................. 2

Third Party Component Version Numbers .................................................................. 4

IPControl Platform Requirements .............................................................................................. 5

Installing IPControl on Windows 7

How to Begin ............................................................................................................................. 7

Starting/Stopping the IPControl Services ................................................................................ 17

Uninstalling IPControl for Windows ....................................................................................... 19

Installing IPControl on UNIX 21

How to Begin ........................................................................................................................... 21

Notes About UNIX ........... .......... ........... .......... ........... .......... ........... .......... ........... ..... 23

IPControl Installation ............................................................................................................... 25

Starting/Stopping the IPControl Services ................................................................................ 32

Starting and stopping all IPControl services .............................................................. 32

Starting and stopping individual IPControl Services ................................................. 33

Configuring the services to start during boot ........................................................................... 34

Uninstalling IPControl for UNIX ............................................................................................. 37

Appendices 39

Appendix A: Configuring Windows Firewall for IPControl ........... .......... ........... .......... ......... 39

Accessing Windows Firewall Configuration ............................................................. 39

Appendix B: DNS and DHCP in the UNIX environment ......... ........... .......... ........... .......... .... 41

DNS ........................................................................................................................... 41

DHCP......................................................................................................................... 42

Appendix C: Multiple Result Manager Setup .......................................................................... 44

Adding a second Result Manager on the Executive........... .......... ........... .......... ......... 44

Adding a Stand Alone Result Manager ..................................................................... 46

Appendix D: Multiple Task Manager Setup ............................................................................ 48

Adding an on-board Task Manager ........................................................................... 48Adding a Stand Alone Task Manager ........................................................................ 50

Appendix E: TCP/UDP Port Numbers and Message Flows ........... .......... ........... .......... ......... 52


4/56


5/56

Guide to Installing IPControl 1

Introduction

About This Guide

Welcome to the IPControl IP address planning and utilizationmanagement system. This Installation Guide is designed to

help you install the IPControl products, which includesIPControl. You may refer to the Guide to Using IPControlfor more product-specific information.

Planning your Installation

This section provides you with information needed to planyour IPControl installation.

IPControl can be installed in a centralized or a distributed

deployment. In a centralized deployment, all IPControlcomponents are located on a single server. This simplifies theinstallation and maintenance of the product but limitsscalability. IPControl can also be deployed in a distributedmanner. IPControl Agents can be deployed in the networkcloser to actual network elements (such as routers) andnetwork services (such as DHCP servers). This allowsIPControl to scale well in larger environments.


6/56


Centralized Deployment

In a centralized deployment, the IPControl Executive and the

IPControl Agent are installed on a single system.

Distributed Deployment

In a distributed deployment, a single IPControl Executive isinstalled, and one or many IPControl Agents are installed.

Disaster Recovery PlanningYou may wish to take this opportunity to review the IPControlDisaster Recovery Guide, in case you are planning onimplementing an Executive disaster recovery scenario.

PrerequisitesThere are several prerequisites that are needed in order toconfigure and install your IPControl system. The followingcheck list provides you with prerequisites that should becollected before starting your installation:

If you are installing the IPControl Executive server on yournetwork:

IP Address of the IPControl Executive server.

The servers hostname must not contain the

underscore character, for compliance with URIstandards.

Network connectivity and appropriate Access LevelControls to exchange data between the IPControlExecutive and IPControl Agents (if deployed in adistributed environment). See Appendix E for moreinformation.

If you are installing the IPControl Agent:

IP Address of the IPControl Executive server.

IP Address of the IPControl Agent you are installing.

The servers hostname must not contain theunderscore character, for compliance with URIstandards.


7/56


Network connectivity and appropriate Access LevelControls to exchange data between the IPControl

Executive server and the IPControl Agents. SeeAppendix E for more information.

The IPControl Executive server is running IPControl6.0 or newer


8/56


Third Party Component Version Numbers

The following components are installed with IPControl and arelisted with the corresponding version numbers for referencepurposes. All version information applies to all serverplatforms unless otherwise noted.

MySQL Database Server 5.5.30

Apache Tomcat Servlet Container 7.0.22

ActiveMQ JMS Server 5.8.0

Java Development Kit

o Windows1.6.0

o

Solaris - 1.6.0o Linux - 1.6.0

Support files for Oracle 10.2.x, 11.2.x (Oracle RDBMSnot supplied)


9/56


IPControl Platform Requirements

IPControl Administrative WebInterface

Browser basedMicrosoft Internet Explorer 9.0

Mozilla Firefox 19.0+

Database ManagementSystem

MySQL Community Edition 5.5.30 orOracle 10.2.x or 11.2.x (customer-provided)

IpControl ExecutiveCentralized manager

Operating System:Windows 2008 server (32-bit English versions)Windows 2008R2 server (64-bit)

RedHat Enterprise Linux v5 (32-bit)RedHat Enterprise Linux v6 (64-bit)CentOS Linux v6 (64-bit)VMWare* with one of the above Intel OS VMs

Solaris 10 (Sparc)

Windows or Linux basedHardware Requirements:

Xeon 1.2 GHz or faster processor2 GB RAM or higher3 GB disk space for base install

Solaris basedHardware Requirements:

Oracle Sparc Enterprise T-Series or higher2 GB RAM or higher3 GB disk space for base install

IpControl Agent / DNS /DHCP

Server

Operating System

Windows** 2008 server (32-bit English version)Windows** 2008R2 server (64-bit)RedHat Enterprise Linux v5 (32-bit)RedHat Enterprise Linux v6 (64-bit)

CentOS Linux v6 (64-bit)VMWare* with one of the above Intel OS VMsSolaris 10 (Sparc)

Windows or Linux basedHardware Requirements:

Xeon 1.2 GHz or faster processor1 GB RAM or higher1 GB disk space for base install

Solaris basedHardware Requirements:

Oracle Netra or higher1 GB RAM or higher1 GB disk space for base install


10/56


* VMWare support notes:

1.

BT Diamond IP software products will run on VMWare as long as a supported operating system is running in the

VMWare session. We believe that our application does not know the difference between hardware platforms as long

as a supported OS is running, and we view VMWare similar to just another piece of hardware.

2.

Further, we do not test on VMWare and we cannot offer to assist or provide recommendations in configuration, setup,or tuning of VMWare.

** ISC DHCP Server does not run on Windows platforms


11/56


Installing IPControl on Windows

How to Begin

Insert the IPControl CD into the CD drive. Start the WindowsExplorer by right mouse clicking on the StartMenu andselecting Explorer, or by finding the Windows Exploreron your Program menu.

Using the Windows Explorer, find the appropriate InControlinstallation executable for your platform (i.e. incinstall-windows32.exeor incinstall-windows64.exeon theIPControl CD, and double click to start the installationprocess.

1. The introduction screen will appear as follows:

Click Next.


12/56


2. The Select Destination Locationscreen will appearas follows:

Select a destination directory for the installation, andthen click Next.

3. The Select Installation Typescreen will appear asfollows:


13/56


Select the desired installation type, and then click Next:

ExecutiveChoose this option to install the

IPControl Executive including the suppliedcopy of MySQL Community Edition.

Executive (Customer Installed Database)Choose this option to install the IPControlExecutive which will utilize an Oracle orMySQL database installation provided by thecustomer.

Agent OnlyChoose this option to install theIPControl Agent including ISC DHCP and/orBIND servers.

4. If installing an Executive, the Select Componentsscreen will appear as follows:

The required components of the IPControl Executiveare automatically selected. You may choose to includethe ISC BIND package for Windows as part of the

Executive installation. Click Next.

5. If installing an Executive with a customer installeddatabase, the Select Componentsscreen will appear asfollows:


14/56


The required components of the IPControl Executivewith a customer installed database are automaticallyselected. You may choose to include the ISC BINDpackage for Windows as part of the Executiveinstallation. Click Next.

6. If installing an Agent, the Select Componentsscreen

will appear as follows:


15/56


The required components of the IPControl Agent areautomatically selected. You may choose to include theISC BIND package for Windows as part of the Agentinstallation. Click Next.

7. If installing an Executive, the Enter Licensescreenwill appear as follows:


16/56


Enter the license key provided by your BT Diamond IPAccount Manager, if available. Otherwise, the license

key must be supplied when the IPControl Executive isaccessed from a supported web browser.

Click Next.

8. The BT Americas, Inc. License Agreementscreenwill appear as follows:

Read the license agreement and, if you accept the termsof the agreement, select that option, then click Next.

9. If installing an Executive, the MySQL CommunityEdition License Agreementscreen will appear asfollows:


17/56


Read the license agreement and, if you accept the termsof the agreement, select that option, then click Next.

10.The IP Address Settingsscreen will appear as follows:

If installing an Executive, enter the IP Address of thehost system for both fields. Otherwise, enter theaddress of the host system for the IPControl Agent


18/56


installation, and the IP Address of the IPControlExecutive.

11.If installing an Executive with customer installeddatabase, the Customer Installed Database Typescreen will appears as follows:

Select Oracle or MySQL for your installed database.

12.

If installing an Executive with customer installedOracle database, the Oracle Settingsscreen willappears as follows:


19/56


20/56


14.The installation wizard will continue to install

IPControl on the host system. When complete, theSelect Additional Tasksscreen will appear as follows:

You can choose to start the IPControl services for theselected installation type. Otherwise, the IPControlservices can be started using the Windows ServicesAdministrative Tool. Click Next.

15.The Setup Completescreen will appear as follows:


21/56


Click Finishto complete the installation and exit thesetup wizard.

Note: If IPControl is installed on a system runningthe Windows Firewall, there may be some additionalconfiguration necessary. Refer to the Configuring

Windows Firewall for IPControlsection in theAppendix for more information.

Starting/Stopping the IPControl Services

IPControl services are installed and started automaticallyduring installation.

If you need to start or stop them manually, use the WindowsService Controller, and follow the instructions provided by theversion of Windows you are using.


22/56


The following is a list of the IPControl services:

Windows service What does it do? Running onMySQL Provides the relational database system that

supports the IPControl system.IPControl Executive serveronly.

IPControl Task Manager Service Provides scheduling functions and controlsthe tasks (units of work) that are sent to theIPControl Agents.

IPControl Executive serveronly.

IPControl Result Manager Service Collects task result information fromIPControl 3.0 or newer Agents and placesthat information into the IPControldatabase.

IPControl Executive serveronly

IPControl ActiveMQ Provides reliable message transport betweenthe IPControl Task Manager, the ResultManager, and the Agent in IPControl 3.0 ornewer

IPControl Executive server,and IPControl Agents

IPControl Log Manager Service Provides a centralized log messagecollection system.


IPControl File Manager Service Provides file transport capabilities. IPControl Executive serveronly.

IPControl Callout Manager Provides external scripting functionality inresponse to alerts generated by IPControl.


IPControl DNS Listener Provides a mechanism for informing theIPControl database of dynamic DNSupdates.


Tomcat Provides the http web server and serves theIPControl web interface.

IPControl Executive server.


23/56


24/56


Click Finishto exit the uninstall wizard.


25/56


Installing IPControl on UNIX

How to Begin

The following instruction should be completedregardless of which component of IPControl you areinstalling.

1. Login as root. Refer to your operating system

documentation for details.2. Insert the IPControl CD into your CD drive, and

mount the drive. If your system is using anautomount feature, this step is not required.Refer to your operating system documentationfor correct syntax, and perform a command suchas:

mount -r F hsfs /dev/dsk/c1t2d0s2 /cdrom

3.

Add an IPControl user to your system that willown the installed files. We recommend addingthe incadminuser. In all examples providedbelow, we use incadminas the IPControl user.If you have selected a different user name,replace incadminwith the user name you haveselected. Refer to your operating systemdocumentation for correct syntax, and perform acommand such as:

useradd d /opt/incontrol s /bin/bash c INC mincadmin

passwd r files incadmin

4. Make a home directory for the user if thecommand that executed in step 3 does not create


26/56


a home directory. In our examples in thisdocument, we will use /opt/incontrol as our

default IPControl Home directory. We referto the IPControl home directory as$INCHOME. Replace /opt/incontrol withyour own directory name in all commands belowif you have selected another directory name. Setappropriate permissions and change the owner ofthe directory. Use commands such as:

cd /opt

mkdir incontrol

chown incadmin incontrol

cd /opt/incontrol

5. Create a group that the IPControl user will be amember of. This group is used to restrict accessto programs that require the setuid bit to be setdue to required access to low-numbered ports.

groupadd incontrol

6. Edit the systems group file and add theincadminuser to the group created in theprevious step. Refer to your operating system

documentation for correct syntax on addingusers to groups. The line in /etc/group mightlook like:

incontrol::303:incadmin

7.

The systems hostname must be mapped to areal IP address when using IPControl, and notto the 127.0.0.1 (or loopback) address.Examine the /etc/hosts file and make sure thehostname is not on the 127.0.0.1 line.

Correct127.0.0.1 localhost10.30.8.40 myserver myserver.example.com

Incorrect127.0.0.1 localhost myserver


27/56


8.

Check to make sure you have at least 3GB ofdisk space to install the application.

df k

9. Copy the appropriate IPControl installationprogram for your supported platform(incinstall-linux32.shfor RHEL 5.x, incinstall-linux64.shfor RHEL 6.x 64-bit, or incinstall-solaris.shfor Solaris 10 Sparc) from the CD tothe system temp directory (/tmp). Replacecdrom in the command below with the actual

mount point/path.

cp /cdrom/incinstall-linux32.sh/tmp/incinstall-linux32.sh

10.

Change permissions on the files that have beencopied so that you can run the incinstall-linux32.shutility. Note that this file can beremoved after the installation is completed:

chmod +x incinstall-linux32.sh

Notes About UNIX

Permissions on several files within the IPControlinstallation are changed during the install procedure toallow incadmin to execute privileged functions for DNSand DHCP. These changes are detailed inAppendix B:DNS and DHCP in the UNIX environment.

Additionally, the BT Diamond IP discovery enginemscanapplication requires rootprivileges. Toaccomplish this, the following steps are taken during theinitial install:

Set the owner of$INCHOME/mscan/mscan to root.

Set the group owner of$INCHOME/mscan/mscan to the name of


28/56


the group specified in the main install screen(usually incontrol)

Set permissions on$INCHOME/mscan/mscan to 4750. Ofparticular note is the setuidbit (4). Thiscauses the program to run as the user whoowns the executable instead of the currentuser. Since the owner is set to root, thismakes it possible for non-root users to runthe application as root. The other bits (750)specify that the owner (root) hasread/write/execute, the group (incontrol) hasread/execute, and everyone else has no

permissions.Linux users: The library, libaio.so.1, is required beforeinstalling IPControl 6.0 with MySQL. If the library is notpresent on your system, you will be notified during theinstallation. Consult your system administrator for moredetails.

64-bit Linux users installing 32-bit IPControl: Thefollowing 32-bit libraries are required:

glibc.i686

libgcc.i686

libaio.i686

ncurses-libs.i686


29/56


IPControl Installation

The follow steps outline the procedures for installingIPControl. Assumptions include:

The incadmin user, group, and homedirectory have been created as defined inthe How to begin section.

Appropriate ports and firewall permissionsare configured in order for the IPControlAgent to communicate to the IPControlExecutive.

If a customer installed Oracle or MySQLdatabase is to be used in place of the copyof MySQL Community Edition includedwith IPControl, then that database has beeninstalled and configured with the IPControldatabase schema.

1. Login to the Executive server as root.

2. Change directory to the system temp directory (i.e./tmp), and run the incinstall-linux32.sh (RH5),

incinstall-linux64.sh (RH6/CentOS6), or incinstall-solaris.sh script. For example:

cd /tmp

./incinstall-linux32.sh

3. The installer uncompresses the JRE (Java RuntimeEnvironment) used to run the installation.

Unpacking JRE

Preparing JRE

Starting Installer

4. The installer then confirms that you want to installIPControl on your system.


30/56


This will install InControl on your computer.

OK [o, Enter], Cancel [c]

5. Hit Enter on your keyboard to proceed with theinstallation.

6. The system will then prompt you to confirm thelocation for the IPControl install:

Where should InControl be installed?

[/opt/incontrol]

7.

Hit enter to accept the default installation directory orchoose a different location that was created for theincadmin user as described above. Please note that if adirectory other than /opt/incontrol is chosen, and theinstallation will include ISC BIND DNS server, then youmust create a symbolic link for /opt/incontrol to the choseninstallation folder.

8.

The installer will then prompt you to select theappropriate type of installation:

Which type of installation should be performed?

Executive [1, Enter]

Executive (Customer Installed Database) [2]

Agent Only [3]

Select the desired installation type, and then hit Enter:

ExecutiveChoose this option to install theIPControl Executive including the suppliedcopy of MySQL Community Edition.

Executive (Customer Installed Database)

Choose this option to install the IPControlExecutive which will utilize an Oracle orMySQL database installation provided by thecustomer.


31/56


Agent OnlyChoose this option to install theIPControl Agent including ISC DHCP and/or

BIND servers.

9. If installing an Executive, the installer will present thefollowing component selection options

Which components should be installed?

*: InControl

*: MySQL

*: ActiveMQ

*: Tomcat

Please select a comma-separated list of theselected values or [Enter] for the default

selection:

The required components of the IPControlExecutive are automatically selected. In addition,the default component selection does not includeBIND and DHCP packages. If DNS and DHCPcomponents are desired to be installed on theExecutive then enter [1,2]. Choose the desiredselection(s) and then hit Enter.

10.If installing an Executive with customer installeddatabase, the installer will present the following

component selection option:


*: InControl

*: ActiveMQ

*: Tomcat

Please select a comma-separated list of theselected values or [Enter] for the defaultselection:

The required components of the IPControlExecutive with customer installed database areautomatically selected. In addition, the default

component selection does not include BIND andDHCP packages. If DNS and DHCP componentsare desired to be installed on the Executive thenenter [1,2]. Choose the desired selection(s) and thenhit Enter.


32/56


If installing an Agent only, the installer will presentthe following component selection option:


*: InControl

*: ActiveMQ

Please select a comma-separated list of theselected values or [Enter] for the defaultselection:

The required components of the IPControl Agentare automatically selected. In addition, the defaultcomponent selection includes the ISC BIND andDHCP packages. Chose the desired selection, andthen hit Enter.

11.Optionally Enter your IPControl License Key. If notentered, you will be prompted for it after logging onto the system.

Please enter your license key (optional).

License Key:

[]

13.Next you will be given the opportunity to view theIPControl License Agreement.

WARNING: Bypassing display of the following BTAMERICAS INC. End User License Agreementrepresents acknowledgement that you have alreadyread and accepted it. License agreements will beavailable under /opt/incontrol/docs.

Display license agreement?

Yes [y], No [n]

14.Follow the prompts appropriately, to either reviewthe licensing agreement or bypass it.

15.Next you will be given the opportunity to view theMySQL License Agreement.WARNING: Bypassing display of the following MySQLLicense Agreement represents acknowledgement thatyou have already read and accepted it. License


33/56


agreements will be available under/opt/incontrol/docs.

Display license agreement?

Yes [y], No [n]

16.Follow the prompts appropriately, to either reviewthe licensing agreement or bypass it.

17.You will now be prompted to enter the user accountthat will own and run the IPControl system. Thisuser account must be created as described above.

Please enter the information required to installInControl.

Who is the UNIX Owner of the InControl system?

[incadmin]

18.Hit Enter to accept the default incadmin user.

19.Next youll be prompted to enter the user group theIPControl admin user belongs to. This user groupmust be created as described above.

What is the name of the UNIX group being used?

[incontrol]

20.Hit Enter to accept the default incontrol group.

21.The installer will then prompt you for the IP addressof the system.

What is the IP Address of this system?

[10.0.0.1]

22.Validate that the IP address of the system is correct.

23.The installer will then prompt you for the IP addressof the Executive.

What is the IP Address of the InControl Executive?

[10.0.1.1]


34/56


24.If installing an Executive, enter the IP address of thehost system. Otherwise, enter the IP address of the

IPControl Executive system.

25.If installing an Executive with a customer installeddatabase, the installer will now prompt you for theremote database type.

What type of remote database are you using?

Oracle [1, Enter], MySQL [2]

26.Select the appropriate database.

27.

If installing an Executive with a customer installed

Oracle database, then you will be prompted for thefollowing information:

Please enter the information required to connect tothe Remote Oracle database.

Login

[incadmin]

Password

[incadmin]

Host or IP

[localhost]

Port

[1521]

Oracle SID

[INC]

28.Enter the correct Oracle Database connectioninformation and continue.

29.If installing an Executive with a customer installed

MySQL database, then you will be prompted for thefollowing information:Please enter the information required to connect tothe Remote MySQL database.

Login

[incadmin]


35/56


36/56


37/56


Starting and stopping individual IPControl Services

To start or stop individual IPControl services, scripts areprovided in the /etc directory below the IPControl homedirectory (i.e. /opt/incontrol/etc). The following is a list ofthe individual scripts that can be used.

IPControl Executive

/opt/incontrol/etc/mysqld_startStartup script for MySQL database

/opt/incontrol/etc/mysqld_stopStop script for MySQL database

/opt/incontrol/etc/tomcat_startStartup script for Tomcat

/opt/incontrol/etc/tomcat_stopStop script for Tomcat

/opt/incontrol/etc/activemq_startStartup script for ActiveMQ router /opt/incontrol/etc/activemq_stopStop script for ActiveMQ router

/opt/incontrol/etc/tm_startStartup script for Task Manager

/opt/incontrol/etc/tm_stopStop script for Task Manager

/opt/incontrol/etc/rm_startStartup script for Result Manager

/opt/incontrol/etc/rm_stopStop script for Result Manager

/opt/incontrol/etc/lm_startStartup script for Log Manager

/opt/incontrol/etc/lm_stopStop script for Log Manager

/opt/incontrol/etc/fm_startStartup script for File Manager

/opt/incontrol/etc/fm_stopStop script for File Manager

/opt/incontrol/etc/cm_startStartup script for Callout Manager

/opt/incontrol/etc/cm_stopStop script for Callout Manager

/opt/incontrol/etc/agent_startStartup script for Agent

/opt/incontrol/etc/agent_stopStop script for Agent

/opt/incontrol/etc/dl_startStart script for DNS Listener

/opt/incontrol/etc/dl_stopStop script for DNS Listener

/opt/incontrol/etc/named_startStart script for ISC BIND (DNS) (*)

/opt/incontrol/etc/named_stopStop script for ISC BIND (DNS) (*)

/opt/incontrol/etc/dhcpd_startStart script for ISC DHCPv4 (*)

/opt/incontrol/etc/dhcpd_stopStop script for ISC DHCPv4 (*)

/opt/incontrol/etc/dhcpd6_startStart script for ISC DHCPv6 (*)

/opt/incontrol/etc/dhcpd6_stopStop script for ISC DHCPv6 (*)

*If Installed

IPControl A gent

/opt/incontrol/etc/activemq_start - Startup script for ActiveMQ Router

/opt/incontrol/etc/activemq_stopStop script for ActiveMQ Router

/opt/incontrol/etc/agent_startStartup script for Agent

/opt/incontrol/etc/agent_stopStop script for Agent

/opt/incontrol/etc/lm_startStartup script for Log Manager

/opt/incontrol/etc/lm_stopStop script for Log Manager


38/56


/opt/incontrol/etc/named_startStart script for ISC BIND (DNS) (*)

/opt/incontrol/etc/named_stopStop script for ISC BIND (DNS) (*)

/opt/incontrol/etc/dhcpd_startStart script for ISC DHCPv4 (*)

/opt/incontrol/etc/dhcpd_stopStop script for ISC DHCPv4 (*)

/opt/incontrol/etc/dhcpd6_startStart script for ISC DHCPv6 (*)

/opt/incontrol/etc/dhcpd6_stopStop script for ISC DHCPv6 (*)

*If Installed

Configuring the services to start during boot

The IPControl services can be configured to automatically startduring system boot.

BT Diamond IP supplies scripts in the etc directory below

the IPControl home directory (i.e. /opt/incontrol/etc).These scripts can be used to start and stop services duringsystem boot and shutdown. These scripts must be moved orlinked to the init.d directory to call the startup scripts duringsystem boot.

1. Login as root.

2. Copy the file /opt/incontrol/etc/init.d.incontrol tothe /etc/init.ddirectory, and rename it toincontrol. For example:

cp /opt/incontrol/etc/init.d.incontrol /etc/init.d/incontrol


39/56


3. Copy the file /opt/incontrol/etc/default.incontrolto the /etc/defaultdirectory, and rename it to

incontrol. For example:

cp /opt/incontrol/etc/default.incontrol /etc/default/incontrol

4. Edit the /etc/default/incontrolfile and make surethe following variables are set correctly:

On the IPControl Executive:

INCADMIN=incadmin

INCHOME=/opt/incontrol

ACTIVEMQ_SLEEP=5

START_MYSQL=YES

START_TOMCAT=YES

START_ACTIVEMQ=YES

START_TM=YES

START_RM=YES

START_LM=YES

START_CM=YES

START_FM=YES

START_AGENT=YES

START_NAMED=YES (* if installed)

START_DHCPD=YES (* if installed)

START_DL=YES

# By default, named will NOT be stopped whenstopping the other InControl components. If you

want to stop DNS when stopping the otherservices, set the below line to YES

STOP_NAMED=NO

# By default, dhcpd will NOT be stopped whenstopping the other InControl components. If you

want to stop DHCPd when stopping the otherservices, set the below line to YES

STOP_DHCPD=NO

# By default, Tomcat will run as the INCADMINuser. If you wish to run the GUI on port 80,Tomcat must run as root in order to access port80, which is a privileged port. To tell Tomcatto run as root, set the below line to YES


40/56


TOMCAT_ROOT=NO

# When DHCP is started by the Agent, the Agent

will provide the path to the DHCP conf and leasefile. When DHCP is started on system boot, thedhcpd_start script needs to know where thesefiles are, since they won't be passed on thecommand line. These values will need to be

modified. If you place DHCP files in a non-standard directory.

DEFAULTDHCPCONF=/opt/incontrol/dhcpd/dhcpd.conf

DEFAULTDHCPLEASE=/opt/incontrol/dhcpd/dhcpd.leases

On the IPControl Agent:

INCADMIN=incadmin

INCHOME=/opt/incontrol

ACTIVEMQ_SLEEP=5

START_MYSQL=NO

START_TOMCAT=NO

START_ACTIVEMQ=YES

START_TM=NO

START_RM=NO

START_LM=NO

START_CM=NO

START_FM=NO

START_AGENT=YES

START_NAMED=YES (* if installed)

START_DHCPD=YES (* if installed)

START_DL=NO

# By default, named will NOT be stopped whenstopping the other InControl components. If you

want to stop DNS when stopping the otherservices, set the below line to YES

STOP_NAMED=NO

# By default, dhcpd will NOT be stopped whenstopping the other InControl components. If you

want to stop DHCPd when stopping the otherservices, set the below line to YES

STOP_DHCPD=NO

# By default, Tomcat will run as the INCADMINuser. If you wish to run the GUI on port 80,Tomcat must run as root in order to access port


41/56


80, which is a privileged port. To tell Tomcatto run as root, set the below line to YES

TOMCAT_ROOT=NO

# When DHCP is started by the Agent, the Agentwill provide the path to the DHCP conf and leasefile. When DHCP is started on system boot, thedhcpd_start script needs to know where thesefiles are, since they won't be passed on thecommand line. These values will need to be

modified. If you place DHCP files in a non-standard directory.

DEFAULTDHCPCONF=/opt/incontrol/dhcpd/dhcpd.conf

DEFAULTDHCPLEASE=/opt/incontrol/dhcpd/dhcpd.leases

5.

Link the /etc/init.d/incontrolfile to entries in/etc/rc3.d, /etc/rc2.d, /etc/rc0.d, and /etc/rcS.d.This will start up the services when the system boots toinit level 3. It will shut down the services when thesystem leaves init level 3.

cd /etc/rc3.d

ln -s ../init.d/incontrol S90incontrol

cd ../rc2.d

ln -s ../init.d/incontrol K90incontrol

cd ../rc1.d

ln -s ../init.d/incontrol K90incontrolcd ../rc0.d


cd ../rcS.d


Uninstalling IPControl for UNIX

Before you uninstall, you should create a safe backup of your database. Oracle database users must

ask their DBA to export the IPControl database, as well as drop the user of the IPControl database.

MySQL users, do the following:

1. From /opt/incontrol/mysql/bin on the Executive, run the command: ./mysqldumpuincadmin

pincadmin --opt incontrol > /opt/safe-backup/incontroldb.sql


42/56


Oracle and MySQL users, do the following for the Executive or Agent UNIX system:

1.

Backup all customized scripts or files that were used in this environment to a safe backup location,

such as /opt/safe-backup

2.

Stop all IPControl services

a.

From /opt/incontrol/etc, run the command: ./incontrol stop

3.

Check that all IPControl services have been stopped.

a. Run the command: psef|grep inc

i. Expected results are none, other than the grep command itself

ii. If anything is leftover, use the kill {pid} command to end the running process.

4. From /opt, run rm r /opt/incontrol for Solaris systems, or rm rf /opt/incontrol for Linux

systems.

5.

IPControl is now uninstalled.


43/56


Appendices

Appendix A: Configuring Windows Firewall for IPControl

Microsoft Windows 2008 includes aWindows Firewallfeaturewhich may disrupt communication of some IPControlcomponents.

In environments where IPControl is set up in a decentralizedfashion, its necessary to configure the Windows Firewall toallow packets to flow freely.

To edit the list of programs that are allowed to communicatethrough the Windows Firewall, follow these steps.

Accessing Windows Firewall Configuration

1. Open the Windows control panel.

2. Choose System and Security.

3.

ChooseWindows Firewall.

4.

Youll see the Windows Firewall configuration screen, asshown below.
http://www.microsoft.com/windowsxp/using/security/internet/sp2_wfintro.mspxhttp://www.microsoft.com/windowsxp/using/security/internet/sp2_wfintro.mspxhttp://www.microsoft.com/windowsxp/using/security/internet/sp2_wfintro.mspxhttp://www.microsoft.com/windowsxp/using/security/internet/sp2_wfintro.mspx


44/56


5. If the Windows Firewall state is currently set to Offthenno further action is necessary. Otherwise, continue with

the steps below.6. Click on theAllow program or feature through

Windows Firewalllink.

7. Click theAllow another programbutton. The list ofregistered programs on the server will display. Click theBrowsebutton to specify a program not in the list.

8. From this dialog, add the following programs, depending

on whether this server is running as an Agent or as anExecutive.

IPControl Executive

C:\Program Files\Diamond IP\InControl\activemq\bin\win32\wrapper.exe

C:\Program Files\Diamond IP\InControl\bin\ipcontrol-agent.exeC:\Program Files\Diamond IP\InControl\bin\ipcontrol-ftpd.exe

IPControl A gent

C:\Program Files\Diamond IP\InControl\activemq\bin\win32\wrapper.exe

C:\Program Files\Diamond IP\InControl\bin\ipcontrol-agent.exe

By default these files will be in C:\Program Files\DiamondIP\InControL, but will vary based on where the product isinstalled.

9. Click OKto save changes all the changes.


45/56


46/56


47/56


Set permissions on $INCHOME/dhcpd/dhcpd to4750.

The inkillutility simply takes the passed process ID (PID)and executes a kill on it. This utility, coupled with thepermissions changes below, allow the incadmin user to killa process owned by root. Changes made that allow us tostopa process owned by root are:

Set the owner of $INCHOME/bin/inkill to root.

Set the group owner of $INCHOME/bin/inkill tothe group named in the install menu (usuallyincontrol).

Set the permissions on $INCHOME/bin/inkill to

4750.Note that the full source code to the inkill utility is includedin the $INCHOME/bin directory as inkill.c. You areencouraged to inspect and/or recompile this source codeyourself should you be concerned about the security of thisutility.


48/56


Appendix C: Multiple Result Manager Setup

For increased performance, the system can be configured to

use multiple result managers instead of one. This divides theprocessing load from the agents, resulting in increasedthroughput of messages from the Agents.

Adding a second Result Manager on the Executive

This section describes the steps needed to add a second (ormore) Result Manager process on the executive. The newResult Manager will process messages from the same incomingqueue as the default Result Manager.

Create the configuration and sc r ipt f i les to run th e new

Result Manager

In the $INCHOME directory, there are two files that controlthe Result Mangers runtime configuration:result_manager.properties andresult_manager_log4j.properties.

1) Make a copy of result_manager.properties. In our example,the copy is named result_manager2.properties.

2) Make a copy of result_manager_log4j.properties. In ourexample, the copy is result_manager_log4j_2.properties.

3) Edit the new result manager properties file (e.g.result_manager_2.properties). Change thelog.config.filename to use a new log4j properties file name(e.g. result_manager_log4j_2.properties).

4) Modify the new log4j file to direct the logging output to adifferent file. In the new file (e.g.result_manager_log4j_2.properties), find the following line:

log4j.appender.RollingFile.File=${INCX_HOME}/log/resultmgr_2.log

Change the file name to direct the logging output to a newfile, for example resultmgr_2.log

In the $INCHOME/etc directory, there is a script thatcontrols the Result Manager, called rm.

1)

Make a copy of rm, e.g. rm_2.

Edit the new script and change the following lines:

From INCPROC_NAME=rm; export INCPROC_NAME

To INCPROC_NAME=rm_2; export INCPROC_NAME


49/56


50/56


51/56


For example, if we use the name alt_rm1, it would readas follows:

Becomes:

c.

Change the network connector that will point to theincx_broker on the original Executive. To do this find thesection that looks like this:

Replace the INCX_IPADDR with the actual IP Addressof the Executive.

6)

Start the stand alone result manager by issuing anincontrol start command.


52/56


Appendix D: Multiple Task Manager Setup

For increased performance, the system can be configured to

use multiple task managers instead of one. This divides theprocessing load of generating task messages for the agents,resulting in increased throughput of task messages to theAgents.

Adding an on-board Task Manager

This section describes the steps needed to add a second (ormore) Task Manager process on the executive system itself.

Create the configuration and sc r ipt f i les to run th e new

Task ManagerIn the $INCHOME directory, there are two files that controlthe Task Mangers runtime configuration:task_manager.properties and tm_log4jconfig.properties.

1)

Make a copy of task_manager.properties. In our example,the copy might be named task_manager_2.properties.

2) Make a copy of task_manager_log4j.properties. In ourexample, the copy might be namedtask_manager_log4j_2.properties.

3) Edit the new task manager properties file (e.g.

task_manager_2.properties). Change thelog.config.filename to use the new log4j properties filename (e.g. task_manager_log4j_2.properties). Add a newline to have the new task manager listen on a different portthan the original task manager. The new line should read:

port.number=4921

The port number just needs to be different from thedefault port number used by the original task managerwhich is 4911.

4) Modify the new log4j file to direct the logging output to a

different file. In the new file (e.g.task_manager_log4j_2.properties), find the following line:

log4j.appender.RollingFile.File=${INCX_HOME}/log/taskmgr.log

Change the file name to direct the logging output to a newfile, for example taskmgr_2.log


53/56


In the $INCHOME/etc directory, there is a script thatcontrols the Task Manager, called tm.

4)

Make a copy of tm, e.g. tm_2Edit the new script and change the following lines:

From INCPROC_NAME=tm; export INCPROC_NAME

To INCPROC_NAME=tm_2; export INCPROC_NAME

From INCPROC_DESC="IPControl Task Manager"; exportINCPROC_DESC

To INCPROC_DESC="IPControl Task Manager 2"; exportINCPROC_DESC

From PROCESS_TAG="$JAVACMD -DINC_TM "; export

PROCESS_TAGTo PROCESS_TAG="$JAVACMD -DINC_TM_2"; exportPROCESS_TAG

From INCPROC_RUN="nohup$INCHOME/task_manager.properties"; export INCPROC_RUN

To INCPROC_RUN="nohup$INCHOME/task_manager_2.properties"; exportINCPROC_RUN

5)

Make a copy of tm_start, e.g. tm_2_start, and edit it so thatit calls ./tm_2 start $1.

6) Make a copy of tm_stop, e.g. tm_2_stop, and edit it so thatit calls ./tm_2 stop $1.

Update the Executive Start up sc r ipts to start and sto p

the new Task Manager

1) Edit the file /opt/incontrol/etc/default.incontrol, and addthe following line:

START_TM_2=YES

2) Edit the file /opt/incontrol/etc/incstatus, and add thefollowing line:

TM_2="tm_2"

Also add $TM_2 to the list of SERVICES:

SERVICES="$MYSQLD $TM_2 "

3) Edit the file /opt/incontrol/etc/incontrol, and add thefollowing lines:


54/56


55/56


$INCHOME/activemq/conf/activemq.xml. You willneed to make a few changes to the activemq.xml file. They

are outlined below.b. Find the section of the file that sets the brokerName

definition. Change the brokerName attribute of thebroker from INCRA_IPADDR to some otherdescriptive name, like alt_tm1.

For example, if we use the name alt_tm1, it would readas follows:

Becomes:

c. Change the network connector that will point to theincx_broker on the original Executive. To do this find thesection that looks like this:

Replace the INCX_IPADDR with the actual IP Address

of the Executive.6) Start the stand alone result manager by issuing an

incontrol start command.


56/56

Documents

IPControl 6.0 Install Guide