[mMC CLI] Configuration File Format

mMC uses configuration files to receive a list of data source configurations.

Create and edit configuration files, using any plain text editor.

The only file format officially supported by mMC is CSV.

CSV configuration files can be of two types:

Multi-type CSV that can contain configurations for different data source types.
Single-type CSV that can contain configurations for sources of a specific DB engine type.

Supported extensions: .csv and .txt.

Configuration File Format

mMC automatically detects the following delimiters: space, tab, comma, colon, and semicolon. However, mMC also allows setting any delimiter of any length manually.

To be interpreted by mMC CLI, configuration files must have correctly defined headers.

Configuration files may contain both database and application data source configurations. If a configuration file contains both databases and applications, mMC scans only data sources that correspond with the database or application keyword in the command.

If a configuration file is single-type, its name must end with _<DB_engine>.csv. For example, config_oracle.csv or sources_sqlserver.csv. The supported DB engine names are db2, hbase, mongoDB, mysql, oracle, postgresql, and sqlserver. In single-type configuration files, the DB Engine header is not required.

If a configuration file is multi-type, it’s recommended to use any name apart from those reserved for single-type configuration files.

If a DB engine is specified in a file name but the file itself contains multi-type data source configurations, mMC ignores data sources that don't match the DB engine specified in the file name.

For sample CSV configuration files, see Sample Configuration Files.

Database Scanning Parameters

Database scanning parameters are engine-specific.

Engine-Specific Parameters

DB2

The following options apply to DB2 sources.

Parameter Name for CSV and TXT	Required	Description
DB Engine		Set to `db2` to identify a data source as a DB2 database and enable DB engine-specific headers
Name		Data source name This name must be unique among all data sources scanned at the same time.
Probe		Set to `true` (default) to scan the data source. Set to `false` to skip it.
Host		Database hostname or IP address
Port		TCP port. By default, 50000
Database ID		Database ID
User		Database user name
Password		Database user password
SSL/TLS		Set to `true` if SSL/TLS protocols are applied. Set to `false` (default) if not applied
CA Certificate		Required, if `SSL/TLS` is `true`. Certification Authority (CA) root certificate path
Tags		Tag(s) to assign to the data source The maximum tag length is 32 characters.

HBase

Parameter Name for CSV and TXT	Required	Description
DB Engine		Set to `hbase` to identify a data source as an HBase database and enable DB engine-specific headers
Name		Data source name This name must be unique among all data sources scanned at the same time.
Probe		Set to `true` (default) to scan the data source. Set to `false` to skip it
Zookeeper Quorum		Required, if no `HBase Config` value is provided. ZooKeeper host
Zookeeper Client Port		ZooKeeper port. By default, 2181
HBase Master Port		HBase master port. By default, 16000
KRB5 Config		Kerberos configuration file path.
HBase Config		Required, if `Zookeeper Quorum` is not set. Required, if `KRB5 Config` is set. `hbase-site.xml` file path
Principal		Required, if `KRB5 Config` is set. Kerberos principal name
Keytab File		Required, if `KRB5 Config` is set. Local keytab Kerberos authentication file path
Tags		Tag(s) to assign to the data source The maximum tag length is 32 characters.

MongoDB

The following options apply to MongoDB sources.

Parameter Name for CSV and TXT	Required	Description
DB Engine		Set to `mongodb` to identify a data source as a MongoDB database and enable DB engine-specific headers
Name		Data source name This name must be unique among all data sources scanned at the same time.
Probe		Set to `true` (default) to scan the data source. Set to `false` to skip it
Host		Cluster hostname or IP address
Port		TCP port. By default, 27017
User		Cluster user name
Password		Cluster user password
Tags		Tag(s) to assign to the data source The maximum tag length is 32 characters.
Cluster name		User-defined cluster name
Authentication		Authentication type. The available values are `none`, `basic` (default), `ldap`, and `x509`
SSL/TLS		Set to `true` if SSL/TLS protocols are applied. Set to `false` (default) if not applied
CA Certificate		Required, if `SSL/TLS` is `true`. Certification Authority (CA) root certificate path
Secret Key		Required, if `SSL/TLS` is `true` or if `authType` is `x509`. CA secret path
Public Key		Required, if `SSL/TLS` is `true`or if `authType` is `x509`. CA public key certificate path

MySQL

The following options apply to MySQL sources.

