Skip Headers
Oracle® Key Manager 3 Administration Guide
Release 3.0
E41579-02
  Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
 
Next
Next
 

3 Using the OKM Manager

This chapter describes the OKM Manager and explains procedures for:

The chapter also provides a brief description of the menus and panes.

What is the OKM Manager?

The OKM Manager is an application that serves as a client to the KMA. It can be used to configure, control, and monitor the KMA. Depending on the assigned user roles, users can perform different operations.

Installing the OKM Manager Software

To download the installer for the OKM Manager software:

  1. Log in to the My Oracle Support (MOS) website at the following location:

    https://support.oracle.com/

  2. Open the Patches & Updates tab (near the top of the window).

  3. In the Patch Search pane, with the Search tab open, click Product or Family(Advanced).

  4. Select the box for Include all products in a family.

  5. In the Product field, type OKM or key and select Oracle Key Manager (OKM) from the pull-down list.

  6. In the Release field drop-down, select Oracle Key Manager (OKM) 3.0.

  7. Close the Release drop-down window and click the Search button.

Starting the OKM Installation

Important – Uninstall any previous OKM Manager version before installing the new OKM Manager. Install and use the OKM 3.0 Oracle Key Manager GUI before connecting to an OKM 3.0 KMA. Do not use an OKM 2.5.x GUI to connect to an OKM 3.0 KMA.

  1. Depending on whether you are running a Windows or Solaris system, select the applicable process to invoke the installer program.

    • For Windows, double-click the shortcut to start the installer program.

    • For Solaris,

    1. Set your DISPLAY environment to identify the system to which this installer should be displayed.

      • If you start the installer program on the local Solaris system, set your DISPLAY environment variable to ”:0.0.”

      • Navigate to the directory where you downloaded the installer.

    2. Invoke the installer.

      For example, if you downloaded the installer to the /tmp directory, and you plan to invoke it on your local Solaris system, you start the installer by entering the following commands at a shell prompt:

      DISPLAY=:0.0
      export DISPLAY
      cd /tmp
      ls install.bin
      sh ./install.bin 
      

      Note:

      If you invoke the installer on one Solaris system and want it to be displayed on another Solaris system, set your DISPLAY environment variable to identify the system on which it should be displayed.

      On the display system, first run the xhost(1) utility to allow access from the system from which you invoke the installer.

      For example, on the system (named ”hosta”) where you wish to display the installer, enter:


      xhost +
      

      On the system where you start the installer, enter:

      ping hosta
      DISPLAY=hosta:0.0 
      export DISPLAY 
      cd /tmp 
      ls install.bin 
      sh ./install.bin
      

      The Introduction window is displayed. The following screen examples are for a Windows system.

      Surrounding text describes install_intro1.jpg.
  2. Select Next.

  3. The Elevated Privileges window is displayed, telling you that you need elevated privileges to complete the installation. This screen does not appear on the Solaris installer.

    Surrounding text describes install_elev_privs2.jpg.
  4. The Choose Install Folder window is displayed.

    Surrounding text describes install_folder3.jpg.
  5. To select the default folder, select Next, or supply your own installation folder, and select Next.

  6. The Choose Shortcut Folder window is displayed, allowing you to create the product icons where you desire.

    Surrounding text describes install_shortcut_folder4.jpg.
  7. Select Next after you make your choice.

  8. The Pre-Installation summary screen is displayed.

    Surrounding text describes install_pre_inst5.jpg.
  9. Select Install to install the OKM Manager, or select Previous to revise your setup.

    Surrounding text describes installer_installing1.jpg.
  10. The installation process is now complete. Select Done to exit.

    Surrounding text describes install_complete6.jpg.

Invoking the OKM Manager

Two methods can be used to invoke the OKM Manager, depending on your environment:

  • Startup with Windows

  • Startup with Solaris.

Starting the OKM Manager with Windows

If you instructed the installation program to create a shortcut, double-click it to launch the OKM Manager application.

Surrounding text describes kms_mgr_icon.jpg.

Otherwise, launch Windows Explorer, navigate to where you installed the OKM Manager, and invoke OKM_Manager.exe.

