Skip to main content
Matrix42 Self-Service Help Center

Blueprints

How to define the attributes you want to collect and create Blueprints that can be mass applied to many Configuration Items.

Overview

Blueprints are a predefined set of Attributes, that can be mass applied to many Configuration Items.  Typically, during implementation an initial set of Blueprints will be preloaded that may be appropriate for your environment, which you can adjust to meet your exact needs.  You can also create your own set of Blueprints.  

Note: Un-linking Blueprint will have a cascading delete effect. All elements that are based on this linkage will be affected (for e.g.  Attributes. Re-linking the Blueprint will not retrieve the data.)

Additionally, each CI can be associated with one or more Blueprint, as you can see in the diagram below.  For example, you may have a basic availability Blueprint that performs ping checks and analyzes for basic failure conditions, which you may apply globally to every CI.  Then, you may have a Linux blueprint which you assign just to your Linux servers.

Note: You can link a Blueprint to multiple CIs, just as you can link a single CI to multiple Blueprints.

Changes made to any component of a Blueprint are applied to every associated CI.

Create a Blueprint

  1. Log in to FireScope SDDM as a FireScope or Account Administrator.
  2. Click on Configuration > Blueprints > Create. The New Blueprint page will be displayed.
clipboard_e405e3d84777ca4061d331544f1f3d6f1.png

Details

Name: Enter a unique name for this Blueprint

Group Memberships

Blueprint Groups: Click the edit button and select the Blueprint Groups that you want this Blueprint to be a member of.

Save or Cancel as needed.

Create Blueprint Attributes

  1. Click on Configuration > Blueprint Attributes > Create. The New Blueprint Attribute page will be displayed.
clipboard_e01dda499a4f73c9dfb320053ac00c6db.png

Blueprint

  • Blueprint:  Click the edit button and chose the Blueprint that will contain this attribute.  Limit 1.
  • Blueprint Attribute Details:
  • Blueprint Attribute Name: Enter a descriptive name for this Attribute.
  • Collect data for this Blueprint Attribute:  If you want to immediately begin collecting data for this Blueprint Attribute then switch this on.

Operation Configuration

Select Operation Configuration and the Operation Configuration page is displayed

clipboard_ef46fe7e04cc63938b052ac020c7a1aca.png

Select Attribute Type and Operation

Attribute Type: Select an attribute type from the list.

  • Agent Remote
  • Calculated Attribute
  • FireScope Agent
  • LDAP Check
  • NetApp Check
  • Percentile
  • SNMPv1 Poll
  • SNMPv2 Poll
  • SNMPv3 Poll
  • SSH Attribute
  • TCP Check
  • Virtual Center
  • Virtual Guest
  • Virtual Host
  • WMI Attribute

Operation: Click the edit button to see a list of existing Operations that can be performed on that Attribute Type and select the one you want.

Define Operation Parameters

  • Operation Parameters:  Edit the Operation parameters, if any, to the desired values
  • Configure Value Processing
  • Base Unit: What unit of measure will the value be in?
  • Data Type: What kind of data is the value expected to be?
  • Collection Interval: Set the time between data collections. Min: 3600. Max: 86400
  • Custom Multiplier: If needed, enter a multiplier to convert the result into the base unit. Zero (0) will be ignored
  • Value Interpretation: Should the value be interpreted as is, or calculated over time?
  • Configuration Item Inventory Field: Pick (or type and hit Enter) the Inventory Field this Attribute will update on its Configuration Item. Limit: 1

Value Display Options

Value Translation:  Should the raw value be translated to something more meaningful when displayed?

Save or Cancel as needed.

To List existing Blueprints go to Configuration > Blueprints > List and the Blueprints page is displayed.

clipboard_e8ccbd1555f76ba3e847fc870fbce02d2.png

This list may be sorted or grouped using any of the column headings.

You can perform actions on the listed Blueprints by clicking on the three dots at the end of the row you are interested in.

  • Edit Blueprint
  • Merge Configuration Items
  • View Blueprint Attributes
  • Delete Blueprint

Blueprint Attributes

