importcollector CLI command

Use this command to import data collectors from a .csv file into the product.

If the .csv file you want to use is generated by using the exportcollector CLI command CLI command and this file contains the Collecting data by using an SSH connection and Monitor file over Windows Share data collectors, then before you run this command, ensure that you edit the .csv file and replace the existing password with the actual password for connecting with the target host from which you want to collect the data. You cannot use this command to import the Upload File type of data collector. 

Note

  • When you import data collectors from a .csv file of the product from a version lower than the 11.3.01 version, the data collectors get associated with index blocks. So, if the .csv file contains a data retention value, it gets assigned to the nearest largest custom or default index block.
  • If a .csv file contains a reference to an index block, and an index block with that internal name is not present, the data collectors get assigned to the Small index block.
  • If a .csv file does not contain a data retention value or an index block, all the data collectors with non-metrics data patterns get assigned to the Small index block and all data collectors with metrics data patterns get assigned to the METRICS index block.
  • If a .csv file contains an invalid index block, the data collectors get assigned to the Small index block.

Recommendation

BMC recommends that you maintain the same configuration of index blocks when you import data collectors across multiple setups.


To understand the syntax and examples, see:

Syntax

Note

Before you run the command, note the following points:

importcollector -u <userName> [-s] -w <password> -d <hostName> -p <port> -f <absoluteCsvFilePath> [-l <locale>]

  • 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
-d
Host name of the Console Server.
-f

Absolute file path of the CSV file that you want to import

-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 input

The following example provides the input for importing a data collector:

importcollector -u admin -w admin12345 -d localhost -p 9797 -f C:\Logins.csv


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

Comments