Serviceability Commands by Managed Device Type

list-menuFeedback?
This article lists the API calls that TAC can send to your managed on-premises devices, using Collaboration Solutions Analyzer with the Serviceability service, to assist them in diagnosing issues with your collaboration infrastructure.
Table 1. Serviceability Connector Commands

Command

Purpose

serab_get_device_aliases

Returns the device aliases from the Serviceability connector. These are the aliases that the connector generates for each device when you configure a connection from Expressway to the device.

get_device_commands

Returns the commands that the connector can send to the specified device.

get_device_command_information

Returns the JSON schema for the specified device command.

Table 2. VOS Product Commands

Command

Purpose

get_system_info

Collects system health information from the specified device (alias) and copies a JSON file of the data to the specified service request.

get_product_information

Collects information about the specified device (alias), including active version, products deployed, product ID, service name, and dependent services. Copies a JSON file of the data to the specified service request.

get_service_status

Collects the status of the specified service, and copies a JSON file of the data to the specified service request.

Collects status of all services if a service is not specified.

get_perfmon_object

Collects performance counters for a specified service, and copies a JSON file of the data to the specified service request.

collect_services_logs_relative

Collects service logs for a specified service, for a specified number of units of a specified unit of time. The relative period starts when the command is issued, and the logs are copied to the specified service request.

collect_services_logs_absolute

Collects service logs for a specified service, for a specified time range. The logs are copied to the specified service request.

collect_filter_services_logs_relative

Collects service logs for a relative period (see above), and also filters the copied files by a specified regular expression.

collect_filter_services_logs_absolute

Collects service logs for an absolute period (see above), and also filters the copied files by a specified regular expression.

collect_coredump

Collects a coredump to a specified filename, and copies the file to a specified service request.

Table 3. Cisco Unified CM Commands

Command

Purpose

get_cluster_nodes

Collects information about all nodes in the specified CUCM cluster (alias) and copies a JSON file of the data to the specified service request.

get_cucm_device_information

Collects real-time information about devices registered to the specified CUCM (alias) and copies a JSON file of the data to the specified service request. See SelectCmDevice at https://developer.cisco.com/docs/sxml/#!risport70-api-reference/risport70-api-reference for more about the input parameters.

get_certificates

Collects all the public certificates from the CUCM database for the specified publisher (alias) and copies a JSON file of the data to the specified service request. You do not need to run this command on subscriber nodes.

set_service_log_level_all_nodes

Applies the specified logging level to a specified service on the specified CUCM publisher (alias). You do not need to run this command on subscriber nodes. This command returns no data, but does require that you specify a service request.

Table 4. Expressway Commands

Command

Purpose

start_diagnostic_logs

Starts diagnostic logging on the specified Expressway (alias), optionally including the pcap file.

stop_diagnostic_logs

Stops diagnostic logging on the specified Expressway (alias).

collect_diagnostic_logs

After starting and then stopping diagnostic logging, this command collects the resulting diagnostic log from the specified Expressway (alias), and copies the data to the specified service request.

Was this article helpful?
Was this article helpful?