NSM service
designers use
the NSM command line interface (CLI) tool to create, update, and maintain NSM service
templates and
also to remove failed NSM service entries which are no longer required.
The tool includes a command-line interface to run commands with specified
input options.
Running the CLI tool
You can execute the NSM CLI by running the /opt/IBM/tivoli/netcool/ncm/bin/nsm/nsmadmin.sh
shell script with specific input options on the Netcool Configuration Manager presentation server where NSM is installed.
CLI commands and options
By using the NSM CLI, NSM service designers can run the following commands with specific input options on NSM service templates and NSM services.
clone command
The NSM service designer can run the clone
command from the NSM CLI to copy the latest enabled version of an existing NSM service template to an XML file. Designers can use this XML file to design a new NSM service template .
create command
The NSM service designer can run the create
command from the NSM CLI to create a NSM service template .
delete command
The NSM service designer can run the delete
command from the NSM CLI to delete the latest enabled version of a NSM service template .
disable command
The NSM service designer can run the disable
command from the NSM CLI to disable the latest enabled version of an existing NSM service template .
disableall command
The NSM service designer can run the disableall
command from the NSM CLI to disable all versions of an of an existing NSM service template .
exportall command
The NSM service designer can run the exportall
command from the NSM CLI to export all enabled latest version NSM service template details to an XML file.
exportdate command
The NSM service designer can run the exportdate
command from the NSM CLI to export the latest enabled version NSM service templates to an XML file, where the create date is since the start date parameter.
exportdaterange command
The NSM service designer can run the exportdaterange
command from the NSM CLI to export the latest enabled version NSM service templates to an XML file, where the create date is between the start and end date parameters.
exportid command
The NSM service designer can run the exportid
command from the NSM CLI to export the latest enabled version NSM service template matching the serviceTemplateId parameter to an XML file.
exportname command
The NSM service designer can run the exportname
command from the NSM CLI to export the latest enabled version NSM service templates matching the name parameter to an XML file.
exportvendor command
The NSM service designer can run the exportvendor
command from the NSM CLI to export the latest enabled version NSM service templates matching the vendor parameter to an XML file.
getversion command
The NSM service designer can run the getversion
command from the NSM CLI to retrieve information about a version of a NSM service template and output this information to an XML file.
import command
The NSM service designer can run the import
command from the NSM CLI to import a single NSM service template by using information from an XML file.
importlist command
The NSM service designer can run the importlist
command from the NSM CLI to import a number of NSM service templates by using information from an XML file.
list command
The NSM service designer can run the list
command from the NSM CLI to list the latest enabled versions of all NSM service templates in an XML file. The information returned contains only the NSM service template summary and does not contain detailed information on the template. If a full NSM service template is required then use the read
or readall
command
purge command
The NSM service designer can run the purge
command from the NSM CLI to delete all versions of a NSM service template .
read command
The NSM service designer can run the read
command from the NSM CLI to retrieve information about the latest enabled version of a NSM service template and output this information to an XML file.
readall command
The NSM service designer can run the readall
command from the NSM CLI to retrieve information about all versions of a NSM service template and output this information to an XML file.
update command
The NSM service designer can run the update
command from the NSM CLI to creates a new version of a NSM service template by updating the information in an existing NSM service template . The update information is retrieved from an XML file.
removeserviceinstance command
The NSM service designer can run the removeserviceinstance
command from the NSM CLI to remove the database entry for an NSM service that reached any of the following states: 'Failed', 'Failed to Delete', or 'Failed with indeterminate state'.
removeserviceinstances command
The NSM service designer can run the removeserviceinstance
command from the NSM CLI to remove old service instances.
NSM command-line logging
You can configure logging for the NSM CLI tool in the /opt/IBM/tivoli/netcool/ncm/bin/nsm/commons-logging.properties
file. This configuration file controls the output to the log file and the console. You can also set the logging level and other logging options.