Maintenance commands

Last Updated : Jul 27, 2023 |

The following table lists all maintenance commands that you can run on the Maintenance Shell console:

Command

Description

General

mtc help

Displays all Maintenance Shell commands.

mtc list servers

Displays the list of configured Routing Core Servers and their status.

mtc list device-history <device ID>

Displays the list of all devices that PPM stores in the database.

To display specific devices details, add the device ID to the command.

mtc list alarms <time range>

Displays the list of all alarms.

To display alarms within specific time range, add the time range to the command.

mtc version server <server ID>

Displays the container image version.

mtc version system

Displays the current version of all Routing Core Servers and Configuration Servers.

mtc version shell

Displays the current Maintenance Shell version.

mtc status health

Displays the status of all Avaya Contact Center – Extended Capacity services.

mtc status traffic

Displays the number of active login sessions and number of active users

mtc status license

Displays the license state and other details, such as expiration date, time to error, time in error, and maximum number of agents.

mtc backup server

Creates a backup file with the Routing Core Server data.

mtc restore server

Restores the Routing Core Server data from a backup file.

mtc release server <server name>

Releases the specific Routing Core Server data.

mtc test alarm raise

Sends a test alarm trap to all destinations.

mtc test alarm clear

Sends a clear test alarm trap to all destinations.

mtc busy-force server <server name>

Forces the server to the maintenance-busy state.

To force a specific server, add the server name to the command.

AE Services maintenance commands

mtc status cti-link <CTI link number>

Displays the status of a specific AE Services server and CTI link.

To view the status of a specific CTI link, add the CTI link number to the command.

mtc list cti-link <CTI link number>

Displays all configured CTI links with their status details.

To display the specific CTI link details, add the CTI link number to the command.

mtc busy cti-link <link ID>

Places the CTI links to the maintenance-busy state.

To place a specific CTI link, add the CTI link number to the command.

mtc release cti-link <link ID>

Releases the CTI link from the maintenance-busy state.

To release a specific CTI link, add the CTI link number to the command.

SIP server maintenance commands

mtc list sip-servers <SIP server ID>

Displays the list of all configured SIP servers on the Routing Core Server with their status.

To display the details of a specific SIP server, add the SIP server ID.

mtc busy sip-server <SIP server ID>

Places the SIP servers in the maintenance-busy state.

To place a specific SIP server in the maintenance-busy state, add the SIP server ID to the command.

busy-force sip-server

Forces the SIP servers to the maintenance-busy state.

mtc monitor sip-server<SIP server ID>

Displays the status of all the configured SIP servers on the Routing Core Server.

To display the status of a specific SIP server, add the SIP server ID.

mtc release sip-servers <SIP server ID>

Releases all SIP servers from the maintenance-busy state.

To release a specific SIP server, add the SIP server ID to the command.

CMS link maintenance commands

mtc list cms <CMS link ID>

Displays the list of all configured CMS links with their status.

To display the specific CMS link details, add the CMS link ID to the command.

mtc busy cms-link <link ID>

Places the CMS links to the maintenance-busy state.

To place a specific CMS link, add the CMS link ID to the command.

mtc release cms-link <link ID>

Releases the CMS link from the maintenance-busy state.

To release a specific CMS link, add the CMS link ID to the command.

Endpoint maintenance commands

mtc list stations <endpoint extension>

Displays the list of all configured endpoints.

To display the specific endpoint details, add the endpoint extension to the command.

mtc find endpoint <endpoint name>

Displays the endpoint details.

To display the details of a specific endpoint, add the endpoint name to the command.

mtc find station <endpoint name>

Searches for the specific endpoint to view its details.

To search for a specific endpoint, add the endpoint name to the command.

mtc busy stations <endpoint extension>

Places the endpoints to the maintenance-busy state.

To force a specific endpoint, add the endpoint extension to the command.

mtc busy-force station <endpoint extension>

Forces the endpoints to the maintenance-busy state.

To force a specific endpoint, add the endpoint extension to the command.

mtc release stations <endpoint extension>

Releases the endpoints.

To release a specific endpoint, add the endpoint extension to the command.

mtc reboot stations <endpoint extension>

Reboots the endpoints

To reboot a specific endpoint, add the endpoint extension to the command.

.

mtc reload stations <endpoint extension>

Reloads the endpoints.

To reload a specific endpoint, add the endpoint extension to the command.

mtc trace station <endpoint extension>

Displays the live trace of a call at the endpoints.

To view the details of a specific endpoint, add the endpoint extension to the command.

Agent maintenance commands

mtc list agents <agent ID>

Displays the list of all agents with the endpoints to which they are logged in.

To display a specific agent, add the agent ID to the command.

mtc find agents <agent name>

Displays a list of agents whose names match with the specified agent name.

You can enter multiple agent names in the command.

mtc monitor traffic

Displays the status of calls in relevant agent groups.

mtc monitor traffic <agent group ID>

Displays the status of calls in a specific agent group.

To view the call traffic details of a specific agent group, add the agent group ID to the command.

mtc monitor agent

Displays the details of a specific agent who is logged in at a specific endpoint.

Use this command to view agent details, such as login and logout time, active, available, and idle time, and offered and answered calls.

mtc trace agent <agent ID>

Displays details of the events of a specific agent who is logged in at an endpoint.

To view details of a specific agent, add the agent ID to the command.

Skill maintenance commands

mtc list skills <skill group ID>

Displays the list of skills whose IDs match with the skill group ID specified in the command.

mtc find skills <skill group name>

Displays the list of skills whose names match with the skill group name specified in the command.

mtc monitor skill <skill id>

Displays the status of all the skills.

mtc trace skill <skill group ID>

Displays the live trace of a call for a specific skill.

To view details of a specific skill, add the skill group ID to this command.

Vector maintenance commands

mtc list vectors <vector number>

Displays the list of vectors whose numbers match with the vector number.

To display a specific vector, add the vector number to the command.

mtc find vector <vector name>

Displays the list of vectors whose names match with the vector name specified in the command.

mtc trace vector <vector id>

Displays a live trace of a call for a specific vector.

To view the vector details of a specific vector, add the vector number in the command.

mtc monitor vector <vector id>

Displays the status of vectors.

To display the status of a specific vector, add the vector number or vector name in the command.

VDN maintenance commands

mtc list vdn <VDN extension>

Displays the list of all VDNs.

To display a specific VDN, add the VDN extension to the command.

mtc find vdn <VDN name>

Displays the specific VDN details.

mtc trace vdn <VDN extension>

Displays information about calls that come to a specified VDN and the vector operation details.

To display a specific VDN, add the VDN extension to the command.

mtc monitor vdn <vdn id>

Displays information about a specific VDN.

Use this command to monitor VDN details such as calls offered, calls answered, list of skills queued, and calls answered on each skill.

High Availability maintenance commands

mtc status ha

Displays the status of all High Availability nodes.

mtc node-failover forced

Starts the forced failover of the current active node.

mtc node-failover gracefully

Starts the forced failover of the current active node in green time.

mtc sync-all nodes now

Synchronizes an active and passive nodes.

mtc sync-all nodes schedule <start time> <end time>

Schedules the synchronization of an active and passive nodes.

You must type the start and end time in the HH:MM:SS format.