Admin Service Commands

The Admin Service includes commands for administering MATRIXX components.

Admin Service Engine Commands describes the Admin Service commands that administer MATRIXX Engine. These commands require that the engine.enabled property is set to true.

Table 1. Admin Service Engine Commands
Command	Description	Required User Role
`mtxctl engine start`	Starts the engine.	MTX_CLI_ADMIN
`mtxctl engine stop`	Stops the engine.	MTX_CLI_ADMIN
`mtxctl engine stats`	Runs the `print_blade_stats.py` utility on the selected engine pod and prints the results. For more information, see the discussion about `print_blade_stats.py`.	MTX_CLI_READ_ONLY
`mtxctl engine checkpoint create`	Runs the `create_checkpoint.py` utility on the selected engine checkpointing pod and prints the results.	MTX_CLI_ADMIN
`mtxctl engine checkpoint list`	Lists the checkpointing directories in /shared/checkpoints on the selected checkpointing engine pod.	MTX_CLI_READ_ONLY
`mtxctl engine checkpoint validate`	Runs the `validateCheckpoint.jar` utility on the selected checkpointing engine pod and downloads the results.	MTX_CLI_READ_ONLY
`mtxctl engine trace subscriber`	Runs the `set_subscriber_trace.py` utility on the selected engine pod and prints the results.	MTX_CLI_ADMIN

Admin Service Event Repository Commands describes the Admin Service commands that administer the Event Repository. These commands require that the global.mongodb.connectionString property is configured.

Table 2. Admin Service Event Repository Commands
Command	Description	Required User Role
`mtxctl eventrepository config check`	Runs the `check_event_repository_configuration.py` utility on an existing engine pod.	MTX_CLI_READ_ONLY
`mtxctl eventrepository config init`	Runs the `configure_event_repository.py` and `create_event_repository_partitions.py` utilities on an existing engine pod.	MTX_CLI_ADMIN
`mtxctl eventrepository loader stats`	Runs the `print_event_repository_loader_stats.py` utility on an existing engine pod.	MTX_CLI_READ_ONLY
`mtxctl eventrepository loader trace`	Runs the `print_event_repository_loader_trace.py` utility on an existing engine pod.	MTX_CLI_READ_ONLY

Admin Service General Ledger Commands describes the Admin Service commands that administer General Ledger (GL) posting and processing. These commands require that general-ledger.posting.enabled property is set to true.

Table 3. Admin Service General Ledger Commands
Command	Description	Required User Role
`mtxctl generalledger posting run`	Runs the GL posting process as a new Kubernetes job.	MTX_CLI_ADMIN
`mtxctl generalledger processor run`	Runs the GL processor as a new Kubernetes job.	MTX_CLI_ADMIN

Admin Service Data Export Commands describes the Admin Service commands that control data export.

Table 4. Admin Service Data Export Commands
Command	Description	Required User Role
`mtxctl dataexport run`	Runs the `data-export.jar` utility on an existing engine pod and downloads the result.	MTX_CLI_ADMIN

For more information about required user roles, see the discussion about required roles in MATRIXX Installation and Upgrade.