BMC - Atrium CMDB extractor

Use the BMC - Atrium CMDB extractor to collect information about the relationships between business services, applications, and computer systems in the CMDB database. The ETL makes API calls to fetch the relationship details, and displays these relationships as a hierarchy according to the standard and unmodified BMC Unified Service model that is created in CMDB. If your enterprise CMDB has customizations, you can use an appropriate generic extractor for collecting the relationship details. Also, to fetch the configuration and performance data of your systems, use another appropriate ETL. For information about the available ETLs, see Out-of-the-box ETLs.

Upgrade note

If you upgrade from an earlier version of TrueSight Capacity Optimization:

  • The new ETLs that you configure and run will import and display CMDB applications in the hierarchy by default. If you do not want to view applications in the hierarchy, do the following:

     ETL configuration to prevent applications in the hierarchy
    1. Log in to the TrueSight Capacity Optimization console.
    2. Configure the ETL. For more information, see the Integration steps section.
    3. Click Administration > ETL and System Tasks > ETL tasks > <CMDB ETL name>.
    4. Click Edit run configuration > Advanced > Additional properties.
    5. For the extract.atrium.import.application.data property, specify the value as false.
  • The existing CMDB ETLs will not import applications but will continue to import business services and computer systems. If you want to view applications in the hierarchy, do the following:

     ETL configuration to view applications in the hierarchy
    1. Log in to the TrueSight Capacity Optimization console.
    2. Click ETL tasks > <ETL name>.
    3. Click Edit run configuration > Advanced > Additional properties.
    4. Add the extract.atrium.import.application.data property and specify its value as true.


Supported versions

Connector nameSupported version of Atrium CMDB
BMC - Atrium CMDB extractor
  • 9.1.04, 9.1.02, 9.1.01, 9.1, and 9.0
  • 8.1.02, 8.1.01, 8.1, and 8.0
  • 7.6.04, 7.6.03, 7.6, and 7.5

Supported platforms

  • VMware: host and guest
  • IBM AIX: LPARs
  • Oracle Solaris: LDOMs, Zones

Integration steps

