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.0 - OneCMDB

User's manual V1.0

From OneCMDB

Contents

Install and uninstall

Requires: Windows 2000 or later, Administrator rights.
or Linux.

To install OneCMDB:

  1. Download the setup.exe.
  2. Double-click the exe-file.
  3. Follow the instructions in the setup windows.

To uninstall OneCMDB:

  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

Start and Stop

Requires: Free ports 8080, 8009 (used by local web server)

Start>Programs>Lokomo OneCMDB Single User Edition>Startup

Image:Ss-startmenu.jpg

  1. Start launches a command window 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.

Follow this procedure to stop OneCMDB:

Start>Programs>Lokomo OneCMDB Single User Edition>Shutdown
Shutdown closes the three command consoles.

Perform automatic discovery

The single user edition includes a [1.0.x#Jobs_and_triggers job] to automatically populate your CMDB with systems available on your network. The systems must respond to either ICMP or ARP to be detected.
Note that the automatic discovery function currently only is available with the Advanced CMDB Model.

Configure discovery

  1. Click the "Data center" link in the History window
  2. In the View window, click "MyDatacenterDiscovery" under the References section.
    1. Scroll down to attribute "target" which defines the network that will be discovered
    2. Click [Edit] to change attribute "target" unless 192.168.1.0/24 is ok. See format.

Run discovery

  1. Click the [Start] button
  2. Click [Refresh] a few times to see progress, a large network may take considerable time to discover
  3. 100% progress indicates that discovery is completed


View result

  1. Click the "Data center" link in the History window
  2. Click the "Network" link in the View window
  3. Click "IPs", "NICs", "DNSEntries" and "Network Interfaces" to view discovered items



You find following data in Network subfolders:

  • IPs lists discovered IP-addresses
  • DNSEntries lists DNS names of discoverd IP-address
  • NICs lists discovered MAC addresses of discovered IP-addresses
  • Network Interfaces lists associated IP-addresses and MAC-addresses

See default model for a more detailed description of the model.

Edit and re-run

After discovery you may manually add data. For example you can create instances of different operating systems and point discovered Network Interfaces to them.

If you re-run discovery it will add new systems 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 discovered 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 default model is used. You want to create an IP adress, 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 default 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 variant of alternative 1, as the folder i an ordinary instance that has a list attribute

(2) (4)

(5,6) (7)

(8) (9)

Alternative 3- via template in designer mode:
Assume the default 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 the folders in the default model. You do this by editing the list attribute in the relevant folder, see alternative 2. Although, 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 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 Descedents 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 a 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 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 defaultExport in under section Descendants in View/Edit window
  3. Click [Start] button.
    The model will be exported to /tmp/defaultOnecmdbModel.xml on Linux, or C:\tmp\defaultOnecmdbModel.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 file it will also include the CI that provide 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 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. 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 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 completed


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

Reset database

A reset of OneCMDB will remove all instances (e.g from discovery) and templates. At restart the system will import the default model again. To reset, follow this procedure:

  1. Stop OneCMDB, see Start or Stop
  2. Open a file browser and move to <onecmdb_install_dir>/data
  3. Remove the all files in the directory
  4. Start OneCMDB, see Start or Stop

Change model

You may exchange the CMDB model used in OneCMDB. Note that when exchanging the model, all data (instances) you have in the database will be lost (deleted)! Follow the following instructions to exchange the model:

  1. Stop OneCMDB, see Start or Stop
  2. Open a file browser and move to <onecmdb_install_dir>/data
  3. Remove all files in the directory
  4. Replace the file <onecmdb_install_dir>/tomcat-5.5.17/webapps/ROOT/WEB-INF/classes/DefaultModel.xml with a new model file.
  5. Start OneCMDB, see Start or Stop
See Developer's manual 1.0.x for XML file schema.

Community and support