Adding data sources

Use a data source to access information held in centralized data stores. These data stores might be a centralized asset database, a file system on a host, or a store accessed using a REST API. You write patterns that specify the target data source, and provide queries to extract the information required. You can use data sources to query an asset database to find the location of hosts as they are discovered.

Related topics

Discovering content from data sources

Discovering content from Web APIs

Discovering content from databases

Discovering content from hosts

A data source can be considered as a type of credential. They contain user name and password information, and are stored in the credential vault on the BMC Discovery appliance or the BMC Discovery Outpost. Data sources also contain endpoint information, though unlike credentials, this can be for a single endpoint only.

Note

The data sources shown on the UI depend on your currently installed Technology Knowledge Update (TKU). Ensure that you have the latest TKU installed. For more information about updated patterns, see the latest TKU documentation.

To add a data source, select the type of data source you want to add from the Add menu. The Add data source page is displayed. This page enables you to enter general details for the data source, such as the name, type, endpoint and so on. Depending on the data source type, you enter any additional parameters for the connection. For example, for a database, you specify a database driver, port, database name, connection timeout, credential group, and additional JDBC parameters.

To add a data source

When you add a data source, you must specify a name. The name must be unique in the BMC Discovery system, including Outposts that are disabled.

From the top-right corner of the page, to view the type of target for which you want to add the data source, click Add.
The available types are grouped into:
- Web API
- Database
- Host
Each grouping contains data source types under it.
Click an option to view the Add Data Source page and specify the details for the data source as listed in the Common details for data sources table.
Specify additional details for the selected data source type.
For more information about these details, see Additional details for data source types.
To save your data source details, click Apply, or to exit the page without saving the changes, click Cancel.

Common details for data sources

The following tables lists the information you must provide for every data source type:

Parameter	Description
Name	An appropriate name for the data source. This label is used later to search for data sources and to specify them in patterns. Specifying a name is mandatory when adding data sources. The data source name must be unique in the BMC Discovery system, including disabled BMC Discovery Outposts.
Data source type	Select the data source type. The data source types available are only from the target grouping you are adding. The groupings are: Web API Database Host
Endpoint	The endpoint of the data source. This is a single endpoint and can be an IPv4 or IPv6 address, or a resolvable host name.
Enabled	Select the check box to enable the data source. You can edit your data sources at any time or disable a given data source.
Description	Add a description that is displayed on the Data Sources page.
User – Name	Add a username for the data source.
User – Password	Add a password for the data source.

Additional details for data source types

The following sections and tables list the information you must provide for the various data source types:

Web API data sources

Each web API data source type has the following parameters.

Data source type	Parameter	Description
Dell EMC ScaleIO REST API	Timeout	Add the time (in seconds) in which a response is expected. The default value is 180 seconds.
Dell EMC ScaleIO REST API	Port	Specify the port to use to connect to the API. The default port is 443.
REST API with basic authentication	Timeout	Add the time (in seconds) in which a response is expected. The default value is 180 seconds.
	Access Protocol	Select Allow HTTP to enable REST API requests to be made over HTTP. HTTP is not a secure protocol as communication is not encrypted. This is a security risk that allows access credentials to be stolen.
	Port	Specify the port to use to connect to the API. The default port is 443.
REST API with digest authentication	Timeout	Add the time (in seconds) in which a response is expected. The default value is 180 seconds.
	Access Protocol	Select Allow HTTP to enable REST API requests to be made over HTTP. HTTP is not a secure protocol as communication is not encrypted. This is a security risk that allows access credentials to be stolen.
	Port	Specify the port to use to connect to the API. The default port is 443.
REST API with OAuth2 authentication	Client details (optional)	Specify an optional Client ID and secret to access REST APIs with OAuth2 authentication. Client ID–A client ID (if required) to access the API. Client secret–The corresponding client secret.
	Token endpoint	Enter the URL on the target where the token endpoint can be obtained. The default value is `/api/token.`
	Timeout	Add the time (in seconds) in which a response is expected. The default value is 180 seconds.
	Access Protocol	Select Allow HTTP to enable REST API requests to be made over HTTP. HTTP is not a secure protocol as communication is not encrypted. This is a security risk that allows access credentials to be stolen.
	Port	Specify the port to use to connect to the API. The default port is 443.
