Home
MATRIXX Administration
Appendixes
MATRIXX Engine Scripts
You can use the following scripts to support servers, clusters, engines, pricing domains, system logging, notification messaging, and event-repository storage. Use them to gather information, perform maintenance operations, such as starting and stopping servers, configure system behavior, and manage engine failover operations.
Cluster Administration Scripts
Use the cluster administration scripts to start, stop, restart, and check the status of all logical servers in a cluster and to sync all MATRIXX directories on all servers in the cluster.
run_cmd_on_cluster.py
Runs the specified command on all servers in the specified cluster, as though the user running the command is logged into a bash shell on a server in that cluster.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
MATRIXX TM Forum Integration
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
- About MATRIXX Administration
  MATRIXX Administration describes how to monitor MATRIXX Engine components and to perform daily operations for maintaining a geographically redundant system. This includes administration for the engine, Traffic Routing Agent, MATRIXX gateways and web apps, and Notification Framework. It also provides information about recovering from a total system failure.
- Administering MATRIXX Engine
  The topics in this section have information about maintaining, managing, and resolving issues with a MATRIXX Engine installation.
- Administering MATRIXX Traffic Routing Agent
  The topics in this section describe administering Traffic Routing Agent (TRA) servers, including starting and stopping Traffic Routing Agent nodes and clusters. The information in this section applies to all Traffic Routing Agent functions unless otherwise noted.
- Administering the Route Cache
  The topics in this section describe administering the Route Cache.
- Administering US Tax Data
  US tax data is imported from CCH tax data, compiled in My MATRIXX, and output as compact MATRIXX Data Container (MDC) files, including an MDC file containing tax database metadata and status information. MDC files are packaged into a .zip file and loaded into the MATRIXX tax database.
- Troubleshooting Issues
  This section has information to help identify and resolve system issues.
- Appendixes
  - Admin Service Commands
    The Admin Service includes commands for administering MATRIXX components.
  - Engine Validation Error Codes
    The following return codes can be written to the system log when a network message is processed.
  - Python Value Type to AVP Type Mapping
    The following table describes how Python value types are mapped to AVP types.
  - MATRIXX Engine Scripts
    You can use the following scripts to support servers, clusters, engines, pricing domains, system logging, notification messaging, and event-repository storage. Use them to gather information, perform maintenance operations, such as starting and stopping servers, configure system behavior, and manage engine failover operations.
    - Analytical and Informational Scripts
      Use the scripts in this section to gather information about system performance, system topology, performance statistics, system configuration, and MATRIXX Engine versioning. All scripts run locally on a server as user mtx.
    - Configuration, Demo, and Test Scripts
      Use these scripts to configure MATRIXX Engine, create demos, and test system functionality.
    - Server Administration Scripts
      Use the following server administration scripts to administer MATRIXX Engine servers.
    - Cluster Administration Scripts
      Use the cluster administration scripts to start, stop, restart, and check the status of all logical servers in a cluster and to sync all MATRIXX directories on all servers in the cluster.
      - Cluster Administration Scripts — Command Line Options
        The scripts that can run on all servers in a MATRIXX Engine support the following command line options when they are initiated by the mtx user. Sometimes, the options are only valid for certain scripts. These cases are noted.
      - activate_cluster.py
        The activate_cluster.py script makes the specified cluster the HA ACTIVE cluster. Its purpose is to switch the state of the STANDBY cluster to an ACTIVE state.
      - check_cluster.py
        The check_cluster.py script checks that the Cluster Manager is running on each server in the specified cluster and returns status information.
      - cluster_mgr_cli.py
        The cluster_mgr_cli.py script provides a simple command line client that can be run on an off-engine server such as a Network Operation Center (NOC) to manage certain cluster operations. This script can retrieve cluster and peer cluster HA states, low-level information about cluster status, the Cluster Manager leader, and the cluster schema version. This script can also shut down a target cluster.
      - rsync_custom_dir_on_cluster.py
        The rsync_custom_dir_on_cluster.py script synchronizes the ${MTX_CUSTOM_DIR} directory on all servers in a cluster with the ${MTX_CUSTOM_DIR} directory on the local server. Synchronization is required after making configuration changes and extending MDCs.
      - run_cmd_on_cluster.py
        Runs the specified command on all servers in the specified cluster, as though the user running the command is logged into a bash shell on a server in that cluster.
      - start_cluster.py
        The start_cluster.py script starts each logical server in succession for a given cluster. If run from a server, it starts all servers in that server's cluster. If run remotely it starts all servers for the engine and cluster that you specify. Run this script as the user mtx.
    - Engine Administration Scripts
      Use the following engine administration scripts to administer the MATRIXX Engine.
    - Control Scripts for Containerized Installations
    - Failover Scripts
      Use these scripts to publish MATRIXX and clean up orphaned transaction log files after an engine failover.
    - Provisioning Scripts
      Use these scripts to provision data in the MATRIXX database.
  - Scripts and Utilities for MATRIXX Gateways and Web Apps
    Use the following scripts to administer MDC Gateway, Gateway Proxy, RS Gateway, and other MATRIXX gateways and web apps.
  - Traffic Routing Agent Administration Scripts
    Use the following scripts to administer Traffic Routing Agents (TRAs), to check the status of a TRA server, or to validate the TRA configuration.
  - MATRIXX Data Container Field Data Types
    MATRIXX Engine supports several data types for its network message MATRIXX Data Containers (MDCs) and database object MDCs. When you define custom MDCs and MDC fields, you must specify one of these data types for the fields.
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
MATRIXX Policy
MATRIXX Kafka CDR Consumer
MATRIXX Pricing and Rating
MATRIXX Pay Now
MATRIXX Subscriber Management
MATRIXX Subscriber Management API
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

run_cmd_on_cluster.py

Runs the specified command on all servers in the specified cluster, as though the user running the command is logged into a bash shell on a server in that cluster.

Syntax

run_cmd_on_cluster.py [-h] [-d] [--debug_config_file_parsing] [--debug_function_calls] [--debug_output_formatting] [--debug_threading_code] -e engineId -c clusterId [--plain] [-s] [-u username] [--ssh_debug]

If the command being called uses any options, put quotes around the entire command. For example, the following command gathers log files created in March 2012 on engine 1, cluster1, and saves them to a ZIP file:

run_cmd_on_cluster.py 1:1 "gather_logs.py -l march2012 -o zip"

Options

For descriptions of the server command line options, see the discussion about command line options for server scripts in MATRIXX Administration.

For more information about the MATRIXX environment variables, see the discussion about container directories and environment variables in MATRIXX Installation and Upgrade.

Analyze Queue Statistics on the Local Cluster

run_cmd_on_cluster.py "analyze_queue_stats.py -f ${MTX_TXN_LOG_DIR}/log_filename"