Setting up a CMDB synchronization connection

This topic provides instructions for configuring synchronization from BMC Discovery to one or more instances of BMC Atrium CMDB, and a Remedyforce CMDB.

Before you begin

Before you can synchronize from BMC Discovery to any instance of BMC Atrium CMDB, you must have prepared that CMDB. For a Remedyforce CMDB, you do not have to prepare the CMDB, though you do have to create a connected application in Remedyforce. See the Remedyforce documentation for more information.

CMDB synchronization and clusters

When configuring CMDB synchronization from a cluster, you can use any machine for the initial configuration and subsequent updates. All data synchronized to any connected BMC Atrium CMDB is sent from the coordinator.

Note

Do not change the CMDB synchronization configuration at the same time that you change the cluster configuration.

  • Changing the CMDB sync configuration means adding connections, removing connections, and starting or stopping a resync. 
  • Changing the cluster configuration means adding members, removing members, moving the coordinator, or changing fault tolerance.

To configure a CMDB synchronization connection

  1. Log in to BMC Discovery.
  2. From the main menu, click the Administration icon.
    The Administration page displays.
  3. From the Model  section, click  CMDB Sync
    If no CMDB Sync has been configured, a banner displays stating that the no CMDB Sync connections are configured
  4. Click Add CMDB Connection  to add and configure a new connection
  5. Enter the required details on the Add CMDB Connection page. For more information about the connection details, see Connection details.
  6. Click Test Connection to verify that the new connection can be reached and the credentials are valid. Testing the connection also retrieves the list of companies from the CMDB for connections other than Remedyforce.

The following image shows a successful connection.


Connection details 

Enter the following details on the Add CMDB Connection page.

Connection name

FieldDescription
NameThe name of the CMDB Sync connection
Access Mechanism

The access mechanism to use to connect to the CMDB:

  • CMDB API - The CMDB REST API access mechanism is preferred as it uses a more secure encryption protocol.
  • Remedy CMDB (REST API) – Requires CMDB 9.1 SP3 and later.
  • Remedyforce

Select the mechanism to use for the connection. The UI refreshes to provide the correct options for the access mechanism that you selected. 

Username

The user name of the CMDB user that is at least a member of a group having the CMDB Data Change All role. If in doubt, create a dedicated discovery user with the same profile as the standard CMDB Demo user.

At minimum, the CMDB Demo user permissions are required for multitenancy to work.

A user is not permitted to connect to the CMDB from a second IP address within 4 hours of their last activity at the first IP address. For a failover scenario, you could also create a second discovery user to connect from the failover appliance.

(info) The Multitenancy option is not available when synchronizing to Remedyforce CMDBs.

Password

The password of the CMDB user (or blank if the user has no password)

Options based on access mechanism

 Options for CMDB API


FieldDescription

Network Address

The BMC Atrium CMDB host. This can be specified as one of the following:

  • Hostname or FQDN
  • IPv4 or IPv6 address
    If BMC Atrium CMDB is installed with an AR System server group, you must enter the following based on the high availability status of the server group:
    • (If high availability is configured) The host name or IP address of the load balancer.
    • (If high availability is not configured) The host name or IP address of the primary AR System Server.
      To learn about the AR System server groups configuration, see the corresponding documentation for versions 8.1, 8.0, and 7.6.04.
      To learn about the AR System server high availability configuration and hardware load balancer, see the corresponding documentation for versions 8.1, 8.0, and 7.6.04.

Specify TCP Port

The communication port. BMC Atrium CMDB typically uses a portmapper service to automatically choose a suitable communication port. If this is not appropriate in your environment, you can configure the CMDB to listen on a specific port, and then specify that port in this field.

Specify RPC Queue

Specify a private RPC queue to use on BMC Atrium CMDB. Ensure that you have configured private queues on the CMDB before using this setting. See Configuring CMDB synchronization through a private queue for more information. The following queue numbers can be used:

  • 390696 (the default, which is also used by the CMDB for various tasks)
  • 390698 (used by Reconciliation)
  • 390699 (used by Normalization)


 Options for CMDB REST API