Control-M Web API	Timeout	Add the time (in seconds) in which a response is expected. The default value is 180 seconds.
	Access Protocol	Select Allow HTTP to enable Web API requests to be made over HTTP. HTTP is not a secure protocol as communication is not encrypted. This is a security risk that allows access credentials to be stolen.
	Port	Specify the port to use to connect to the API. The default port is 443.

Database data sources

Each database data source type has the following parameters.

Data source type	Parameter	Description
IBM Db2	Driver	Select a driver from the list of configured drivers. The default driver is: Default IBM DB2 driver. To add a new driver, or update an existing driver, see Managing database drivers.
	Port	Specify the port to use to connect to the database. The default port is 50000.
	Database Name	The name of the database to connect to.
	Timeout	Add the time (in seconds) in which a response is expected. The default value is 60 seconds.
	Credential Group	If the data source can be used for multiple database types, it can be added to a credential group in TPL. Enter the name of the credential group.
	Additional Properties	Additional properties for the JDBC driver. Enter these as a key=value pair, on separate lines.
Ingres	Driver	Select a driver from the list of configured drivers. The default driver is: Default Ingres driver. To add a new driver, or update an existing driver, see Managing database drivers.
	Port	Specify the port to use to connect to the database. The default port is 21064.
	Database Name	The name of the database to connect to.
	Timeout	Add the time (in seconds) in which a response is expected. The default value is 60 seconds.
	Credential Group	If the data source can be used for multiple database types, it can be added to a credential group in TPL. Enter the name of the credential group.
	Additional Properties	Additional properties for the JDBC driver. Enter these as a key=value pair, on separate lines.
Microsoft SQL Server	Driver	Select a driver from the list of configured drivers. The default driver is: Default Microsoft SQL Server driver. To add a new driver, or update an existing driver, see Managing database drivers.
	Port	Specify the port to use to connect to the database. The default port is 1433.
	Database Name	The name of the database to connect to.
	Timeout	Add the time (in seconds) in which a response is expected. The default value is 60 seconds.
	Credential Group	If the data source can be used for multiple database types, it can be added to a credential group in TPL. Enter the name of the credential group.
	Additional Properties	Additional properties for the JDBC driver. Enter these as a key=value pair, on separate lines.
MySQL	Driver	Select a driver from the list of configured drivers. The default driver is: Default MySQL driver. To add a new driver, or update an existing driver, see Managing database drivers.
	Port	Specify the port to use to connect to the database. The default port is 3306.
	Database Name	The name of the database to connect to.
	Timeout	Add the time (in seconds) in which a response is expected. The default value is 60 seconds.
	Credential Group	If the data source can be used for multiple database types, it can be added to a credential group in TPL. Enter the name of the credential group.
	Additional Properties	Additional properties for the JDBC driver. Enter these as a key=value pair, on separate lines.
Oracle	Driver	Select a driver from the list of configured drivers. You must select a driver depending on whether the Oracle database connection uses SID (Site Identifier) or service name. Choose one of the default values: Default Oracle driver with SID or Default Oracle driver with service name. To add a new driver, or update an existing driver, see Managing database drivers.
	Port	Specify the port to use to connect to the database. The default port is 1521.
	Database Name	The name of the database to connect to. For Oracle, the Database name corresponds to the SID or the service name.
	Timeout	Add the time (in seconds) in which a response is expected. The default value is 60 seconds.
	Credential Group	If the data source can be used for multiple database types, it can be added to a credential group in TPL. Enter the name of the credential group.
	Additional Properties	Additional properties for the JDBC driver. Enter these as a key=value pair, on separate lines.
PostgreSQL	Driver	Select a driver from the list of configured drivers. The default driver is: Default PostgreSQL driver. To add a new driver, or update an existing driver, see Managing database drivers.
	Port	Specify the port to use to connect to the database. The default port is 5432.
	Database Name	The name of the database to connect to.
	Timeout	Add the time (in seconds) in which a response is expected. The default value is 60 seconds.
	Credential Group	If the data source can be used for multiple database types, it can be added to a credential group in TPL. Enter the name of the credential group.
	Additional Properties	Additional properties for the JDBC driver. Enter these as a key=value pair, on separate lines.