To integrate TrueSight Capacity Optimization with the Atrium CMDB Parser, perform the following task:

  1. Navigate to Administration > ETL & SYSTEM TASKS > ETL tasks.
  2. In the ETL tasks page, click Add > Add ETL under the Last run tab.
  3. In the Add ETL page, set values for the following properties under each expandable tab

    Note

    Basic properties are displayed by default in the Add ETL page. These are the most common properties that you can set for an ETL, and it is acceptable to leave the default selections for each as is.

    Basic properties

    Property Description
    Run configuration
    ETL task name By default, this field is populated based on the selected ETL module. You can specify a different name for the ETL Task. Duplicate names are allowed.
    Run configuration name Default name is already filled out for you. This field is used to differentiate different configurations you can specify for the ETL task. You can then run the ETL task based on it.
    Deploy status You can 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.
    • 1 - Light: Add bare minimum activity logs to the log file.
    • 5 - Medium: Add medium-detailed activity logs to the log file.
    • 10 - Verbose: Add detailed activity logs to the log file. Info,

    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 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.
    Module selection

    Ensure that the Based on datasource option is selected.

    Note

    If you select Based on Open ETL template, 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

    ETL module (BMC recommends you to make this selection first) Select BMC - Atrium CMDB extractor.
    Module description A link in the user interface that points you to this technical document for the ETL.
    Datasets

    Enables you to select or deselect metric groups for which data will be populated from the Available datasets. The OpenStack 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.

    1. Click Edit.
    2. Select one (click) or more (ctrl+click or shift+click) datasets that you want to include from the Available datasets and click >> to move them to Selected datasets.
    3. Click Apply.
    Entity catalog
    Sharing status  Select any one:
    • Shared entity catalog: Select this option if, for the same entities, data is coming from multiple sources. For example, BPA ETL.
      • Sharing with Entity Catalog: Select an entity catalog from the drop-down list.
    • Private entity catalog: Select this option if, for the same entity, data is coming from a single source.
    Object relationships
    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.

    Additional Information

    By default, a new domain is created for each ETL, with the same name of the extractor module. As the ETL is created, a new hierarchy rule with the same name of the ETL task is automatically created, with an active status; if you update the ETL specifying a different domain, the hierarchy rule will be updated automatically. The hierarchy rule will be created with status ACTIVE.

    Select any one of the following options:

    • New domain: Create a new domain. Specify the following properties under New domain:
      • Parent: Select a parent domain for your new domain from the domain selector control.
      • Name: Specify a name for your new domain.
    • Existing domain: Select an existing domain. Make a selection for the following property:
      • Domain: Select an existing domain from the domain selector control.

    If the domain is already used by any other hierarchy rule, a Domain conflict option is displayed. You can select one of the following solutions:

      • Enrich domain tree: Create a new independent hierarchy rule to add a new set of entities and/or relations not defined by other ETLs (for example this ETL is managing storage while others are managing servers)
      • ETL Migration: This configuration is recommended if new ETL manages same set of entities and/or relations (already defined in current domain tree). Typical use case is the migration from one or more ETLs to a new ETL instance. It will stop all relations imported by ETL instances and restore only valid relations after first run; this configuration reuses existing hierarchy rule to correctly manage relation updates.
        • Select a Hierarchy Rule to be used for current ETL from among the rules that are populating the selected domain.
          Additional information of the ETL using the selected rule is also displayed.
    CMDB connection parameters
    CMDB server The host name or IP address of the computer that hosts the BMC Atrium server (for example: cmdbserver1.orgname.com). The ETL uses the BMC Remedy AR System API to connect to the Atrium CMDB server. The ETL excludes the system if it's reconciliationId is 0.
    Username

    The name of the user. The user must have administrative privileges on the BMC Atrium server.

    Password The password of the user.
    ETL task properties
    Task group Select a task group to classify this ETL into. It is not necessary to group it into a task group.
    Running on scheduler Select the scheduler over which you want to run the ETL. The type of schedulers available are:
    • PrimaryScheduler: Runs on the AS.
    • GenericScheduler: Runs on a separate machine.
    • Scheduler: Runs on a dedicated scheduler machine.
    Maximum execution time before warning The number of hours, minutes, or days for which the ETL should be executed before generating warnings or alerts, if any.
    Frequency  Select the frequency for ETL execution. Available options are:
    • Predefined: Specify the following details:
      • Predefined frequency: Select a frequency from Each DayEach Week or Each Month.
      • Start timestamp: Based on the Predefined frequency selection, specify from the following details:
         - hour: Specify hour in HH format.
         - minute: Specify minute in MM format.
         - week day: Select the day of the week when the ETL has to be executed.
         - month day: Select the day of the month when the ETL has to be executed.
    • Custom: Specify the following details:
      • Custom frequency: Enter a time interval in number of minutes, hours, days, or weeks.
      • Custom start timestamp: Specify the timestamp in YYYY-MM-DD HH:MM format or select it using the date picker.

    Note

    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.

    Advanced properties

    Property Description
    Collection level
    Metric profile selection

    Select any one:

    • Use Global metric profile: Select this to use an out-of-the-box global profile, that is available on the Adding and managing metric profiles page. By default, all ETL modules use this profile.
    • Select a custom metric profile: Any metric profiles you add in the Add metric profile page (Administration > DATAWAREHOUSE > Metric profiles).

    For more information, see Adding and managing metric profiles.

    Levels up to

    The metric level defines the amount of metric imported into the data warehouse. If you increase the level, additional load is added to the data warehouse while decreasing the metric level reduces the number of imported metrics.

    Choose the metric level to apply on selected metrics:

    • [1] Essential
    • [2] Basic
    • [3] Standard
    • [4] Extended

    For more information, see Aging Class mapping.

    Metric filter
     Metric list <for selected dataset>

    Click Edit and select the metrics that will be loaded for each dataset that you selected under Run configuration > Datasets. If no metric is specified, all metrics will be loaded.

    CMDB connection parameters
    TCP Port

    Specify the TCP port number that is used by BMC Atrium. The Atrium administrator can provide this port number.

    You need to specify this port number only if the BMC Remedy AR system server is not registered with a portmapper or if a Port 111 firewall blocks the portmapper port. Otherwise, you do not need to specify the port number because the portmapper automatically locates the port. For more information, see Understanding port numbers in BMC Remedy AR System .
    Use UUID for VMware vms Specify if the UUID should be used instead of the VM name to identify VMware guest machines.
    Import VMware Data Import VMware host and guest machines.
    List additional cmdb relationship classes Specify the relationship classes that you want to use for displaying CMDB relationships. By default, the following relationship classes are supported: BMC_Dependency, BMC_Impact, and BMC_Component
    Import filter

    Configure one or more filtering properties in this section to include or exclude entities while importing.

    Whitelist file path

    Use this property to import only specific business services or computer systems. By default, the ETL imports all business services and computer systems.

      To import specific business services or computer systems
    1. In a text file, add the names of business services or computer systems that you want to import in the following format:
      ClassName;AttributeName;AttributeValue
    2. In the Use file at path field, specify the path to this text file.
    3. Run the ETL and verify that only the specified business services or computer systems are imported in the hierarchy.

    Example:

    To import business services BService_1 and BService_2 and their computer systems, add them to the text file as follows:
    BMC_BUSINESSSERVICE;Name;BService_1
    BMC_BUSINESSSERVICE;Name;BService_2

    After you run the ETL, only BService_1 and BService_2 business services and their computer systems will be displayed in the hierarchy.

    For more information about CMDB class and attribute names, see Common Data Model advanced concepts .

    Blacklist file path

    Use this property to exclude specific business services or computer systems while importing. By default, the ETL imports all business services and computer systems.

      To exclude business services or computer systems
    1. In a text file, add the names of business services or computer systems that you want to exclude while importing in the following format:
      ClassName;AttributeName;AttributeValue
    2. In the Use file at path field, specify the path to this text file.
    3. Run the ETL and verify that the specified business services or computer systems are not displayed in the hierarchy.

    Example:

    To exclude computer systems hp1appo1 and hp1app02 while importing, add them to the text file as follows:
    BMC_COMPUTERSYSTEM;Name;hp1appo1
    BMC_COMPUTERSYSTEM;Name;hp1app02

    After you run the ETL, these computer systems will not be imported and displayed in the hierarchy.

    For more information about CMDB class and attribute names, see Common Data Model advanced concepts .

    Additional properties
    List of properties

    Additional properties can be specified for this ETL that act as user inputs during execution.

    1. Click Add.
    2. Add an additional property in the etl.additional.prop.n box.
    3. Click Apply.

    Repeat this task to add more properties.

    Notes:

    • If you want to view the application-wise relationship in the hierarchy, add the extract.atrium.import.application.data property and set its value to true. If you do not want to view applications, set the extract.atrium.import.application.data property value to false.
    • Update the value of the extract.atrium.traverse.direction property depending on the relationships that you want to view in the CMDB data model.
      • IN: Specify to view the relationships from business services to computer systems.
      • OUT: Specify to view the relationships from computer systems to business services.
      • BOTH: This is the default value for viewing all relationships.
    • The ETL excludes computer systems whose VirtualSystemType is set to any of the following in the CMDB system:

        • Xen
        • HP nPartitions
        • VPar
        • Microsoft Hyper-V
        • Integrity VM
        • Xen Hypervisor
        • VMware (In VMware, in addition to VirtualSystemType, if the enablerType=VMware Server/VMware ESX Server, the ETL excludes the computer system.)
      • If you want to import such virtual systems, add the extract.cmdb.non.default.platforms property and set its value to the required virtual system. For example, if you set the value of the extract.cmdb.non.default.platforms property to HYPERV, then systems with virtualSystemType=Microsoft Hyper-V are imported.
      • For VMware virtual systems, add the extract.atrium.import.data.for.vmw property and set its value to true.
    Loader configuration
    Empty dataset behavior Choose one of the following actions if the loader encounters an empty dataset:
    • Warn: Warn about loading an empty dataset.
    • Ignore: Ignore the empty dataset and continue parsing.
    ETL log file name Name of the file that contains the ETL execution log; the default value is:%BASE/log/%AYEAR%AMONTH%ADAY%AHOUR%MINUTE%TASKID.
    Maximum number of rows for CSV output A number which limits the size of the output files.
    CSV loader output file name Name of the file generated by the CSV loader; the default value is: %BASE/output/%DSNAME%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSID%TASKID.
    Capacity Optimization loader output file name Name of the file generated by the BMC Capacity Optimization loader; the default value is:
    %BASE/output/%DSNAME%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSID%TASKID
    Detail mode  Select the level of detail:
    • Standard: Data will be stored on the database in different tables at the following time granularities: Detail (configurable, by default: 5 minutes), Hourly, Daily, Monthly.
    • Raw also: Data will be stored on the database in different tables at the following time granularities: Raw (as available from the original data source), Detail (configurable, by default: 5 minutes), Hourly, Daily, Monthly.
    • Raw only: Data will be stored on the database in a table only at Raw granularity (as available from the original data source).
    For more information on granularities, see Accessing data using public views and Sizing and scalability considerations.
    Reduce priority

    Select either Normal or High.

    Remove domain suffix from datasource name (Only for systems) If set to True, the domain name is removed from the data source name. For example, server.domain.com will be saved as server.
    Leave domain suffix to system name (Only for systems) If set to True, the domain name is maintained in the system name. For example: server.domain.com will be saved as such.
    Update grouping object definition If set to True, the ETL will be allowed to update the grouping object definition for a metric loaded by an ETL.
    Skip entity creation (Only for ETL tasks sharing lookup with other tasks) If set to True, this ETL does not create an entity, and discards data from its data source for entities not found in BMC Capacity Optimization. It uses one of the other ETLs that share lookup to create the new entity.
    Scheduling options
    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 can be executed only during the selected days of the week. To avoid 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  By default this property is set to True. Set it to False if you want to disable the preceding Scheduling options that you specified. Setting it to False is useful if you want to temporarily turn off the mask validation without removing any values.
    Execute after time  Specify a value in the hours:minutes format (for example, 05:00 or 16:00) to wait before the task must be executed. This means that once the task is scheduled, the task execution starts only after the specified time passes.
    Enqueueable  Select one of the following options:
    • False(Default): While a particular task is already running, if the next execution command arises – it is ignored.
    • True: While a particular task is already running, if the next execution command arises – it is placed in a queue and is executed as soon as the current execution ends.
  4. Click Save.
    You return to the Last run tab under the ETL tasks page.
  5. Validate the results in simulation mode: In the ETL tasks table under ETL tasks > Last run, locate your ETL (ETL task name), click  to run the ETL.
    After you run the ETL, the Last exit column in the ETL tasks table will display one of the following values:
    • OK: The ETL executed without any error in simulation mode.
    • WARNING: The ETL execution returned some warnings in simulation mode. Check the ETL log.
    • ERROR: The ETL execution returned errors and was unsuccessful. Edit the active Run configuration and try again.
  6. Switch the ETL to production mode: To do this, perform the following task:
    1. In the ETL tasks table under ETL tasks > Last run, click the ETL under the Name column.
    2. In the Run configurations table in the ETL details page, click  to edit the active run configuration.
    3. In the Edit run configuration page, navigate to the Run configuration expandable tab and set Execute in simulation mode to No.
    4. Click Save.
  7. Locate the ETL in the ETL tasks table and click  to Run it, or schedule an ETL run.
    After you run the ETL, or schedule the ETL for a run, it will extract the data form the source and transfer it to the TrueSight Capacity Optimization database.