Parameter Name for CSV and TXT	Required	Description
DB Engine		Set to `mysql` to identify a data source as a MySQL database and enable DB engine-specific headers
Name		Data source name This name must be unique among all data sources scanned at the same time.
Probe		Set to `true` (default) to scan the data source. Set to `false` to skip it
Host		Database hostname or IP address
Port		TCP port. By default, 3306
Database ID		Database ID
User		Database user name
Password		Database user password
Timezone		Session timezone name For the available timezone name values, see the `NAME` column in the `time_zone_name` table in the https://dev.mysql.com/downloads/timezones.html.
Tags		Tag(s) to assign to the data source The maximum tag length is 32 characters.
Extended Scan		Set to `true` to use the Extended Scan mode. Specify `Scan Duration` and `Sample Interval` By default, `false`
Scan Duration		Required, if `Extended Scan` is `true`. Total number of seconds for query execution in Extended Scan mode. Must be a positive integer from 1800 to 86400 inclusive
Sample Interval		Required, if `Extended Scan` is `true`. Total number of seconds for query execution in Extended Scan mode. Must be a positive integer from 1800 to 86400 inclusive

Oracle

The following options apply to Oracle sources.

Parameter Name for CSV and TXT	Required	Description
DB Engine		Set to `oracle` to identify a data source as an Oracle database and enable DB engine-specific headers
Name		Data source name This name must be unique among all data sources scanned at the same time.
Probe		Set to `true` (default) to scan the data source. Set to `false` to skip it.
Analyze workload		Set to `true` to enable workload analysis for Oracle. By default, `false`. Requires access to Oracle AWR repository data. Be sure to configure AWR data retention and verify licensing.
Host		Database hostname or IP address
Port		The TCP port for the database. Oracle default is 1521.
SID		Database SID or service name
Service Name		Required, if no `SID` value is provided. Database service name
SID		Required, if no `Service Name` is provided. Database SID
User		Database user name
Password		Database user password
Tags		Tag(s) to assign to the data source The maximum tag length is 32 characters.
Is CDB		Oracle Container Database (CDB) flag. If set to `true`, set `CDB SID`, `CDB User`, and `CDB Password`.
CDB SID		Required, if `Is CDB` is `true`. CDB Service ID
CDB User		Required, if `Is CDB` is `true`. CDB common user name
CDB Password		Required, if `Is CDB` is `true`. CDB common user password

PostgreSQL

The following options apply to PostgreSQL sources.

Parameter Name for CSV and TXT	Required	Description
DB Engine		Set to `postgresql` to identify a data source as a PostgreSQL database and enable DB engine-specific headers
Name		Data source name This name must be unique among all data sources scanned at the same time.
Probe		Set to `true` (default) to scan the data source. Set to `false` to skip it.
Host		Database hostname or IP address
Port		TCP port. By default, 5432
Database ID		Database ID
User		Database user name
Password		Database user password
Tags		Tag(s) to assign to the data source The maximum tag length is 32 characters.
Extended Scan		Set to `true` to switch to the Extended Scan mode. Specify the Scan Duration and Sample Interval parameters. By default, `false`.
Scan Duration		Required, if `Extended Scan` is `true`. Total number of seconds for query execution in Extended Scan mode. Must be a positive integer from 1800 to 86400 inclusive
Sample Interval		Required, if `Extended Scan` is `true`. Total number of seconds for query execution in Extended Scan mode. Must be a positive integer from 1800 to 86400 inclusive

SQL Server

The following options apply to SQL Server sources.

Parameter Name for CSV and TXT	Required	Description
DB Engine		Set to `sqlserver` to identify a data source as a SQL Server database and enable DB engine-specific headers
Name		Data source name This name must be unique among all data sources scanned at the same time.
Probe		Set to `true` (default) to scan the data source. Set to `false` to skip it
Host		Hostname or IP address
Port		TCP port. By default, 1433
Database ID		Database ID
User		Required, if `Windows Authentication` is `false`. Database user name
Password		Required, if `Windows Authentication` is `false`. Database user password
Tags		Tag(s) to assign to the database The maximum tag length is 32 characters.
Windows Authentication		Set to `true` to use Windows Kerberos authentication. Set to `false` (default) if using SQL Server authentication

Application Scanning Parameters

Applications

Parameter Name for CSV and TXT	Required	Description
Name		Data source name This name must be unique among all data sources scanned at the same time.
Language		Primary language. Options: `JAVA` or `CSHARP`
Directory		Application root folder path For Windows, in the application location, use the double slashes instead of the single slashes.
Probe		Set to `true` (default) to scan the data source. Set to `false` to skip it.
Dialect		Primary dialect. The available values are `PLSQL`, `PGSQL`, `MYSQL`, `HBASE`, and `MSSQL`