Deprecated: Function split() is deprecated in /storage/content/94/122194/onecmdb.org/public_html/wiki/includes/Parser.php on line 2719 Deprecated: Function split() is deprecated in /storage/content/94/122194/onecmdb.org/public_html/wiki/includes/Parser.php on line 2773 Deprecated: Function split() is deprecated in /storage/content/94/122194/onecmdb.org/public_html/wiki/includes/Parser.php on line 2773 User's manual V1.4 - OneCMDB

User's manual V1.4

From OneCMDB

Contents

Install, uninstall, startup and shutdown

If upgrading from older OneCMDB version, see known upgrade problem.

On Windows platforms

To install:

  1. Download the setup file
  2. Note that you must have Administrator's rights to perform the installation
  3. Double-click the downloaded setup file
  4. Follow the instructions in the setup windows

Note that the installer stores information regarding the installation in the following registry key:

HKLM\SOFTWARE\Lokomo OneCMDB | Single User Edition

To uninstall:

  1. Stop OneCMDB, if it is running.
  2. Run the Uninstall program in the OneCMDB Windows Program Start Group:
Start>Programs>Lokomo OneCMDB Single User Edition>Uninstall

If you, for some reason, prefer to uninstall the software manually, just delete the installation folder, the shortcuts on the start menu, and the registry key mentioned above.

To start:

Start>Programs>Lokomo OneCMDB Single User Edition>Startup

Image:Ss-startmenu.jpg

Observe that the application requires free ports 8080 and 8009 (used by local web server)

  1. A command window is launched and you are requested to hit a key to start a local web server (Tomcat) and a local database (HSQL).
  2. Two new command console windows now open up. Tomcat may take 1-2 minutes before everything is loaded. Tomcat is ready when you see the log line "INFO: Server startup in xxx ms" in the Tomcat console window.
  3. Hit a key a in the first command console window again, this will open up a web browser. It will take a few more seconds before the browser presents the OneCMDB GUI start page for the first time.

The startup routine may seem cumbersome. The reason is that we have packaged the single user edition as a stand-alone desktop program, although it is designed for server deployment. We may in the future provide a Windows installation using Services, which will get rid of the command consoles.

To stop:

Start>Programs>Lokomo OneCMDB Single User Edition>Shutdown

Shutdown closes the three command consoles.

On Linux platforms

To install:

  1. Download the setup file to the directory on your system where you want OneCMBD installed.
  2. Uncompress (unzip) and extract (untar) the setup file using the following command:

tar -xfz <name of setup file>

(Note that a GNU compatible tar utility is required (standard on most Linux platforms))
  1. All files will be stored in a subdirectory named onecmdb
  2. OneCMDB is now installed and the subdirectory contains all files needed to run OneCMDB.

To uninstall, simply delete all files in the OneCMDB directory.

To start, use the following shell command:

$ bin/onemdb.sh start

It will start the required programs neeeded; HSQLDB for data storage, Apache Tomcat driving the business logic and the GUI.

To open the OneCMDB GUI, use a browser and open:

http://localhost:8080

