Serviceability Commands by Managed Device Type in webex

Using Collaboration Solutions Analyzer with the Serviceability service, TAC is able to send API calls to your managed on-premises devices, which they can use to diagnose problems with your collaboration infrastructure based on the data collected through Collaboration Solutions Analyzer.

Serviceability Connector

Table 1. Serviceability Connector Commands

Command	Purpose
serab_get_device_aliases	From the Serviceability connector, this function returns the device aliases. In the configuration of a connection from Expressway to a device, the connector generates a list of aliases that will be used to identify the device.
get_device_commands	The connector returns a list of commands that can be sent to the device specified by the connector.
get_device_command_information	The device command specifies a JSON schema that is returned by the function.

Voice Operating System (VOS) Products

Table 2. VOS Product Commands

Command	Purpose
get_system_info	A JSON file containing information on the status of the device is created and copied to the service request associated with the specified device (alias).
get_product_information	Finds information about a device (alias), including the name of the device, its active version, deployed products, product IDs, and dependent services. It copies the data in a JSON format to the service request specified in the request.
get_service_status	Data about the status of a specified service is collected, and a JSON file is copied to the service request containing the data about the service. In the absence of a specific service, this method collects the status of all services.
get_perfmon_object	In this function, you can collect performance counters for a service you specify, and you can export them as a JSON file, and attach it to your service request.
collect_services_logs_relative	Collect logs pertaining to a given service over a specified period of time for a given number of units within a certain unit of time for a specified service. Logs for the specified service request are copied to the relative period as soon as the command is issued.
collect_services_logs_absolute	This capability allows a user to collect log files over a specified period of time for a specific service, enabling the collection of critical information. In order to copy the logs, a service request must be specified so that the logs can be copied.
collect_filter_services_logs_relative	As well as collecting service logs for a certain period of time (see above), it also filters the copied files according to a regular expression that is specified.
collect_filter_services_logs_absolute	The program collects and filters the previously copied files according to a regular expression and stored them in a database for a specified period of time (see above).
collect_coredump	A coredump file is collected and copied to a specified service request after it has been collected to the exact filename.

Cisco Unified Communications Manager

Table 3. Cisco Unified CM Commands

Command	Purpose
get_cluster_nodes	It is used to collect information about all the nodes in the cluster (alias) specified by the client, and then use that information to create a JSON file from the data in the service request.
get_cucm_device_information	CUCMs (aliases) can be associated with JSON files containing information about devices registered with them. In order to receive the real-time information about devices registered to the specified CUCM (aliases), the appropriate service request is copied and pasted. See SelectCmDevice at https://developer.cisco.com/docs/sxml/#!risport70-api-reference/risport70-api-reference for more about the input parameters.
get_certificates	It is responsible for gathering all public certificates for the publisher (alias) specified in the service request that are stored in the CUCM database. This information is copied as a JSON file to the service request. This command is not required to be run on subscriber nodes since it does not modify anything on them.
set_service_log_level_all_nodes	Log levels are applied to services on CUCM publishers (aliases). The subscriber nodes do not need to be executed with this command. You will not receive any data when you run this command, but you will have to specify a service request in order for it to work.

Cisco Expressway Series

Table 4. Expressway Commands

Command	Purpose
start_diagnostic_logs	The selected Expressway (alias) will be logged on with a diagnostic logging process, including a pcap file if requested.
stop_diagnostic_logs	The specified Expressway (alias) will be stopped from logging diagnostic data (alias).
stop_diagnostic_logs	A diagnostic log is collected and copied to the specified service request after diagnostic logging is started and stopped for the specified Expressway (alias).