FieldDescription
REST API URLThe complete URL for the CMDB REST API, including protocol and (if non-standard) the port. For example https://cmdb.example.com:8443/
The following are optional if the REST API is accessed through a proxy.
HTTP Proxy AddressIP address or DNS address of the proxy. Note that if the API URL is an HTTPS URL, the proxy is contacted with HTTPS; if it is an unencrypted HTTP URL, the proxy is contacted with HTTP.
HTTP Proxy PortProxy port to use.
HTTP Proxy UsernameFor authenticating proxies, the proxy username.
HTTP Proxy PasswordFor authenticating proxies, the proxy password.


 Options for Remedyforce

FieldDescription
Production Environment Select the check box if you are synchronizing to a Remedyforce production environment. For production environments, the system uses https://login.salesforce.com for the connection and security verification. This is the default. Deselect the check box if you are synchronizing to a test environment. For test environments, the system uses https://test.salesforce.com for the connection and security verification.
Consumer Key

Enter the consumer key that you obtained from the Connected App. For more information about obtaining the consumer key, see Integrating Remedyforce with BMC Discovery.

Consumer Secret Enter the consumer secret that you obtained from the Connected App. For more information about obtaining the consumer secret, see Integrating Remedyforce with BMC Discovery .
The following are optional if Remedyforce is accessed through a proxy.
HTTP Proxy AddressIP address or DNS address of the proxy. Note that because the Salesforce login URLs are HTTPS, the proxy is always contacted with HTTPS.
HTTP Proxy PortProxy port to use.
HTTP Proxy UsernameFor authenticating proxies, the proxy user name.
HTTP Proxy PasswordFor authenticating proxies, the proxy password.

Common options

FieldDescription
Continuous Sync

Select the check box to enable continuous sync for this CMDB connection.

During continuous CMDB synchronization, whenever BMC Discovery finishes scanning a device, it is added to the synchronization queue. Similarly, whenever a device node is removed due to aging, it is also queued for synchronization, meaning that the deletion is propagated into the CMDB. In this way, the CMDB stays completely synchronized with BMC Discovery.

Batch Size

Enables you to configure the batch size used for batch operations. If you experience timeouts during a batched operation, most likely during a resync, these may be prevented by setting it to a lower value. You can set the batch size to anything between 1 and 1000. The default is 100.

Concurrent Workers

Enables you to specify the number of workers used by the CMDB sync process. You can set the number of workers from 1 to 20. The default is 1.

The best practice is to start from the default and gradually increase the number up to when sync rate keeps up with discovery rate.

Dataset ID

The ID of the dataset used for Discovery data. The default is BMC.ADDM.
(info)The Dataset ID option is not available for connections to Remedyforce.

Data Model

The data model for your CMDB. Different versions of the CMDB have different data models, so the data from BMC Discovery must be transformed differently according to the CMDB version.
The preferred value for Data Model is Standard impact population

Select the correct data model from the menu. If you select an incorrect value, you might encounter errors during synchronization.

Data model valueEffect

Standard impact population

HasImpact and ImpactDirection attributes are set as appropriate.

No impact detailsNo impact details are set by BMC Discovery. They may be set by Impact Normalization in the CMDB for connections other than Remedyforce.

Multitenancy

Multitenancy support. Selecting this check box enables you to choose a default company name from the drop-down list to assign to a discovery run during an initial scan. The list of companies is not populated until one connection has been successfully tested, or you click Get Companies (which also tests the connection).

This section is always displayed. However, if another connection exists, instead of the multitenancy configuration options, a message stating Configure multitenancy from the overview page is displayed along with a link to the CMDB Sync page.

(info) The Multitenancy option is not available when synchronizing to Remedyforce CMDBs.





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

Comments

  1. Stefan Hall

    Does the sync via REST API also use an RPC port and what is this port? Could I change this one too?

    Jun 29, 2018 01:45
    1. Duncan Grisby

      No, it does not use an RPC queue. The RPC queue numbers are only pertinent to the old ONC RPC based API. The REST API is a totally distinct entry point into the CMDB. You just need the address and TCP port.

      Jul 02, 2018 03:52
  2. Gustavo Del gerbo

    Can REST API connection be used also with LoadBalancer name?

    Apr 17, 2019 02:45