mcsadmin Commands in 1.4¶

MariaDB ColumnStore ships with a command-line utility and administrative console called mcsadmin to configure and manage MariaDB ColumnStore deployments.

mcsadmin commands can be run as command-line arguments:

$ sudo mcsadmin getStatus

Alternatively, if you need to execute several commands, you can open the administrative console by running mcsadmin without arguments:

$ sudo mcsadmin

Command

Description

?

Get help on the Console Commands

addDbroot

Add DBRoot Disk storage to the MariaDB Columnstore System

addModule

Add a Module within the MariaDB Columnstore System. This command is used to configure a Module to the Configuration Database within the MariaDB Columnstore System. It will also install the MariaDB Columnstore Packages and setup the module to make it ready to be restored

alterSystem-disableModule

Disable a Module and Alter the MariaDB Columnstore System. This command is used to place a Module in an disable state and restart the associated processes the MariaDB Columnstore System.

alterSystem-enableModule

Enable a Module and Alter the MariaDB Columnstore System. This command is used to place a Module in an enable state and restart the associated processes the MariaDB Columnstore System.

assignDbrootPmConfig

Assign unassigned DBroots to Performance Module. This command could be used after a Performance Module and/or DBRoot is added

assignElasticIPAddress

Assign Amazon Elastic IP Address to a module (deprecated)

disableLog

Disable the levels of process and debug logging

disableMySQLReplication

Disable MariaDB Replication functionality on the system

enableLog

Enable the levels of process and debug logging

enableMySQLReplication

Enable MariaDB Replication functionality on the system

exit

Exit from the Console tool

findObjectFile

Get the name of the directory containing the first file of the object. uses Object ID (OID) or Schema Table Column

getActiveAlarms

Get Active Alarm list. Displays all the Alarms that are currently active

getActiveSQLStatements

Get List Active SQL Statements within the System

getAlarmConfig

Get Alarm Configuration Information. Can display all Alarms or a single Alarm

getAlarmHistory

Get system alarms. Get all set and clear alarms reported on the system on a daily basis

getAlarmSummary

Get Summary counts of Active Alarm

getLogConfig

Get the System log file configuration. Get the process and debug log file configuration on each Module

getModuleConfig

Get Module Name Configuration Information. Can display all Module Name parameters, parameters for a single module name, or a single parameter for a specific module name

getModuleCpu

Get a Module CPU usage. The Modules CPU Usage percentage will be displayed

getModuleCpuUsers

Get a Module Top Processes utilizing CPU. The top number of processes using more than 0% will be displayed

getModuleDisk

Get a Module Disk usage. The Modules Disk Usage will be displayed

getModuleHostNames

Get a list of Module host names (NIC 1 only)

getModuleMemory

Get a Module Memory usage. The Modules Memory Usage percentage will be displayed

getModuleMemoryUsers

Get a Module Top Processes utilizing Memory. The top number of processes using more than 0% will be displayed

getModuleResourceUsage

Get a Module Resource usage. The Modules Resource Usage will be displayed Resources consist of CPU, Memory, and Disk usage

getModuleTypeConfig

Get Module Type Configuration Information. Can display all Module Type parameters, parameters for a single module type , or a single parameter for a specific module type

getProcessConfig

Get Process Configuration Information. Can display all Process parameters, parameters for a single process, or a single parameter for a specific process

getProcessStatus

Get MariaDB Columnstore Process Statuses. Get Status of the MariaDB Columnstore Processes within the MariaDB Columnstore System

getSoftwareInfo

Get the MariaDB Columnstore Package information

getStorageConfig

Get System Storage Configuration Information. Displays storage and dbroot assignment Information

getStorageStatus

Get System Storage Status. Get Status of the MariaDB Columnstore DBRoot Storages within the MariaDB Columnstore System

getSystemCpu

Get System CPU usage on all modules. The System Modules CPU Usage percentage will be displayed

getSystemCpuUsers

Get System Top Processes utilizing CPU. The top number of processes using more than 0% will be displayed

getSystemDirectories

Get System Installation and Temporary Logging Directories

getSystemDisk

Get System Disk usage on all modules. The System Modules Disk Usage will be displayed

getSystemInfo

Get the Over-all System Statuses. Get the System, Module, Process, and Active Alarm Statuses

getSystemMemory

Get System Memory usage on all modules. The System Modules Memory Usage percentage will be displayed

getSystemMemoryUsers

Get System Top Processes utilizing Memory. The top number of processes using more than 0% will be displayed

getSystemNetworkConfig

Get System Network Configuration Information. Displays the Network Host Names and IP Addresses for all Modules, Switches, and Storage Units that make up the system

getSystemResourceUsage

Get System Resource usage on all modules. The System Modules Resource Usage will be displayed Resources consist of CPU, Memory, and Disk usage

getSystemStatus

Get System and Modules Status. Get Status of the MariaDB Columnstore System and the modules within the MariaDB Columnstore System

help

Get help on the Console Commands

monitorAlarms

Monitor alarms in realtime mode. Enter "control-C" to exit monitorAlarms command

movePmDbrootConfig

Move DBroots from one Performance Module to another. This command would be used before a Performance Module is removed or added

quit

Exit from the Console tool

redistributeData

Redistribute table data across all dbroots to balance disk usage

removeDbroot

Remove DBRoot Disk storage from the MariaDB Columnstore System

removeModule

Remove a Module within the MariaDB Columnstore System. This command is used to unconfigure a Module from the Configuration Database within the MariaDB Columnstore System

resetAlarm

Resets an Active Alarm. Resetting the Alarm will remove it from the Active Alarm Log file

restartSystem

Restarts a stopped or shutdown MariaDB Columnstore System. If system is shutdown, then a server root password should be entered if a ssh key is not defined

resumeDatabaseWrites

Resume performing writes to the MariaDB Columnstore Database

setAlarmConfig

Set an Alarm Configuration parameter

setModuleTypeConfig

Set a Module Type Configuration parameter

setProcessConfig

Set a Process Configuration parameter

shutdownSystem

Shuts down the MariaDB Columnstore System. This command stops the processing of applications on all Modules within the MariaDB Columnstore System It should be using when performing an upgrade

startSystem

Starts a stopped or shutdown MariaDB Columnstore System. If system is shutdown, then a server root password should be entered if a ssh key is not defined

stopModule

Stop a module. Used by columnstore stop script to stop individual modules.

stopSystem

Stops the processing of the MariaDB Columnstore System. It will leave the Modules powered on and the Operating Systems enable This command might be used for Software Maintenance reasons

suspendDatabaseWrites

Suspend performing writes to the MariaDB Columnstore Database

switchParentOAMModule

Switches the Active Parent OAM Module to another Performance Module. A System stop and start is performed as part of the process Command is recommended to be done while the system is idle

system

Execute a system shell command

unassignDbrootPmConfig

Unassign DBroots from a Performance Module. This command could be used before a DBRoot is removed

unassignElasticIPAddress

Unassign Amazon Elastic IP Address (deprecated)