Sybase	Driver	Select a driver from the list of configured drivers. You must select a driver depending on whether the Sybase database connection uses JTDS or the proprietary Sybase driver. Choose one of the default values: Default JTDS based Sybase driver or Default Proprietary Sybase driver. To add a new driver, or update an existing driver, see Managing database drivers.
	Port	Specify the port to use to connect to the database. The default port is 5000.
	Database Name	The name of the database to connect to.
	Timeout	Add the time (in seconds) in which a response is expected. The default value is 60 seconds.
	Credential Group	If the data source can be used for multiple database types, it can be added to a credential group in TPL. Enter the name of the credential group.
	Encrypt Password	Select the check box to encrypt the password. The checkbox was removed in August TKU (TKU 2020-Aug-1). To encrypt the password, you must enter `ENCRYPT_PASSWORD=true` in the Additional Properties field described below.
	Additional Properties	Additional properties for the JDBC driver. Enter these as a key=value pair, on separate lines.
Other Database	Driver	Select a driver from the list of configured drivers. There is no default driver. To add a new driver, or update an existing driver, see Managing database drivers.
	Port	Specify the port to use to connect to the database. The default port is 65535.
	Database Name	The name of the database to connect to.
	Timeout	Add the time (in seconds) in which a response is expected. The default value is 60 seconds.
	Credential Group	If the data source can be used for multiple database types, it can be added to a credential group in TPL. Enter the name of the credential group.
	Additional Properties	Additional properties for the JDBC driver. Enter these as a key=value pair, on separate lines.

Host data sources

Each host data source type has the following parameters.

Data source type	Parameter	Description
SSH (ssh settings)	SSH Port	If the host for which this credential is created is configured to listen for SSH connections on a nonstandard port, pick a port from the drop-down list. You can specify only those SSH ports that are defined in Discovery Configuration on the Administration page.
	Timeout (in seconds)	Enter a timeout period (in seconds) for a session. This timeout includes the credential handshaking (see also the Session Login Timeout). This timeout is used to control sessions. The default value is 180 seconds.
	SSH Key—Private Key File	Specify an existing SSH key that you already have deployed in your organization. Click Choose File to locate the private key and click Open to select it. For more information about setting up a private key, see Using SSH keys.
	SSH Key—Passphrase	Specify the passphrase for the UNIX host here. When you click Apply on the Add Credentials page to save the credential, the key and passphrase are validated. We recommend that when you upload the private key to the BMC Discovery machine, you protect the vault with a passphrase.
	SSH Authentication	To use an SSH key or password, select Key or Password. If you have not configured an SSH key, Key is disabled.
SSH (UNIX Settings)	Switch User?	To use the su command to change to the root or any other user, select Switch User. In the following two fields, enter the user to change to, and the corresponding password. The password text is not echoed to the screen.
	SU User—Name	Username used to log in to hosts identified by the key.
	SU User—Password	Enter the password into the password entry field; the password text is not echoed to the screen. Note: On the Edit Login Credential page, this field is displayed as Set Password. The existing password is shown as a series of asterisks in this field, and it cannot be edited. To enter a new password, select the check box. The password entry field is cleared. Now enter the new password.
	Prompt	Add a regular expression to define valid prompt characters expected.
	Force Subshell	To force the session to open a Bourne (`/bin/sh`) subshell, if the default login shell is a C shell (`/bin/csh` `/bin/tcsh`), select Yes. This selection enables you to cater to machines using nonstandard shells.
	Use password for privilege escalation	Select the check box to permit the password to be sent when a command requests a privilege escalation, for example sudo.
Windows	—	No additional Windows parameters are required.
vCenter	Timeout	Add the time (in seconds) in which a response is expected. The default value is 60 seconds.
vCenter	HTTPS Port	To choose a custom HTTPS port, choose from the ports in the list. You must already have configured a custom HTTPS port in Administration > Discovery Configuration.
vSphere	Timeout	Add the time (in seconds) in which a response is expected. The default value is 60 seconds.
vSphere	HTTPS Port	To choose a custom HTTPS port, choose from the ports in the list. You must already have configured a custom HTTPS port in Administration > Discovery Configuration.