BMC - TrueSight Capacity Optimization Gateway VIS files parser
Use the BMC - TrueSight Capacity Optimization Gateway VIS files parser to collect performance and configuration data from a Gateway Server instance and transfer it to the BMC Helix Continuous Optimization database. You can also use this parser to collect recovery data from a Gateway VIS files parser server instance.
Note
The BMC - TrueSight Capacity Optimization Gateway VIS files parser is available out-of-the-box. However, you can also create this ETL from the Gateway Manager automatically. To do this, select the Auto create ETLs to populate data from this gateway server option when you add a Gateway Server. For more information, see Adding, removing, and inspecting Gateway Server details.
Collecting data by using the BMC - TrueSight Capacity Optimization Gateway VIS files parser ETL
To collect data by using the BMC - TrueSight Capacity Optimization Gateway VIS files parser ETL, do the following tasks:
I. Complete the preconfiguration tasks.
II. Configure the ETL.
III. Run the ETL.
Depending on the option you select while configuring the ETL, ensure that the following requirements are met:
- For the gateway service option, ensure that the Gateway Server is up and running.
- For the file option, ensure that you have a VIS file.
You must configure the ETL to connect to Gateway Server for data collection. ETL configuration includes specifying the basic and optional advanced properties. While configuring the basic properties is sufficient, you can optionally configure the advanced properties for additional customization.
A. Configuring the basic properties
Some basic properties display default values. You can modify these values when required.
To configure the basic properties:
- Navigate to Administration > ETL & System Tasks, and select ETL tasks.
- On the ETL tasks page, click Add > Add ETL under the Last run tab. The Add ETL page displays the configuration properties. You must configure properties in the following tabs: Run configuration, Entity catalog, and VIS file parser configuration.
- On the Run configuration tab, complete these steps:
- From the ETL module list, select BMC - TrueSight Capacity Optimization Gateway VIS files parser. The name of the ETL is displayed in the ETL task name field. You can edit this field to customize the name.
- From the platform list, select the required platform. When you select a platform, the Object relationships tab is displayed.
- The Import HMC data option is displayed only when you select AIX Power VM/WPAR platform. The default selection for importing HMC data is yes.
- Select the type of data that you want to collect. The performance data is always selected. Depending on the selected data types, specific metrics of the associated data set are included.
Click the Entity catalog tab, and select one of the following options:
Shared Entity Catalog: Select if the other ETLs access the same entities that are used by this ETL.
- From the Sharing with Entity Catalog list, select an entity catalog name that is shared between ETLs.
- Private Entity Catalog: Select if you want to use this ETL independently.
Click the Vis file parser configuration tab, and configure the following properties:
Depending on how you want to configure this ETL, select one of the following options to extract data:
- via gateway service: Extract data by using the gateway service. This is the default selection.
- Gateway Server: Select a Gateway Server from the list. All gateway servers configured in the Administration > Gateway Manager are displayed in the list.
- Manager run list: Specify the manager run from the Available manager runs list. You can specify multiple manager runs and separate them by a semicolon. For example,
vcenter.msf; Test.msf; vcenter5.1.msf; Test1.msf.
- Available manager runs: Displays the list of available manager runs for the selected Gateway Server.
via file: Extract data by using the CSV file. When you select this option, the File location tab is displayed.
- via gateway service: Extract data by using the gateway service. This is the default selection.
Click the File location tab. Depending on the file location, select one of the following methods to retrieve the CSV file and configure the properties.
Property Description Directory Path of the directory that contains the CSV file. File list pattern A regular expression that defines which data files the ETL must read. The default value is (?$<$!done)\$
, which indicates that the ETL must read all the files except the files whose name ends with the string "done". For example,my_file_source.done
.Recurse into subdirs? Select Yes to inspect the subdirectories of the target directories. After parse operation Select one of the following options to be performed on the imported CSV file:- Do nothing: Do nothing after import.
- Append suffix to parsed file: Append a specified suffix to the imported CSV file. For example,
_done
or_imported
. - Archive parsed file in directory: Archive the parsed file in the specified directory. The default directory is
%BASE/../repository/imprepository
. Also, specify whether you want to compress archived parsed files. - Archive bad files in directory: Archive erroneous files in the specified directory. The default directory is
%BASE/../repository/imprepository
. Also, specify whether you want to compress archived bad files.
Note
You can configure automatic cleaning of parsed files using the Filesystem cleaner task. For more information, see Configuring the FileSystem Cleaner task.
Property Description Network Share Path Path of the shared folder. For example, //hostname/sharedfolder. Subdirectory (Optional) Specify a subdirectory within a mount point. File list pattern A regular expression that defines which data files the ETL must read. The default value is (?$<$!done)\$
, which indicates that the ETL must read all the files except the files whose name ends with the string "done". For example,my_file_source.done
.Recurse into subdirs? Select Yes to inspect the subdirectories of the target directories. After parse operation Depending on what to do after the CSV file is imported, select one of the following options:- Do nothing: Do nothing after import.
- Append suffix to parsed file: Append a specified suffix to the imported CSV file. For example,
_done
or_imported
. - Archive parsed file in directory: Archive the parsed file in the specified directory. The default directory is
%BASE/../repository/imprepository
. Also, specify whether you want to compress archived parsed files. - Archive bad files in directory: Archive erroneous files in the specified directory. The default directory is
%BASE/../repository/imprepository
. Also, specify whether you want to compress archived bad files.
Note
You can configure automatic cleaning of parsed files using the Filesystem cleaner task. For more information, see Configuring the FileSystem Cleaner task.
Username Enter the user name to connect to the file location server. Password required Select Yes or No. Password Enter the password to connect to the file location server. Applicable if you selected Yes for Password required. Property Description Directory Path of the directory that contains the CSV file. File list pattern A regular expression that defines which data files the ETL must read. The default value is (?$<$!done)\$
, which indicates that the ETL must read all the files except the files whose name ends with the string "done". For example,my_file_source.done
.Recurse into subdirs? Select Yes to inspect the subdirectories of the target directories. After parse operation Depending on what to do after the CSV file is imported, select one of the following options:- Do nothing: Do nothing after import.
- Append suffix to parsed file: Append a specified suffix to the imported CSV file. For example,
_done
or_imported
. - Archive parsed file in directory: Archive the parsed file in the specified directory. The default directory is
%BASE/../repository/imprepository
. Also, specify whether you want to compress archived parsed files. - Archive bad files in directory: Archive erroneous files in the specified directory. The default directory is
%BASE/../repository/imprepository
. Also, specify whether you want to compress archived bad files.
Note
You can configure automatic cleaning of parsed files using the Filesystem cleaner task. For more information, see Configuring the FileSystem Cleaner task.
Remote host Enter the host name or IP address of the remote host to connect to. Username Enter the user name to connect to the file location server. Password required Select Yes or No. Password Enter the password to connect to the file location server. Applicable if you selected Yes for Password required. Property Description Directory Path of the directory that contains the CSV file. Files to copy (with wildcards) Specify the files that you want to copy to the database. File list pattern A regular expression that defines which data files the ETL must read. The default value is (?$<$!done)\$
, which indicates that the ETL must read all the files except the files whose name ends with the string "done". For example,my_file_source.done
.Recurse into subdirs? Select Yes to inspect the subdirectories of the target directories. After parse operation Depending on what to do after the CSV file is imported, select one of the following options:- Do nothing: Do nothing after import.
- Append suffix to parsed file: Append a specified suffix to the imported CSV file. For example,
_done
or_imported
. - Archive parsed file in directory: Archive the parsed file in the specified directory. The default directory is
%BASE/../repository/imprepository
. Also, specify whether you want to compress archived parsed files. - Archive bad files in directory: Archive erroneous files in the specified directory. The default directory is
%BASE/../repository/imprepository
. Also, specify whether you want to compress archived bad files.
Note
You can configure automatic cleaning of parsed files using the Filesystem cleaner task. For more information, see Configuring the FileSystem Cleaner task.
Remote host Enter the name or IP address of the remote host to connect to. Username Enter the user name to connect to the file location server. Password required Select Yes or No. Password Enter the password to connect to the file location server. Applicable if you selected Yes for Password required. Property Description Directory Path of the directory that contains the CSV file. File list pattern A regular expression that defines which data files the ETL must read. The default value is (?$<$!done)\$
, which indicates that the ETL must read all the files except the files whose name ends with the string "done". For example,my_file_source.done
.Recurse into subdirs? Select Yes to inspect the subdirectories of the target directories. After parse operation Depending on what to do after the CSV file is imported, select one of the following options:- Do nothing: Do nothing after import.
- Append suffix to parsed file: Append a specified suffix to the imported CSV file. For example,
_done
or_imported
. - Archive parsed file in directory: Archive the parsed file in the specified directory. The default directory is
%BASE/../repository/imprepository
. Also, specify whether you want to compress archived parsed files. - Archive bad files in directory: Archive erroneous files in the specified directory. The default directory is
%BASE/../repository/imprepository
. Also, specify whether you want to compress archived bad files.
Note
You can configure automatic cleaning of parsed files using the Filesystem cleaner task. For more information, see Configuring the FileSystem Cleaner task.
Remote host Enter the host name or IP address of the remote host to connect to. Username Enter the user name to connect to the file location server. Password required Select Yes or No. Password Enter the password to connect to the file location server. Applicable if you selected Yes for Password required. (Optional) Override the default values of properties in the following tabs:
- Click Save.
The ETL tasks page shows the details of the newly configured BMC - TrueSight Capacity Optimization Gateway VIS files parser ETL.
(Optional) B. Configuring the advanced properties
You can configure the advanced properties to change the way the ETL works.
To configure the advanced properties:
- On the Add ETL page, click Advanced.
Configure the following properties:
Click Save.
The ETL tasks page shows the details of the newly configured BMC - TrueSight Capacity Optimization Gateway VIS files parser ETL.
After you configure the ETL, you can run it to collect data. You can run the ETL in the following modes:
A. Simulation mode: Only validates connection to the data source, does not collect data. Use this mode when you want to run the ETL for the first time or after you make any changes to the ETL configuration.
B. Production mode: Collects data from the data source.
A. To run the ETL in the simulation mode
To run the ETL in the simulation mode:
- Navigate to Administration > ETL & System Tasks, and select ETL tasks.
- On the ETL tasks page, click the ETL. The ETL details are displayed.
- In the Run configurations table, click Edit to modify the ETL configuration settings.
- On the Run configuration tab, ensure that the Execute in simulation mode option is set to Yes, and click Save.
- Click Run active configuration. A confirmation message about the ETL run job submission is displayed.
- On the ETL tasks page, check the ETL run status in the Last exit column.
OK Indicates that the ETL ran without any error. You are ready to run the ETL in the production mode. - If the ETL run status is Warning, Error, or Failed:
- On the ETL tasks page, clickin the last column of the ETL name row.
- Check the log and reconfigure the ETL if required.
- Run the ETL again.
- Repeat these steps until the ETL run status changes to OK.
B. To run the ETL in the production mode
You can run the ETL manually when required or schedule it to run at a specified time.
To run the ETL manually
- On the ETL tasks page, click the ETL. The ETL details are displayed.
- In the Run configurations table, click Edit to modify the ETL configuration settings. The Edit run configuration page is displayed.
- On the Run configuration tab, select No for the Execute in simulation mode option, and click Save.
- To run the ETL immediately, click Run active configuration. A confirmation message about the ETL run job submission is displayed.
When the ETL runs, it collects data from the source and transfers it to the BMC Helix Continuous Optimization database.
To schedule the ETL run in the production mode
By default, the ETL is scheduled to run daily. You can customize this schedule by changing the frequency and period of running the ETL.
To configure the ETL run schedule:
- On the ETL tasks page, click the ETL, and click Edit task. The ETL details are displayed.
On the Edit task page, do the following, and click Save:
- Specify a unique name and description for the ETL task.
- In the Maximum execution time before warning field, specify the duration for which the ETL must run before generating warnings or alerts, if any.
- Select a predefined or custom frequency for starting the ETL run. The default selection is Predefined.
- Select the task group and the scheduler to which you want to assign the ETL task.
Click Schedule. A message confirming the scheduling job submission is displayed.
When the ETL runs as scheduled, it collects data from the source and transfers it to the BMC Helix Continuous Optimization database.
Verify that the ETL ran successfully and check whether the BMC - TrueSight Capacity Optimization Gateway VIS files parser is refreshed in the Workspace.
To verify whether the ETL ran successfully
- Click Administration > ETL and System Tasks > ETL tasks.
- In the Last exec time column corresponding to the ETL name, verify that the current date and time are displayed.
- In the Last exit column corresponding to the ETL name, verify that the status is OK.
In case of WARNING or ERROR, click in the last column of the ETL name row to review the log files.
To verify that the BMC - TrueSight Capacity Optimization Gateway VIS files parser data is refreshed:
- In the Workspace tab, expand BMC -TrueSight Capacity Optimization Gateway VIS file parser > Systems.
- In the left pane, verify that the hierarchy displays the required instances.
- Click any of the instances, and click the Metrics tab in the right pane.
- Check if the Last Activity column in the Configuration data and Performance metrics tables displays the current date.
The following image shows sample metrics data. To learn more about these metrics and other related concepts, see Entity relationship, metrics and lookup information for BMC - TrueSight Capacity Optimization Gateway VIS files parser.
Comments
Log in or register to comment.