deletecomponents CLI command

Use this command to delete duplicate instances of components that are displayed on the Administration > Components tab. You can also use this command to delete instances of components that are uninstalled or removed from the deployment.

For example, if you perform a custom installation of the Collection Station on a computer and then you uninstall it and later reinstall it on the same computer, the Administration > Components page displays a duplicate entry for the Collection Station with the status green. In this scenario, you can run this command to delete the duplicate entry of the Collection Station.

This command works for all components except the indexers which are in use.The command only removes the component from the database; it does not uninstall the component. So if you restart the service for the TrueSight IT Data Analytics Server, the deleted component is again visible on the product UI. When you run this command, only one component can be deleted with each CLI execution.

To understand the syntax and examples, see:

Syntax

Note

Before you run the command, note the following points:

deletecomponents -t <Identifier-Type> -n <Identifier> -d <hostName> -p <portNumber> -u <userName> -w <password> [-l <locale>] [-s]

  • Angle brackets (< >) indicate a variable value that needs to be user defined.

  • Square brackets ([ ]) indicate optional parameters.

The following table describes the parameters used in the syntax:

ParameterDescription
-t

Identifier type used for selecting component types to delete.

The identifier can be one of the following:

  • NAME
  • TYPE

Examples:

  • -t NAME
  • -t TYPE
-n

Identifier used as a criterion to delete components.

The identifier can be either the component name or type as displayed in the Name or Type columns on the Administration > Components tab, as follows:

  • -n <Component-Name>
  • -n <Component-Type>

Example:

  • -n COLLECTION_STATION-clm-18.bmc.com-8080
  • -n COLLECTION_STATION

Note: If you specify the component type only, then the component with the same type is deleted. For example, -n INDEXER.

-d
Host name of the Console Server.
-p
Port number of the Console Server.
-u
User name to use to connect with the Console Server.
-w
Password corresponding to the user name to use to connect with the Console Server.
-l

(Optional) Indicates the locale in which you want to display messages when the command is run.

You can set one of the following locales:

  • English
  • Simplified Chinese
  • German
  • French

By default, the messages are displayed in the locale of the system on which the CLI is run.

The value can be set to one of the following depending on the locale you choose:

  • English: en
  • Simplified Chinese: chs
  • German: de
  • French: fr

Example: If you want to set the locale as Simplified Chinese, you need to specify, l=chs.

-s
(Optional) Indicates an HTTPS connection.

Example inputs

The following example provides the input for deleting an instances of the Indexer component:

deleteComponents -t TYPE -n INDEXER –d localhost –p 9797 –u admin –w admin12345

The following example provides the input for deleting the specified component name:

deleteComponents -t NAME -n COLLECTION_STATION-clm-005518.bmc.com-8080 –d localhost –p 9797 –u admin –w admin12345

only one component can be deleted with each CLI execution

Was this page helpful? Yes No Submitting... Thank you

Comments