mMC CLI
The migVisor Metadata Collector Command Line Interface (mMC CLI) is a standalone command-line application for scanning relational and NoSQL databases alongside Java and C# applications. To scan sources, mMC CLI takes the input configuration files and accesses the sources by their parameters. For more details about the configuration file format, see User-Defined Source Configuration File Structure. Additionally, mMC CLI can scan single data sources using parameters set in a command.
Use mMC CLI directly from the command line shell or terminal. To run mMC CLI, unpack the archive and execute the BAT or SH file.
CLI Command-Language Syntax
After downloading the mMC CLI archive, unpack and run the executable.
mmc-cli.sh/mmc-cli.bat [scanning options] source <source type> [source-specific arguments]
mMC can scan either single databases and applications or multiple databases and applications set in a configuration file or files.
To write a command:
Provide the scanning options. The scanning options are common and can be used for any source.
Enter the
source
keyword.Specify a source type:
database
for database(s).application
for application(s).
If a single database is being scanned, provide its DB engine:
db2luw
for scanning a single DB2 LUW data source.hbase
for scanning a single HBase cluster.mongodb
for scanning a single MongoDB cluster.mysql
for scanning a single MySQL data source.oracle
for scanning a single Oracle data source.postgresql
for scanning a single PostgreSQL data source.sqlserver
for scanning a single SQL Server data source.
If a single application is being scanned, provide the main project language:
java
for scanning a single Java application.csharp
for scanning a single C# application.
If multiple databases or applications are being scanned, after specifying the
database
orapplication
source type, provide theconf
keyword.Provide source-specific arguments.
For example:
mmc-cli.sh/mmc-cli.bat [scanning options] source database oracle [oracle-specific arguments]
For more details, see Command Constructor.
To print a listing of options and arguments available in mMC CLI, run the following command:
mmc-cli.sh/mmc-cli.bat -h
To print help for a specific option or argument, add the -h
or --help
option after the positional argument.
For example, mmc-cli.sh source database conf -h
or mmc-cli.sh source application java --help
.
Arguments and Options
| Explicit query definition file(s) path. By default, query definition files are unpacked in the same folder as File names follow the template
The argument is optional. If it is not provided, mMC uses query definition files stored in the mMC working directory. If the argument is provided, then, paths must be provided for all DB engines of the scanned databases. Multiple query file names must be separated by space character. |
| Maximum number of threads used for parallel execution of queries. The default maximum number of threads is 4. |
| Metadata collection period start date. By default, one year prior to the organization account creation in migVisor. Applicable to Oracle only. |
| Metadata collection period end date. By default, the date of the organization account creation in migVisor. Applicable to Oracle only. |
| Number of minutes set for query timeout. If an individual query exceeds the timeout value it is stopped, and the next query will be executed. The default query timeout is 4 minutes. |
| Required. migVisor account username. mMC CLI displays a silent password prompt after its start. |
| Run mMC CLI in offline mode and save scan results to an encrypted file. By default, mMC runs in online mode. In online mode, mMC uploads scan results directly to mConsole. Both online and offline modes require valid migVisor credentials for internal validation. |
Usage
mmc-cli.sh/mmc-cli.bat [scanning options] source database/application conf PATH(S) [-d/--delimiter DELIMITER]
PATH(S) | Required. Configuration file path(s), delimited by the space character. The only officially supported file format is CSV. Each file must adhere to the User-Defined Source Configuration File Structure. 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 |
| Custom delimiter used to separate values in configuration file(s) set by PATH(S). Can contain any number of characters. By default, mMC attempts to detect a delimiter automatically. The auto-detected delimiters are comma, space, colon, semicolon, and tab. |
Usage
mmc-cli.sh/mmc-cli.bat [scanning options] source application LANGUAGE PATH DIALECT
Required arguments:
LANGUAGE | Application primary language. Available values: |
PATH | Application root folder path. |
DIALECT | Primary dialect. Available values: |
Usage
mmc-cli.sh/mmc-cli.bat [scanning options] source database db2luw HOST PORT --db-user USERNAME database NAME [--tags TAGS] [-h/--help]
HOST | Required. Database hostname or IP address. |
PORT | Required. TCP port. |
| Required. Database user name. |
| SSL/TLS protocols flag. |
| Required, if |
| Required. Database name. |
| Custom properties flag. |
| Required, if Custom parameters are not validated by mMC and can pose a security risk. Proper syntax and caution are required. |
| Tag(s) to assign to the data source. The maximum tag length is 32 characters. |
Usage
mmc-cli.sh/mmc-cli.bat [scanning options] source database hbase QUORUM [--zp PORT] [--mp PORT] [--hbase_config FILE] [--keytab FILE] [--krb5 FILE] [--principal NAME] [--tags TAGS] [-h/--help]
QUORUM | Required, if |
| ZooKeeper port. By default, 2181. |
| HBase master port. By default, 16000. |
| Kerberos configuration file path. |
| Required, if QUORUM is not set and |
| Required, if QUORUM is not set and |
| Required, if QUORUM is not set and |
| Tag(s) to assign to the data source. The maximum tag length is 32 characters. |
Usage
mmc-cli.sh/mmc-cli.bat [scanning options] source database mongodb HOST PORT [--cluster-name NAME] [--db-user USERNAME] [--auth-type TYPE] [--ssl] [--ca-cert PATH] [--secret PATH] [--public-key PATH] [--tags TAGS] [-h/--help]
HOST | Database hostname or IP address. |
PORT | TCP port. |
| User-defined cluster name. |
| Cluster user name. |
| Authentication type. Available values: |
| SSL/TLS protocols flag |
| Required, if |
| Required, if |
| Required, if |
| Tag(s) to assign to the data source. The maximum tag length is 32 characters. |
Usage
mmc-cli.sh/mmc-cli.bat [scanning options] source database mysql HOST PORT --db-user USERNAME --database NAME [--extended-scan] [--scan-duration DURATION] [--sample-interval INTERVAL] [--tags TAGS] [-h/--help]
HOST | Required. Database hostname or IP address. |
PORT | Required. TCP port. |
| Required. Database user name. |
| Required. Database name. |
| Extended Scan mode flag. This option triggers execution of the extended queries set that run on a source for a definite time and collect specific workload-related data. |
| Required, if |
| Required, if |
| Custom properties flag. |
| Required, if Custom parameters are not validated by mMC and can pose a security risk. Proper syntax and caution are required. |
| Tag(s) to assign to the data source. The maximum tag length is 32 characters. |
| Optional. Scans all databases in the instance. |
Usage
mmc-cli.sh/mmc-cli.bat [scanning options] source database oracle HOST PORT --db-user USERNAME [--workload] [--service NAME] [--sid SID] [--cdb] [--cdb-user USERNAME] [--cdb-sid SID] [--tags TAGS] [-h/--help]
HOST | Required. Database hostname or IP address. |
PORT | Required. TCP port. |
| Required. Database user name. |
| Workload repository. REPOSITORY Options: AWR Utilizing Oracle's Automatic Workload Repository (AWR) can offer a comprehensive workload analysis including deep insights and requires a paid license. Confirm that AWR data retention and proper licensing is in place before proceeding with this option. To allow for comprehensive analysis, when selecting a custom collection period, make sure to select a time range that encompasses relevant workload trends and peaks. Statspack Utilizing Oracle's Statspack can offer a comprehensive workload analysis similar to AWR, and is free to use. Confirm proper setup and configuration before proceeding with this option. To allow for comprehensive analysis, when selecting a custom collection period, make sure to select a time range that encompasses relevant workload trends and peaks. Dynamic Views Oracle's Dynamic Views primarily contain aggregated information collected since the last instance startup. Although it is readily available and free for immediate use without the need for additional licensing or configurations, data acquired through this method may lack the granularity needed to assess system load over time, and therefore, choosing this option will result in an inadequate representation and analysis of workload and target sizing information. During the scanning of AWR and Statspack repositories, the following requisite checks are performed:
When Dynamic Views is selected as a workload repository, the scan operation is performed in two stages:
The scan operation can be interrupted at any time during the second stage to retrieve the information collected up to that point. |
| Required, if |
| Required, if |
| Required, if SID is not set. Database service name. |
| Required, if service name is not set. Database SID. |
| Oracle Container Database (CDB) flag. If this argument is provided, provide CDB credentials using the |
| Required, if |
| Required, if |
| Custom properties flag. |
| Required, if Custom parameters are not validated by mMC and can pose a security risk. Proper syntax and caution are required. |
| Tag(s) to assign to the data source. The maximum tag length is 32 characters. |
Primary and Standby Sources Scanning
To get more accurate scanning results, perform scanning of primary Oracle sources. In the case of scanning a standby source instead of a primary one, certain metrics and features may show different results on mConsole.
Metrics
View the list of vulnerable metrics and the mConsole → Source Details sections these metrics belong to (for details, see Source Analysis):
Metric | Section |
---|---|
Server RAM, Hostname | Source Details - Overview |
Max Sessions, Max Active Sessions | Target Sizing |
OCI Applications, Non OCI Applications | Detailed Technical Dashboard |
Number of unique queries | Workload |
Database Uptime | Source Details - Overview |
SGA Utilization | Migration Insights |
Features
The following features may contain wrong data if collected from a standby source scanning:
Feature’s name | Description |
---|---|
Goldengate | Identifies processes of goldengate replication. |
FINER_GRANULARITY_SUP_LOGGING | Indicates whether the database is enabled for subset database replication. |
Database Corrupted Blocks | Indicates if database has corrupted data blocks. |
ASM Diskgroups | Indicates if database uses ASM storage. |
Platform | Indicates Oracle database platform. |
Unified Auditing | Indicates whether 'Unified Auditing' feature is enabled in the database. |
Results Cache | Indicates whether 'Results Cache' feature used in the database. |
Resource Manager | Indicates whether database utilizes Resource Manager plans other than default one. |
RMAN | Identifies RMAN backup usage. |
Real Application Clusters | Indicates whether database is Real Application Cluster database. |
Multitenant | Indicates where database uses multitenant containers. |
Large SGA | Identifies if database has more than 300 GB configured for SGA memory. |
High CPU Count | Identifies if database server has more than 96 CPU. |
DataGuard | Identifies if dataguard feature is in use. |
DBVault | Indicates whether 'Oracle Database Vault' feature is enabled in the database. |
Usage
mmc-cli.sh/mmc-cli.bat [scanning options] source database postgresql HOST PORT --db-user USERNAME database NAME [--extended-scan] [--scan-duration DURATION] [--sample-interval INTERVAL] [--tags TAGS] [-h/--help]
HOST | Required. Database hostname or IP address. |
PORT | Required. TCP port. |
| Required. Database user name. |
| Required. Database name. |
| Extended Scan mode flag. This option triggers execution of the extended queries set that run on a source for a definite time and collect specific workload-related data. |
| Required if |
| Required if |
| Custom properties flag. |
| Required, if Custom parameters are not validated by mMC and can pose a security risk. Proper syntax and caution are required. |
| Tag(s) to assign to the data source. The maximum tag length is 32 characters. |
| Optional. Scans all databases in the instance. |
Usage
mmc-cli.sh/mmc-cli.bat [scanning options] source database sqlserver HOST PORT --db-user USERNAME --database NAME [--win-auth] [--tags TAGS] [-h/--help]
HOST | Required. Database hostname or IP address. |
PORT | Required. TCP port. |
| Required. Database user name. |
| Required. Database name. Optional, if |
| Windows Authentication flag. |
| Extended Scan mode flag. This option triggers execution of the extended queries set that run on a source for a definite time and collect specific workload-related data. The scan process can be interrupted at any time during the Extended Scan stage to retrieve the information collected up to that point. |
| Required, if |
| Required, if |
| Custom properties flag. |
| Required, if Custom parameters are not validated by mMC and can pose a security risk. Proper syntax and caution are required. |
| Tag(s) to assign to the data source. The maximum tag length is 32 characters. |
| Optional. Scans all databases in the instance. |
Diagnostic options show information about the mMC application itself and do not connect to any databases.
| Print a listing of options and arguments available in mMC CLI. To print help for a specific option or argument (currently supports only source type options), add the -h or --help option after a positional argument. For example, |
| Print the version of mMC. |