IBM Operations Analytics - Log Analysis, Version 1.3.2

pkg_mgmt.sh command

You can use the pkg_mgmt.sh command to install, upgrade, and uninstall an Insight Pack, list the artifacts in an Insight Pack, and deploy IBM® Tivoli® Monitoring Log File Agent configuration files that are contained in an Insight Pack.

Syntax

The pkg_mgmt.sh command is in the <HOME>/IBM/LogAnalysis/utilities directory and it has the following syntax:
 pkg_mgmt.sh    list | install | deploy | undeploy | upgrade | uninstall | install_logsample | uninstall_logsample

Parameters

The pkg_mgmt.sh command has the following parameters:

list
Use the list parameter to list the artifacts in an Insight Pack.
To list the contents of an Insight Pack, run the pkg_mgmt.sh command with these parameters:
<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh -list list_options insight_pack
-U username -P password
where insight_pack is the path to the Insight Pack for which you want to list the contents. The options for the list parameter are:
all
Lists all of the artifacts that are related to an Insight Pack
rulesets
Lists all of the Rule Sets related to an Insight Pack
filesets
Lists all of the File Sets related to an Insight Pack
sourcetypes
Lists all of the Source Types related to an Insight Pack
collections
Lists all of the Collections related to an Insight Pack
logsources
Lists all of the Data Sources related an Insight Pack
These additional parameters can be defined:
-U
(Optional) The user name for a user with administrative access rights. This parameter is only necessary if the default unityadmin password was changed.
-P
(Optional) The password for the user name that is specified by you. This parameter is only necessary if the default unityadmin password was changed.
To display a list of installed Insight Packs, run the command:
<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh -list
To display changes to an Insight Pack after installation, run the command:
<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh -diff insight_pack 
-U username -P password
where insight_pack is the path to the Insight Pack for which you want to list the differences.
These additional parameters can be defined:
-U
(Optional) The user name for a user with administrative access rights. This parameter is only necessary if the default unityadmin password changed.
-P
(Optional) The password for the user name that is specified by you. This parameter is only necessary if the default unityadmin password changed.
install
Use the install parameter to install an Insight Pack.
To install a downloaded Insight Pack, run the pkg_mgmt.sh command with these parameters:
<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh 
-install insight_pack.zip 
-U username -P password

where insight_pack is the path to the Insight Pack that you want to install.

These additional parameters are also defined:
-U
(Optional) The user name for a user with administrative access rights. This parameter is only necessary if the default unityadmin password changed.
-P
(Optional) The password for the user name that is specified by you. This parameter is only necessary if the default unityadmin password changed.
deploy
Use the deploy parameter to deploy IBM Tivoli Monitoring Log File Agent configuration files that are contained in an Insight Pack.
To deploy the IBM Tivoli Monitoring Log File Agent configurations files, run the pkg_mgmt.sh command with these parameters:
<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh 
-deploylfa insight_pack.zip
-f

where insight_pack is the path to the Insight Pack containing your configuration files.

This additional parameter is also defined:
-f
(Optional) This parameter removes all prompts. It is intended for advanced users who want to complete an installation that is similar to a silent installation.

A message is displayed that indicates that the IBM Tivoli Monitoring Log File Agent process is being stopped. Enter Y to continue. If you add the -f parameter to the command, the message is not displayed.

undeploy
Use the undeploy parameter to end any IBM Tivoli Monitoring Log File Agent configuration files that are already deployed for the Insight Pack.
To deploy the IBM Tivoli Monitoring Log File Agent configurations files, run the pkg_mgmt.sh command with these parameters:
<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh -undeploylfa insight_pack.zip

where insight_pack is the path to the Insight Pack containing your configuration files.

upgrade
Use the upgrade parameter to upgrade an Insight Pack that you previously installed.
To upgrade an Insight Pack, run the pkg_mgmt.sh command with these parameters:
<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh -upgrade insight_pack.zip
-U username -P password -f
where insight_pack is the path to the Insight Pack that you want to upgrade. These additional parameters are also defined:
-U
(Optional) The user name for a user with administrative access rights. This parameter is only necessary if the default unityadmin password changed.
-P
(Optional) The password for the user name that is specified by you. This parameter is only necessary if the default unityadmin password changed.
-f
(Optional) This parameter can also be used to install the Insight Pack, if it is not already installed.
(Optional) If the Insight Pack is not installed and you did not specify the -f parameter, a message is displayed indicating that the Insight Pack is not installed. If you want to proceed, enter Y.
uninstall
Use the uninstall parameter to remove an Insight Pack that you previously installed.
To remove an Insight Pack, run the pkg_mgmt.sh command with these parameters:
<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh -uninstall insight_pack
-U username -P password -f
where insight_pack is the path to the Insight Pack that you want to remove. For example, <HOME>/IBM/LogAnalysis/logsources/DB2InsightPack.
These additional parameters are also defined:
-U
(Optional) The user name for a user with administrative access rights. This parameter is only necessary if the default unityadmin password changed.
-P
(Optional) The password for the user name that is specified by you. This parameter is only necessary if the default unityadmin password changed.
-f
(Optional) You can automatically remove any artifacts that were created using artifacts that are contained in the Insight Pack. If you add this parameter, you are not warned before the removal of these artifacts.
A message is displayed listing artifacts that you created using the items in the Insight Pack. This message indicates that these items are being removed. Specify Y and allow the removal to complete. If you add the -f parameter to the command, the message is not displayed.
install_logsample
Use the install_logsample parameter to install Log Samples.
To install a Log Sample, run the pkg_mgmt.sh command with these parameters:
<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh -install_logsample insight_pack
-U username -P password -f
where insight_pack is the path to the Insight Pack for the Log Sample you want to install. For example, <HOME>/IBM/LogAnalysis/logsources/DB2InsightPack.
Note: Log Samples are not provided with all Insight Packs.
These additional parameters are also defined:
-U
(Optional) The user name for a user with administrative access rights. This parameter is only necessary if the default unityadmin password changed.
-P
(Optional) The password for the user name that is specified by you. This parameter is only necessary if the default unityadmin password changed.
-f
(Optional) You can automatically remove any artifacts that were created using artifacts that are contained in the Insight Pack. If you add this parameter, you are not warned before the removal of these artifacts.
uninstall_logsample
Use the uninstall_logsample parameter to uninstall Log Samples.
To uninstall a Log Sample, run the pkg_mgmt.sh command with these parameters:
<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh -uninstall_logsample insight_pack
-U username -P password -f
where insight_pack is the path to the Insight Pack for the Log Sample that you want to remove. For example, <HOME>/IBM/LogAnalysis/logsources/DB2InsightPack.
Note: Log Samples are not provided with all Insight Packs.
These additional parameters are also defined:
-U
(Optional) The user name for a user with administrative access rights. This parameter is only necessary if the default unityadmin password changed.
-P
(Optional) The password for the user name that is specified by you. This parameter is only necessary if the default unityadmin password changed.
-f
(Optional) You can automatically remove any artifacts that were created using artifacts that are contained in the Insight Pack. If you add this parameter, you are not warned before the removal of these artifacts.
Parent topic: Extending reference

Feedback