Cisco Cisco Videoscape Voyager Vantage 3.0 User Guide
14
Overview
System Requirements
Note:
Vantage JSON Diagnostics currently supports SeaChange International VOD Web Service API calls. ARRIS VOD
and other API calls are not currently supported.
System Requirements
Vantage JSON Diagnostics requires Vantage Release 6.0 or later middleware and Cisco Explorer G6, G8, or G10 series
set-top devices. The system also must allow access to a Broadcast File System (BFS) server for storage and retrieval of
the Remote Diagnostics configuration file.
set-top devices. The system also must allow access to a Broadcast File System (BFS) server for storage and retrieval of
the Remote Diagnostics configuration file.
Configuration
The JSON Diagnostics feature is configured by setting parameters in a configuration file named diagnostics.ini, which is
stored on the BFS server at bfs://msconfig/rtn/<hubid>. This file provides all configuration parameters in name-value
pair format. Vantage reads this file from BFS and loads it for reference in the folder /rtn/DWS.
stored on the BFS server at bfs://msconfig/rtn/<hubid>. This file provides all configuration parameters in name-value
pair format. Vantage reads this file from BFS and loads it for reference in the folder /rtn/DWS.
Note:
For Remote Diagnostics to function, the diagnostics.ini file must exist in /rtn/DWS and all parameters must be
present and have valid values.
For additional details, see
.
REST APIs
Remote Diagnostics uses two REST-compliant Web Service APIs to enable the retrieval of diagnostic information:
A Public REST API is a simple HTTP server in the headend that is used to request on-screen diagnostics and the
current diagnostic log file from an HTTP client in each set-top. This API supports the “pull” aggregation method.
current diagnostic log file from an HTTP client in each set-top. This API supports the “pull” aggregation method.
A Private REST API is a simple HTTP server in each set-top that is used to deliver error or log text to a designated
HTTP client in the headend. This API supports the “push” aggregation method.
HTTP client in the headend. This API supports the “push” aggregation method.
For additional details, see
.
Available Data
Vantage JSON Diagnostics can remotely access all of the data available from Vantage set-tops through the on-screen
diagnostics interface. For reference, this document incorporates the Vantage Diagnostic Screens Technical Reference
Guide - Software Release 6.0 for G6, G8, and G10 Set-Tops, which describes each field in the on-screen diagnostics
by category, screen, and page.
diagnostics interface. For reference, this document incorporates the Vantage Diagnostic Screens Technical Reference
Guide - Software Release 6.0 for G6, G8, and G10 Set-Tops, which describes each field in the on-screen diagnostics
by category, screen, and page.
Instructions for accessing the diagnostic information from the set-top are also included. For details, see
.
VOD Error Logs
Vantage can generate critical error logs on behalf of the VOD server when browsing catalogs or playing VOD assets. For
additional details, see
additional details, see
.
Data Aggregation
To collect and analyze the data provided by JSON Diagnostics, use the application software of your choice and the
organization and display methods best suited to your purposes.
organization and display methods best suited to your purposes.
The following illustration shows one example. Here, a single set-top device is chosen by its IP address and polled for its
onscreen diagnostic information, which is delivered to the application as a single JSON file.
onscreen diagnostic information, which is delivered to the application as a single JSON file.