To create a new Blueprint Attribute, navigate to Configuration > Blueprint Attributes > Create and the New Blueprint Attribute page is displayed

clipboard_e09e353f68b022bfda183608e8c3e9192.png

Blueprint

Blueprint: Click the edit key to select the Blueprint that will contain this Attribute.

Blueprint Attribute Details

Blueprint Attribute Name: Provide a unique name for this attribute.

Collect Data for this Blueprint Attribute: Select this to begin collecting data for this attribute.

Select Operation Configuration to display the Operation Configuration page

clipboard_ec4bcbfe1f9dbb68e3f02b3913fb089ae.png
  1. Select Attribute Type and Operation
    1. Attribute Type:  Select the type of attribute you are creating from the list
    2. Operation Function Name: Click the edit button and select an Operation if needed.
  2. Define Operation Parameters

Operation Parameters:  If you selected an Operation Function it will appear here.  You can leave it as is, or change the operation parameters, to the desired values

  • Configure Value Processing
    • Base Unit: Select the base unit from the list
    • Custom Multiplier:  If needed, enter a value to be multiplied by the attribute value to convert the result into the base unit
    • Data Type: Select the Data Type from the list
    • Value Interpretation: Select the Value Interpretation from the list
    • Collection Interval:  Set the time between data collections
    • Configuration Item Inventory Field:  Type a value or select a value from the list

Select Value Display Options to display the Value Display Options page

clipboard_e63863b2c65054fd1bf178f998e72896e.png
  1. Value Translation: Select an appropriate translation for this value if needed

Click Save or Cancel as needed.

List Blueprint Attributes

Navigate to Configuration > Blueprint Attributes > List to display the Blueprint Attributes page

clipboard_e8e49b39ea5ba625a774306ec12b11a51.png

This list may be sorted or grouped using any of the column headings.

You can select one or more Blueprint Attributes from the list and use the Modify Selected drop-down in the upper right of the page to perform certain actions for the selected attributes including Set Enabled, Set Disabled and more.

You can perform actions on the listed Blueprint Attributes by clicking on the three dots at the end of the row you are interested in.

  • Edit Blueprint Attribute
  • Delete Blueprint Attribute

Alternative Method to create a Blueprint

One drawback of the method mentioned above is that you cannot test Attributes prior to applying the Blueprint to one or more CIs. The following outlines an alternative method whereby we create a normal CI that can be tested and then convert it into a Blueprint.  Please note that Attributes that use WMI, filesystems or SNMP may include paths that are unique to a specific system and may not be able to collect data when applied to a different system.

  1. First create a normal CI
  2. Create, test and tweak its Attributes until you have the desired configuration.  
  3. Export the CI. Administration> Configuration Item Migration > Export
  4. Edit the XML file and change the Status Value to 3 and change the CI name to a name for your new Blueprint.
  5. Import your modified XML and then apply this new Blueprint to any related CIs.
clipboard_e158f0a8c2f92e6f34cb19893ec303330.png

Blueprint Groups

A Blueprint group is a useful way to organize your numerous Blueprints. For example, create groups and associate with Blueprints by device type, application type or vendor. Grouping of Blueprint CIs for both permissions and based on functionality or service provided by the CIs.

  1. Click on Configuration > Blueprint Groups > Create. The New Blueprint Group page will be displayed.
clipboard_eea9f24ab46237ae58f4e2b0330360db4.png

Details

  • Name:  Provide a name for this Blueprint group
  • Group Membership: Press the edit button toselect the individual Blueprints for this group.

Save or Cancel as needed.

To List existing Blueprint Groups, go to Configuration > Blueprint Groups > List and the Blueprints page is displayed.

clipboard_e9843f453492585cc96159092e295020f.png

This list may be sorted or grouped using any of the column headings.

You can perform actions on the listed Blueprints by clicking on the three dots at the end of the row you are interested in.

  • Edit Blueprint Group
  • View Blueprint Groups
  • Delete Blueprint Group

Manage Linked Blueprints

Blueprint Linkage is the most comprehensive method to manage your blueprints and large number of related CIs. As an administrator you can verify blueprints currently in use.

  1. Click on Configuration > Inventory > Batch Blueprint Linkage. Blueprint Linkage will be displayed.