Lookup details

The connector defines multiple lookup fields for coordinating with other connectors. The following table lists the sequence of field sets for strong lookup and weak lookup.

Entity Type Strong lookup fields Weak lookup fields 
GenericRECONCILIATION_ID; INSTANCE_IDHOSTNAME; NAME

Virtual Host - AIX PowerVM, Virtual Host - Solaris, Virtual Host - VMware, Virtual Machine - AIX LPAR, Virtual Machine - Solaris LDOM, and Virtual Machine - Solaris Zone

RECONCILIATION_ID; INSTANCE_ID

HOSTNAME; NAME

Virtual Machine - VMware

RECONCILIATION_ID; INSTANCE_ID

HOSTNAME; UUID; NAME

Metrics and relationships

Metrics supported by the SYSCNF dataset

TrueSight Capacity
Optimization Metric
CMDB Class NameCMDB AttributeComment

HW_MODEL

BMC_ComputerSystem

Model

 

HW_VENDOR

BMC_ComputerSystem

ManufacturerName

 

ASSET_OWNER

BMC_ComputerSystem

OwnerName

 

CPU_NUM

BMC_Processor

NumberOfCores

Add number of Cores for all BMC_processor instances

CPU_MHZ

BMC_Processor

MaxClockSpeed

Add MaxClockSpeed for all BMC_Processor instances