In case you want to use OneCMDB from other computers, open the browser on the other computer and replace `localhost' with the name, or IP address, of this computer. Remember to open the firewall (on this computer) to allow TCP requests on port 8080.

To stop OneCMDB:

$ bin/onemdb.sh stop

It takes down the database and the Apache Tomcat in a controlled manner.

Get started

When the system boots the first time it initializes a Configuration Management Database according to the default model in the system and then you will see the Welcome Screen in the OneCMDB GUI. At this point you must authenticate yourself. Default login credentials are:

  • username=admin
  • password=123

After you have logged in, you may click on the ""xxxx Data Center"" link in the History window at the left and you will go to the starting point of the CMDB that is initialized. You may now browse, search and edit the data as described in the following chapters. You can also edit and enhance the structure of the CMDB as described further on.

If you at this point like to replace the database model, use the OneCMDB Model Replacer Utility as described further on in this manual.

Perform automatic discovery

You can execute a utility that automatically populates your CMDB with network equipment available on your network. The systems must respond to either ICMP or ARP to be detected.

Run discovery

  1. Start the Discovery utility:
  • On Windows: Go to the Windows Start menu and select the Discover Network utility in the OneCMDB directory.
  • On Linux: Run the Discover script in the OneCMDB directory.
  1. Follow the instructions provided by the utility.

Configure discovery

The Discovery utility has a paramater that defines the network that will be discovered. If you like to alter the address range you must edit the parameter inside the Discover script. The script is located in the directory where OneCMDB is installed.

View result

When the Discover utility has completed all network equipemnt found is stored in the CMDB and can be viewed from the OneCMDB GUI.

Note that any (dummy or demonstration) data that was in the CMDB prior to running the Discover utility remains and is mixed with the new data.

Edit and re-run

After discovery you may manually add and alter data, for example you can add information to each CI encountered.

If you re-run the Discover utility it will add new equipment but not remove old ones.

Browse and Search database

Browse

Browse the database by following links available in the view/edit window.
For example, the following images show how to browse to a system's IP address:

(1) (2)

(3) (4)

Search

Search the database by entering a free text string in the Search form field.
For example, to find the IP address you previously browsed to, enter the IP address into the search field:

(1) (2)

(3)

Collapse History

The History will grow until you collapse it. If the CI you view appears several times in the History, indicated by several orange CIs, you can click the top orange item and the view will remain on the CI but the history is shorter.

Edit database data

New Instance

Alternative 1 - via other instance:
Assume the Advanced Model is used. You want to create an IP address, that you can do via a DNSEntry which is supposed to reference an IP address.

  1. Switch to user mode.
  2. Browse to the relevant DNSEntry.
  3. Click [Edit].
  4. Scroll down to attribute "OS", click its drop-down menu and chose "IP" under Create new
  5. The system will automatically create a new instance of IP and present it to you
  6. Set the "ipAddress " and "addrType" attributes of IP
  7. Click [Apply], you will return to the DNSENtry and your recently created IP will be presented as value
  8. Click [Apply], the IP value is set in DNSEntry and you return to View state


(2) (4)

(5,6) (7)

(8)

Alternative 2 - via a folder:
Assume the Advanced Model is used. You want to create an IP adress, that you can do via the "IPs" folder.

  1. Switch to user mode.
  2. Browse to IPs folder.
  3. Click [Edit].
  4. Scroll down to attribute "ips", click its drop-down menu and chose "IP" under Create new
  5. The system will automatically create a new instance of IP and present it to you
  6. Set the "ipAddress " and "addrType" attributes of IP
  7. Click [Apply], you will return to the IP and your recently created IP will be presented as value
  8. Click [Add] to add it to the list
  9. Click [Apply], the IP value is set in DNSEntry and you return to View state

Note, this alternative is only a variant of alternative 1, as the folder is an ordinary instance that has a list attribute

(2) (4)

(5,6) (7)

(8) (9)

Alternative 3- via a template in designer mode:
Assume the Advaned Model is used. You want to create an IP adress, you can do that by using the template directly.

  1. Switch to designer mode.
  2. In Template chain window, click on ROOT template.
  3. Use view/edit window to browse to IP template
  4. Click [Edit] button.
  5. Click [New] button under section Descendants.
  6. The system will automatically create a new instance of IP and present it to you
  7. Set the "ipAddress " and "addrType" attributes of IP
  8. Click [Apply], you will return to the IP template and your recently created IP is added under section Descendants
  9. Click [Apply], and you return to View state


Note, you must manually add new instances to folders. You do this by editing the list attribute in the relevant folder, see alternative 2. However, new instances created by auto discovery will be added automatically to the folders.

Edit Instance

You can edit Instances both in user and designer mode.

  1. Browse to the relevant CI using view/edit window
  2. Press [Edit] button.
  3. Modify the attribute values
  4. Press [Apply] to save your modifications.

Edit simple attribute:
[Image - screenshot of edit string attribute]
Edit a list attribute:
[Image - screenshot of edit list attribute]
Edit a reference attribute:
[Image - screenshot of edit reference attribute]

Remove Instance

  1. Switch to designer mode.
  2. In Template chain window, click on ROOT template.
  3. Use view/edit window to browse to a template.
  4. Click [Edit].
  5. Under section Descendents press trashcan for the instance you want to remove.
  6. Click [Ok] in the pop-up window.
  7. Click [View] to return to View state.


(3) (5)


Note, you must manually remove the references in folders to the removed instance. Removed instances show up in folders as entries with value "empty".

Edit database structure

New Template

  1. Switch to designer mode.
  2. In Template chain window, click on ROOT template.
  3. Use view/edit window to browse to a template.
  4. Press [Edit] button.
  5. Press [New] button under descedants.
  6. Modify identification
    1. Set template option
    2. Modify Alias, by default it get the unreadable id
    3. Set Displayname, by default it get Dispalyname from the parent template
    4. Set icon
  7. Add new attributes
  8. Press [Apply]

Edit Template

You can edit Instances both in user and designer mode.

  1. Browse to relevant template using view/edit window.
  2. Press [Edit] button.
  3. Modify attributes
    1. Modify attribute value
    2. Add/remove attribute
  4. Press [Apply] to save your modifications.

For example, you may edit simple attribute: [Image - screenshot of edit string attribute]
Or you may edit a reference:
[Image - screenshot of edit reference attribute]

Note, your changes will be copied to all the descendants! Exact behavior is controlled through policies.

Note, removing an attribute that references another CI doesn't remove the referenced CI. For example, removing a reference to a NIC instance in the NICs folder doesn't remove the instance.

Remove Template

  1. Switch to designer mode.
  2. In Template chain window, click on ROOT template.
  3. Use view/edit window to browse to the parent of the template you want to remove.
  4. Press [Edit].
  5. Under section Descedents press trashcan for the tempalte you want to remove.

Change log

Every modification you do to a CI is logged automatically.



Each row shows a change. You see the id of the RFC (Request For Change), time and a textual description of the change.
The RFC is generated automatically by the system, as OneCMDB requires an RFC for any kind of change to the database.
In Team edition of OneCMDB you will also see in the change log the user that ordered a change.

Export database

You export the database to an XML file by triggering the export job.

  1. Switch to Designer mode.
  2. Browse to Export Job
    1. Click Root in Template chain window
    2. Click Job in under section Descendants in View/Edit window
    3. Click JobProcess in under section Descendants in View/Edit window
    4. Click ExportModel in under section Descendants in View/Edit window
    5. Click ExportModel[defaultExport] in under section Descendants in View/Edit window
  3. Click [Start] button.
    The model will be exported to /tmp/ExportedModel.xml on Linux, or C:\tmp\ExportedModel.xml on Windows.
  4. Click [Refresh] button to see progress.
  5. The job has finished when 'state' attribute value says IDLE and 'status' attribute says Completed. If the job failed 'status' should say Failed.

Note: Export writes everything in the database to the export file: Hence, it will also include the CI that provides input parameters to the export job itself. That CI includes a "state" attribute, indicating that the Job is "RUNNING". If importing the export file into another OneCMDB, you must first manually edit the 'state' attribute and set it to "IDLE" else the Job [Start] button in the GUI will be greyed out.

Import database

Use this function to extend your database model or populating an existing database with more CI:s. You import a OneXMDB XML file by running the import job.

  1. Save your XML file on the local disk, e.g. C:\tmp\myadditions.xml
  2. Switch to Designer mode.
  3. Browse to Import Job.
    1. Click Root in Template chain window
    2. Click Job in under section Descendants in View/Edit window
    3. Click JobProcess in under section Descendants in View/Edit window
    4. Click ImportModel in under section Descendants in View/Edit window
    5. Click ImportModel[defaultImport] in under section Descendants in View/Edit window
  4. Edit path that points to XML file on your local disk.
    1. Click [Edit]
    2. Edit the attribute importUrl, e.g. write file:///tmp/myadditions.xml (assumes you only have one disk)
    3. Click [Apply]
  5. Click [Start] button.
  6. Click [Refresh] to see that the import job has completed


Note: Instance 'displayName' and 'description' are copied from Templates when importing an XML file, according to default policies. That is, do not set 'displayName' or 'description' for instances in the XML file as these settings will anyway not be used.

Replace model

You may replace the CMDB model used in OneCMDB, for example change from the Basic Model to the Advanced Model. Note that if you replace the model, all instances (e.g from discovery or manual entry) and all user-defined templates will be deleted as the database is reset.

On Windows

Ensure that OneCMDB is shut down and execute the following command to replace the model:

Start>Programs>Lokomo OneCMDB Single User Edition>Replace Model

At next startup of the system the new model will be read and initialized.

On Linux

Ensure that OneCMDB is shut down and execute the following command to replace the model:

$ bin/replmod.sh

Manual replacement

If you for some reason like to replace the model manually, do as follows:

  1. Stop OneCMDB
  2. Open a file browser and move to <onecmdb_install_dir>/hsqldb-x.x.x/data
  3. Remove all files in the directory
  4. Replace the file <onecmdb_install_dir>/tomcat-x.x.x/webapps/ROOT/WEB-INF/classes/Model.xml with a new model file.
  5. Start OneCMDB again. The new model is read and the database initialized

Reset the database

A reset of the OneCMDB database will remove all instances (e.g from discovery or manual entry) and all user-defined templates. Next time the system is booted after a database reset it will import the database model again.

To reset the database, follow this procedure:

  1. Stop OneCMDB
  2. Open a file browser and move to <onecmdb_install_dir>/hsqldb-x.x.x/data
  3. Remove all files in the directory
  4. Start OneCMDB again. The model is read again and the database initialized

Community and support