clipboard_e014a71fa26ab555207593baba0b4e869.png

 

clipboard_e8004cb3c157be1e7b8b925a2b377507f.png
  1. Set the Group Context: Using the Omnibar at the top of the page (just below the FireScope logo), select the Service Group and/or Logical Group containing the Configuration Items to link/unlink.
  2. Select the Blueprint: Click the edit button to manage the linked Configuration Items.  Limit 1

A list of Available Configuration Items will appear that you can add to your Linked Blueprint

clipboard_e8db08a0bfaa9b7610b091c7f267e1181.png

Column headings can be used to Sort and Group the list

To select items to sync to this Blueprint, first select the Available CI’s you are interested in by clicking in the box to the left of the CI.

Sync Selected: Once you have selected one or more CI’s click the Sync Selected button at the top of the list.

Link All in Logical Group: Click this buttonas an alternative to selecting individual CI’s from the list and it will link all of the CI’s in the Service Group or Logical Group.

Unlink All in Logical Group: Click this button ifyou want to unlink all items in the Logical Group from this Blueprint

Note: This list shows the currently linked CIs as well as other CIs in the system.

clipboard_e602828558823b272793cf62de4c99dd2.png

Note: The list of blueprints in the CI listing grid will let you know if there are already other blueprints applied to those CIs. 

Note: Un-linking Blueprint will have a cascading delete effect. All elements that are based on this linkage will be affected (for e.g.  Attributes and Dashboards. Re-linking the Blueprint will not retrieve the data.)

Blueprint Linkage for Logical Groups

Blueprint linkage for logical groups has a special process reserved for dynamically replacing the Logical Group macro “[LOGICALGROUP.NAME]” to be used in objects that may have group context. In the Blueprint’s Attributes, you can use the macro in the description or operation fields (depends on the object type) and a Blueprint linkage will substitute the macro with the actual Logical Group name.

For example, an Blueprint Attribute with:

 operation = grouped_average(“[LOGICALGROUP.NAME]”,”number_processes()”,”min_value”,”300″)
description =  Average number of process for [LOGICALGROUP.NAME]

Apply this blueprint to a logical group called “Local Servers” that has a chosen CI delegate of “Server Info” will result in the following:

CI “Server Info” will now have this attribute

operation = grouped_average(“”Local Servers”,”number_processes()”,”min_value”,”300″)
description =   Average number of process for Local Servers

To access Blueprint linkage for Logical Groups, just add a logical group to the global nav on the manage blueprint page.

Click on Configuration > Manage Linked Blueprints > Select a Blueprint

 The Blueprint linkage page will be displayed.

clipboard_e23eaa73b302d9454dcfeeb5084704e0a.png

To add a blueprint to all Cis in Logical group you will need to first select a Logical Group in the Global Nav.

clipboard_e112368f070aecf49ada34756b19067ed.png
  1. You will now see a list of Blueprints that has the macro prepared for Logical Group linkage.
  2. Click on the Blueprint. Available logical Groups will be displayed.
    Click on the button or icon to link it.
    Note: Un-linking Blueprint will have a cascading delete effect. All elements that are based on this linkage will be affected (for e.g.  Attributes. Re-linking the Blueprint will not retrieve the data.)
  3. Click on the Save button.

 Best Practice for Logical Group Blueprint

  1. For each Logical Group, set a delegate CI to represent the CI members as the location of grouped check Attributes.
  2. Create a Blueprint that contains ONLY Grouped Check Attributes that has the proper macro substitution in the Blueprint objects.
  3. Link the Blueprint to the Logical Groups and use the Blueprint to manage your configurations.
  4. Make sure you identify and provide user access to the delegate CI.

 The following Blueprint objects support Logical Group macro substitution:

Blueprint Attribute

  • Allow Grouped Check attribute ONLY if [LOGICALGROUP.NAME] macro in description and operation.

Blueprint Macros