CPU_MODEL

BMC_Processor

Model

 

TOTAL_REAL_MEM

BMC_ComputerSystem

TotalPhysicalMemory

 

OS_TYPE

BMC_OperatingSystem

OSType

 

OS_VER

BMC_OperatingSystem

VersionNumber

 

DISK_NUM

BMC_DiskDrive

 Get number of instances of BMC_DiskDrive

DISK_SIZE

BMC_DiskDrive

DriveSizeAdd DriveSize for all BMC_DiskDrive instances

Populated object relationships

Relationship nameSource entityDestination entityMeaning

GM_CONTAINS_ZN

Solaris LDOM

Solaris Zone

LDOM contains zone

VH_CONTAINS_GM

VMware Host

VMware VM

VMware Host contains a VM. This relationship is hidden in the UI.

CONTAINSBusiness serviceBusiness serviceBusiness service depends on the child business service.
CONTAINSBusiness serviceComputer System
(Stand alone physical machine, LPAR, LDOM, ZONE, VMware Host, VM)
Computer System
(Stand alone physical machine, LPAR, LDOM, ZONE, VMware Host, VM)

For more information on how to extract object relationships dataset; see: Writing an extractor for a CMDB - Object Relationships dataset

Hierarchy rule

The hierarchy rule will be used to process object relationships, and will run automatically, as part of the daily run.