Starting the OKM Manager with Solaris

As with Windows, you can direct the installation program to create a shortcut. For example, if you create the shortcut in your home directory, you can invoke it at a shell prompt by entering:

~/OKM_Manager

Alternatively, you can navigate to where you installed the OKM Manager and invoke it by entering:

./OKM_Manager

OKM Manager GUI Overview

The OKM Manager GUI is shown below with a sample menu.

Surrounding text describes main1.jpg.

The OKM Manager GUI contains a System menu, View menu, and Help menu. Click the appropriate action bar item to display a menu and then select a menu item.

Toolbar buttons provide shortcuts to several menu options.

System Menu

Surrounding text describes system_menu1.jpg.

System Menu Options

  • Connect: Displays the Connect to Cluster dialog box that allows you to connect to a pre-existing Cluster using a Profile or to create a new Cluster profile.

  • Disconnect: Displays the Disconnect from KMA dialog box that disconnects you from the KMA.

  • Change Passphrase: Displays the Change passphrase dialog box that lets you modify the passphrase.

  • Save Certificates: Displays the Save Certificates dialog box that permits you to edit the CA Certificate and Client Certificate file names.

  • Options: Displays the Options dialog box that is used to specify various configuration settings.

  • Exit: Closes the OKM Manager GUI.

View Menu

Surrounding text describes view_menu1.jpg.

View Menu Options

  • Refresh: Refreshes the screen.

  • Save Report: Save Report allows you to download the contents of any List screen. to a text file on the system where the OKM Manager is running.

  • Select All: Select All selects all items on a List screen.

  • Sort By: Sorts a list of items on a List screen. This is equivalent to clicking on column headings in a list.

Help Menu

Surrounding text describes help_menu1.jpg.

Help Menu Options

  • OKM Manager Help: Displays the online help index and table of contents for OKM Manager.

  • About OKM Manager: Displays the version and copyright information about OKM Manager. Click the Close button to close this dialog box.

Surrounding text describes aboutdialog.jpg.

Toolbar Buttons

The table below describes the Toolbar buttons on the OKM.

Button Description
Connect Displays the Connect to KMA dialog box that allows you to connect to a KMA by selecting a profile.
Disconnect Displays the Disconnect from KMA dialog box that allows you to disconnect from the KMA.
Help Displays the online help index and table of contents for OKM.

Shortcut Keys

Shortcut keys allows you to choose commands in a single step. The following shortcut keys are used:

Description Shortcut Keys
Cuts the current selection Ctrl+X
Copies the current selection Ctrl+C
Copies the contents from the Clipboard to the current selection point Ctrl+V
Brings up a dialog box to save a report to a local site Ctrl+S

Menu Accelerator Keys

Menu accelerator keys are supported for all menu items. Hold down the ”Alt” key to display the accelerator keys.

Using Online Help

You can use online help for complete information about the OKM. Online help is easy to use. You are able to view topics in various ways. You can:

  • Browse a table of contents

  • Search for keywords

  • Use an index

  • Navigate backward

  • Print topics.

OKM Manager GUI Panes

The OKM Manager GUI includes three panes:

  • OKM Management Operations Tree

  • OKM Management Operation Details

  • Session Audit Log.

OKM Management Operations Tree Pane

The OKM Management Operations Tree pane, located on the left-side of the screen, displays all operational functions of the OKM. Depending on your assigned role(s), the options on this tree pane differ. The example below shows the operations that a Security Officer can perform.

Surrounding text describes op_tree_pane.jpg.

OKM Management Operation Details Pane

When an operation is selected, the OKM Manager Operation Details pane, to the right of the Operations Tree Pane, displays the required components for the selected operations. You can apply filters on the items that are displayed in list panels. The example below shows the User List, when the User List menu option was selected from the System Management menu in the Operations Tree pane.

Surrounding text describes op_details_pane1.jpg.

Session Audit Log Pane

The Session Audit Log pane, below the Operations Tree Pane and the Operations Details Pane, provides a scrollable list of the most recent session events.

Surrounding text describes session_audit_log_pane1.jpg.