Macros provide the ability to dynamically expand Blueprint Attributes based upon Inventory information on each CI, like the number of CPUs, They are commonly used in Blueprint Attributes for filesystems, network interfaces, etc.  The Macro variables are replaced with the corresponding value when the Blueprint is linked to a CI.
Note:

  • CI Inventory should exist for any Blueprint Macro Attributes to be populated.
  • If you insert a Macro into the Attribute operation a corresponding Macro must be inserted into the Attribute description. As shown in the example below CI_CPU.INDEX macro
clipboard_e769a9708908144d50d571296f4692583.png

Available Blueprint Macros 

CPU Description
[CI_CPU.NAME] Name of the CPU.
[CI_CPU.INDEX] Numeric identifier of a specific CPU.
Network Interface Description
[CI_INTERFACE.DESCRIPTION] Description of a specific network interface.
[CI_INTERFACE.NAME] Name of a specific network interface.
Storage(disk) Description
[CI_STORAGE.FILESYSTEM] A filesystem associated with this CI (e.g. C:, D:, /home)
[CI_STORAGE.MULTIPLIER] The custom attribute multiplier used to convert value. For example, from bytes to megabytes.
NetApp Description
[CI_NETAPP.AGGREGATE.NAME] Name of the NetApp aggregate.
[CI_NETAPP_VOLUME.NAME] Name of the NetApp volume.

Create and Update CI Inventory

CI Inventory should exist for any Blueprint Macro Attributes to be populated. It can be created or updated from CI form or Network Discovery form. The following information explains how to create and update a CI Inventory.

Create CI Inventory from a CI Form

  • If a CI already exists then
    • Open the existing CI

Data Collection and Evaluation for this Device:  Under Network Discovery sub section, check the Run Network Discovery Job box. This section will be activated.
Note: Selecting this option will set the system to run discovery on the IP/DNS – and create configuration based on results (applies profiles).

clipboard_e375fa4067760f5e0d5eee893f1693863.png
  • Blueprint linkage for CI Inventory: Click on the Edit button to select a Macro Blueprint.
    Note: Blueprint linked to this CI will try to expand dynamic elements with appropriate Macros.
  • If the CI does not exist then,
    • Create a new CI.

Data Collection and Evaluation for this Device: Under Scan CI on Create sub section check the Run Network Discovery Job. This section will be activated.

clipboard_edc99358fae2d22574b24dc3da25120f2.png
  • Blueprint linkage for CI Inventory: Click on the Edit button to select a Macro Blueprint.
    Note: Blueprint linked to this CI will try to expand dynamic elements with appropriate Macros.

Create CI Inventory from a Network Discovery form.

  • If a CI already exists then under Result Processing Options section on Network Discovery form,
  • Select Update existing Configuration Item Inventory.
    • Then select a Blueprint with Inventory macro attributes
    • After you save the job will run.

If the CI does not exist then under Result Processing Options section on Network Discovery form,

clipboard_e3b7802b4335df7fae7b1d1add89d0021.png

Mass applying Blueprints

There are several ways to link CIs and Blueprints. In addition to automatically assigning Blueprints during Discovery, federation from CMDB or at time of import, you can also manually associate a CI to a Blueprint by editing the CI.  However, there are occasions where you may need to assign a new Blueprint to a large group of CIs, which is why FireScope SDDM includes a Batch Blueprint Linkage page for doing exactly this.

  1. The CI edit form
  2. The Blueprint edit form
  3. Manage Linked Blueprint – this is the most comprehensive method to manage your blueprints and large number of related CIs. As an administrator you can verify Blueprints currently in use.

Configuration > Blueprint > List, the Blueprint Linkage page with the list of Blueprints will be displayed.

clipboard_e071b25de4db9588e36db6ee16bab0d06.png

Click on the three dots next to the Blueprint you want to manage and click Manage Configuration Items: a page with the list CIs will be displayed. 
Note: 
Un-linking Blueprint will have a cascading delete effect. All elements that are based on this linkage will be affected (for e.g.  Attributes. Re-linking the Blueprint will not retrieve the data.)

clipboard_e06f0bbe60687053c1de94befa5d1708e.png
  1. Click on the checkbox to link the Blueprint to the CI.          
    Note:
     If you link and unlink several CIs with blueprints, expect the process to take a greater amount of time to complete.