Atrium user configuration

The configured Atrium user should have administrative privileges on the BMC Atrium server, so that BMC Atrium can be scanned to fetch information about computer systems, hardware configuration, and business service instances.

ETL output

Note

The ETL fetches the BMC_ComputerSystem and BMC_Application CMDB class name instances. You get the following instance values:

Values for the BMC_ComputerSystem class instance:

InstanceValue
PrimaryCapabilityServer
MarkAsDeletedNo

DataSetID

BMC.ASSET

Values for the BMC_Application class instance:

InstanceValue

MarkAsDeleted

No

DataSetID

BMC.ASSET

The BMC Atrium CMDB ETL discovers standalone systems and the following for different platforms:

  • VMware: host and guest
  • IBM AIX: LPARs
  • Oracle Solaris: LDOMs, Zones

It also discovers business services, applications, and related computer systems.

In a CMDB data model that is created by using ADDM computer systems, relationships are defined as a source Configuration Item (CI) that is related to a target CI. For example, the following data model shows the computer systems (source CIs) that are related to business services (target CIs) (arrows pointing upwards from computer systems to related business services).

Classes and relationships


When you run the ETL, it captures these relationships as a hierarchy of business services, related applications, and the associated computer systems.

Note

For sharing lookup of BMC Atrium CMDB connector with Gateway Server connector, ensure that the BMC Atrium CMDB connector removes the domain suffix from the data source name.

For more information, see Handling ETL lookup name. Also, ensure that Import VMware Data option as found in CMDB connection parameters in Advanced configuration is False, as this is not currently supported, while sharing the lookup with Gateway Server connector.

Related topics

Using ETL datasets

Developing custom ETLs

Dataset reference for ETL tasks

Viewing datasets and metrics by dataset and ETL module

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

Comments