BMC TrueSight Capacity Management supports integration with BMC TrueSight Operations Management 10.1 through the BMC - TrueSight Operations Management 10.1 extractor.
This topic contains the following sections:
BMC - TrueSight Operations Management 10.1 extractor is a Java-based extractor that uses REST APIs to extract performance and configuration data from BMC TrueSight Operations Management. The extractor communicates with the Data Integration APIs of BMC TrueSight Operations Management. For more information, see Data Integration API calls to TrueSight Operations Management 10.1.
The extractor supports the following platforms:
If you want to extract data for any other platform, use the BMC - TrueSight Operations Management 10.1 Generic extractor.
If you are using BMC TrueSight Operations Management version 10.0 or earlier, use the BMC - TrueSight Operations Management 9.0/9.5/9.6/10.0 extractor.
To toggle full-screen mode for this topic (recommended), type f. To hide the navigation tree on the left, type [.
Integration of BMC TrueSight Capacity Optimization with BMC TrueSight Operations Management 10.1 supports the following platforms:
Supported Knowledge Modules (KMs) and BMC PATROL Agents:
|BMC TrueSight Capacity |
|PATROL Knowledge Module (KM)||BMC PATROL Agent Version|
|AIX||BMC PATROL for UNIX and Linux||9.11.20 and later||9.5.00 and later|
|KVM||BMC PATROL for UNIX and Linux||9.11.20 and later|
|BMC PATROL for Linux||1.1|
|Solaris||BMC PATROL for UNIX and Linux||9.11.20 and later|
|Standalone||BMC PATROL for Microsoft Windows Servers||4.7.00 and later|
|BMC PATROL for UNIX and Linux||9.11.20 and later|
|BMC PATROL for Linux||1.1|
For more information, see BMC TrueSight Operations Management.
This integration provides additional metrics and relationships that allow proper management of partitioned UNIX systems that are now supported in this version.
Specific versions of PATROL Agents, and Windows, UNIX, or Linux KMs are required to ensure that these additional metrics and relationships are collected and published to the BMC TrueSight Operations Management database.
In the Run configuration tab, under ETL module, select BMC - TrueSight Operations Management 10.1 extractor.
Specify values for the following properties under each expandable tab:
By default, the most common, basic properties that you can set for an ETL are displayed in the Add ETL page. You can accept these default selections.
|ETL task name||Accept the default name based on the selected ETL module or specify a different name for the ETL task. Duplicate names are allowed.|
|Run configuration name||Review the default name. This field is used to differentiate configurations that you can specify for the ETL task. You can then run the ETL task based on the configuration name.|
|Environment||Select Production or Test to mark the ETL tasks. For example, you can start by marking the task as Test and change it to Production after you have seen that you are getting what you wanted.|
|Description||(Optional) Enter a brief description for this ETL.|
|Log level||Select how detailed you want the ETL log to be. The log includes Error, Warning and Info type of log information.
Note: Log levels 5 and 10 are typically used for debugging or troubleshooting ETL issues. Using a log level of 5 is general practice; however, you may choose level 10 to get a high level of detail while troubleshooting.
|Execute in simulation mode||Select Yes if you want to validate the connectivity between the ETL engine and the target, and to ensure that the ETL does not have any other configuration issues.
When set to Yes, the ETL will not store actual data into the data warehouse. This option is useful while testing a new ETL task.
Ensure that the Based on datasource option is selected.
Note: If you select Based on Open ETL template, BMC TrueSight Capacity Optimization is integrated with a Generic extractor based on the selected Open ETL template. For more information, see Generic ETL based on a template.
Ensure that BMC - TrueSight Operations Management 10.1 extractor is selected.
Note: You selected this property in the earlier step.
|Module description||Review the short description of the ETL module.|
|Platform||Select any one of the following platforms:
|Sharing status||Select either of the following options:
|Associate new entities to||
Specify the domain where you want to add the entities created by the ETL. You can select an existing domain or create a new one.
Info: By default, a new domain is created for each ETL, with the same name as the extractor module. As the ETL is created, a new hierarchy rule with the same name as the ETL task is created automatically, with an active status. If you update the ETL specifying a different domain, the hierarchy rule will be updated automatically.
Select either of the following options:
TrueSight Operations Management Connection
|Data Integration API URL||
Specify the host name of the Presentation Server in the provided URL format: https://<host>/tsws. You must replace <host> with the host name.
|Username||Type the user name to connect to the Presentation Server. You can use the default user, apiuser.|
|Password||Type the password for the specified user name to connect to the Presentation Server. The password for the default user, apiuser, is displayed in encrypted format.|
|Tenant name||Specify the name of the tenant for which the data needs to be extracted. The tenants are configured on the Presentation Server. The default tenant BmcRealm is displayed.|
ETL task properties
|Task group||Select a task group into which you want to classify this ETL.|
|Running on scheduler||Select the scheduler on which you want to run the ETL.|
|Maximum execution time before warning||Select the number of hours, minutes, or days to to execute the ETL for before generating warnings, if any.|
|Frequency||Select the frequency of ETL execution. Available options are:
|Start timestamp: hour\minute (Applies to Predefined frequency)||Select the HH:MM start timestamp to add to the ETL execution that is running on a Predefined frequency.|
|Custom start timestamp||Select a YYYY-MM-DD HH:MM timestamp to add to the ETL execution that is running on a Custom frequency.|
To view or configure advanced properties, click Advanced. You do not need to set or modify these properties unless you want to change the way the ETL works. These properties are for advanced users and scenarios only.
Select or clear metric groups for which data will be populated in the Available datasets. The connector allows you to choose only from the given list of datasets, and you cannot include additional datasets to the run configuration of the ETL.
|Metric profile selection||
Select either of the following options:
For more information, see Metric profiles.
|Levels up to||
Define the amount of metric imported into the data warehouse. Increase the level to add load to the data warehouse or decrease the metric level to reduce the number of imported metrics.
Choose the metric level to apply on selected metrics:
For more information, see Aging Class mapping.
|List of properties||
Specify any additional properties for this ETL that act as user inputs during execution. You can specify values for these properties either at this time or from the "You can manually edit ETL properties from this page" link that is displayed for the ETL in view mode.
|Empty dataset behavior||Select one of the following actions to take if the loader encounters an empty dataset:
|ETL log file name||Type or verify the name of the file that contains the ETL execution log; the default value is:
|Maximum number of rows for CSV output||Select a number which limits the size of the output files.|
|CSV loader output file name||Type or verify the name of the file generated by the CSV loader; the default value is:
|Capacity Optimization loader output file name||Type or verify the name of the file generated by the BMC TrueSight Capacity Optimization loader; the default value is:
|Detail mode||Select the level of detail:
|Reduce priority||Select one of the following priorities:
|Remove domain suffix from datasource name||(Only for systems) Set to True to remove the domain name from the data source name. For example,
|Leave domain suffix to system name||(Only for systems) Set to True to retain the domain name in the system name. For example:
|Update grouping object definition||Set to True to allow the ETL to update the grouping object definition for a metric loaded by an ETL.|
|Skip entity creation||(Only for ETL tasks sharing lookup information with other tasks) Set to True to prevent this ETL from creating an entity. With this setting, the ETL discards data from its data source for entities not found in BMC TrueSight Capacity Optimization. It uses one of the other ETLs that share lookup to create the new entity.|
|Hour mask||Specify a value to execute the task only during particular hours within the day. For example, 0 – 23 or 1,3,5 – 12.|
|Day of week mask||Select the days so that the task is executed only during the selected days of the week. To omit setting this filter, do not select any option for this field.|
|Day of month mask||Specify a value to execute the task only during particular days within a month. For example, 5, 9, 18, 27 – 31.|
|Apply mask validation||Set to False to disable the preceding Scheduling options that you specified. This property is useful if you want to temporarily turn off the mask validation without removing any values. By default this property is set to True.|
|Execute after time||Specify a value in the hours:minutes format (for example, 05:00 or 16:00) to indicate the time to wait before the task must be executed. After the task is scheduled, the task execution starts only after the specified time passes.|
|Enqueueable||Select one of the following options:
Click the Download links in the following table to view a PDF of the list of parameter mappings for each platform.
|Platform||BMC TrueSight Operations Management |
Data Integration API calls to TrueSight Operations Management 10.1
Task API call Authenticate to Presentation Server POST https://<PresentationServerHostName>/tsws/10.0/api/authenticate/login Retrieves a list of tenants GET https://<PresentationServerHostName>/tsws/10.0/api/omprovider/tenants Retrieves a list of devices GET https://<PresentationServerHostName>/tsws/10.0/api/omprovider/devices Retrieves a list of monitor types GET https://<PresentationServerHostName>/tsws/10.0/api/omprovider/monitorTypes Retrieves all instances present on the device GET https://<PresentationServerHostName>/tsws/10.0/api/omprovider/instances Retrieves configuration data POST https://<PresentationServerHostName>/tsws/10.0/api/omprovider/configdata Retrieves performance data POST https://<PresentationServerHostName>/tsws/10.0/api/omprovider/perfdata Log out and disconnect POST https://<PresentationServerHostName>/tsws/10.0/api/authenticate/logout