Download Blueprints

SNMP Table Blueprints

SNMP Table Blueprints allow a user to specify a Blueprint, a Blueprint that contains attributes with specific macros which expand when applied to a specific SNMP table based on the number of rows found.

Typically a user will already know the exact table OID they are targeting or they will use a MIB browser to determine the location of the data they are interested in monitoring. As an example, we will be targeting the ifTable (1.3.6.1.2.1.2.2) in this document. All OIDs that belong to an SNMP table following the same general format:

<tableOID>.1.<column>.<rowIndex>

Note that <rowIndex> can be something as simple as an integer, but it can also be something more complicated like an IP address. The key to knowing where the <column> part of the OID begins is the repeating ‘.1’ preceding it which is common for all SNMP tables. In the case of the ifTable, this is called ifEntry.

Note: Most users may opt to run the Discovery job without profiles. If that is the case, the CI must already exist, and the user will need to manually assign the appropriate SNMP credential to the CI.

To create a Discovery Job with SNMP Table Blueprint

  1. Configuration > Discovery Jobs> Create. Network Discovery page will be displayed.
clipboard_e4a432f98544c655a1fd1e884789765bc.png

Select Configuration Items and scroll down to Blueprint Assignments and specify the SNMP Object ID Blueprints

clipboard_eef9965ba3a5f680623b7a49a9bd1efaf.png

Add Blueprint Assignment:  Click this button to reveal the Blueprint data entry information.

Blueprint: Click the edit button and select a Blueprint to apply to this SNMP Object ID. Limit: 1

SNMP Object ID: Specify the SNMP Object ID

Description Column:  Field should contain the column of the SNMP table which contains something descriptive and preferably unique. This is used by the [CI_SNMP_TABLE.ROW_DESCRIPTION] macro to give Attributes meaningful names. For the ifTable, the most meaningful Description Column would be ‘2’, the ifDescr column, since the data in that column is both descriptive and usually unique for each row in the table.

 Blueprint Attribute SNMP Form

Navigate to Configuration > Blueprint Attributes > Create > Operation Configuration to display the New Blueprint Attribute page

clipboard_e815620b6cadc60c13e3a76ab11ce5194.png

Macros

[CI_SNMP_TABLE.TABLE_OID] – when an Attribute specified in the BP is created for each row in the table, this macro will be replaced with the SNMP Table OID.
[CI_SNMP_TABLE.ROW_INDEX] – when an Attribute specified in the BP is created for each row in the table, this macro will be replaced with the row index of that row.
[CI_SNMP_TABLE.ROW_DESCRIPTION] – when an Attribute specified in the BP is created for each row in the table, this macro will be replaced with the actual value in the row/column of the table.

Example Data

The following is a walk against the Liebert device in our office (10.0.2.12) and targets the ifTable. The data we are interested in has been put in bold.

[root@sedge ~]# snmpwalk -v 2c -c fspublic -Of -On 10.0.2.12 1.3.6.1.2.1.2.2
.1.3.6.1.2.1.2.2.1.1.1 = INTEGER: 1
.1.3.6.1.2.1.2.2.1.1.2 = INTEGER: 2
.1.3.6.1.2.1.2.2.1.2.1 = STRING: foo
.1.3.6.1.2.1.2.2.1.2.2 = STRING: bar