Status Bar

The Status Bar, at the bottom of the screen, is comprised of the following fields:

  • User Name: Displays the user name of the currently logged-in user. In the screen below, the Security Officer (SO) is logged in.

  • Connection Status: Displays the state of the current connection, that is, Connected

  • KMA IP Address: Displays the Management Network IP address and Name of the target KMA.

If there is no connection to the KMA, the Status fields are blank.

Surrounding text describes status_bar1.jpg.

Panels

The are common panel components in the OKM Manager screens. These are described below:

Title

Displays the title of the screen.

Filter

Allow you to filter the database by specific keys. It contains the following components:

Table label: Specifies the table to which the filtering applies

Filter Attribute combo box: Indicates the fields to filter

Filter Operator 1 combo box: Provides the filter operators that are applied to Filter Value 1. The filter operations are:

  • Equals =

  • Not equal <>

  • Greater than >

  • Less than <

  • Greater than or equals >=

  • Less than or equals <=

  • Starts with ~

  • Empty

  • Not Empty

Filter Value 1 control: Used as a single value or the starting value of the filter key range

Filter Value 2 control: Used as a single value or the ending value of the filter key range

Use button: Applies the filter to the displayed list.

Refresh:

Click this button to refresh the displayed list. This does not apply filters selected since the last Use or Reset, and does not change the page of the list.

Reset:

Click this button to remove all filters and reset the displayed list to the first page.

Click this button to go to the first page of the list.

Surrounding text describes okm_first_page.jpg.

Click this button to go to the previous page.

Surrounding text describes okm_prev_page.jpg.

Click this button to go to the next page.

Surrounding text describes okm_next_page.jpg.

Results in Page:

Displays the number of items that can be displayed on the current page. Appends ”(last page)” if you are at the end of the list. The maximum number of items displayed on a page is defined by the Query Page Size value on the Options dialog.


Note:

If the number of records output is greater than the Query Page Size, multiple pages are displayed. Click the buttons below the filters to move between pages.

Sorting:

Click a column heading to sort the list by that field. If the output requires multiple pages, the complete set of results is sorted, then the corresponding page is returned.

Message

Displays messages that are related to database queries. It works in conjunction with the Database View list. It contains the following components:

  • Static text label: Displays error messages, such as:

    Result limit exceeded. 10,000 results returned. Use a filter to reduce the filter size.
    

Uninstalling the OKM Manager Software

Two options are available to begin to uninstall the OKM software:

  • Navigate to the directory where the uninstall program resides and launch the executable file from there

  • For Windows users only, launch the Add or Remove Programs process

In both cases, the Preparing Setup window is displayed after you finish these procedures. See "Completing the Uninstall Process".

Invoking the Executable File

To uninstall the OKM Manager software:

  1. Navigate to the ”Uninstall_Oracle_ Key_Manager” directory, which resides under the directory where the OKM Manager was installed.

  2. Invoke the ”Uninstall_Oracle_Key_Manager.exe” (Windows) or ”Uninstall_Oracle_Key_Manager” (Solaris) executable to launch the uninstall process.

  3. The Preparing Setup window is displayed, while the install/uninstall program prepares for the uninstall process.

Invoking Add/Remove Programs (Windows Only)

  1. Click Start, select Settings, Control Panel, double-click Add or Remove Programs. The Add or Remove Programs window is displayed. Scroll down the list (if the software is not visible), select Sun KMS Manager, then click the Change/Remove button.

  2. The Preparing Setup window is displayed, while the install/uninstall program prepares for the uninstall process.

Completing the Uninstall Process

The OKM uninstall dialog box is displayed, prompting you to confirm that you want to remove the selected application and all its features.

Surrounding text describes guiuninstall.jpg.
  1. Click the Next button to continue or click the Cancel button to stop the process and return to the Add or Remove Program window (Windows) or shell prompt (Solaris).


    Note:

    Your connection profiles will not be removed.

  2. When the uninstall process is completed, the Uninstall Complete window is displayed. Click the Finish button to close this window. Close this window to return to the Add or Remove Program window (Windows) or shell prompt (Solaris).