.1.3.6.1.2.1.2.2.1.3.1 = INTEGER: ethernetCsmacd(6)
.1.3.6.1.2.1.2.2.1.3.2 = INTEGER: softwareLoopback(24)
.1.3.6.1.2.1.2.2.1.4.1 = INTEGER: 1500
.1.3.6.1.2.1.2.2.1.4.2 = INTEGER: 65535
.1.3.6.1.2.1.2.2.1.5.1 = Gauge32: 0
.1.3.6.1.2.1.2.2.1.5.2 = Gauge32: 0
.1.3.6.1.2.1.2.2.1.6.1 = STRING: 0:0:68:16:21:ad
.1.3.6.1.2.1.2.2.1.6.2 = STRING:
.1.3.6.1.2.1.2.2.1.7.1 = INTEGER: up(1)
.1.3.6.1.2.1.2.2.1.7.2 = INTEGER: up(1)
.1.3.6.1.2.1.2.2.1.8.1 = INTEGER: up(1)
.1.3.6.1.2.1.2.2.1.8.2 = INTEGER: up(1)
.1.3.6.1.2.1.2.2.1.9.1 = Timeticks: (0) 0:00:00.00
.1.3.6.1.2.1.2.2.1.9.2 = Timeticks: (0) 0:00:00.00
.1.3.6.1.2.1.2.2.1.10.1 = Counter32: 2380387288
.1.3.6.1.2.1.2.2.1.10.2 = Counter32: 0

.1.3.6.1.2.1.2.2.1.11.1 = Counter32: 21411374
.1.3.6.1.2.1.2.2.1.11.2 = Counter32: 0
.1.3.6.1.2.1.2.2.1.12.1 = Counter32: 76120178
.1.3.6.1.2.1.2.2.1.12.2 = Counter32: 0
.1.3.6.1.2.1.2.2.1.13.1 = Counter32: 0
.1.3.6.1.2.1.2.2.1.13.2 = Counter32: 0
.1.3.6.1.2.1.2.2.1.14.1 = Counter32: 0
.1.3.6.1.2.1.2.2.1.14.2 = Counter32: 0
.1.3.6.1.2.1.2.2.1.15.1 = Counter32: 0
.1.3.6.1.2.1.2.2.1.15.2 = Counter32: 0
.1.3.6.1.2.1.2.2.1.16.1 = Counter32: 1571495108
.1.3.6.1.2.1.2.2.1.16.2 = Counter32: 0

.1.3.6.1.2.1.2.2.1.17.1 = Counter32: 17288348
.1.3.6.1.2.1.2.2.1.17.2 = Counter32: 0
.1.3.6.1.2.1.2.2.1.18.1 = Counter32: 15
.1.3.6.1.2.1.2.2.1.18.2 = Counter32: 0
.1.3.6.1.2.1.2.2.1.19.1 = Counter32: 0
.1.3.6.1.2.1.2.2.1.19.2 = Counter32: 0
.1.3.6.1.2.1.2.2.1.20.1 = Counter32: 0
.1.3.6.1.2.1.2.2.1.20.2 = Counter32: 0
.1.3.6.1.2.1.2.2.1.21.1 = Gauge32: 0
.1.3.6.1.2.1.2.2.1.21.2 = Gauge32: 0
.1.3.6.1.2.1.2.2.1.22.1 = OID: .0.0
.1.3.6.1.2.1.2.2.1.22.2 = OID: .0.0

 

Based on this data, you should specify the following in the Discovery job:

SNMP Table OID: 1.3.6.1.2.1.2.2
Description Column: 2

If the you are interested in ifInOctets, then specify the following as an Attribute in the BP:

Attribute Description: [CI_SNMP_TABLE.ROW_DESCRIPTION] ifInOctets
SNMP OID/Operation: [CI_SNMP_TABLE.TABLE_OID].1.10.[CI_SNMP_TABLE.ROW_INDEX]

This would create 2 attributes:

Attribute Description: foo ifInOctets
SNMP OID/Operation: 1.3.6.1.2.1.2.2.1.10.1

Attribute Description: bar ifInOctets
SNMP OID/Operation: 1.3.6.1.2.1.2.2.1.10.2

If you are interested in ifOutOctets, then specify the following as an Attribute in the BP:

Attribute Description: [CI_SNMP_TABLE.ROW_DESCRIPTION] ifOutOctets
SNMP OID/Operation: [CI_SNMP_TABLE.TABLE_OID].1.16.[CI_SNMP_TABLE.ROW_INDEX]

This would create 2 attributes:

Attribute Description: foo ifOutOctets
SNMP OID/Operation: 1.3.6.1.2.1.2.2.1.16.1

Attribute Description: bar ifOutOctets
SNMP OID/Operation: 1.3.6.1.2.1.2.2.1.16.2

  • Was this article helpful?