204
Cisco Systems, Inc. www.cisco.com JSON Diagnostics for VOD User Guide Vantage Software Release 6.x for G6, G8, and G10 Set-Tops First Published: May 19, 2016 Note: This product requires a separate license. Contact your Cisco account manager for purchasing details.

JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Embed Size (px)

Citation preview

Page 1: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

JSON Diagnostics for VOD User GuideVantage Software Release 6.x for G6, G8, and G10 Set-TopsFirst Published: May 19, 2016

Note: This product requires a separate license. Contact your Cisco account manager for purchasing details.

Cisco Systems, Inc. www.cisco.com

Page 2: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.All printed copies and duplicate soft copies are considered un-Controlled copies and the original on-line version should be referred to for latest version.Cisco has more than 200 offices worldwide. Addresses, phone numbers, and fax numbers are listed on the Cisco website at www.cisco.com/go/offices.Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL:www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

© 2016 Cisco Systems, Inc. All rights reserved.

2

Page 3: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14REST APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Available Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14VOD Error Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Data Aggregation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Configuration and Performance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

REST APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Public REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

General Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Supported URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Optional Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Combining Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21HTTP Status Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Private REST API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22General Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Supported URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Optional Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23HTTP Status Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

VOD Error Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

3

Cisco Systems, Inc. www.cisco.com

Page 4: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

VODCAT Initialization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Success Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Failure Cases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

DLOG|SPM_VODCTLG|ERROR|Vod Diagnostics Init failed . . . . . . . . . . . . . . . . . 29VOD Catalog Browse / Entitlement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Failure Cases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31On Demand Session Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Failure Cases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32On Demand Playback/Trickplay. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Failure Cases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Using Channel Change Data to Identify an RF Issue. . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Using Reboot Log Data to Identify a Faulty DNCS Hub ID . . . . . . . . . . . . . . . . . . . . . . . 35

Accessing Vantage Diagnostic Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Accessing Diagnostics Using the Set-Top Front Panel Buttons . . . . . . . . . . . . . . . . . . . 37Accessing Diagnostics Using the Set-Top Remote Control . . . . . . . . . . . . . . . . . . . . . . 37Identifying Information in Vantage Diagnostic Screens. . . . . . . . . . . . . . . . . . . . . . . . . . 38

Setting Screen Transparency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Exiting the Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Rebooting the Set-Top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Summary Information Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Pages 1-4: Summary Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Pages 5-8: Error Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Manufacturer Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Host Status Summary Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Host Bootloader Information Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Host Component Information Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Host QAM Status Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Host DAVIC Status Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Host DOCSIS Status Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Page 1: Configuration and Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Page 2: Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Pages 3-5: DOCSIS Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Pages 6-13: DSG Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

4

Page 5: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Page 14: SEB Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Pages 15-22: SEB Connected Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

DOCSIS DSID Forwarding Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68DOCSIS Downstream Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69DOCSIS Upstream Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71DVR Information Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Page 1: Physical Drive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Pages 2-4: Partition Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Linux Memory Information Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74CableCARD Information Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Common Download Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Platform Status Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Media Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Decoder/Encoder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Audio Channel Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Direct FB Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Page 1: RP Video Stream Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Page 2: RP Screen and Layer Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91InBand SEC Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94MPEG Disp Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Home Networking Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Pages 1-2: UPnP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Page 3: Streaming (Client) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Pages 4-6: Failed Streaming Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Pages 7-10: Streaming (Server) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Page 11: Media Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

System Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Pages 1-4: In-Band Network Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Page 5: OOB Network Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Page 6: DOCSIS Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Page 7: Device Address Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Page 8: HDMI Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Card Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Summary Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

5

Page 6: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

DVR Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Page 1: Physical Drive Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Page 2: Partition Information Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Home Networking Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Host Status Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114MoCA Summary Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114MoCA Node Rate Table Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116MoCA Node Power Level Table Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117MoCA Node Statistics Table Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Cisco CAS Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Page 1: Cisco Conditional Access Kernel Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Page 2: CAM Status Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Page 3: IPPV Information Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Services Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Services Summary Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132N/W and Tuning Status Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Second Tuner Status Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Digital Video Status Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Copy Protection Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148VOD Information Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153VOD Diag Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155SAM Information Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157SAM EDCT Information Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157RF Statistics Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159DVR Status Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163PPV Summary Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164SDV Diagnostic Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Page 1: Client and Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Page 2: Media Carousel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Page 3: Session and Tuner Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

EAS Diagnostic Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177EPG Info Diagnostic Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

6

Page 7: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

WiFi Summary Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Page 1: Access Point Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Pages 2-3: WiFi IP Client Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Proxy Summary Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183Page 1: BFS, SA CVT, and Image Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Pages 2-3: IP Client Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

WebServices Summary Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Page 1: REST Web Server Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187Page 2: REST Web Clients Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187Pages 3-5: REST Web Services Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

Post & Boot Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Post & Boot Result Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Version and MACs Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Version and MACs Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

HDD Information Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Page 1: DVR Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Pages 2-3: Partition Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

CableCARD MMI Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197CableCARD MMI Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Media Shrink Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Page 1: Media Shrink Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Page 2: Media Shrink Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Page 3: Media Shrink History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Reboot STB Diagnostic Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Rebooting the Set-top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

7

Page 8: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

8

Page 9: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

PrefaceAbout This Guide

This guide is a resource for service providers planning to implement the Vantage JSON Diagnostics feature to retrieve diagnostic data from Explorer G6, G8, and G10 series set-tops. Vantage JSON Diagnostics provides set-top diagnostic and error log information to third-party software in the headend for performance charting, analysis, and troubleshooting.

Examples of tasks that you can perform using Vantage JSON Diagnostics include the following:

Examine set-top VOD error logs

Review set-top VOD purchase or rental histories

Identify installed set-top software components

Verify set-top network configuration

Determine if and when a decryption failure occurs

Evaluate set-top RF tuner and signal health

Assess overall system response times

AudienceThis guide is written for network operators and other personnel who have experience using diagnostic information from Vantage set-tops for performance analysis and troubleshooting.

9

Cisco Systems, Inc. www.cisco.com

Page 10: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Preface

Organization

OrganizationThis guide includes the following sections:

Section Title Description

Overview, page 13 Briefly describes the Remote Diagnostics feature.

Configuration, page 17 Lists and describes the configuration options available for Remote Diagnostics and how to enable them.

REST APIs, page 19 Provides a reference for the APIs used to trigger the transfer of diagnostic data from a set-top population to the headend.

VOD Error Logs, page 25 Identifies error logs that can be collected by Remote Diagnostics and describes the possible significance of each.

Best Practices, page 35 Suggests specific use cases for set-top diagnostic information in performance analysis and troubleshooting.

Accessing Vantage Diagnostic Screens, page 37 Explains how to access diagnostics, identify diagnostic information, exit diagnostics, and reboot the set-top.

Summary Information Diagnostics, page 39 Describes the information available about the status of system initialization, system description, and boot status.

Manufacturer Diagnostics, page 45 Describes the status information available about the Bootloader, system components, Conditional Access (CA), DVR (if equipped), Linux memory, QAMs, the network, DOCSIS, common downloads, platform components, and the home network.

System Diagnostics, page 99 Describes real-time statistics available on the in-band channels on your system.

Card Diagnostics, page 105 Describes the available CableCARD summary information and explains how to view any additional information provided by the card manufacturer.

DVR Diagnostics, page 109 Describes the information available about the hard disk drive on the set-top that stores digital video.

Home Networking Diagnostics, page 113 Describes the information available about the clients connected to the network, the host and client digital rights management (DRM) capability, and the MoCA network.

Cisco CAS Diagnostics, page 119 Describes the information available about Cisco CA encryption, the conditional access system, and Internet pay-per-view (IPPV) purchases.

Services Diagnostics, page 129 Describes the status and other diagnostic information available on tuners, video, copy protection, VOD, SAM, PPV, SDV, EAS, EPG, and (if suitable hardware is attached) information related to Wi-Fi and IP Client support.

Post & Boot Diagnostics, page 189 Explains how to review power-up self-test results from the set-top in order to confirm hardware component status, boot status, and readiness to receive data.

Version and MACs Diagnostics, page 191 Explains how to verify the version numbers and serial numbers for all applicable hardware and software modules in the set-top.

HDD Information Diagnostics, page 193 Describes the information available about the hard drive installed in a DVR-equipped set-top.

10

Page 11: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Preface

Conventions

ConventionsThis document uses the following conventions.

Note: Means reader take note. Notes contain helpful suggestions or references to material not covered in the manual.

Caution: Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data.

Warning: IMPORTANT SAFETY INSTRUCTIONS Means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with standard practices for preventing accidents. Use the statement number provided at the end of each warning to locate its translation in the translated safety warnings that accompanied this device. SAVE THESE INSTRUCTIONS

Regulatory: Provided for additional information and to comply with regulatory and customer requirements.

Obtaining Documentation and Submitting a Service RequestFor information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service request, and gathering additional information, see What’s New in Cisco Product Documentation.

To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the What’s New in Cisco Product Documentation RSS feed. The RSS feeds are a free service.

CableCARD MMI Diagnostics, page 197 Explains how to access the MMI diagnostic screen displayed by the CableCARD module, if installed.

Media Shrink Diagnostics, page 199 Describes the information available to monitor and troubleshoot Media Shrink, a feature that increases the recording capacity of a set-top by transcoding MPEG2 video to MPEG4 format.

Reboot STB Diagnostic Screen, page 203 Explains how to access the Reboot STB diagnostic screen that lets you conveniently reboot the set-top.

Conventions Indication

bold font Commands and keywords and user-entered text appear in bold font.

italic font Document titles, new or emphasized terms, and arguments for which you supply values are in italic font.

[ ] Elements in square brackets are optional.

{x | y | z } Required alternative keywords are grouped in braces and separated by vertical bars.

[ x | y | z ] Optional alternative keywords are grouped in brackets and separated by vertical bars.

string A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.

courier font Terminal sessions and information the system displays appear in courier font.

< > Nonprinting characters such as passwords are in angle brackets.

[ ] Default responses to system prompts are in square brackets.

!, # An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line.

11

Page 12: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Preface

Conventions

12

Page 13: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

OverviewVantage JSON Diagnostics provides an HTTP transport method for retrieving diagnostic and error log information from Cisco Explorer G6, G8, and G10 series gateways. As a service provider, you can aggregate this data in a variety of ways to help analyze network performance and troubleshoot problems down to the level of an individual set-top.

Vantage diagnostic data is obtained from set-tops in one of two ways:

Pulling (polling) each set-top in turn from the headend

Pushing (transmitting) from each set-top to the headend

Both methods are initiated using Web Service APIs and pass data in JSON format. (Unformatted text is also an option.) The operator controls many aspects of diagnostic collection by setting parameters in a configuration file.

13

Cisco Systems, Inc. www.cisco.com

Page 14: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

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 RequirementsVantage 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.

ConfigurationThe 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.

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 Configuration, page 17.

REST APIsRemote 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.

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.

For additional details, see REST APIs, page 19.

Available DataVantage 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.

Instructions for accessing the diagnostic information from the set-top are also included. For details, see Accessing Vantage Diagnostic Screens, page 37.

VOD Error LogsVantage can generate critical error logs on behalf of the VOD server when browsing catalogs or playing VOD assets. For additional details, see VOD Error Logs, page 25.

Data AggregationTo 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.

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.

14

Page 15: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Overview

Data Aggregation

The menu system allows the operator to drill down through the file to view the category, screen, and page of interest. The corresponding JSON data appears in the window at right.

Given the many possible combinations of data, collation method, and display format, the best general recommendation is to chose with a specific diagnostic purpose in mind. This guide includes suggestions for using JSON diagnostics to identify and troubleshoot specific network and set-top issues. For details, see Best Practices, page 35.

15

Page 16: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Overview

Data Aggregation

16

Page 17: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

ConfigurationIntroduction

The Vantage Diagnostics configuration file, diagnostics.ini, provides the configuration parameters for the operation of the diagnostics. The file is available from BFS in the path bfs://msoconfig/rtn/<hubid>/diagnostics.ini. All parameters included in diagnostics.ini are set in <name>=<value> format, with each name-value pair separated by a new line.

Vantage reads this file from BFS during initialization, loads it for reference in the folder /rtn/DWS, and configures itself according to the parameters specified in the file. Vantage also keeps the diagnostics.ini file up to date with any BFS changes.

Note: JSON Diagnostics requires that the diagnostics.ini file exist in /rtn/DWS and that all parameters be present and have valid values. If the configuration file is missing or incomplete, Vantage disables JSON Diagnostics.

The following example shows typical contents for a configuration.ini file.

[PUBLIC_CONFIG]http-port-public=10086#[ASYNC_CONFIG]diaglog-size-kb=2000diag-copies=20diag-carry-over=200circular-buffer-size-objs=2000http-post-rate=2http-post-burst-interval=2http-url-collector=http://10.10.1.3:10083/diagnostics/osd/pages#[LOG_FWD]DL_MSP_MPLAYER=DLOGL_NORMALDL_MSP_AVPM=DLOGL_ERRORDL_SPM_VODCTLG=DLOGL_NORMAL

In this example, http://10.10.1.3:10083/diagnostics/osd/pages is the collector URL on the headend network. The three files specified in the [LOG_FWD] section (DL_MSP_MPLAYER=DLOGL_NORMAL, DL_MSP_AVPM=DLOGL_ERROR, and DL_SPM_VODCTLG=DLOGL_NORMAL) are pushed to this URL by each set-top in the network.

Configuration and PerformanceThe transfer of diagnostic and logging information from each set-top to the headend unavoidably reduces the bandwidth available for content delivery. Conditions such as a persistent defect in a set-top or remote control can trigger aggressive error logging activity, and with that, the potential to noticeably degrade performance.

To help reduce any such impact, JSON Diagnostics includes configuration parameters that limit the size of an individual log file, and that specify which error logs are included for transfer to the headend. These and other configuration options are described below.

Configuration ParametersThe following table describes all configuration parameters and identifies their default values and value ranges.

17

Cisco Systems, Inc. www.cisco.com

Page 18: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Configuration

Configuration Parameters

Table 1 JSON Diagnostics Configuration Parameters

Name Value Description Default Value

Allowed Range<min, max>

http-port-public <Port Number> Port number for the Public REST API. If this parameter is not specified, the default value is used.

10086 N/A

diaglog-size-kb <size in kb> Indicates when the diaglog should be rotated (similar to slog).

100 <100, 2048>

diag-copies <max files to save>

The number of diagnostic log files to save (compressed).

1 <1,10>

diag-carry-over <messages to keep on rotate>

Number of messages to save in older log files. For log rotation, existing log files are renamed to a new name such as mv diagnostics.log diagnostics.1 followed by a call such as tail -200 new-name > diagnostics.log, where 200 is the number of messages saved in the file.

200 <200, 600>

circular-buffer- size-objs

<max objects to be stored>

Maximum number of events that can be queued for transport and pulled using the post rate value. If this constraint cannot be met, objects are dropped, oldest first. A buffer helps to even out data traffic during periodic heavy logging.

During heavy logging, new messages push out the oldest ones so that the data collector holds only the most recent events. There is no signaling when events have been dropped.

200 <200, 2000>

http-post-rate <max average number of objects per sec>

Used with the http-post-burst-interval parameter for HTTP POST rate smoothing, if http-url-collector is specified.

1 <1, 20>

http-post-burst-interval

<time interval in secs >

Used to determine the number of messages [http-post-rate * http-post-burst-interval], if available, to be sent at every http-post-burst-interval.

1 <1, 60>

http-url- collector

<HTTP URL> HTTP URL of the Data Collector. “” (Empty)

N/A

Module name <log level> Module name and severity level pairs used to control which logs are sent to the headend data collector. See VOD Error Logs for details.

Note: If an entry for a section is present, any logs visible to the customer are forwarded regardless of section. This limits excessive logging and allows the developer to control what is important to log externally.

For example, DL_CV|DL_NOISE forwards to diagnostics.log as long as there is a setting in diagnostics.ini for that section.

“” (Empty)

N/A

18

Page 19: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

REST APIsVantage JSON Diagnostics uses two REST-compliant Web Service APIs to retrieve 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.

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.

This section describes both APIs in detail.

Public REST APIThe Public REST API allows external data collectors (clients) to retrieve diagnostic screen and error log data in JSON format. This is a read-only API with simple or no authentication, depending on configuration (see Configuration for details).

Note: The statistics data collected by the private API is available to the public API except through the log file retrieval.

General SyntaxHTTP GET {url} {parameter 1 & . . . parameter n}

Where url is a supported URL, and may be followed by one or more optional parameters concatenated by the ampersand (&) character. The supported URLs and optional parameters are described below.

Supported URLs

Table 1 URLs for Public REST API

URL Supported Parameters Description

/diagnostics/osd/pages format, datatype, path, category, subcategory, pagenum, title

Diagnostic screen data, delivered in JSON (or optional plain text) format. Options give the ability to retrieve a specific page or all pages of data.

/diagnostics/logs/module name, begintime, endtime Error report data for the specified module.

The Name is from the JavaScript client (and would include vod or ppv) or from dlog. All log data is stored in the file in JSON format.

19

Cisco Systems, Inc. www.cisco.com

Page 20: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

REST APIs

Public REST API

Optional Parameters

Table 2 REST Parameters for Public API

format “text” Return information as formatted text. (Default)

“json” Return information in JSON format.

datatype “dbReplica” JSON objects are constructed to match format in diagnostic screen database. (Default)

“smartConvert”

path <text> Text indicating page to be referenced by other parameters. Roughly, a directory path of the hierarchical OSD pages.

pagenum <integer> Diagnostic page number within a category or sub-category. If not specified, the default is all pages.

title <text> Selects diagnostic pages by title. If not specified, the default is all titles.

name <module name> Specifies the type of log file to return. Currently only dlog is used, but the JavaScript logging could use vod or similar. If not specified, the default is all logs.

begintime <time-stamp> If present, represents the oldest time stamp to return. This is useful to avoid retrieving duplicates if the caller keeps the newest time stamp from the last GET.

endtime <time-stamp> If present, represents the last time stamp to return. This is useful to limit the log messages to a certain period of time around a failure.

Each URL supports one or more of the following optional parameters.

REST Parameter Value Description

JSON objects are created for flexible random access of elements.

The paths are strict comparisons and are case-sensitive. The exact page names must be known by the client.

All logs are stored in a single file. This is a filter for transport.

Time is in UNIX standard seconds from the EPOCH, midnight Jan 1, 1970 UTC.

20

Page 21: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

REST APIs

Public REST API

Combining ParametersTo combine selection parameters, use the ampersand (&) to represent a logical AND. For example:

category=DOCSIS%20STATUS&title=IP%20DIRECT%20FILTERS

This API combines two query parameters:

category=DOCSIS%20STATUS

title=IP%DIRECT%FILTERS

This API returns all pages in the category “DOCSIS STATUS” with the title “IP DIRECT FILTERS.”

Note: Combining selection parameters reduces network traffic at some expense to set-top CPUs. All log records are stored in a single flat file, and each record in the file must be parsed for selection.

UsageFollowing are examples of complete Public REST API calls.

http://7.22.5.3/diagnostics/osd/pages?format=text

Returns all diagnostic pages in text form. Similar to the output of resdiag SilentDiag.

http://7.22.5.3/diagnostics/osd/pages?format=json&datatype=dbReplica&title=DOCSIS%20Events

Returns all diagnostic subpages with the title “DOCSIS Events” in JSON format.

http://7.22.5.3/diagnostics/osd/pages?format=json&datatype=smartConvert&path=Manufacturer%20Diag+DOCSIS%20Status+Down%20Stream&pagenum=1

Returns the first page navigating down through two subcategories.

http://7.22.5.3/diagnostics/logs/module?name=dlog&begintime=1432930361

Returns the DLOG messages collected at the designated time based on the diagnostics.ini file from the private interface.

Note: The message file is not filtered by default. Duplicate messages can be retrieved and filtered by the client by time stamp or by using the optional begintime and endtime filters. In this example, begintime is UNIX time for May 29, 2015 at 4:12:40 PM EDT.

http://7.22.5.3/diagnostics/logs/module?name=vod

Returns the VOD messages generated by JavaScript applications that use the vod name in the private interface. No such files exist at the time of writing.

HTTP Status CodesWhen used, the Public REST API may return any of the following status codes:

200 OK: Successful request

400: Bad Request

A parameter or its value was not recognized, or the query was otherwise malformed.

404: Not Found

The URL path is invalid.

21

Page 22: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

REST APIs

Private REST API

Note: Other errors not listed above may be generated by libevhtp; for example, 500: Internal Server Error.

Private REST APIThe Private REST API allows Vantage JavaScript software modules to push log messages to the Async Diagnostics Process using HTTP PUT. The Private REST API uses TCP port 10080.

General SyntaxHTTP PUT {url} {parameter 1 & . . . parameter n}

Where url is a supported URL, and may be followed by one or more optional parameters concatenated by the ampersand (&) character. The supported URLs and optional parameters are described below.

Supported URLs

Optional ParametersEach URL supports one or more of the following optional parameters.

Table 3 URLs for Private REST API

URL Supported Parameters Description

/diagnostics/logs name, section, level Used to PUT error message text. The error text is the body (HTTP payload), while metadata is communicated using REST parameters.

22

Page 23: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

REST APIs

Private REST API

Table 4 REST Parameters for Private API

UsageFollowing are examples of complete Private REST API calls.

http://localhost:8899/diagnostics/logs?name=dlog&section=DL_SPM_VODCTLG&level=1 "sam_ChannelIsAnalog:3503 - Failed to get service param for serviceId(285) sourceId(13)"

Upload error text for the DL_SPM_VODCTLG software module with a severity of 1 (Error).

Note: Typically, the payload is a simple text string. However, it can include a valid embedded JSON segment.

REST Parameter Value Description

name “vod” Indicates VOD logging data.

Note: Log messages generated by JavaScript should use a descriptive name (such as vod) to ensure a logical grouping.

“dlog” Indicates DLOG logging data, that is, all log messages that met the criteria in diagnostics.ini.

Every message passed through dlog() has the dlog name inserted by dlog.

section <text> Section label.

For dlog() based logging, use the labels for the Sections enumeration defined in dlog.h. For example, DL_SPM_VODCTLG.

For JavaScript logging, use JS-%s, where %s is replaced with a short descriptive label like JS-vod.

level <integer> Indicates the severity of the error text.

Levels are defined as follows:

0: Emergency 1: Error 2: Significant Event 3: Normal 4: Minor Event 5: Minor Debug 6: Data Processing 7: Noise 8: Function Calls 9: Really Noisy

JavaScript logging uses Error level 1. The level is not used on messages generated by JavaScript, but 1 is the default.

23

Page 24: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

REST APIs

Private REST API

http://localhost:10080/diagnostics/logs?name=vod&section=JS-vod&level=1 “Interesting log message generated by JavaScript code.”

Upload error text for the JavaScript “vod” component with a severity of 1 (Error).

HTTP Status CodesWhen used, the Private REST API may return any of the following status codes:

200 OK: Successful HTTP PUT

400: Bad Request

A parameter or its value was not recognized, or the query was otherwise malformed.

404: Not Found

The URL path is invalid.

Note: Other errors not listed above may be generated by libevhtp; for example, 500: Internal Server Error.

24

Page 25: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

VOD Error LogsIntroduction

Vantage middleware can generate critical error logs on behalf of the VOD server when browsing catalogs or playing VOD assets. This section lists these error logs by category, explains why they may occur, identifies their potential impact, and provides other details needed help resolve any related issues.

Occasionally, successful scenarios can generate error logs because critical logs are set to Error status level by default. For this reason, the following descriptions include both success and failure cases.

VODCAT InitializationThe following mentioned logs serve as example for a successful VOD initialization and possible failures.

Success Cases

DLOG|SPM_VODCTLG|ERROR|[vod_Init][1070] Initialize VOD Rental Asset Sync utility

ReasonSuccessfully initialized the Rental asset sync utility responsible for syncing the purchased asset details across all the IP Clients connected to a Gateway within a Home Network.

DLOG|SPM_VODCTLG|ERROR|[vod.cpp][vod_Init][1090]: Successfully created configWatchThread

ReasonSuccessfully created a thread that monitors the /rtn/config.ini file for any changes. Apart from other things, this file contains configurations for the vod module with respect root level catalogue uids, corresponding samids and vod types.

DLOG|SPM_VODCTLG|ERROR|[vod.cpp][configWatchThread][820] Vod Application is Authorized... Starting the VODCAT SUBSYSTEM...

ReasonThe “_VOD” package is authorized for this set-top. This could be either during bootup or at a later point. The vod module goes ahead after this to initialize the VodCatManager based on the srmManufacturerId.

DLOG|SPM_VODCTLG|ERROR|[vod.cpp][vod_system_init][1057] vod_system_init() successful

ReasonAs part of this, the /rtn/config.ini file is parsed and the vod module would initialize the VodCatManager based on the srmManufacturerId. Also the cmod library is initialized successfully as well.

25

Cisco Systems, Inc. www.cisco.com

Page 26: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

VOD Error Logs

VODCAT Initialization

DLOG|SPM_VODCTLG|ERROR|[parseConfigFile][466] Parse config file for ManufacturerId

ReasonThis is part of the initialization. Once a valid config.ini file is found, it would be parsed to get the required parameters.

DLOG|SPM_VODCTLG|ERROR|[vod.cpp][parseNpsFile][301] OperatingMode is in two way

ReasonThe STB is in Interactive mode already. This is mandatory requirement for the vod module to function since it needs to communicate to an external vod catalogue server for fetching the catalogs.

DLOG|SPM_VODCTLG|ERROR|[vod.cpp][parseNpsFile][309]- OperatingMode From nps.ini:Interactive :: gSess.OperatingMode:Broadcast

ReasonThe STB has gone from Broadcast to Interactive mode. It is a mandatory requirement for the vod module to be in Interactive mode to function since it needs to communicate to an external vod catalogue server for fetching the catalogs.

DLOG|SPM_VODCTLG|ERROR|vod-internal.cpp:void vod_SetTwoWay(bool):1968: Set g_IsSystemTwoWay is 0

ReasonThis is just a call to set the system two way (interactive) status.

DLOG|SPM_VODCTLG|ERROR|vod-internal.cpp:eVodCatResult vod_initialize(short unsigned int*):736: Entering vod_LaunchVodInit() call

ReasonThe Vantage startup module has initiated the initialization of the vod catalogue subsystem.

DLOG|SPM_VODCTLG|ERROR|vod-internal.cpp:eVodCatResult vod_initialize(short unsigned int*):828: vod_initialize() successful

ReasonInitialization of the vodcat subsystem was successful.

DLOG|SPM_VODCTLG|ERROR|SeachangeVodCatManager.cpp:virtual eVodCatResult SeachangeVodCatManager::VodInit(short unsigned int*):75: VodInit() successful

ReasonThis log indicates that the vodcat module for the Seachange VodCat Manager was initialized successfully This is done as part of vod_initialize().

DLOG|SPM_VODCTLG|ERROR|vod-internal.cpp:void* tr_VodInit(void*):955: Csci_Sgdm_GetGroupId call returned status:0,sgid:2000043 state:2

ReasonThe vodcat system needs the sgid for requesting the catalogues. This log says that the service group id and the state of the SGDM has been retrieved successfully.

26

Page 27: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

VOD Error Logs

VODCAT Initialization

DLOG|SPM_VODCTLG|ERROR|vod-internal.cpp:void* tr_VodInit(void*):966: /bfs/VodlinkOOB/hosts is present.

ReasonThis file is same as the cmod_hosts file. The cmod_hosts file has been successfully downloaded from the headend and the vod module is able to locate that in the STB.

DLOG|SPM_VODCTLG|ERROR|vod-internal.cpp:void* tr_VodInit(void*):1004: /tmp/cmod_hosts is now downloaded and available.

ReasonThe cmod_hosts file has been successfully downloaded from the headend and the vod module is able to locate that in the set-top.

DLOG|SPM_VODCTLG|ERROR|vod-internal.cpp:void* tr_VodInit(void*):1008: Waiting for network and system ready.

ReasonThe set-top is waiting for the Sign-On (interactive) to be complete and as well as the System to complete bootup(inclusive of Galio loading).Vod requires the STB to be in two-way (interactive) mode and System ready.

DLOG|SPM_VODCTLG|ERROR|vod-internal.cpp:void* tr_VodInit(void*):1012: Network is two way and System is Ready

ReasonThe set-top has completed Sign-On successfully and as well as the System is Ready (inclusive of Galio loading).Vod requires the set-top to be in two-way mode and System ready. Until this point any attempt to browse the catalog would result in catalog error.

DLOG|SPM_VODCTLG|ERROR|vod-internal.cpp:void* tr_VodInit(void*):1035: Init CMod library was a sucess, returned 0

ReasonThe initialization of the CMOD library is successful.

DLOG|SPM_VODCTLG|ERROR|vod-init.cpp:CatObject* vod_ParseSVodConfig():161: uids : 0X11a8001e,0x11a8001a,0x11a8006f,0x11a80077,0x11a80079,0x11a8006e,0x11a8007b,0x11a8007a,0x11a80073,0x11a8006a,0x11a80074,0x11a80078,0x11a8006c - Memory Address : 0x570e180

ReasonThese are the catalogue uuids configured for this STB that corresponds to top level catalogues. These values are retrieved from config.ini.

DLOG|SPM_VODCTLG|ERROR|vod-init.cpp:CatObject* vod_ParseSVodConfig():179: TYPES parsed for subsection:'contextids' from section:'vod' is vod,sVOD,sVOD,Svod,SVOD,SvoD,svod,svOd,svod,SVOd,svod,svod,SvOd

ReasonThese are the catalogue types configured for this STB that corresponds to top level catalogues. This may be either Susbscription VOD (svod) or just Transaction VOD (vod). The value is case insensitive.

27

Page 28: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

VOD Error Logs

VODCAT Initialization

DLOG|SPM_VODCTLG|ERROR|vod-init.cpp:CatObject* vod_ParseSVodConfig():188: SAM_IDS parsed for subsection:'contextids' from section:'vod' is 329,597,370,373,371,369,349,367,379,381,380,372,366

ReasonThese are the catalogue contextids configured for VOD application that corresponds to top level catalogs.

DLOG|SPM_VODCTLG|ERROR|vod-init.cpp:CatObject* vod_ParseSVodConfig():197: POSTERART parsed for subsection:'contextids' from section:'vod' is /bfs/rtnclient/posterart

ReasonThe configured BFS path for the vod poster art file.

Failure Cases

DLOG|SPM_VODCTLG|ERROR|[vod.cpp][vod_system_init][1052] Invalid config.ini file. Waiting for a valid one...

ReasonThe latest /rtn/config.ini file is still not downloaded from the headend or there is a problem downloading it. Check if the config.ini is configured properly in BFS on DNCS.

Note: This would result in the user seeing the “The catalog that you have attempted to access does not appear to be configured correctly, please contact Rogers Support at 1-888-Rogers-1 (7643771). Error code: #835MC” error. Check if there are any BFS related errors.

DLOG|SPM_VODCTLG|ERROR|vod-internal.cpp:void* tr_VodInit(void*):996: File: /tmp/cmod_hosts Not Available. Wait

ReasonVodcat module needs the IP address of the catalogue servers for catalogues retrieval. The cmod_hosts file contains the information regarding the catalogue server IP addresses. This log indicates that MW BFS module has not completed download of the cmod_hosts file or there is an issue with downloading the cmod_hosts file.

Note: This would result in the user seeing the “The catalog that you have attempted to access does not appear to be configured correctly, please contact Rogers Support at 1-888-Rogers-1 (7643771). Error code: #835MC” error. Check if there are any BFS related errors.

DLOG|SPM_VODCTLG|ERROR|[vod.cpp][parseConfigFile][508] m_SrmManufacturerId Unavailable for subsection:'srmManufacturer' from section:'on-demand-system', and using default gOnDemandSystem.SrmManufacturerId as Seachange

ReasonThe config.ini file doesn’t contain 'srmManufacturer'.

Note: Vodcat module needs the SRM Manufacturer ID to initialize the corresponding Catalogue Manager. This information should be configured in the /rtn/config.ini. If it is not available then vod playback module uses the default one which is Seachange.

DLOG|SPM_VODCTLG|ERROR|[vod.cpp][parseConfigFile][534] m_StreamerManufacturerId Unavailable for subsection:'streamerManufacturer' from section:'on-demand-system', and using default gOnDemandSystem.StreamerManufacturerId as Seachange

ReasonThe config.ini file doesn’t contain 'streamerManufacturer'.

28

Page 29: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

VOD Error Logs

VODCAT Initialization

Note: Vodcat module needs the Streamer Manufacturer ID to initialize the corresponding Stream Controller and in turn that decides the type of Stream Control protocol to be used. This information should be configured in the /rtn/config.ini. If it is not available then vod playback module uses the default one which is Seachange.

DLOG|SPM_VODCTLG|ERROR|pIniConfig was not created

ReasonFailed to access the config.ini file.

Note: This would result in the user seeing the “The catalog that you have attempted to access does not appear to be configured correctly, please contact Rogers Support at 1-888-Rogers-1 (7643771). Error code: #835MC” error. Check if there are any BFS related errors.

DLOG|SPM_VODCTLG|ERROR|Vod Diagnostics Init failed

ReasonCreation of diag file failed. Diagnostics info will not be available.

Note: Check for any filesystem related errors. The vod diagnostics file is created at /tmp/vod-diag.txt.

DLOG|SPM_VODCTLG|ERROR|"[vod.cpp][vod_system_init][980] Unable to set the OnDemandSystem properties in the VodCatManager

ReasonFailed to set the OnDemandSystem settings to the VodCatManager. If the provided input is NULL then it results in this error.

Note: This would result in the user seeing the “The catalog that you have attempted to access does not appear to be configured correctly, please contact Rogers Support at 1-888-Rogers-1 (7643771). Error code: #835MC” error.

DLOG|SPM_VODCTLG, DLOGL_ERROR, [ parseNpsFile][271] tini_create() failed %d || nps.ini file does not exist

ReasonThe nps.ini file is not available for extracting the operating mode information.

Note: This would result in the user seeing the “The catalog that you have attempted to access does not appear to be configured correctly, please contact Rogers Support at 1-888-Rogers-1 (7643771). Error code: #835MC” error. Check if there are any BFS related errors.

DLOG|SPM_VODCTLG, DLOGL_ERROR, [vod.cpp] parseNpsFile][290] OperatingMode is not in two way

ReasonBox is not in two way. VOD doesn’t get initialized until box is in two-way.

Note: The STB is in not Interactive mode. This is mandatory requirement for the vod module to function since it needs to communicate to an external vod catalogue server for fetching the catalogues.This would result in the user seeing the “The catalog that you have attempted to access does not appear to be configured correctly, please contact Rogers Support at 1-888-Rogers-1 (7643771). Error code: #835MC” error.

29

Page 30: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

VOD Error Logs

VODCAT Initialization

DLOG|SPM_VODCTLG, DLOGL_ERROR, [vod-internal.cpp][vod_initialize][795]Failed to Register with the MSP for VodSessionExistence notification";

ReasonVOD failed to register with MSP module for notification. Need MSP logs to investigate further.

Note: This may result in the bookmark not getting updated intermittently.

DLOG|SPM_VODCTLG, DLOGL_ERROR, [vod-internal][tr_VodInit][900]/bfs/VodlinkOOB/hosts is NOT present!;

Reason“VodlinkOOB/hosts” - file does not exist in BFS. Without this file VOD will not be initialized.

Note: This would result in the user seeing the “The catalog that you have attempted to access does not appear to be configured correctly, please contact Rogers Support at 1-888-Rogers-1 (7643771). Error code: #835MC” error. Check if there are any BFS related errors.

DLOG|SPM_VODCTLG, DLOGL_ERROR, [vod-internal][ tr_VodInit][919]Could not get the VodBfsUtility instance;

ReasonFailed to get a BFS object.

Note: BFS is required by VOD module to download files like the VodlinkOOB/hosts. This would result in the user seeing the “The catalog that you have attempted to access does not appear to be configured correctly, please contact Rogers Support at 1-888-Rogers-1 (7643771). Error code: #835MC” error. Check if there are any BFS related errors.

DLOG|SPM_VODCTLG, DLOGL_ERROR, , [vod-init][ vod_ParseSVodConfig][191] Failed to get SAM_IDS for subsection:samids from section:'vod'",

ReasonFailed to get SAM IDs configured for vod catalogue direct channel mapping.

Note: This would result in the user seeing the “Content Unavailable” error. Check if the config.ini is properly configured.

DLOG|SPM_VODCTLG, DLOGL_ERROR, [vod-init][ vod_ParseSVodConfig][164] Failed to get UID for subsection:'uids' from section:'vod'

ReasonFailed to get UUIDs configured for vod catalogs.

Note: This would result in the user seeing the “Content Unavailable” error. Check if the config.ini is properly configured.

DLOG|SPM_VODCTLG, DLOGL_ERROR, [vod-init][ vod_ParseSVodConfig][200] Failed to get POSTERART for subsection:posterartpath' from section:'vod'

ReasonFailed to get the POSTERART image path from config.ini file.

Note: Check if the config.ini is properly configured. This would result in the user not seeing the poster art images for assets during browsing of catalogs.

30

Page 31: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

VOD Error Logs

VOD Catalog Browse / Entitlement

DLOG|SPM_VODCTLG, DLOGL_ERROR, [vod-init][ vod_ParseSVodConfig][235] Resetting Number of catalog retries to 100

ReasonResetting the catalog retries count to 100.

Note: This happens when the config.ini was updated and subsequent fetch of the updated catalogues has failed. The vod module attempts retry for a maximum of 100 times every 10 secs. This would result in the user seeing the “The catalog that you have attempted to access does not appear to be configured correctly, please contact Rogers Support at 1-888-Rogers-1 (7643771). Error code: #835MC” error. Check if the config.ini is properly configured.

DLOG|SPM_VODCTLG, DLOGL_ERROR, , [vod-internal][tr_VodInit][900] File: /tmp/cmod_hosts Not Available. Wait,

ReasonVodcat module needs the IP address of the catalogue servers for catalogues retrieval. The VodlinkOOB/hosts file contains the information regarding the catalogue server IP addresses. This log indicates that BFS module has not completed download of the VodlinkOOB/hosts file or there is an issue with downloading the VodlinkOOB/hosts file.

Note: This log is expected for a temporary period during boot up while download of the file is in progress.This would result in the user seeing the “The catalog that you have attempted to access does not appear to be configured correctly, please contact Rogers Support at 1-888-Rogers-1 (7643771). Error code: #835MC” error. Check if there are any BFS related errors.

VOD Catalog Browse / Entitlement

Failure Cases

DLOG|SPM_VODCTLG|ERROR|[vod.cpp][VodCat_GetCatalogs][1561].Failed to initialize vodcat manager.

ReasonVOD module failed to initialize the vodcat manger.

Note: This would result in the user seeing the “The catalog that you have attempted to access does not appear to be configured correctly, please contact Rogers Support at 1-888-Rogers-1 (7643771). Error code: #835MC” error. Check if there are any config.ini configuration related errors and any other VODCAT logs.

DLOG|SPM_VODCTLG|ERROR|VodCatObj_GetString failed, return Status=1

ReasonFailure to fetch the metadata of the asset.

Note: There could be issues with the STB not able to reach the VOD catalogue server. In that case the user would be seeing the following error messages; “Unable to browse the selected destination” and “The request to the server has timed out. Please try again later”

31

Page 32: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

VOD Error Logs

On Demand Session Setup

On Demand Session Setup

Failure Cases

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "SessionSetup error: 0x%x", errStatus;

ReasonVOD session setup failed due to:

Failed to set-up a connection with network.

Failed to send SessionSetup request message to network.

Note: The user would see the barker “On Demand is currently experiencing problems, please try again later”.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "Callback signal for Stream Setup error";

ReasonStreaming socket event failed because session object is not in active session list.

Note: The user would see the barker “On Demand is currently experiencing problems, please try again later”.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "Error invalid sgId: %d ", sgId;

ReasonThe supplied sgid to the session setup request is invalid.

Note: The user would see the barker “On Demand is currently experiencing problems, please try again later”. There might be an issue with Vantage software itself.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "Error invalid assetId: %d", assetId;

ReasonThe supplied assetId to the session setup request is invalid.

Note: The user would see the barker “On Demand is currently experiencing problems, please try again later”. Check if the service URL is correct.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "On Demand pointer is NULL";

ReasonThe On Demand object pointer is NULL.

Note: The user would see the barker “On Demand is currently experiencing problems, please try again later”. Check for possible memory corruptions or if the service URL is correct.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "warning: socketFd == -1";

ReasonThe socket connection to the Stream server is invalid.

Note: The user would see the barker “On Demand is currently experiencing problems, please try again later. Check for possible memory corruptions or if the service URL is correct.

32

Page 33: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

VOD Error Logs

On Demand Playback/Trickplay

On Demand Playback/TrickplayThis section covers the various error cases that would occur when the user tries to playback a VOD asset or does trick play operations on them.

Failure Cases

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "warning tunerController->Load status: %d", status;

ReasonFailed to load the RF source with the given tuning parameters.

Note: The user would see the barker “On Demand is currently experiencing problems, please try again later”.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "warning: loadTuningParamsAndPlay status %d", status;

ReasonFailed to load the RF source with the given tuning parameters.

Note: The user would see the barker “On Demand is currently experiencing problems, please try again later”.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "Callback signal for LSC NO PERMISSION";Note: This error code is explained in the LSCP protocol specification.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "Callback signal for LSC_NO_RESOURCES";Note: This error code is explained in the LSCP protocol specification.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "Callback signal for LSC_NO_MEMORY";Note: This error code is explained in the LSCP protocol specification.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "Callback signal for LSC_WRONG_STATE";Note: This error code is explained in the LSCP protocol specification.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "Callback signal for LSC_BAD_PARAM";Note: This error code is explained in the LSCP protocol specification.

DLOG|MSP_ONDEMAND|DLOGL_ERROR, "Callback signal for LSC_SERVER_ERROR";Note: This error code is explained in the LSCP protocol specification.

33

Page 34: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

VOD Error Logs

On Demand Playback/Trickplay

34

Page 35: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Best PracticesThis section presents examples of using JSON diagnostics to identify and troubleshoot issues in a service provider network that includes Explorer G6, G8, or G10 set-tops operating in a Vantage 6.0 environment.

Using Channel Change Data to Identify an RF IssueFollowing is an example of a log that might be sent from a set-top to the headend during a channel change:

{"Dlog":{"mac-address":"08:80:39:88:8d:1c","date":"2015-04-17T12:48:55", "section":"STATISTICS”,"level":"NORMAL","content":["ChanChange:1.72secs;OldChan:10;OldFreq:393.00;OldSrcId:8125;OldMode:QAM256;NewChan:11;NewFreq:381.00;NewSrcId:1212;NewMode:QAM256;\n"]}}

A review of this log shows an unusually high number of channel changes that took longer than 5 seconds. Further inspection reveals a high concentration of these long channel changes occur when changing to a channel whose carrier frequency is 381 MHz.

This finding could point to a problem with the 381 MHz signal level in the area of the plant that is servicing this set-top. A proactive check of plant signal levels could then be scheduled for the next customer service truck roll to the area.

Using Reboot Log Data to Identify a Faulty DNCS Hub IDFollowing is an example of a log that might be sent from a set-top STB to the headend after a reboot:

{"Dlog":{"mac-address":"08:80:39:88:8d:1c","date":"2015-04-17T12:02:35","section":"STATISTICS","level":"NORMAL","content”:["RebootReason:UserReboot;PowerUpTime:2015-04-17_12:00:13_EDT;Bootloader:20.00secs,total:20.00secs;Kernel:24.36secs,total:44.36secs;InitScripts:11.64secs,total:56.00secs;ApplicationStart:41.95secs,total:97.95secs;FP:-00-:2.03secs,total:99.98secs;FP:-01-:21.06secs,total:121.04secs;FP:-02-:63.53secs,total:184.57secs;FP:-03-:0.04secs,total:184.61secs;FP:-04-:2.03secs,total:186.64secs;FP:-05-:2.02secs,total:188.66secs;SystemReady:117.98secs,total:306.65secs;\n"]}}

To improve readability, here is an example of how this data might be formatted by a third-party aggregation application:

Reboot reason : UserReboot Power Up Time : Fri April 17 12:00:13 2015 EDT Bootloader => Linux kernel : 20.00 seconds, total time: 20.00 seconds Kernel booted => Init scripts started : 24.36 seconds, total time: 44.36 seconds Init scripts => Application start : 11.62 seconds, total time: 55.98 seconds Application started => Waiting for SessInit : 41.97 seconds, total time: 97.95 secondsFront panel"-00-" SessInit ready => Waiting for Hub Id : 2.03 seconds, total time: 99.98 secondsFront panel"-01-" Hub Id is ready=> Waiting for SI : 21.06 seconds, total time: 121.04 secondsFront panel"-02-" SI is ready => Waiting for BFS : 63.53 seconds, total time: 184.57 secondsFront panel"-03-" BFS is ready => Waiting for SAM : 0.04 seconds, total time: 184.61 secondsFront panel"-04-" SAM is ready => Waiting glbl cfg : 2.03 seconds, total time: 186.64 secondsFront panel"-05-" Glbl cfg ready => Launching UI : 2.02 seconds, total time: 188.66 seconds UI launched => System ready : 117.98 seconds, total time: 306.65 seconds

A review of this log for a particular set-top population shows that, on average over the last two days, set-tops took 15 minutes to boot, and most of that time (11 minutes average) was spent with “-01-” on the set-top front panel.

35

Cisco Systems, Inc. www.cisco.com

Page 36: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Best Practices

Using Reboot Log Data to Identify a Faulty DNCS Hub ID

Because the FP number changes from “-01-” to “-02-” when the set-top gets its Hub ID, we can infer from the data that set-tops are taking an average of 11 minutes to get their Hub ID from the DNCS. Because each log has the set-top MAC address, we can look them up in DNCS to find the associated Hub ID and proceed to debug that Hub ID.

36

Page 37: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Accessing Vantage Diagnostic ScreensIntroduction

This section explains how to gain access to the Vantage diagnostics using the buttons on either the set-top front panel (not available on all models) or the set-top remote control. It also explains how to identify diagnostic information, how to exit the diagnostics, and how to reboot the set-top.

Accessing Diagnostics Using the Set-Top Front Panel ButtonsNote: The following steps apply only to set-tops equipped with front panel buttons, such as the Cisco Explorer 4642 and Cisco Explorer 8642.

Follow these steps to access the Vantage diagnostic screens using the front panel buttons:

1. Press and hold the VOL+ and INFO buttons simultaneously for about 5 seconds.

The first diagnostic screen appears.

2. Press VOL+ (alone) to navigate to the next diagnostic screen. For the previous screen, press VOL-.

3. To enter a submenu of related screens (available if a + symbol precedes the screen title), press the SELECT key.

4. To browse within a menu, press the CH+ button for the next item, or the CH- button for the previous item.

5. To return to the previous menu, press the INFO button.

Accessing Diagnostics Using the Set-Top Remote ControlFollow these steps to access the diagnostic screens using the remote control:

1. Press and hold the EXIT key for about two seconds.

The POWER LED on the front panel of the set-top blinks.

2. In rapid succession, press the DOWN key twice, followed by the number 2.

A diagnostic screen appears.

3. To navigate to the next diagnostic screen, press the RIGHT ARROW key. To view the previous diagnostic screen, press the LEFT ARROW key.

4. To enter a submenu of related screens (available if a + symbol precedes the screen title), press the SELECT key.

5. To browse within a menu, press the DOWN ARROW key for the next item, or the UP ARROW key for the previous item.

6. To return to the previous menu, press the BACK/LAST key.

37

Cisco Systems, Inc. www.cisco.com

Page 38: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Accessing Vantage Diagnostic Screens

Identifying Information in Vantage Diagnostic Screens

Identifying Information in Vantage Diagnostic ScreensThis section helps you to locate information within the Vantage diagnostic screens. The following example shows the components of an Vantage diagnostic screen.

Note: This screen is for illustrative purposes only.

Setting Screen TransparencyYou can set the transparency level of the diagnostic pages so that you can still see the video behind the diagnostic page displayed. This can be helpful when you troubleshoot.

You can change the transparency level of the video using either the set-top front panel or the remote control. Press the GUIDE button to rotate through four available transparency levels (0%, 25%, 50%, 100%).

Exiting the DiagnosticsTo exit the diagnostic screens, press the EXIT button on the front panel of the set-top or on the remote.

Rebooting the Set-TopTo reboot the set-top, press the POWER, SELECT, and GUIDE buttons on the front panel of the set-top at the same time.

Note: This procedure does not apply to Cisco Explorer 9865 set-tops.

You can also reboot the set-top from the diagnostics pages. See Reboot STB Diagnostic Screen, page 203 for more information.

38

Page 39: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Summary Information DiagnosticsIntroduction

The Summary Information diagnostic screens let you view information about the status of system initialization, system description, and boot status. Depending on set-top model, the information in this screen may be divided among several pages.

Tasks that you can perform from this screen include the following:

Summary Information

Determine the current middleware software version and provisioning status.

Verify the in-band (IB) and out-of-band (OOB) network parameters.

Determine the current tuner in focus.

Error Summary

Determine whether the in-band PAT,OMT, and OC are experiencing timeouts.

Determine whether the OOB OC is experiencing timeouts.

Determine whether in-band tuner failures exist.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

Pages 1-4: Summary InformationTasks that you can perform from this screen include the following:

Determine the current middleware software version and provisioning status.

Verify the in-band (IB) and out-of-band (OOB) network parameters.

Determine the current tuner in focus.

Note: Some field values may change depending on the middleware installed.

39

Cisco Systems, Inc. www.cisco.com

Page 40: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Summary Information Diagnostics

Pages 1-4: Summary Information

Table 1 Summary Screen - Pages 1-4

Field Name Description Possible Values

Firmware Version, Date The version of the set-top firmware and its date of installation.

[Device dependent]

Example: 3.0.6.118 Fri Apr 8 2011, 7:41:54 PM GMT

CP Status The current status of the CableCARD/host authentication (binding).

Ready — Authorization has been received from the headend by the card/Host pair and the authentication and binding are complete

Not Ready — Waiting for authorization, or authorization failed

n/a — Failure or no CableCARD module detected

CA Status Status of the conditional access for the set-top.

Ready

Not Staged

Not Initialized

Not Authorized

CA Comm Error

Channel Error

Other CA Error

CA Unknown Error

InBand Network

Tuner-1 — Tuner-8 Displays the Frequency, Modulation, Power levels, SNR (signal-to-noise ratio), and whether the carrier is locked for all tuners.

Note: If Tuner-n is disabled, the screen displays n/a for all Tuner-n fields.

[Tuner-dependent values]

Frequency (MHz) The frequency (freq) in which each in-band tuner is tuned (MHz).

[Dependent upon setting]

Modulation The current QAM modulation mode of each in-band tuner.

[QAM-dependent]

Example:

QAM-64

QAM-256

Analog

Other

40

Page 41: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Summary Information Diagnostics

Pages 1-4: Summary Information

Power (dBmV) The approximate received signal level (PWR, dBmV) at each tuner.

[Hardware-specific]

Value displayed in white — Signal level nominal

Value displayed in amber — Signal level is between -12 and -15 dBmV or between +12 and +15 dBmV

Value displayed in red — Signal level is either lower than -15 dBmV or higher than +15 dBmV

n/a - Not applicable to this set-top

SNR (dB) The signal-to-noise ratio (SNR, in dB) of applicable QAM data channels for each tuner.

[Hardware-specific]

Value displayed in white — Signal level is nominal

Value displayed in red — Signal level is unacceptably too high or too low:

— QAM-64 — Signal level is lower than 25 dB

— QAM-256 — Power level is either between -10 and -15 dBmV and SNR less than 36 dB; or, power level is between +10 and +15 dBmV and SNR less than 33 dB

n/a — Not applicable to this set-top

Carrier Lock Indicates whether the tuner is locked to a QAM carrier.

Locked — Tuner is locked to a carrier

Unlocked — Tuner is not locked to a carrier

Table 1 Summary Screen - Pages 1-4 (continued)

Field Name Description Possible Values

41

Page 42: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Summary Information Diagnostics

Pages 1-4: Summary Information

Power Status Not applicable to Vantage set-tops. n/a

Boot Status Not applicable to Vantage set-tops. Boot process in unknown state

Firmware D/L Status The status of the firmware download process.

Succeeded — The download process succeeded

Failed — The set-top could not complete the download

MaxRetryReached — The download process was retried unsuccessfully for the permissible maximum number of times

None — The download process is not active

Deferred — The set-top acknowledges that the download has been deferred

InProgress — The download is in progress

Cancelled — The set-top acknowledges that the download was cancelled

Aborted — The set-top acknowledges that the download was aborted

Complete — The set-top acknowledges that the download is complete

Deferred Expired — The set-top notifies DLSS that the deferral period has expired

Table 1 Summary Screen - Pages 1-4 (continued)

Field Name Description Possible Values

42

Page 43: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Summary Information Diagnostics

Pages 5-8: Error Summary

Pages 5-8: Error SummaryTasks that you can perform from this screen include the following:

Determine whether the in-band PAT, PMT, and OC are experiencing timeouts.

Determine whether the OOB OC is experiencing timeouts.

Determine whether in-band tuner failures exist.

Note: The Cisco Explorer 4642 and 8642 set-tops have a single-page Error Summary screen.

Table 2 Summary Screen - Pages 5-8

Field Name Description Possible Values

Application Signaling Not applicable to Vantage set-tops. n/a

PAT, PMT timeouts Displays errors in reading the Program Association Table (PAT) and Program Map Table (PMT).

[Integer > 0] , [Integer > 0]

Example: 0, 0

IB, OOB OC timeouts Displays the number of in-band object carousel (IB OC) and out-of-band object carousel (OOB OC) timeouts.

[Integer > 0] , ]Integer > 0]

Example: 0, 0

InBand Network Displays the Failed Tune Count and Last Failed Frequency for each of the set-top tuners.

[Integer > 0]

Failed Tune Count Displays the number of tuning errors that have occurred since the last host boot cycle for each of the tuners.

[Integer > 0]

Last Failed Freq The last frequency (in MHz) into which each in-band tuner failed to tune.

[Integer > 0] MHz — The last frequency that could not be tuned into since the last host boot cycle

N/A — A tuning error has not occurred since the last host boot cycle

43

Page 44: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Summary Information Diagnostics

Pages 5-8: Error Summary

44

Page 45: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer DiagnosticsIntroduction

The Manufacturer diagnostic screens let you view information about the state of the Bootloader, system components, Conditional Access (CA), DVR (if equipped), Linux memory, QAMs, the network, DOCSIS, common downloads, platform components, and the home network.

These screens are divided into pages and sections that are devoted to specific tasks. Tasks that you can perform from these screens include the following:

Host Status Summary

Verify the current status of the boot process.

Verify the system information.

Check the amount of available memory.

Check when the DHCT was last booted and if it is receiving the correct time.

Host Bootloader Information

Determine the Bootloader version number.

Verify the vendor ID for the DHCT manufacturer.

Determine the identification number of the flash ROM image.

Determine the code version table (CVT) download group for the DHCT.

Host Component Information

Verify the software and software version for each component installed on the DHCT.

Verify the release status for the software and driver components installed on the DHCT.

Determine when a component was created.

Host QAM Status

Check the integrity of the QAM signal.

Determine the current capacity of the QAM buffer.

Verify the total number of packets received since the QAM channel became active.

Determine the status of the QAM channel.

Host DAVIC Status

Confirm the power levels and frequencies of the FDC and RDC.

Confirm the network parameters for the Ethernet.

45

Cisco Systems, Inc. www.cisco.com

Page 46: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Introduction

Confirm the network parameters for the RF network.

DOCSIS Status

Verify the status of the DOCSIS network operations on your system.

Determine if the DHCT is running in DSG mode.

Verify the DNCS MAC and IP addresses.

DOCSIS Events

Determine the level of the events listed.

Determine the most recent occurrence of DOCSIS events.

Determine how often the events occur.

DSG Filters

Determine the destination MAC and IP addresses for a DSG tunnel.

Determine the number of packets that have been filtered through a tunnel.

SEB Status

Determine whether the SEB feature is enabled on the eCM.

Determine the current role and figure of merit of the eCM.

Note: This feature is no longer supported. This screen will be removed in a future release.

SEB Connected Devices

Determine the MAC address and device type of the SEB Client.

Determine the client-side TCP port number and IP address of the SEB tunnel.

Determine the server-side TCP port number and IP address of the SEB tunnel.

Note: This feature is no longer supported. This screen will be removed in a future release.

DOCSIS DSID Forwarding

Determine the Downstream Service Identifier (DSID) and its types.

Determine the channel number and number of packets forwarded in a particular DSID.

Determine the Cable Modem Interface Mask (CMIM) of the DSID.

Note: This screen applies only for G8 and G10 set-tops.

DOCSIS Downstream

Verify the downstream interface index (ifIndex), channel ID, and status.

Determine the downstream frequency, modulation, and interleaving interval.

Determine downstream forward error correction (FEC) code information.

Note: This screen applies only for G8 and G10 set-tops.

46

Page 47: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Introduction

DOCSIS Upstream

Verify the upstream interface index (ifIndex), channel ID, and status.

Determine the upstream frequency and modulation.

Determine number of upstream bytes transmitted.

Note: This screen applies only for G8 and G10 set-tops.

DVR Information - Physical Drive

Determine the model number and serial number of the DVR hard drive.

Verify the amount of free space available on the DVR hard drive.

Determine the size and capacity of the ITFS (Information Technology File System) and the AVFS (Audio/Video File System) file systems.

Verify statistical information about the DVR hard disk in the DHCT.

DVR Information - Partition

Verify the capacity for the partition.

Verify the amount of available space that remains in the partition.

Determine if any lost or bad clusters exist in the partition.

Linux Memory Information

Verify the total RAM capability for the system.

Determine the total RAM available for use.

Determine the kernel reserve memory size.

Determine whether there is a memory leak in your system.

CableCARD Information

Determine the CableCARD OOB mode.

Determine the copy protection provisioning status.

View the CableCARD, host, and manufacturer IDs.

View the CableCARD MAC address, serial number, and software and hardware versions.

Common Download

Verify the status of the current download.

Verify the path that the current download is using.

Verify the percentage of download completion.

Platform - RP Media Main Status

View the state of the media manager handle.

View the source, video decoder, and audio decoder to which the media manager handle is attached.

47

Page 48: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Navigation

Platform - MPEG Decoder/Encoder Status

Determine the MPEG Transport PID for each decoder.

Verify whether the MPEG stream is progressive or interlaced for each decoder.

Determine the number of frames that have been decoded on the current channel.

Platform - Audio Channel Status

Identify if any errors have occurred that relate to MPEG or AC3 decoding (during playback).

Determine the type of audio format being sent through the HDMI port.

Verify the type of closed captioning being decoded.

Platform - DirectFB Info

View the associations, associated types, and display options for the video stream handler.

View the freeze state and decoder being used.

View the ID, capabilities, size, and configuration of the screen.

View the status, ID, capabilities, and configuration of the layers.

Platform - InBand SEC Filter

Identify the section and source being filtered.

Identify the state of the filter.

Compare the filter results with other values.

Platform - MPEG Display Status

Determine the current resolution of each stream that is being displayed.

Identify the horizontal and vertical size of the frame.

Determine if any frames were discarded.

Identify if the deinterlacer is activated for either stream.

Home Networking Status

Verify whether UPnP devices are available on the network and review the services offered by them.

Verify the status of the home network playback being rendered.

Verify the Media Server name of this set-top and its status.

Verify the list of clients that are currently being streamed by this server and the filenames that are being served.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

Host Status Summary ScreenTasks that you can perform from this screen include the following:

48

Page 49: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host Status Summary Screen

Verify the current status of the boot process.

Verify the system information.

Check the amount of available memory.

Check when the DHCT was last booted and if it is receiving the correct time.

49

Page 50: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host Status Summary Screen

Table 1 Host Status Summary Screen

Field Name Description Possible Values

Initialization

HOST SN The serial number of the host. [Hardware-dependent value]

CableCARD The status of the CableCARD module. AmsReady — The CableCARD module has completed the boot process

AmsNotReady — The CableCARD module has not completed the boot process

AmsReset — The CableCARD module has been reset

AmsRemoved — The CableCARD module has been removed from the host

AmsFailed — The CableCARD host has failed

VPOD — In this mode, the CAM features are handled by the embedded POD module

UnknownHoming — If you see this indicator, contact Cisco Services

UNConfig The boot process for the User-to-Network configuration (UNConfig).

B'cast only — Global broadcast message received and the DHCT is in one-way mode

Ready — An individually addressed configuration message received

Searching — No UNConfig message received

50

Page 51: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host Status Summary Screen

OOB Mode The out-of-band (OOB) mode. DAVIC

DSG

DSGOneWay

ADSG

ADSGOneWay

UNKNOWN

IP Direct

IP Direct Test *

DAVIC Fallback

* Note: This value is displayed only if the IP Direct Migration App Test is in progress on the set-top.

Fallback Reason The cause for the DAVIC fallback.

Note: This field is displayed only if the OOB Mode is DAVIC Fallback.

Mapfile Failure

Scan Failure

Unci TimedOut

Uncc TimedOut

DHCP Failure

System Description

HW Rev The version of the host's hardware. [Hardware-dependent value]

SW Rev The version of the resident application.

[Hardware-dependent value]

BOOTR The version of the host bootloader. [Software-dependent value]

Example: 2.5

Model The model number of the host. [Hardware-dependent value]

Memory Usage (KB)

System Heap Overall memory available to the porting layer.

[Hardware-dependent value]

Video Heap Memory initialized when video streaming begins.

[Hardware-dependent value]

Total The total amount of memory assigned.

[Integer >= 0]

Free The amount of free memory available. [Integer >= 0]

Clocks

Table 1 Host Status Summary Screen (continued)

Field Name Description Possible Values

51

Page 52: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host Bootloader Information Screen

Host Bootloader Information ScreenTasks that you can perform from this screen include the following:

Determine the Bootloader version number.

Verify the vendor ID for the DHCT manufacturer.

Determine the identification number of the flash ROM image.

Determine the code version table (CVT) download group for the DHCT.

SysUpTime The amount of time elapsed since the tru2way system last booted.

Note: The time is shown in the hexadecimal format in parentheses.

[Days, Hours, Minutes, Seconds]

Booted The date and time that the Explorer DHCT last booted.

Note: The time is shown in the hexadecimal format in parentheses.

[Date, Time]

Current The current date and time.

Note: The time is shown in the hexadecimal format in parentheses.

[Date, Time]

CPU/Bus Speed The speed (in MHz) at which the microprocessor and data bus are running.

[Hardware-dependent value]

Ev Pool The number of events available in the event pool of the OS.

[Integer > 0]

Table 1 Host Status Summary Screen (continued)

Field Name Description Possible Values

52

Page 53: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host Component Information Screen

I

Host Component Information ScreenTasks that you can perform from this screen include the following:

Verify the software and software version for each component installed on the DHCT.

Verify the release status for the software and driver components installed on the DHCT.

Determine when a component was created.

Table 2 Host Bootloader Information Screen

Field Name Description Possible Values

Vendor ID The vendor number defined by the manufacturer for the DHCT (hexadecimal format).

[Manufacturer-dependent] — first 6 digits of the set-top MAC address

n/a — Bootloader not loaded

HW Model The hardware model for the DHCT (hexadecimal format).

[Hardware model-dependent]

n/a — Bootloader not loaded

HW Version The version number of the hardware mode (hexadecimal format).

[Hardware model-dependent]

n/a — Bootloader not loaded

Bldr Version The software version of the Bootloader (hexadecimal format).

[Software-dependent]

n/a — Bootloader not loaded

Group ID The CVT group to which the DHCT belongs.

0x00000000 — Default group ID

0x00000xxx — "xxx" are three numerals

n/a — DHCT does not support CVT download

CDL Group ID The Common Download Group to which the DHCT belongs.

0x00000000 — Default group ID

0x000000xx — "xx" are two numerals

n/a — DHCT does not support CVT download

Image ID The bootloader image ID. [Hexadecimal Image ID]

0x00000000 — Default image ID

0x000000xx — "xx" are two numerals

n/a — Bootloader image not loaded

NVM Writes The number of writes to the non-volatile memory (NVM) since the DHCT last booted.

[Integer > 0]

n/a — Bootloader not loaded

53

Page 54: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host QAM Status Screen

Host QAM Status ScreenTasks that you can perform from this screen include the following:

Check the integrity of the QAM signal.

Determine the current capacity of the QAM buffer.

Verify the total number of packets received since the QAM channel became active.

Determine the status of the QAM channel.

Table 3 Host Component Information Screen

Field Name Description Possible Values

Component The name of each component installed on the set-top.

[Component-dependent]

Version The version of each software component installed on the set-top.

[Software-dependent]

Example: 1.0.15.01

Time The time (GMT) that each component was created.

[Software-dependent]

Example: 20:37:03 GMT

P/D Defines the state of the software code.

P — Production code

D — Debug code

54

Page 55: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host QAM Status Screen

Table 4 Host QAM Status Screen

Field Name Description Possible Values

Modulation QAM tuner modulation mode. QAM-64

QAM-256

n/a

Frequency (MHz) The frequency (freq) in which the inband tuner is tuned (MHz).

[Dependent upon setting]

RF Power (dBmV) The approximate received signal level.

Refer to hardware specifications.

Value displayed in white — Signal level normal

Value displayed in amber — Signal level marginally too high or too low

Value displayed in red — Signal level unacceptably too high or too low

n/a — Not applicable on this DHCT

Example: 26.0

S/N (dBmV) Signal-to-noise ratio. Refer to hardware specifications.

Value displayed in white — Signal level normal

Value displayed in amber — Signal level marginally too high or too low

Value displayed in red — Signal level unacceptably too high or too low

n/a — Not applicable on this DHCT

Example: 39.60

State Tuner state. Locked

Unlocked

Seconds The number of seconds that the tuner has been locked on the current frequency.

[Integer > 0]

Decoder

Audio PID The audio PID number in the MPEG stream that contains the audio information being decoded.

[Decimal > 0] — Streaming

[Decimal = 0] — Not streaming

55

Page 56: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DAVIC Status Screen

Host DAVIC Status ScreenTasks that you can perform from this screen include the following:

Confirm the power levels and frequencies of the FDC and RDC.

Confirm the network parameters for the Ethernet.

Confirm the network parameters for the RF network.

Video PID The video PID number in the MPEG stream that contains the video information being decoded.

[Decimal > 0] — Streaming

[Decimal = 0] — Not streaming

PCR PID The PID number in the stream that refers to the PCR time stamp.

[Decimal > 0] — Streaming

[Decimal = 0] — Not streaming

PCR Lock The time stamp of the last PCR synchronization lock.

[Integer > 0]

Important: If this number does not change each time the screen refreshes, then video may have been lost.

PTS A presentation time stamp that changes each time that the screen refreshes.

n/a — Tuned to an analog channel

UNIX format — Number should change each time the screen refreshes

Important: If this number does not change each time the screen refreshes, then video may have been lost.

Program Num The program number associated with active content within the set-top.

[Integer > 0]

Table 4 Host QAM Status Screen (continued)

Field Name Description Possible Values

56

Page 57: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DAVIC Status Screen

Table 5 Host DAVIC Status Screen

Field Name Description Possible Values

FDC Shows levels in reference to the Forward Data Channel as described below.

RDC Shows levels in reference to the Reverse Data Channel as described below.

Frequency The frequency (Freq) of the tuned QPSK receiver.

[Network dependent]

FDC Range: 70–130 MHz

RDC Range: 8 to 26.5 MHz

Status The status of the receiver in regards to receiving valid data.

Locked — Receiver locked onto a frequency with valid QPSK data

Unlocked — Receiver not locked onto a frequency with valid QPSK data

Level The approximate received signal level in dBmV.

Refer to hardware specifications.

Value displayed in white — Signal level nominal

Value displayed in amber — Signal level marginally too high or too low

Value displayed in red — Signal level unacceptably too high or too low

Data Rate Current data rate (in Kbps) of the FDC/RDC.

[Integer > 0]

S/N The signal-to-noise ratio in dB. Refer to hardware specifications.

Value displayed in white — Signal level nominal

Value displayed in amber — Signal level marginally too high or too low

Value displayed in red — Signal level unacceptably too high or too low

n/a — Not applicable for this DHCT

Corr Bytes The number of corrected bytes sent or received.

[Integer > 0]

Un Cor Bytes The number of uncorrected bytes sent or received.

[Integer > 0]

Seconds The number of seconds that the frequency has been locked.

[Integer > 0]

Total Bytes The total number of data bytes successfully read since the frequency was locked.

[Integer > 0]

57

Page 58: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DOCSIS Status Screen

Host DOCSIS Status ScreenTasks that you can perform from this screen include the following:

DOCSIS Status

Verify the status of the DOCSIS network operations on your system.

Retransmission The total number of data bytes requiring retransmission since the frequency was locked.

[Integer > 0]

Err Avg/Inst Two unique numbers that describe data errors.

First Number — The average number of errors during the time the frequency was locked

Second Number — The number of errors since the last time the screen was refreshed

[Integer > 0] / [Integer > 0]

Ethernet

MAC The MAC address assigned to the Ethernet adapter.

[Hardware-dependent, unique for each Ethernet network interface]

Example: 00:40:7B:C0:EE:C1

IP The IP address assigned to the Ethernet adapter.

[Network-dependent]

Example: 10.1.0.1

Subnet Mask The IP subnet mask assigned to the Ethernet adapter.

[Network-dependent]

Example: 255.255.255.0

RF Network

MAC The MAC address assigned to the RF network adapter.

[Hardware-dependent, unique for each Ethernet network interface]

Example: 00:40:7B:C0:EE:C1

IP The IP address assigned to the RF network adapter.

[Network-dependent]

Example: 10.1.0.1

Subnet Mask The IP address assigned to the RF network adapter.

[Network-dependent]

Example: 255.255.255.0

HUB ID The hub to which this host is assigned.

[Hub-dependent]

N/A

SNMP Mgr Indicates if the IP address of the network management system in which it can then send Simple Network Management Protocol (SNMP) traps.

[Network-dependent]

Example: 10.1.0.1

Table 5 Host DAVIC Status Screen (continued)

Field Name Description Possible Values

58

Page 59: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DOCSIS Status Screen

Determine if the DHCT is running in DSG mode.

Verify the DNCS MAC and IP addresses.

DOCSIS Events

Determine the level of the events listed.

Determine the most recent occurrence of DOCSIS events.

Determine how often the events occur.

DSG Filters

Determine the destination MAC and IP addresses for a DSG tunnel.

Determine the number of packets that have been filtered through a tunnel.

SEB Status

Determine whether the SEB feature is enabled on the embedded cable modem (eCM).

Determine the current role and figure of merit of the eCM.

Note: This feature is no longer supported. This screen will be removed in a future release.

Page 1: Configuration and AddressNote: Field names marked with * apply for G8 and G10 set-tops only.

59

Page 60: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DOCSIS Status Screen

Table 6 Host DOCSIS Status Screen - Page 1

Field Name Description Possible Values

Configuration

Access Mode Indicates the operating mode of the eSTB.

VPOD-OperDCM : DAVIC

VPOD-OperDCM : DOCSIS IP DIRECT

Config File The file name that represents the configuration file.

[Network-dependent]

UNConfig DCM The status of the DHCT cable modem (DCM).

DODA

DAVIC

TelcoReturn

DOCSIS

Ethernet

Unknown

DOCSISONLY

DAVICONLY

DODAONLY

EthernetOnly

DavicExpress

TelcoReturnOnly

DavicExpressOnly

CPE Mod ID The identification number for the QPSK modulator.

[Integer > 1]

Max CPE MACs The maximum number of external Ethernet MAC addresses the cable modem can support plus one.

[Integer > 1]

CM Bpi Privacy Cable Modem Baseline Privacy Interface. Determines the status of privacy between the cable modem and the CMTS.

Enabled: 1

Enabled: 2

Enabled: 1, 2

Disabled: 1

Disabled: 2

Disabled: 1, 2

Mapfile Information * The mapfile version and date and time of the last read.

[Version, Last Read Time stamp]

eSTB WAN IP Prov Mode * IP provider mode of eSTB WAN interface

IPv4

IPv6

Dual

60

Page 61: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DOCSIS Status Screen

Page 2: StatusesNote:

Field names marked with * apply for G8 and G10 set-tops only.

Field names marked with ** apply for G6 set-tops only.

eCM IP Prove Mode (MDD) * (Not available) (Not available)

eCM IP Prove Mode Override * (Not available) (Not available)

Addresses

CPE MAC The MAC address for the cable modem host.

[Hardware-dependent]

CPE IPv4 The IPv4 address for the PowerTV CPE.

[Network-dependent]

CPE Lease Exp v4 The expiration date for the lease on the PowerTV CPE.

[Time]

YYMMDD.hhmmss format

CM MAC The MAC address for the cable modem.

[Hardware-dependent]

CM IPv4 The IPv4 address for the cable modem host.

[Network-dependent]

CM IPv6 The IPv6 address for the cable modem host.

[Network-dependent]

DNCS IPv4 The IPv4 address for the DNCS with which the eCM connected.

[Network-dependent]

DNCS IPv6 The IPv6 address for the DNCS with which the eCM connected.

[Network-dependent]

Table 6 Host DOCSIS Status Screen - Page 1 (continued)

Field Name Description Possible Values

61

Page 62: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DOCSIS Status Screen

62

Page 63: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DOCSIS Status Screen

Table 7 Host DOCSIS Status Screen - Page 2

Field Name Description Possible Values

Server State The operational state of DOCSIS. EstablishTOD

ImageDwnload

Inactive

ObtainingIP

Operational

Ranging

ReadingUCD

Registering

Scanning

SendingaParams

Unauthorized

Unavailable: Displays in red

Connectivity The status of the network connectivity.

Inactive

Scanning

Reading UCD

Ranging

Obtaining IP

EstablishToD

SendingParams

Registering

Operational

ImageDwnLoad

Unauthorized

Other

1WayOperational

2WayUpDisabled

Unknown — Contact Cisco

63

Page 64: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DOCSIS Status Screen

CM Status Value The status of the embedded cable modem.

Other

NotReady

NotSynchronized

PhySynchronized

UsParametersAcquired

RangingComplete

IpComplete

TodEstablished

SecurityEstablished

ParamTransferComplete

RegistrationComplete

Operational

Access Denied

Unknown — Contact Cisco Services

CM Status Code These values are defined by the DOCSIS standard.

Refer to Annex D of the DOCSIS 2.0 OSSI specification for details.

sysUpTime * The Up time of the eSTB. [Days, Hours, Minutes, Seconds]

sysDescr * The system description of the eSTB, which includes the hardware revision, vendor, and model number.

[HW Rev, Vendor, Boot loader Rev, SW Rev, Model]

Downstream ** Displays information about the Downstream signal as described below.

Upstream ** Displays information about the Upstream signal as described below.

Mod ** A downstream and upstream mode for the inband tuner.

Downstream:

QAM-64

QAM-256

Other

Unknown

Upstream:

QAM-16

QPSK

Other

Freq ** The downstream and upstream frequency (MHz).

[Dependent on frequency]

Table 7 Host DOCSIS Status Screen - Page 2 (continued)

Field Name Description Possible Values

64

Page 65: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DOCSIS Status Screen

Width ** The upstream and downstream signal bandwidth.

6 MHz: Downstream for DOCSIS

8 MHz: Downstream for Euro-DOCSIS

Variable: Bandwidth for upstream signal

Level ** The downstream and upstream power levels relative to 1 millivolt (dBmV).

[Integer]

Pkts ** The cumulative number of packets received downstream and transmitted upstream.

[Integer > 0]

bps ** The downstream and upstream transmission rates in bits per second (bps).

[Integer > 0]

Ch ID ** The upstream channel ID (UCID) identification value that is associated with a DSG rule.

[Integer > 0]

Symbol Rate ** The upstream baud rate in kilosymbols per second (ksps).

[Network-dependent]

S/N ** The approximate downstream / upstream signal-to-noise S/N ratio (dB).

[Integer > 0]

Corr/Uncorr ** The number of correctable errors / The number of uncorrectable errors.

[Integer > 0] / [Integer > 0]

Table 7 Host DOCSIS Status Screen - Page 2 (continued)

Field Name Description Possible Values

65

Page 66: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DOCSIS Status Screen

Pages 3-5: DOCSIS Events

Pages 6-13: DSG Filters

Table 8 Host DOCSIS Status Screen - Pages 3-5

Field Name Description Possible Values

Level The DOCSIS level of the event. Debug

Information

Notice

Warning

Error

Critical

Alert

Emergency

Last The most recent occurrence of the event.

YYMMDD at hhmmss.d (where d is tenths of seconds), -/+ UTC time differential

Example:

091012 at 120105.2, -5.0 translates to October 12, 2009 at 12:01:05:02, UTC - 5 hours (west of UTC)

Count The number of times the event has occurred.

[Integer > 1]

ID The event ID. [Integer > 0]

First The first occurrence of the event. YYMMDD at hhmmss.d (where d is tenths of seconds), -/+ UTC time differential

Example:

091012 at 120105.2, -5.0 translates to October 12, 2009 at 12:01:05:02, UTC - 5 hours (west of UTC)

Table 9 Host DOCSIS Status Screen - Pages 6-13

Field Name Description Possible Values

Tunnel ID The ID associated with this tunnel. [Integer > 1]

IP Addr Type The type of IP configuration in use. IPv4

IPv6

Start Port The start UDP port value that is associated with the DSG tunnel.

[Integer > 0 and < 65535]

End Port The end UDP port values that is associated with the DSG tunnel.

[Integer > 0 and < 65535]

66

Page 67: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Host DOCSIS Status Screen

Dest IP The destination IP address that is associated with the DSG tunnel and used with the DSG eCM filtering and forwarding process.

[Network-dependent]

0 — Indicates that the destination IP address does not apply

Source IP The source IP address that is associated with the DSG tunnel and is used with the DSG eCM filtering and forwarding process.

[Network-dependent]

0 — Indicates that the source IP filtering does not apply

Source Mask The source IP subnet mask for the DSG stream that is used to filter and forward DSG traffic.

[Network-dependent]

Time Active The amount of time the tunnel has been active.

[Hours, Minutes, Seconds]

Client ID Type The client type as defined by the DSG specification.

CableCARD

Broadcast ID

MAC Address

CA System ID

Client ID Value

Client ID Value The value or address associated with the Client ID Type.

[Client ID Type field-dependent]

MAC The destination MAC address associated with the DSG tunnel entry.

[Hardware-dependent]

Num Pkts The total number of packets that are being classified and filtered for the DSG tunnel entry since the entry was created.

[Integer > 0]

Num Octets The total number of octets that are being classified and filtered for the DSG tunnel entry since the entry was created.

[Integer > 0]

Table 9 Host DOCSIS Status Screen - Pages 6-13 (continued)

Field Name Description Possible Values

67

Page 68: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

DOCSIS DSID Forwarding Screen

Page 14: SEB Status

Pages 15-22: SEB Connected Devices

DOCSIS DSID Forwarding ScreenTasks that you can perform from this screen include the following:

Determine the Downstream Service Identifier (DSID) and its types.

Table 10 Host DOCSIS Status Screen - Page 14

Field Name Description Possible Values

Control Object Indicates whether the SEB feature is enabled on the eCM.

True

False

Role Indicates the current role of the eCM. disabled (1)

sebServerIneligible (2)

sebServerNoClients (3)

sebServerWithClients (4)

sebClientNoTunnel (5)

sebClientWithTunnel (6)

attemptingTwoWay (7)

Figure of Merit The figure of merit of the eCM. [Integer]

Table 11 Host DOCSIS Status Screen - Pages 15-22

Field Name Description Possible Values

MAC ID MAC address of the SEB Client. [Hardware-dependent]

Device Type Type of the device used as the SEB Client.

eSTB

Tunnel Client Port The client-side TCP port number of the SEB Tunnel.

[Integer]

A value of 0 indicates that a SEB Tunnel is not established.

Tunnel Client IP Addr The client-side IP address of the SEB Tunnel.

[Network-dependent]

A value of 0.0.0.0 indicates that an

SEB Tunnel is not established.

Tunner Server Port The server-side TCP port number of the SEB Tunnel.

[Integer]

A value of 0 indicates that an SEB Tunnel is not established.

Tunnel Server IP Addr The server-side IP address of the SEB Tunnel.

[Network-dependent]

A value of 0.0.0.0 indicates that a SEB Tunnel is not established.

68

Page 69: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

DOCSIS Downstream Screen

Determine the channel number and number of packets forwarded in a particular DSID.

Determine the Cable Modem Interface Mask (CMIM) of the DSID.

Note: The fields in this table apply for G8 and G10 set-tops only.

DOCSIS Downstream ScreenTasks that you can perform from this screen include the following:

Verify the downstream interface index (ifIndex), channel ID, and status.

Determine the downstream frequency, modulation, and interleaving interval.

Determine downstream forward error correction (FEC) code information.

Note: The fields in this table apply for G8 and G10 set-tops only.

Table 12 DOCSIS DSID Forwarding Screen

Field Name Description Possible Values

DSID DSID of the forwarding service. 20-bit big-endian value in hexadecimal notation.

Type Type of DSID. Integer

0 — resequencing

1 — multicastCable(MDF)

Num Chan Channel number for the DSID. [Integer]

CMIM CMIM value of the DSID. 32-bit big-endian value in hexadecimal notation.

Num Pkts Number of packets forwarded in the particular service.

Integer

69

Page 70: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

DOCSIS Downstream Screen

Table 13 DOCSIS Downstream Screen

Field Name Description Possible Values

ifIndex Interface Index of the downstream channel.

[Integer]

3 — One of the CATV downstream interfaces

48-79 — Additional CATV downstream interfaces

Ch ID Identification value associated with a DSG rule.

[Integer > 0]

Status Status of the Downstream interface. Up

Down

Freq The downstream and upstream frequency (MHz).

[Dependent on frequency]

Mod A downstream mode for the inband tuner.

Downstream

— QAM-64

— QAM-256

— Other

— Unknown

Interleave The forward error correction (FEC) interleaving used for the downstream channel.

[Integer]

Values:

— 1: Unknown

— 2: other

— 3: taps8Increment16

— 4: taps16Increment8

— 5: taps32Increment4

— 6: taps64Increment2

— 7: taps128Increment1

— 8: taps12Increment17

Width The downstream signal bandwidth. 6 MHz: Downstream for DOCSIS

8 MHz: Downstream for EuroDOCSIS

Level the downstream power levels relative to 1 millivolt (dBmV).

[Integer]

MER Modulation error ratio (MER) of the downstream channel.

[Integer]

bps The downstream transmission rate in bits per second (bps).

[Integer > 0]

Bytes The cumulative number of bytes received downstream.

[Integer > 0]

70

Page 71: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

DOCSIS Upstream Screen

DOCSIS Upstream ScreenTasks that you can perform from this screen include the following:

Verify the upstream interface index (ifIndex), channel ID, and status.

Determine the upstream frequency and modulation.

Determine number of upstream bytes transmitted.

Note: The fields in this table apply for G8 and G10 set-tops only.

Correctable The number of correctable errors. [Integer > 0] / [Integer > 0]

Uncorrectable The number of uncorrectable errors. [Integer > 0] / [Integer > 0]

Unerrored Code words received on downstream channel without error.

[Integer > 0]

Table 13 DOCSIS Downstream Screen (continued)

Field Name Description Possible Values

71

Page 72: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

DVR Information Screen

DVR Information ScreenTasks that you can perform from this screen include the following:

Physical Drive

Determine the model number and serial number of the DVR hard drive.

Verify the amount of free space available on the DVR hard drive.

Determine the size and capacity of the ITFS (Information Technology File System) and the AVFS (Audio/Video File System) file systems.

Verify statistical information about the DVR hard disk in the DHCT.

Partition Information

Table 14 DOCSIS Upstream Screen

Field Name Description Possible Values

ifIndex Interface Index of the upstream channel.

[Integer]

4 — One of the CATV upstream interfaces

88-111 — Additional CATV upstream interfaces

Ch ID Identification value associated with a DSG rule.

[Integer > 0]

Status Status of the upstream interface. Up

Down

Freq The upstream frequency (MHz). [Dependent on frequency]

Mod The upstream mode for the inband tuner.

Upstream

— Other

— QPSK

— QAM16

— QAM8

— QAM32

— QAM64

— QAM256

Width The upstream signal bandwidth. Variable — bandwidth for the upstream channel

Level the upstream power levels relative to 1 millivolt (dBmV).

[Integer]

bps The upstream transmission rate in bits per second (bps).

[Integer > 0]

Bytes The cumulative number of bytes transmitted upstream.

[Integer > 0]

72

Page 73: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

DVR Information Screen

Verify the capacity for the partition.

Verify the amount of available space that remains in the partition.

Determine if any lost or bad clusters exist in the partition.

73

Page 74: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Linux Memory Information Screen

Page 1: Physical Drive

Pages 2-4: Partition Information

Linux Memory Information ScreenTasks that you can perform from this screen include the following:

Table 15 DVR Information Screen - Page 1

Field Name Description Possible Values

Model Number The model type for the DVR HDD. [Model-dependent]

Serial Number The serial number for the DVR HDD. [Model-dependent]

Firmware Version The firmware identification number. [Software-dependent]

Removable Indicates whether the hard drive is removable.

Yes — The hard drive is removable

No — The hard drive is not removable

Capacity The size of the sectors for the HDD. [Hard drive-dependent]

Internal Temp The internal operating temperature of the hard drive.

[Integer > 0]

Last scan status Time of the last scan. [Time]

Remapped sector count Remapped sector count of HDD S.M.A.R.T. data.

0 — Desired value

[Integer > 0] — Could indicate an issue

Table 16 DVR Information Screen - Pages 2-4

Field Name Description Possible Values

Media Volume

Bytes per Cluster The number of bytes per cluster. [Integer > 0]

Total Clusters The total number of clusters in the partition.

[Integer > 0]

Free Clusters The total number of free clusters (not written to) in the partition.

[Integer > 0]

Media Info

Deleted file count The number of files deleted from this partition.

[Integer > 0]

Total file count The total number of files on the partition.

[Integer > 0]

TSB n File Name Actual TSB n (n=1-8) file name of the internal HDD.

[Hardware dependent]

TSB n Duration TSB duration of the internal HDD (in seconds).

[1 < Integer < 18000]

TSB n Bit Rate TSB bit rate of the internal HDD (in kbps) given by the application.

[Integer > 0]

74

Page 75: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Linux Memory Information Screen

Verify the total RAM capability for the system.

Determine the total RAM available for use.

Determine the kernel reserve memory size.

Determine whether there is a memory leak in your system.

75

Page 76: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

CableCARD Information Screen

CableCARD Information Screen

Table 17 Linux Memory Info Screen

Field Name Description Possible Values

System RAM

Total The total physical system RAM visible to Linux (in kB). This will be the actual RAM size minus a small amount reserved for use by the bootloader (around 1 MB).

[Integer > 0]

Boot The amount of RAM (in kB) required to boot the Linux kernel. This includes all static device allocations in kernel space.

[Integer > 0]

Useable The total free usable RAM (kB) available after booting the kernel. This is reported by Linux as memTotal.

[Integer > 0]

Usable RAM

Total The total free usable RAM (kB) available after booting the kernel. This is reported by Linux as memTotal.

[Integer > 0]

Kernel The amount of RAM (kB) reserved for use by the Linux kernel.

[Integer > 0]

User The maximum amount of RAM (kB) available to user processes. Reported by Linux as CommitLimit.

[Integer > 0]

Free The total amount of free RAM (kB) currently available to the system. This is reported by Linux as MemFree.

[Integer > 0]

Kernel

Reserved The amount of RAM (kB) reserved for use by the Linux kernel.

[Integer > 0]

Cache The amount of RAM (kB) used in Linux cache. Reported by Linux as Cached.

This disposable cache may cause kernel memory usage to exceed the specified limit reserved for the kernel.

[Integer > 0]

User

Total The maximum amount of RAM (kB) available to user processes. Reported by Linux as CommitLimit.

[Integer > 0]

Used The total address space (kB) currently committed to user space (including the PTV heap). Reported by Linux as CommittedAS.

[Integer > 0]

Free The total free address space (kB) currently available to user space processes.

[Integer > 0]

76

Page 77: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

CableCARD Information Screen

Tasks that you can perform from this screen include the following:

Determine the CableCARD OOB mode.

Determine the copy protection provisioning status.

View the CableCARD, host, and manufacturer IDs.

View the CableCARD MAC address, serial number, and software and hardware versions.

77

Page 78: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

CableCARD Information Screen

Table 18 CableCARD Information Screen

Field Name Description Possible Values

CA Mode Displays the communication mode of the CableCARD module.

OOB — The CableCARD module is communicating with the headend using the out-of-band channel

DOCSIS — The CableCARD module is communicating with the headend using a DOCSIS channel

CA Status Displays whether the CableCARD module has requested the host authentication key for binding.

Ready — The host authentication key has been requested

Not Ready — The host authentication key has not been requested

Serial Numbers

ISE The Internal Secure Element (ISE) component serial number.

[Hardware-dependent]

ESE The External Security Element (ESE) smart card (optional component) serial number.

[Hardware-dependent]

Unavailable — Smart card is not currently in use

ISE Ver The ISE component version number. [Hardware-dependent]

ESE Ver The ESE smart card (optional component) version number.

[Hardware-dependent]

Unavailable — Smart card is not currently in use

CP ID Information

CableCARD ID Displays the ID of the CableCARD module inserted into the host.

[Hardware-dependent]

Host ID Displays the ID of the host. [Hardware-dependent]

CableCARD Mfr. ID Displays the manufacturer of the CableCARD module.

[Hardware-dependent]

CP / CA System ID Displays the system ID of the copy protection system (CP) and of the conditional access system (CA).

CP System ID

0 — Invalid value

1 — Invalid value

2 — CableCARD CP system; valid value

3 — Invalid value

4 — Invalid value

CA System ID [Hardware-dependent]

Example: 0xE00

CableCARD MAC Address The MAC address of the CableCARD module inserted into the host.

[Hardware-dependent]

78

Page 79: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Common Download Screen

Common Download ScreenTasks that you can perform from this screen include the following:

Verify the status of the current download.

Verify the path that the current download is using.

Verify the percentage of download completion.

CableCARD Serial Number The MAC address of the CableCARD module inserted into the host.

[Hardware-dependent]

CableCARD HW Version CP The hardware version of the CableCARD module inserted into the host.

[Hardware-dependent]

Certificate Check Displays the results of the copy protection authentication between the CableCARD module and the host.

OK — The copy protection certificates have been successfully authenticated

Failed — One of the certificates failed authentication

Last Comm. Err Time when the last error occurred. [Date, Time]

Never — Desired value; no errors have occurred

Last Comm. Time Time when the last communication occurred.

[Date, Time]

Entitlement Agent

ISE The Internal Secure Element (ISE) component serial number.

[Hardware-dependent]

Table 18 CableCARD Information Screen (continued)

Field Name Description Possible Values

79

Page 80: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Common Download Screen

Table 19 Common Download Screen

Field Name Description Possible Values

Status Status of the download. No Trigger — No valid trigger received

Current — CVT received, image on set-top is current

Required — CVT received, download required

Downloading — Download in progress

Complete — Download complete, reboot imminent

Path Path of the download. None — No download in progress

FAT — In-Band FAT channel DSM-CC data carousel

OOB — DSG application tunnel DSM-CC data carousel

TFTP — DOCSIS TFTP

Hardware ID Hardware ID of the platform. [Platform-dependent]

Group ID Common download group ID stored in the bootloader.

[Integer > 0]

Current Image Current image name stored in bootloader.

[File-dependent]

Pending Image Pending image name, from CVT. [File-dependent]

Written Displays size of file (in kB) written to persistent memory (HDD or flash).

[File-dependent]

80

Page 81: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Common Download Screen

Complete Percentage of download completed. [0 < Integer < 100]

Table 19 Common Download Screen (continued)

Field Name Description Possible Values

81

Page 82: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Common Download Screen

Error Last error detected. Important: The errors displayed can include some or all of the following:

None — Desired result

Trigger Status Invalid_CVT

Trigger Status Damaged_CVT

Trigger Status Invalid_CVT_CVC

Trigger Status CVT_No_CVC

Trigger Status CVT_Mismatch_VendorID

Trigger Status CVT_Mismatch_HardwareVersionID

Trigger Status CVT_Mismatch_HostMACAddress

Trigger Status CVT_Mismatch_HostID

Trigger Status CVT_Mismatch_GroupID

Image Status Invalid_CodeImage

Image Status Invalid_CodeImage_CVC

Image Status Mismatch_MessageDigest

Image Status Mismatch_CodeImageCRC

Download Status Download_Failed

Download Status

Download_MaxRetry_Reached

Download Status Download_Cancelled

Download Status Download_Aborted

Upgrade Status Upgrade_Failed

Upgrade Status Damaged_CodeImage

Table 19 Common Download Screen (continued)

Field Name Description Possible Values

82

Page 83: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Platform Status Screens

Platform Status ScreensThe Platform Status diagnostic screens contain information regarding video and audio transmission, tuner status, DMSA channel status, and display status of the stream.

Tasks that you can perform from this screen include the following:

RP Media Main Status

View the state of the media manager handle.

View the source, video decoder, and audio decoder to which the media manager handle is attached.

MPEG Decoder/Encoder Status

Determine the MPEG Transport PID for each decoder.

Verify whether the MPEG stream is progressive or interlaced for each decoder.

Determine the number of frames that have been decoded on the current channel.

Audio Channel Status

Identify if any errors have occurred that relate to MPEG or AC3 decoding (during playback).

Determine the type of audio format being sent through the HDMI port.

Verify the type of closed captioning being decoded.

Platform - DirectFB Info

View the associations, associated types, and display options for the video stream handler.

View the freeze state and decoder being used.

View the ID, capabilities, size, and configuration of the screen.

View the status, ID, capabilities, and configuration of the layers.

InBand SEC Filter

Identify the section and source being filtered.

Identify the state of the filter.

Compare the filter results with other values.

MPEG Display Status

Determine the current resolution of each stream that is being displayed.

Error (continued) Last error detected. Upgrade Status

Reboot_MaxRetry_Reached

Upgrade Status Certificate_Failure

Table 19 Common Download Screen (continued)

Field Name Description Possible Values

83

Page 84: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Navigation

Identify the horizontal and vertical size of the frame.

Determine if any frames were discarded.

Identify if the deinterlacer is activated for either stream.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

84

Page 85: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Navigation

Media Info

Table 20 Platform Status Screens - Media Info

Field Name Description Possible Values

State The current state of the media manager handle.

MediaOpened — A media handle has been opened

DsiOpened — A media handle was opened and the PID table set for the media handle, but currently no AV decoder(s) is allocated to it

DecAllocated — A media handle was opened, the PID table is set, and an AV decoder(s) has been allocated and started

Source The source to which this media manager handle is attached.

RF Tuner

IP Tuner

Play File — Local DVR file playback

HTTP Source — Playback fof video from an HTTP server

Memory Source — Playback from local memory buffers

Vid Decoder Indicates the video decoder allocated to this media manager handle.

Digital 0 — Digital decoder (main)

Digital 1 — Digital decoder (PIP)

Analog 0 — Analog decoder (main)

Analog 1 — Analog Decoder (PIP)

Aud Decoder Indicates the audio decoder allocated to this media manager handle.

Digital 0 (primary) — Digital decoder

Digital 1 (secondary) — Digital decoder

Analog 0 (primary) — Analog decoder

Analog 1 (secondary) — Analog Decoder

85

Page 86: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Navigation

Decoder/Encoder

Table 21 Platform Status Screens - Decoder/Encoder

Field Name Description Possible Values

State The current state of the MPEG channel.

Connected

Initialized

Open

Pre-initialized

Started

Pid The MPEG transport PID used to encapsulate IHP PDUs within MPEG-PS sections in order to transmit them to the client.

0 — No PID is assigned or it is not known

[Integer > 0]

Screen Type The type of stream being sent. HD — High definition

SD — Standard definition

MPEG Stream Type The type of stream being decoded. MPEG1

MPEG2

Scan Type Indicates whether the stream is progressive or interlaced.

Progressive

Interlaced

Decoder Skips The number of times the decoder has skipped since tuning to this channel.

[Integer > 0]

Change Counter The number of times that the stream has changed since tuning to this channel.

[Integer > 0]

Bit Buffer Free The available buffer memory not currently being used.

[Integer > 0]

Bit Buffer Level The number of bits being held in the buffer.

[Integer > 0]

Frames per Second The frame rate of the stream. [Integer > 0]

Vidc Sync Error The difference between the PTS value and the PCR value.

[Integer > 0]

RFF Count The number of times that the Repeat First Field flag has occurred.

[Integer > 0]

Frame count The number of frames that have been decoded since the DHCT was booted.

[Integer > 0]

Horiz Res The horizontal resolution of the decoded video.

[Stream-dependent]

Vert Res The vertical resolution of the decoded video.

[Stream-dependent]

86

Page 87: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Navigation

Audio Channel Info

Table 22 Platform Status Screens - Audio Channel Info

Field Name Description Possible Values

Decoder Status

Decoder 1 / Decoder 2 Displays the status of the audio decoders 1 and 2 as described below.

Pid The PID of the audio stream. [Integer > 0]

Mpeg Errors The number of MPEG decoding errors detected by the audio DSP since the playback began.

[Integer > 0]

AC3 Errors The number of AC3 decoding errors detected by the audio DSP since the playback began.

[Integer > 0]

WD Timeouts The number of times the audio DSP has reset because of a Watch Dog timeout.

[Integer > 0]

Fatal Errors The number of times the audio DSP has reset count because of a fatal error.

[Integer > 0]

Audio Type The type of audio encoding format. MpegLayer1

MpegLayer2

MpegLayer3

Dolby AC3

PCM

Digital Closed Caption Syntax

C Type The type of closed captioning being decoded.

DVS-157 (Digicypher)

EIA-708 w/ DTVCC (EIA-708 with Digital Television Closed Captioning)

EIA-708 w/o DTVCC (EIA-708 without Digital Television Closed Captioning)

None

SA type 0

CC Type Count The number of Closed Captioning formats currently available in the stream.

[Integer > 0]

HDMI Status

87

Page 88: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Navigation

State The current state of the HDMI port. Compatible Monitor connected

Incompatible Monitor connected

Initialized

Pre-Initialized

Revoked Monitor connected

Extension Version The Electronic Industries Alliance (EIA) standard to which this television complies.

EDID

EIA-861

EIA-861A

EIA-861B

Unknown

Audio Format The type of audio being sent out through the HDMI port.

AC3 (compressed)

Linear Pulse Code Modulation (LCPM; uncompressed)

No Audio

HDCP Status

State The current state of the HDCP process.

Initialized

Authenticated

In process/Incompatible

Initialized Key Exchange

Pre-initialized

Table 22 Platform Status Screens - Audio Channel Info (continued)

Field Name Description Possible Values

88

Page 89: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Direct FB Info

Direct FB Info

Page 1: RP Video Stream Handler

Table 23 Platform Status Screens - Direct FB Info - Page 1

Field Name Description Possible Values

VSH 1 / VSH 2 Displays the status of the video screen handler 1 and 2 as described below.

Freeze State Freeze mode (no frame update on screen) status.

true — Freeze mode

false — Not in freeze mode

Reference Count Reference count data for VSH data structure. Value changes on displaying/stopping content on various outputs.

[Integer > 0]

Decoder Unit Decoder providing frames to this VSH unit.

[Integer 0 to n-1] — Decoder unit where n represents the total number of decoders in the set-top

Stream Type Source stream types. Analog

Digital

Association Count Total number of associations handled from this VSH.

[Integer > 0] — Equals the number of "Display To Layer" plus the number of "Display to Surface"

Associations

Type Type of association. Layer — Video content sent to a video layer

Surface — Video content sent to a graphics surface (PIP)

Display Flag Flags based on which middleware frame callback would be invoked.

Sum of flag (hexadecimal) values:

0 — No callback

2 — Callback invoked on

AFD change

4 — Callback invoked on

Aspect ratio change

8 — Callback invoked on frame size change

10 — Callback invoked for all frames

10000 — Populate frame surface in callback

20000 — Provide decimated frame surface in callback

89

Page 90: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Direct FB Info

Surface / Layer Id Surface or layer ID. Layer ID for layer:

4 — HD screen

8 — SD screen

DFB surface pointer for surface

Scaling rectangle Coordinates for the scaling rectangle. Rectangular coordinates (can have top left values and bottom right values can cross screen size)

Note: These coordinates are relative to the screen rectangle = (size of layer [based on scan rates] for layer rendering/size of surface for surface rendering).

Opaque rectangle Coordinates for the opaque rectangle (deprecated).

Rectangular coordinates (rectangle within screen/surface area)

Video rectangle Coordinates for the video rectangle.

The video rectangle is the position on the screen where video is seen.

Rectangular coordinates (rectangle within screen/surface area)

Table 23 Platform Status Screens - Direct FB Info - Page 1 (continued)

Field Name Description Possible Values

90

Page 91: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Direct FB Info

Page 2: RP Screen and Layer Status

Table 24 Platform Status Screens - Direct FB Info - Page 2

Field Name Description Possible Values

Screen Statuses

Name Name of the screen. HD screen

SD screen

Capabilities Capabilities of the screen. Sum of hexadecimal values:

1 — Vsync suport

2 — Power management support

10 — Mixer support

20 — Encoder support

40 — Output support

Port Configuration Provides details about the output ports connected.

Sum of hexadecimal values:

1— VGA

2 — SCART

4 — Y/C

8 — CVBS

10 — 2nd SCART

20 — Component

40 — HDMI

80 — DVO

Size Resolution of the screen. Resolution (based on scan rate):

720x480

1280x720

1920x1080

Layer Count Number of layers in the screen. [1 > Integer > 5]

Layer Statuses

Name Name of the layer. HD Graphics1/2/3

SD Graphics1/2

HD Video

SD Video

HD Diag

SD Diag

91

Page 92: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Direct FB Info

Enable Count The number of entities that have requested to enable the video layer. Video layer would be enabled only if the count is greater than or equal to 2.

[Integer > 1]

Capabilities Capabilities of the layer. Sum of hexadecimal values:

1— Layer has drawable surface

2 — Global alpha support

4 — Pixel alpha support

8 — Movable layer

10 — Flicker filtering support

20 — Deinterlace support

40 — Source colorkey support

80 — Destination color key support

100 — Brightness support

200 — Contrast support

400 — Hue support

800 — Saturation support

1000 — Z order support

2000 — Field parity support

4000 — Hardware window support

8000 — Selectable sources

10000 — Alpha ramp support

20000 — Premulitplied alpha support

100000 — Positionable layer

200000 — Resizeable layer

—— Clip region support

Table 24 Platform Status Screens - Direct FB Info - Page 2 (continued)

Field Name Description Possible Values

92

Page 93: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Direct FB Info

Configuration Configuration of the layer. Sum of hexadecimal values:

1 — Alpha channel

2 — Flicker filtering

4 — Deinterlacing

8 — Source color key

10 — Destination color key

20 — Global alpha factor

40 — Field parity

1000 — Front buffer only

2000 — Back buffer in video memory

4000 — Back buffer in system memory

8000 — Triple buffering

10000 — No layer buffer

Size Dimensions of the screen. [width x height]

Level Z-order level of the layer. [Integer > 0]

Table 24 Platform Status Screens - Direct FB Info - Page 2 (continued)

Field Name Description Possible Values

93

Page 94: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Direct FB Info

InBand SEC Filter

Table 25 Platform Status Screens - InBand SEC Filter

Field Name Description Possible Values

PID Packet identifier of the section being filtered.

16-bit value — As defined by ISO 13818-1

SrcName Source being monitored for incoming sections.

QAM [1-3] — QAM tuner 1 through 3

FIFO [1-11] — FIFO inputs 1 through 11

RefCount Number of unique section filters currently filtering on this given PID.

[Integer > 0]

PSI Err Number of DMA ring buffer reads. [Integer > 0]

CRC Err Number of DMA ring buffer read errors.

[Integer > 0]

OFLow? The DMA buffer overflow status. True — Buffer overflow occurred

False — No buffer overflow occurred

OFCnt The number of times the DMA buffer overflow occurred.

[Integer > 0]

Filter Name

State Current state of the section filter. 0 — Invalid State

1 — Initialized

2 — Idle

3 — Reading

PrgHdl Program handle associated with this section filter.

[variable]

BW Bandwidth of data expected on this section filter.

Low — Low bandwidth data

High — High bandwidth data

TO (ms) Timeout (in milliseconds) while waiting for sections.

–1— Infinite timeout

[Integer > 0]

CbkCnt Number of callbacks made to MW by this section filter.

[Integer > 0]

ReadDataSize The total number of bytes read by this section filter and passed to the MW during its lifetime.

[Integer > 0]

HWFltEnable Indicates whether the HW filter is enabled for this section filter.

0 — HW Filter not enabled

1 — HW filter enabled

Filter Group

ID Filter group ID of the first group of this section filter.

[Variable]

Filter Number to be compared against Value and Mask operation.

[64-bit filter number]

94

Page 95: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Home Networking Screen

MPEG Disp Status

Home Networking ScreenTasks that you can perform from this screen include the following:

Verify whether UPnP devices are available on the network and review the services offered by them.

Verify the status of the home network playback being rendered.

Verify the Media Server name of this set-top and its status.

Verify the list of clients that are currently being streamed by this server and the filenames that are being served.

Value Value for the filter. [64-bit number]

Mask Mask for the filter. [64-bit number]

Offset Offset on which to test the Value/Mask combination.

[32-bit number]

Comp Comparison rule to use on the Value. 1 — 'Equal to' comparison

2 — 'Not Equal To' comparison

3 — 'Less Than' Comparison

4 — 'Greater Than' comparison

Table 25 Platform Status Screens - InBand SEC Filter (continued)

Field Name Description Possible Values

Table 26 Platform Status Screens - MPEG Disp Status

Field Name Description Possible Values

Dispaly 1 / Display 2 Shows the status of displays 1 and 2 as described below.

Display Config The current output configuration of the display.

480i

480p

720p

1080i

Deinterlacer ON An indication of whether the Deinterlacer is turned on or off.

False (Off)

True (On)

Low Delay Indicates whether or not the stream is low delay video encoding capable.

False (Not capable)

True (Capable)

Horz Res The horizontal resolution of the frame. [Frame-dependent integer value]

Vert Res The vertical resolution of the frame. [Frame-dependent integer value]

Discarded Frame The number of late frames that were discarded.

[Integer > 0]

95

Page 96: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Home Networking Screen

Pages 1-2: UPnP

Page 3: Streaming (Client)

Pages 4-6: Failed Streaming Requests

Table 27 Home Networking Screen - Pages 1-2

Field Name Description Possible Values

Servers Lists the Universal Plug and Play (UPnP) media servers and their schemas available in the network.

[Network-dependent]

Table 28 Home Networking Screen - Page 3

Field Name Description Possible Values

URL The URL of the file being played back. [File dependent]

Player ID The ID of the current playback. [File-dependent]

Note: The ID displayed is a hexadecimal integer.

Server IP The IP address of the server that is streaming to the client.

[Network-dependent]

State The current state of the remote playback.

Playing

Paused

Stopped

Length The duration of the item being played back.

[File-dependent]

Note: The number displayed is in seconds.

Play Speed The play speed information for verifying trick modes.

[Mode-dependent]

Note: The play speed is displayed as a fraction of the non-trick play speed.

Play Position The current playback position. [Integer < Length of file]

Title Title of the file being played back. [File-dependent]

Objects ID The ID of the object being played back.

[File-dependent]

Content Type The type of content being played back.

[File-dependent]

96

Page 97: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Home Networking Screen

Pages 7-10: Streaming (Server)

Page 11: Media Server

Table 29 Home Networking Screen - Pages 4-6

Field Name Description Possible Values

URL The URL of the file being played back. [File-dependent]

Player ID The ID of the current playback. [File-dependent]

Note: The ID displayed is a hexadecimal number.

Server IP The IP address of the server that is streaming to the client.

[Network-dependent]

HTTP Code HTTP code that reflects the status of the HTTP request sent between the client and the server.

[Status-dependent]

State The current state of the remote playback.

Playing

Paused

Stopped

Table 30 Home Networking Screen - Pages 7-10

Field Name Description Possible Values

Active Clients Number of streaming clients active in the network.

[Integer > 0]

Server ID ID of the server streaming the video. [Network-dependent]

Client IPs IP addresses of the clients streaming the video.

[Network-dependent]

Client MAC MAC addresses of the clients streaming the video.

[Hardware-dependent]

URLs List of the URLs of the files being streamed

[Network-dependent]

Table 31 Home Networking Screen - Page 11

Field Name Description Possible Values

Friendly Name Name of the media server in use. [Product-dependent]

Server State State of the media server. [Product-dependent]

97

Page 98: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Manufacturer Diagnostics

Home Networking Screen

98

Page 99: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

System DiagnosticsIntroduction

The System Diagnostics screens let you obtain statistical information about the in-band channels on your system in real time.

These screens are divided into pages and sections that are devoted to specific tasks. Tasks that you can perform from these screens include the following:

In-Band Network

Confirm the number of successful and unsuccessful tuning requests.

Confirm the number of correctable and uncorrectable data blocks received.

Verify the program number and CCI of the MPEG stream.

Out-of-Band Network

Confirm the power levels and frequencies of the OOB network.

Monitor the signal lock, signal-to-noise ratio, and error correction in the OOB network.

Monitor the round-trip delay of the RDC.

DOCSIS

Verify the status of the DOCSIS network operation on your system.

Device Address

View the network and MAC addresses of the various interfaces on the set-top.

HDMI

Determine the HDMI connection status of the set-top.

Determine the type of audio format being sent through the HDMI port.

Verify the streaming format and HDCP status of the HDMI port.

NavigationTo enter the System Diagnostic screens, press the SELECT on the set-top remote control or the set-top front panel. For screens with multiple pages, use the < and > arrow keys to move from page to page.

Pages 1-4: In-Band Network ScreenTasks that you can perform from this screen include the following:

99

Cisco Systems, Inc. www.cisco.com

Page 100: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

System Diagnostics

Page 5: OOB Network Screen

Confirm the number of successful and unsuccessful tuning requests.

Confirm the number of correctable and uncorrectable data blocks received.

Verify the program number and CCI of the MPEG stream.

Page 5: OOB Network ScreenTasks that you can perform from this screen include the following:

Table 1 Pages 1-4: In-Band Network Screen

Field Name Description Possible Values

Tuner n Displays the status of Tuner n (n = 1 – 8) as described below.

Success Tune Count The number of successful tuning requests.

[Integer > 0]

Failed Tune Count The number of unsuccessful tuning requests.

[Integer > 0]

Last Failed Frequency The last frequency (in MHz) that the in-band tuner failed to tune.

[Integer > 0] MHz — The last frequency that failed to tune since the last host boot cycle

N/A — A tuning error has not occurred since the last host boot cycle

Correctable The number of bytes received in error that have been successfully corrected by the forward error correction (FEC) code.

[Integer > 0]

Important: If incrementing rapidly, picture freezing or macroblocking may be present.

Uncorrectable The number of data blocks received in error that were not successfully corrected by the FEC code.

[Integer > 0]

Important: If incrementing rapidly, picture freezing or macroblocking may be present.

PRC Lock The time stamp of the last PCR synchronization lock.

[Integer > 0] — Number should change each time the screen refreshes; otherwise video may be lost.

MPEG Program The MPEG program number assigned to the video stream.

[Hexadecimal number] (dependent on current video stream)

CCI If streaming, the source copy control information (SRC CCI) value being encoded into the program map table (PMT) will appear.

free — Unlimited copying of content

never — Content cannot be copied

no more — Content cannot be copied

once — Content can be copied once

undefined — No CCI value

100

Page 101: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

System Diagnostics

Page 5: OOB Network Screen

Confirm the power levels and frequencies of the OOB network.

Monitor the signal lock, signal-to-noise ratio, and error correction in the OOB network.

Monitor the round-trip delay of the RDC.

101

Page 102: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

System Diagnostics

Page 5: OOB Network Screen

I

Table 2 OOB Network Screen

Field Name Description Possible Values

FDC / RDC Shows the frequency and power of the Forward Data Channel (FDC) and the Reverse Data Channel (RDC) as described below.

Frequency (MHz) The frequency (Freq) of the tuned QPSK receiver in MHz.

[Network-dependent]

Power (dBmV) The approximate received signal level.

Refer to hardware specifications.

Value displayed in white — Signal level is nominal

Value displayed in amber — Signal level is marginally too high or too low

Value displayed in red — Signal level is unacceptably too high or too low

RDC Data Rate (kb/s) Current data rate of the RDC. [Integer > 0]

FDC Lock QPSK receiver (Rx) tuner lock status. Locked — Desired value

Not Locked

FDC SNR (dB) The signal-to-noise ratio. Refer to hardware specifications.

Value displayed in white — Signal level is nominal

Value displayed in amber — Signal level is marginally too high or too low

Value displayed in red — Signal level is unacceptably too high or too low

n/a — Not applicable for this DHCT

FDC FEC Corr (/Sec) The number of bytes received in error that have been successfully corrected by the forward error correction (FEC) code.

[Integer > 0]

Important: If incrementing rapidly, picture freezing or macroblocking may be present.

RDC Delay (μSec) The round-trip delay in microseconds between the set-top and the modem at the headend or hub that is used to determine when to transmit the slotted-aloha packets.

Note: Slotted-aloha packets are used to assign periods of time or slots when the set-top can transmit without interfering with other set-tops on the same hub.

[Integer > 0]

102

Page 103: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

System Diagnostics

Page 6: DOCSIS Screen

Page 6: DOCSIS ScreenTasks that you can perform from this screen include the following:

Verify the status of the DOCSIS network operation on your system.

Page 7: Device Address ScreenTasks that you can perform from this screen include the following:

View the network and MAC addresses of the various interfaces on the set-top.

Page 8: HDMI ScreenTasks that you can perform from this screen include the following:

Table 3 Page 6: DOCSIS Screen

Field Name Description Possible Values

Downstream Center Freq The center frequency of the downstream channel (MHz).

[Frequency-dependent]

Downstream Rcvd Power The downstream power level relative to 1 millivolt (dBmV).

[Integer > 0]

Downstream Carrier Lock Displays whether the downstream carrier has locked onto a frequency.

Locked

Unlocked

Downstream SNR The approximate downstream signal-to-noise ratio (in dB).

[Integer > 0]

Upstream Center Freq The center frequency of the upstream channel (MHz).

[Frequency-dependent]

Upstream Power The upstream power level relative to 1 millivolt (dBmV).

[Integer > 0]

Table 4 Page 7: Device Address Screen

Field Name Description Possible Values

Device Address The various interfaces on the set-top. [Device-dependent]

Examples:

eSTB — Set-top

eCM — Set-top cable modem

Card — CableCARD module

MAC The MAC address of the interface referred to in 'Device Address'.

[Device-dependent]

Example: 00:01:e6:68:9b:e5

IP The IP address assigned to the Ethernet adapter associated with the device.

[Network-dependent]

Example: 10.1.0.1

103

Page 104: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

System Diagnostics

Page 8: HDMI Screen

Determine the HDMI connection status of the set-top.

Determine the type of audio format being sent through the HDMI port.

Verify the streaming format and HDCP status of the HDMI port.

Table 5 Page 8: HDMI Screen

Field Name Description Possible Values

Connection Status Current state of the HDMI port connection.

Compatible Monitor connected

Incompatible Monitor connected

Initialized

Pre-Initialized

Revoked Monitor connected

False (no connection)

Connected Device Type The type of device connected to the HDMI port.

[Device-dependent]

HDCP Status Current state of the HDCP process. Initialized

Authenticated

In process/Incompatible

Initialized Key Exchange

Pre-initialized

# Horizontal Lines The number of horizontal lines in the video stream.

[Stream-dependent]

# Vertical Lines The number of vertical lines in the video stream.

[Stream-dependent]

Frame Rate The frame rate of the video stream. [Stream-dependent]

Aspect Ratio The aspect ratio of the video stream. [Stream-dependent]

Streaming Format The format of the streaming video. [Stream-dependent]

104

Page 105: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Card DiagnosticsIntroduction

The Card diagnostic screen displays CableCARD information followed by any additional information provided by the CableCARD manufacturer. The host displays its own CableCARD summary information on the first summary screen. The host then pulls any subsequent CableCARD diagnostic screens from the CableCARD module and displays them for your information.

Note:

The content of screens other than the summary screen are dependent on the CableCARD manufacturer and so are not included in this document.

If you are using Cisco M-Cards for your CableCARD modules, you can get detailed information on these screens from M-Card and S-Card Diagnostic Screens on a TV Host: A Reference Guide.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

Summary ScreenTasks that you can perform from the Summary screen include the following:

Determine the CableCARD OOB mode

Determine the copy protection provisioning status

View the CableCARD, host, and manufacturer IDs

View the CableCARD MAC address, serial number, and software and hardware versions

105

Cisco Systems, Inc. www.cisco.com

Page 106: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Card Diagnostics

Summary Screen

Table 1 Card Summary Screen

Field Name Description Possible Values

CA Mode Displays the communication mode of the CableCARD module.

POD

VPOD

Err

CA Status Displays the status of the mutual authentication between the CableCard and the host.

ready — indicates mutual authentication between CableCARD and host has succeeded and they are bound successfully

not ready — indicates mutual authentication between CableCARD and host has not commenced or is in process

not available

Serial Numbers

Note: These fields are available only in Cisco Mcard or Embedded CA mode.

ISE The Internal Secure Element (ISE) component serial number.

[Hardware-dependent]

ESE The External Security Element (ESE) smart card (optional component) serial number.

[Hardware-dependent]

Unavailable: smart card is not currently in use

ISE Ver The Internal Secure Element (ISE) Software version number.

[Software-dependent]

Ex: 5.02

ESE Ver The External Security Element (ESE) smart card (optional component) version number.

[Hardware-dependent]

Unavailable: smart card is not currently in use

CP ID Information

CableCARD ID Displays the ID of the CableCARD module inserted into the host.

[Hardware-dependent]

Host ID Displays the ID of the host. [Hardware-dependent]

CableCARD Mfr. ID Displays the manufacturer ID of the CableCARD module.

[Hardware-dependent]

106

Page 107: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Card Diagnostics

Summary Screen

CP / CA System ID Displays the system ID of the copy protection system (CP) and of the conditional access system (CA).

CP System ID:

0 — invalid value

1 — invalid value

2 — CableCARD CP system; valid value

3 — invalid value

4 — invalid value

CA System ID:

[Hardware-dependent]

Example: 0xE00

CableCARD MAC Address The MAC address of the CableCARD module inserted into the host.

[Hardware-dependent]

CableCARD Serial Number The Serial Number of the CableCARD module inserted into the host.

[Hardware-dependent]

CableCARD HW Version The hardware version of the CableCARD module inserted into the host.

[Hardware-dependent]

CP Certificate Check Displays the validation status of the copy protection certificates exchanged between the CableCARD module and the host.

OK — the copy protection certificates have been successfully authenticated

Failed — one of the certificates failed authentication

Last Comm. Err The last error occurred and command which causes the error.

[Integer >= 0] (Displayed while in VPOD mode)

See MCard Pages (Displayed while in CableCARD mode)

Last Comm. Time Time when the last communication occurred.

[Date, Time] (Displayed while in VPOD mode)

See MCard Pages (Displayed while in CableCARD mode)

Table 1 Card Summary Screen

Field Name Description Possible Values

107

Page 108: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Card Diagnostics

Summary Screen

108

Page 109: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

DVR DiagnosticsIntroduction

The DVR Diagnostics screen contains information regarding the hard disk drive on the set-top that is used to store digitally recorded video programs.

This screens is divided into pages and sections that are devoted to specific tasks. Tasks that you can perform from these screens include the following:

Physical Drive

Determine the model and serial number of the hard drive.

Verify the amount of available free space.

Determine the size and capacity of the Information Technology File System (ITFS).

Determine the size and capacity of the Audio/Video File System (AVFS).

Verify statistical information about the DVR hard disk in the DHCT.

Partition Information

Verify the capacity of the partition.

Verify the amount of available space that remains in the partition.

Determine if any lost or bad clusters exist in the partition.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

Page 1: Physical Drive ScreenTasks that you can perform from this screen include the following:

Determine the model and serial number of the hard drive.

Verify the amount of available free space.

Determine the size and capacity of the Information Technology File System (ITFS).

Determine the size and capacity of the Audio/Video File System (AVFS).

Verify statistical information about the DVR hard disk in the DHCT.

109

Cisco Systems, Inc. www.cisco.com

Page 110: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

DVR Diagnostics

Page 2: Partition Information Screen

Page 2: Partition Information ScreenNote: This diagnostic screen only appears on set-top models that include a DVR.

Tasks that you can perform from this screen include the following:

Verify the capacity of the partition.

Verify the amount of available space that remains in the partition.

Determine if any lost or bad clusters exist in the partition.

Table 1 DVR Diagnostics Screen: Page 1

Field Name Description Possible Values

Model Number The model number of the hard drive. [Model-dependent]

Unavailable

Serial Number The serial number of the hard drive. [Model-dependent]

Unavailable

Firmware Version The firmware identification number. [Software-dependent]

Removable A confirmation that indicates if the hard disk is removable.

No

Yes

Unavailable

Capacity The total amount of disk space available on the hard drive.

[Model-dependent]

Unavailable

Internal Temp The internal operating temperature of the hard drive.

[Integer > 0]

Last Scan Status Time of the last scan. [Time]

Remapped Sector Count Remapped sector count of HDD S.M.A.R.T. data.

0 — Desired value

[Integer > 0] — Could indicate an issue

110

Page 111: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

DVR Diagnostics

Page 2: Partition Information Screen

I

Table 2 DVR Diagnostics Screen: Page 2

Field Name Description Possible Values

Media Volume

Bytes per Cluster The number of bytes per cluster. [Integer > 0]

Total Clusters The total number of clusters in the partition.

[Integer > 0]

Free Clusters The total number of free clusters (not written to) in the partition.

[Integer > 0]

Media Info

Deleted file count The number of files deleted from this partition.

[Integer > 0]

Total file count The total number of files on the partition.

[Integer > 0]

TSB n File Name Actual TSB n (n=1-8) file name of the internal HDD.

[Hardware dependent]

TSB n Duration TSB duration of the internal HDD (in seconds).

[1 < Integer < 18000]

TSB n Bit Rate TSB bit rate of the internal HDD (in kb/s) given by the application.

[Integer > 0]

111

Page 112: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

DVR Diagnostics

Page 2: Partition Information Screen

112

Page 113: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Home Networking DiagnosticsIntroduction

The Home Networking Diagnostics screens let you view information about the clients connected to the network, the host and client digital rights management (DRM) capability, and the components, characteristics, and performance of the MoCA network.

These screens are divided into pages and sections that are devoted to specific tasks. Tasks that you can perform from these screens include the following:

Host Status

Verify the maximum number of clients allowed to connect to the network.

Determine the current number of clients connected to the network.

Verify the client IP addresses, MAC addresses, and DRM capability.

Verify the host DRM capability.

MoCA Summary

Verify the MoCA network levels.

Verify transmit and receive data rates for the nodes in the network.

Verify the number of nodes in the network.

MoCA Node Rate Table

Determine the transmit rate from the local node.

Determine the data rate used for packets to all other nodes.

MoCA Node Power Level Table

Determine the receive level from the other nodes in the netowrk to the local node.

Determine the path loss from each node to the local node.

MoCA Node Statistics Table

Determine the transmit and receive bit rates and path margins for each local node in the network.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

113

Cisco Systems, Inc. www.cisco.com

Page 114: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Home Networking Diagnostics

Host Status Screen

Host Status ScreenTasks that you can perform from this screen include the following:

Verify the maximum number of clients allowed to connect to the network.

Determine the current number of clients connected to the network.

Verify the client IP addresses, MAC addresses, and DRM capability.

Verify the host DRM capability.

MoCA Summary ScreenTasks that you can perform from this screen include the following:

Verify the MoCA network levels.

Verify transmit and receive data rates for the nodes in the network.

Verify the number of nodes in the network.

Table 1 Host Status Screen

Field Name Description Possible Values

Max Clients The maximum number of clients the host can support.

0 — Host does not support home networking clients

[Integer > 0]

# Clients Number of connected clients. [Integer > 0]

Client IP The IP address of connected clients. 0 — No IP address assigned

[network-dependent]

Host DRM Status of the host DRM capability. 0x00 — Host has no DRM capability

0x01 — Host supports DRM but not for home networked clients

0x02 — Host supports DRM for itself and for home networked clients

Client MAC MAC address of connected clients. [Hardware-dependent]

Client DRM Status of the client DRM capability. 0x00 — Client has no DRM capability

0x01 — DRM trust not established in client

114

Page 115: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Home Networking Diagnostics

MoCA Summary Screen

I

Table 2 MoCA Summary Screen

Field Name Description Possible Values

Node ID The local node ID. [Integer 0 < (N-1)] where N = 8 for MoCA 1.0 and N = 16 for MoCA 1.1

Version Version of the MoCA standard used to form the network.

1.0

1.1

2.0

Link Status Status of the MoCA network. Link Up — Preferred value

No Link

Disabled

LOF (MHz) Last Operational Frequency (in MHz). [Integer > 0]

Note: This is typically equal to the channel.

Link Privacy Indicates the status of Link Privacy. Enabled

Disabled

MAC MAC address of the MoCA interface. [Hardware-dependent]

Example: If the STB RF MAC of the set-top is 00:1E:6B:D2:4D:4C, the MoCA interface MAC is 20:1E:6B:D2:4D:4C.

Preferred NC Determines whether the set-top is configured to be a preferred network coordinator.

True — The set-top is configured as a preferred network coordinator

False — The set-top is not configured as a network coordinator

Note: Configuring a set-top as a preferred NC means that the set-top (node) has an advantage in the dynamic NC selection process. An NC will still be selected if all nodes on the network are set to False.

Interface Indicates whether the MoCA interface is Enabled or Disabled.

Enabled

Disabled

RF Channel (MHz) Channel center frequency of the MoCA network (in MHz).

[825 > Integer < 1525]

Important: A changing value indicates that the set-top is hunting for the correct frequency.

Up Time Length of time that the Status has been at Link Up.

[Time]

Example: 3h 10m 6s

115

Page 116: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Home Networking Diagnostics

MoCA Node Rate Table Screen

MoCA Node Rate Table ScreenTasks that you can perform from this screen include the following:

Determine the transmit rate from the local node.

Determine the data rate used for packets to all other nodes.

Brdcst Phy Rate Data rate used for packets broadcast to all other nodes.

[Integer > 0]

LP CRC Link Privacy Checksum value. [Integer > 0]

Important: For two or more devices to form a MoCA network, their LP checksums must match.

# nodes Number of remote nodes present on the MoCA network.

[Integer 0 < (N-1)] where N = 8 for MoCA 1.0 and N = 16 for MoCA 1.1

NC Node Id Node ID of the network coordinator. [Integer 0 < (N-1)] where N = 8 for MoCA 1.0 and N = 16 for MoCA 1.1

IF Summary

IP IP address acquired using HHCP or IPv4 Link-Local protocol.

[Network-dependent]

Note: After Link Up, the set-top automatically acquires an IP address from a DHCP server in a MoCA device. If none of the MoCA Devices have DHCP enabled, the set-top will acquire an IP address using IPv4 Link-Local Protocol.

# Tx Pckts Number of Ethernet packets transmitted by this node since MoCA link up.

[Integer > 0]

# Rx Pckts Number of Ethernet packets received by this node since MoCA link up.

[Integer > 0]

# Rx Drops Number of Ethernet packets with errors dropped by this node since MoCA link up.

[Integer > 0]

Mask Subnet mask of the MoCA IF IP. [Network-dependent]

Tx Pckts drop Number of transmitted Ethernet packets dropped by this node since MoCA link up.

[Integer > 0]

Rx Pcs correction Number of Ethernet packets with errors corrected by this node since MoCA link up.

[Integer > 0]

Table 2 MoCA Summary Screen (continued)

Field Name Description Possible Values

116

Page 117: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Home Networking Diagnostics

MoCA Node Power Level Table Screen

MoCA Node Power Level Table ScreenTasks that you can perform from this screen include the following:

Determine the receive level from the other nodes in the netowrk to the local node.

Determine the path loss from each node to the local node.

MoCA Node Statistics Table ScreenTasks that you can perform from this screen include the following:

Determine the transmit and receive bit rates and path margins for each local node in the network.

Table 3 MoCA Node Rate Table

Field Name Description Possible Values

Unicast PHY Rate Transmit rate from the local node to every other node in the network (in Mb/s).

[Integer > 0]

Brdcst PHY Rate Data rate used for packets broadcast to all other nodes (in Mb/s).

[Integer > 0]

Table 4 MoCA Node Power Level Table

Field Name Description Possible Values

Rx Power (dBm) Receive level from each other node to the local node (in dBm).

[Integer < 0]

Path Loss (dBm) Approximate loss from each node to the local node (in dB).

[Integer < 0]

Important: Losses greater than 54 dB an indicate a problem with the home wiring.

Table 5 MoCA Node Statistics Table Screen

Field Name Description Possible Values

NODE ID Two-digit node ID number. [Integer > 0]

NODE MAC MAC address of the node. [Hardware-dependent]

Unicast PHY Rate (Mbps) Tx Transmit rate for the local node (in Mb/s).

[Integer > 0]

Note: Preferred value is at least 180 Mb/s. Wait at least 30 seconds after Link Up is achieved to verify.

Unicast PHY Rate (Mbps) Rx Receive rate for the local node (in Mb/s).

[Integer > 0]

Path Margin (dB) Difference (in dB) between actual and minimum acceptable signal strength.

[Integer > 0]

N/A

117

Page 118: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Home Networking Diagnostics

MoCA Node Statistics Table Screen

118

Page 119: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Cisco CAS DiagnosticsIntroduction

The Cisco CAS diagnostic screens let you view information about the Cisco conditional access (CA) encryption, the conditional access system (CAM), and Internet pay-per-view (IPPV) purchases.

These screens are divided into pages and sections that are devoted to specific tasks. Tasks that you can perform from these screens include the following:

Cisco Conditional Access Kernel

Verify the total number of messages and type of messages received by the set-top.

View the number of messages validated by the ISE and ESE components.

Verify if the Sub Expires date is at least 30 days ahead of the current date.

Determine the encryption status for a program.

CAM Status

Verify the status of Conditional Access Management (CAM).

Verify that a valid ECM PID has been received.

Verify the total number of ECMs that have been received.

Determine which package IDs have authorized a program.

IPPV Information

Verify the total number of Purchase BGAMs received and accepted by the set-top.

Verify status information about the IPPV purchases.

Confirm the last attempted and successful IPPV purchase.

Verify if the set-top has been polled.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

Page 1: Cisco Conditional Access Kernel ScreenTasks that you can perform from this screen include the following:

Verify the total number of messages and type of messages received by the set-top.

View the number of messages validated by the ISE and ESE components.

119

Cisco Systems, Inc. www.cisco.com

Page 120: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Cisco CAS Diagnostics

Page 1: Cisco Conditional Access Kernel Screen

Verify if the Sub Expires date is at least 30 days ahead of the current date.

Determine the encryption status for a program.

120

Page 121: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Cisco CAS Diagnostics

Page 1: Cisco Conditional Access Kernel Screen

Table 1 Cisco CAS Diagnostics- Page 1

Field Name Description Possible Values

Received ISE/ESE Shows the information for Received, ISE, and ESE as described below.

EMMs Indicates the number of EMMs processed.

[Integer > 0]

Note: Increments when authorization is sent to the set-top.

Time GBAMs Indicates the number of Time GBAM messages processed.

[Integer > 1]

0 — Time GBAMs not yet processed

App GBAMs Indicates the number of Application GBAM messages received.

[Integer > 1]

0 — Application GBAMs not yet processed

Ext GBAMs Indicates the number of extend event GBAMs received.

[Integer > 0]

Note: Changes when an event (PPV/IPPV [interactive PPV]) is extended.

Total/Unique ECM Indicates the total number and number of unique entitlement control messages (ECMs) received.

[Integer > 0]

Note: Increments when ECMs are received.

121

Page 122: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Cisco CAS Diagnostics

Page 1: Cisco Conditional Access Kernel Screen

Errors This section contains error statistics for the secure microprocessor. Error statistics are accumulated and displayed for the following categories:

Errors — The number of errors that have occurred with the ISE (secure micro), Comm (Communication with the secure microprocessor), or the version

CMD/Err — The last error that occurred with the ISE, Communication with the secure microprocessor, or the version. If no errors have occurred, then these values are zero

Date.Time — The date and time when the last error occurred for the ISE, Comm, or the version. Never appears if there are no errors

ISE Statistics for the ISE:

0 — No errors present

[non-0] — Indicates EMMs have expired

Comm Statistics for the communications with the secure microprocessor:

0 — No errors present

[non-0] — Indicates secure element detected on error

Version PowerKEY software version:

[Software-dependent]

Example: PKEY_3.9.9.2-p +dvrs3, 09:29:29 Nov 20 2007

Prog Stat Digital PID on which ECMs associated with the current program are received (hexadecimal number)

0 — Program is not encrypted or scrambled (that is, in the clear)

[non-0] — Encryption issue has occurred:

— 0 — Program is not encrypted or scrambled (in the clear)

— [non-0] — Encryption issue has occurred

Prog Entitle Current entitlement ID for which the current program is authorized (hexadecimal number).

0 — Program is not encrypted or scrambled (in the clear)

[non-0] — Encryption issue has occurred

Table 1 Cisco CAS Diagnostics- Page 1 (continued)

Field Name Description Possible Values

122

Page 123: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Cisco CAS Diagnostics

Page 1: Cisco Conditional Access Kernel Screen

Decrypt Stat Status of the decryption. Blacked Out — DHCT is authorized to receive program, but program is blacked out in geographical area

ECM Strm Err — Internal error condition occurred within the QAM broadcasting the current program

No Longer Auth — DHCT is no longer authorized for program

Okay — Current decryption status is okay (decrypting) or program is in the clear (see Prog Stat above)

Late Keys Number of times that a program key decryption operation occurred after the DHCT received the program data.

Note: MPEG decoding artifacts (macroblocks) seen concurrent with these errors may be attributed to this condition.

0 — Encryption is OK

[non-0] — Encryption issue has occurred

Sub Expires Date and time that the subscription authorizations expire (MMDD.hhmmss).

[Time]

Note: Subscription authorizations generally expire 20 to 30 days from the previous renewal date. A date less than 20 days into the future indicates a problem.

Expired: Subscription is expired

CA Time Current authenticated time received through the GBAM (MMDD.hhmmss).

[Time]

Note: This value matches the current time to the nearest minute.

EUT Update Last time the set-top received an update to the entitlement unit table (EUT Update).

[Time]

Note: Time is updated according to system activity (typically a few times a day). All set-tops should reflect the same time.

Decrypt Fail Time of the last program decryption failure (MMDD.hhmmss).

[Time]

Never — No decryption failures

Last Late Key Time that the last late key occurred (MMDD.hhmmss).

[Time]

Never — No late keys

Table 1 Cisco CAS Diagnostics- Page 1 (continued)

Field Name Description Possible Values

123

Page 124: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Cisco CAS Diagnostics

Page 2: CAM Status Screen

Page 2: CAM Status ScreenTasks that you can perform from this screen include the following:

Verify the status of Conditional Access Management (CAM).

Verify that a valid ECM PID has been received.

Verify the total number of ECMs that have been received.

Determine which package IDs have authorized a program.

124

Page 125: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Cisco CAS Diagnostics

Page 2: CAM Status Screen

I

Table 2 Cisco CAS Diagnostics - Page 2

Field Name Description Possible Values

Primary/Secondary Shows the information for the primary and secondary CAM as described below.

Source Id The source ID for the CAM. Source ID Number (integer and hexadecimal format)

Unavailable — Not tuned to an encrypted channel

Device Id The authorization information about the secure micro.

Internal

External

Unavailable — Not tuned to an encrypted channel

Mode The type of encryption format. PowerKEY — Cisco encryption format

Harmony — Cisco/Motorola cooperative encryption format

Scrambled Analog

Unavailable — Not tuned to an encrypted channel

ECM Pid The PID number of the PID that is carrying the ECM stream.

[PID number] (hexadecimal format)

Unavailable — Not tuned to an encrypted channel

ECM Count The total number of ECMs received for this program.

[Integer > 0]

Unavailable — Not tuned to an encrypted channel

Valid Count The number of unique (key-change) ECMs processed.

[Integer > 0]

Unavailable — Not tuned to an encrypted channel

ECM Delay The worst-case timing between received ECM packets (in ms).

Note: QAM transmission timing is set to 100 ms.

[Integer > 0]

Unavailable — Not tuned to an encrypted channel

ECM Started The date and time when the program originally started (MMDD:hhmmss).

[Time]

Unavailable — Not tuned to an encrypted channel

EUIDs The list of package IDs that are authorizing the program (hexadecimal format).

[Package ID]

Unavailable — Not tuned to an encrypted channel

125

Page 126: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Cisco CAS Diagnostics

Page 3: IPPV Information Screen

Page 3: IPPV Information ScreenTasks that you can perform from this screen include the following:

Verify the total number of Purchase BGAMs received and accepted by the set-top.

Verify status information about the IPPV purchases.

Confirm the last attempted and successful IPPV purchase.

Verify if the set-top has been polled.

126

Page 127: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Cisco CAS Diagnostics

Page 3: IPPV Information Screen

Table 3 Cisco CAS Diagnostics - Page 3

Field Name Description Possible Values

Prch GBAMS

Received The total number of purchase GBAMs received by the DHCT.

0 — Issue with GBAMs

[Integer > 0]

ISE The number of purchase GBAMs accepted by the ISE.

0 — Issue with GBAMs

[Integer > 0]

ESE The number of purchase GBAMs accepted by the ESE (smart card).

0 — Unless using a secure card

Last Attempted

Device The purchase device used for last purchase attempt.

ESE

ISE

Result The result code for the purchase attempt.

[Hexadecimal number]

EID The entitlement identification of the attempted purchase.

[Hexadecimal number]

Time The date and time of attempted purchase (MMDD.hhmmss).

[Time]

Never — No attempted purchase

Last Success

EID The EID value for the last successful purchased event.

[Hexadecimal number]

127

Page 128: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Cisco CAS Diagnostics

Page 3: IPPV Information Screen

Time Date and time of purchase (MMDD.hhmmss).

Note: Never will appear in the Time field if there are no purchases.

[Time]

Never — No purchases

FPM Poll The date and time of the last forward purchase message poll (FPM Poll) request (MMDD.hhmmss).

[Time]

Never — No request sent

PPV Collect The status of the PPV event collection (Indicates the time for the last and next FPM poll, as well as the number of EIDs).

[Timestamp, Reply@, EIDs=x]

Timestamp — Last time DHCT was polled to collect PPV purchases; displays either:

— [MMDD.hhmmss] — Date and time of collection

— Never — No collection made

Reply@ — Time the DHCT replied to the poll:

— [MMDD.hhmmss] — Date and time of reply

— [Empty Field] — No reply

EIDs = x — Number of EIDs (x) for uncollected purchase events:

— [EIDs = 0] — All purchase events collected

— EIDs = [Integer > 0] — Only lists up to 20 EID values for events

Note: If the EID value is greater than 20, additional purchased events are stored and not displayed.

Table 3 Cisco CAS Diagnostics - Page 3 (continued)

Field Name Description Possible Values

128

Page 129: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services DiagnosticsIntroduction

The Services diagnostic screens let you view status and other information on tuners, video, copy protection, VOD, SAM, PPV, SDV, EAS, and EPS, and also provide RF statistics.

These screens are divided into pages and sections organized roughly by task. Tasks that you can perform from these screens include the following:

Status Summary

Verify the current status of the boot process.

Verify the system information.

Check the amount of available memory.

Check when the DHCT was last booted and if it is receiving the correct time.

N/W and Tuning Status

Confirm the tuning mode.

Verify MPEG information for the current stream.

Confirm that the DHCT displays an RF network IP address, subnet mask, and hub ID.

Second Tuner Status

Tasks that you can perform from this screen include the following:

Verify the working status of the second QAM and second MPEG decoder.

Determine if the second tuner is picking up sufficient frequency,.

Verify the tuning mode of the second QAM.

Digital Video Status

Verify the decoding of digital video on a single screen.

Record this screen and then replay the recording later to determine the cause of any decoding issues.

Copy Protection

Verify the status of the DOCSIS network operations on your system.

Determine if the DHCT is running in DSG mode.

Verify the DNCS MAC and IP addresses.

VOD Information

129

Cisco Systems, Inc. www.cisco.com

Page 130: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Introduction

Confirm the status of the internal and external VOD services.

Verify the status of the VOD sessions.

Determine if SI data is in-band or out-of-band.

Verify that there is an EID associated with the VOD session.

Confirm the status of the internal and external VOD services.

Verify the status of the VOD sessions.

VOD Diagnostics

Confirm the status of the VOD package and VOD search package.

Verify the IP addresses of the connection manager and MET (ARRIS only).

Verify the status of the VOD database.

SAM Information

Verify the name of downloaded applications.

Determine what services are currently running.

Verify the EID required to run an application.

SAM EDCT Information

Identify information about the currently loaded and currently assigned display channel table (DCT).

Determine the physical hub or bouquet ID assignment for the DHCT.

Evaluate possible errors that the DHCT experienced while attempting to load the Group Definitions File (GDF) from BFS.

RF Statistics

Confirm the power levels and frequencies of the FDC and the RDC.

Confirm the power levels and frequencies of the QAM modulator.

Monitor the average and instantaneous errors of the FDC and the QAM.

DVR Status

Determine the current status of the ITFS, WDIDE, and AVFS.

Determine the status of cross links.

Verify whether any files are corrupt.

PPV Summary

Identify if a PPV has been purchased.

Determine if a PPV event is expired.

Identify the status of a barker.

Verify the purchase attempt for a PPV event.

SDV Diagnostics

130

Page 131: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Navigation

Determine if the client (DHCT) is authorized for SDV services.

Identify the status of the SDV server.

Verify details about the transmission of data for the SDV service.

Determine the date and time that the mini carousel (MC) was last loaded in cache.

Determine the current status for the mini carousel.

Identify the version for the mini carousel.

Determine the current status of an SDV session.

Determine the current status of the tuner.

Verify the name of the current SDV session.

EAS Diagnostics

View the number of text EAS messages that the DHCT has received.

View the number of force-tune EAS messages that the DHCT has received.

EPG Information

View the status of EPG search.

View the status of the EPG local database.

View the status of the EPG data in the local database.

WIFI Summary

View operating status and parameters for the attached VEN501 WAP.

View operating status and parameters for any IP Client set-tops in the network.

Proxy Summary

View Proxy Download configuration parameters for the G8 set-top.

Confirm the SA CVT version.

Identify the name and storage location of the last image download.

Examine client download trigger information.

WebServices Summary

View a summary of REST web server parameters.

View a summary of REST IP Client parameters.

View a summary of REST web services statistics.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

131

Page 132: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Services Summary Screen

Services Summary ScreenTasks that you can perform from this screen include the following:

Verify the current status of the boot process.

Verify the system information.

Check the amount of available memory.

Check when the DHCT was last booted and if it is receiving the correct time.

132

Page 133: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Services Summary Screen

Table 1 Status Summary Screen

Field Name Description Possible Values

Initializations

Status The status of the overall boot process.

Host Ready: The DHCT has completed the boot process and is in two-way mode

CPU/Bus The speed (in MHz) at which the microprocessor and data bus are running.

[Hardware-dependent]

Memory

System Heap Overall memory available to the porting layer.

[Hardware-dependent]

SARA Heap Memory available to the SARA middleware.

[Hardware-dependent]

Video Heap Memory that is initialized when video begins streaming.

[Hardware-dependent]

Total The total amount of memory assigned.

[Integer > 0]

Free The amount of free memory available. [Integer > 0]

Largest The largest contiguous, free block of memory available.

[Integer > 0]

Chunks The number of memory chunks available..

[Integer > 0]

RF Parameters

Tuner 1 Describes the following frequency data at the center of the channel of the inband tuner:

If tuned to a digital channel, this field displays the frequency, the current approximate signal level, and the average errors per second.

If tuned to an analog channel, this field displays the frequency and the analog channel

Frequency (MHz) — Dependent upon setting

Signal Level:

— Acceptable Range: –16 to +15 dBmV

— Recommended Range: –8 to +8 dBmV

Average Errors per Second — Integer close to 0 that is not changing.

133

Page 134: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

N/W and Tuning Status Screen

N/W and Tuning Status ScreenTasks that you can perform from this screen include the following:

Confirm the tuning mode.

Verify MPEG information for the current stream.

Confirm that the DHCT displays an RF network IP address, subnet mask, and hub ID.

FDC Provides information about the forward data channel (FDC).

Frequency (MHz) — Dependent upon the setting in which out-of-band receiver is tuned

Signal Level (approximate):

— Acceptable Range: –16 to +15 dBmV

— Recommended Range: –10 to +10 dBmV

Average Errors per Second — Integer close to 0 that is not changing

RDC The information about the reverse data channel (RDC).

Frequency (MHz) — Dependent upon the setting to which RDC transmitter is broadcasting

Signal Level of Transmitter:

— Acceptable Range: +25 to +55 dBmV

— Recommended Range: +27 to +53 dBmV

Round Trip Delay — Delay between the DHCT and quadrature phase shift keying (QPSK) modem at the headend or hub (μsec)

Clocks

Booted The date and time that the DHCT last booted.

Note: The hexadecimal format for the date and time is shown in parentheses.

[Date, Time]

Current The current date and time.

Note: The hexadecimal format for the date and time is shown in parentheses

[Date, Time]

Table 1 Status Summary Screen (continued)

Field Name Description Possible Values

134

Page 135: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

N/W and Tuning Status Screen

I

Table 2 N/W and Tuning Status Screen

Field Name Description Possible Values

Statuses

Tuning Mode The current mode of the inband tune. Analog: If sap or stereo are detected on the current analog channel, one of the following modes appear:

— Analog (sap)

— Analog (sap, stereo)

— Analog (stereo)

QAM-64

QAM-128

Tuner 1 State The state of the tuner according to the TV manager component of the middleware.

Found QAM: Tuner successfully tuned to a digital channel

Found Sync: Tuner successfully tuned to an analog channel

Idle/Available: Tuner is not in use by an application; tuner is available for use

Waiting QAM: TV Manager is waiting for the tuner to tune to the desired QAM frequency and lock onto valid data

Waiting Sync: TV Manager is waiting for the tuner to find the signal on an analog channel

135

Page 136: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

N/W and Tuning Status Screen

TV Mgr The state of the TV tuner resource in the resident application according to the TV Manager component of the PowerTV OS.

Note: If the resident application is not using the tuner, the TV Manager displays the state of the active resource using the tuner (if any).

Active: The resource of the resident application is currently active (in use/tuned)

Denied: The tuning request for the resource was denied

Inactive: TV Manager is not in use and is available to process requests

Notified: TV Manager has instructed the resident application to release the resource not the tuner so the TV Manager can use the tuner for a different request

Suspended: The tuner resource for the resident application is suspended

Suspending: TV Manager has notified the owner of the currently active resource to suspend so that it can use the tuner for another request

Unknown: TV Manager received an unknown state

Waiting PAT: TV Manager is waiting for the Program Association Table (PAT) to arrive on a QAM channel before the tuning request can complete

Waiting PMT: TV Manager is waiting for the program Map Table (PMT) to arrive on a QAM channel before the tuning request can complete

Tx Res Err The last resource denied error code received by the ResApp from the TV manager when trying to tune (if any).

0x00000000: No resource errors

0x[non-zero hexagonal number]: Indicates an error was received

Tuning Tbl The most recent tuning table activation date and time (MMDD.hhmm) received by the DHCT.

[Time]

Example: 0507.1500

Table 2 N/W and Tuning Status Screen (continued)

Field Name Description Possible Values

136

Page 137: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

N/W and Tuning Status Screen

Channel The channel number and the status for the tuned channel.

Clear to Air (unencrypted)

Free Preview

Purchased (for pay-per-view)

Subscription

Unauthorized

Note: An unauthorized channel may display unauthorized for a few seconds and then it changes to n/a when the unauthorized barker appears.

Source Id The source identification number for the tuned channel.

[Channel-dependent]

(hexadecimal format)

BFS Dir The date and time (MMDD.hhmmss) that the BFS directory was last read.

[Time]

Example: 0507.150027

MPEG Stats

Video The program identifier (PID) number within the MPEG stream that contains the video information being decoded.

[Channel-dependent]

n/a: Tuned to an analog channel

Audio The PID number within the MPEG stream that contains the audio information being decoded.

[Channel-dependent]

n/a: Tuned to an analog channel

PCR The PID number that is used to decode the program clock reference (PCR) information.

Note: The PCR PID is typically the same as the video PID.

[Channel-dependent]

n/a: Tuned to an analog channel

PCR Lock The time stamp of the last PCR synchronization lock.

[Integer > 0]: Number should change each time the screen refreshes; otherwise video may be lost

n/a: Tuned to an analog channel

A/V Disc The sum of the discontinuity errors encountered on either the audio or video streams.

Note: Discontinuity errors indicate that packets were transmitted out of order or with a gap between them, which indicates data loss.

0: No discontinuity errors

[Integer > 0]: Could indicate a problem

Note: If A/V Disc is high, an issue such as macroblocking may be present.

n/a: Tuned to an analog channel

Table 2 N/W and Tuning Status Screen (continued)

Field Name Description Possible Values

137

Page 138: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

N/W and Tuning Status Screen

PTS A presentation time stamp (PTS) that changes each time the screen refreshes.

UNIX format: Number should change each time the screen refreshes; otherwise video may be lost

Important: If this number does not change each time the screen refreshes, then video may have been lost.

n/a: Tuned to an analog channel

PEI The number of errors (packet error indication [PEI]) in the MPEG stream before reaching the broadband interface processor (BIP).

0: No errors in MPEG stream

[Integer > 0]: Errors exist and may cause an issue

n/a: Tuned to an analog channel

PER The PERs reported by the MPEG decoder chip.

0: No errors in pipeline stream

[Integer > 0]: Errors exist and may cause an issue

Note: Some errors may be normal depending on the MPEG stream being decoded.

SER Displays the number of SERs reported by the MPEG decoder chip.

0: No server errors

[Integer > 0]: Errors exist and may cause an issue

Note: Some errors may be normal depending on the MPEG stream being decoded.

n/a: Tuned to an analog channel

RST Displays the number of times the software driver has restarted (RST) the MPEG decoding process.

0: No errors in MPEG stream

[Integer > 0]: Errors exist and may cause an issue

n/a: Tuned to an analog channel

Ethernet

IP The IP address assigned to the Ethernet adapter.

[Network-dependent]

Subnet Mask The IP subnet mask assigned to the Ethernet adapter.

[Network-dependent]

RF Networks

Table 2 N/W and Tuning Status Screen (continued)

Field Name Description Possible Values

138

Page 139: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Second Tuner Status Screen

Second Tuner Status ScreenNote: This diagnostic screen only exists on DHCT models that include a DVR.

Tasks that you can perform from this screen include the following:

Verify the working status of the second QAM and second MPEG decoder.

Determine if the second tuner is picking up sufficient frequency,.

Verify the tuning mode of the second QAM.

Important::

The information displayed in the Second QAM section of the Second Tuner Status diagnostic screen always refers to the Second Tuner, that is, the additional tuner included with your DHCT if equipped with a DVR.

The information displayed in the Second MPEG Decoder section of the Second Tuner Status diagnostic screen always displays PIP video data.

The screens described in this section only appear on G8 set-top hardware. G6 set-tops have only two tuners.

IP The IP address that the controller assigned to the RF network.

[Network/DHCT configuration-dependent]

Unavailable — DHCT is not authorized for two-way communications or is unable to establish a two-way connection with the network

Subnet Mask The IP subnet mask that is assigned to the RF network adapter by the controller.

[Network-dependent]

Hub ID The hub number to which the DHCT is connected when booted.

[Network-dependent]

SNMP Mgr Indicates if the IP address of the network management system in which it can then send Simple Network Management Protocol (SNMP) traps.

[Network-dependent]

Entitlement Agents The entitlement agent ID (EAID) that was installed on the ISE or ESE (also known as a smart card) and inserted in to the DHCT.

0x00000001

Note: The number within the brackets is an index number. The hexadecimal number that follows the index number displays the EAID.

ESE[1]

ISE[1]

Table 2 N/W and Tuning Status Screen (continued)

Field Name Description Possible Values

139

Page 140: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Second Tuner Status Screen

Table 3 Second Tuner Status Screen

Field Name Description Possible Values

Second QAM

Status The status of the second QAM. Locked — Receiver is locked onto a valid analog or QAM channel

Unlocked — Valid data is not being received

S/N The approximate signal-to-noise ratio (dB).

[Integer >= 0]

n/a

EQ Gain The QAM equalizer gain on the QAM data channel.

Amber — Marginal signal problem exists and needs to be corrected

Red — Serious signal problem exists and needs to be corrected

White — No signal problems exist

Seconds The number of seconds the tuner has been locked on current frequency.

[Integer >= 0]

Freq The frequency to which the inband tuner is tuned (MHz).

[Dependent upon tuned frequency]

Tuning Mode The tuning mode of the in-band tuner. Analog

QAM-64

QAM-128

QAM-256

Level The approximate signal level. Amber — Level is marginally too high or too low

Red — Level is too high or too low

White — Level is normal

Corr Bytes The number of bytes received in error that were successfully corrected by the FEC code.

[Integer > 0]

Uncorr Bytes The number of data bytes received in error that were not successfully corrected by FEC code.

[Integer > 0]

Errs Avg/Inst Two unique numbers that describe data errors:

First Number — The average number of errors during the time the frequency was locked.

Second Number — The number of errors since the last time the screen was refreshed.

[Integer > 0] / [Integer > 0]

Second MPEG Decoder

140

Page 141: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Second Tuner Status Screen

A/V Disc The sum of the discontinuity errors encountered on either the audio or video streams that have occurred since the current stream was tuned.

Note: Discontinuity errors indicate that packets were transmitted out of order or with a gap between them. This indicates data loss.

0 — Desired value

[Integer > 0] — Indicates an issue

PCR Lock The time stamp of the last PCR synchronization lock.

[Integer > 0] — Number should change each time the screen refreshes; otherwise video may be lost.

Video The video PID number in the MPEG stream that contains the video information being decoded.

[Hexadecimal value > 0] — Streaming

[Hexadecimal value = 0] — Not streaming

Audio The audio PID number in the MPEG stream that contains the audio information being decoded.

[Hexadecimal value > 0] — Streaming

[Hexadecimal value = 0] — Not streaming

PCR The PID number used to decode the PCR information.

Note: The PCR PID is typically the same as the Video PID.

[Channel-dependent]

PTS A presentation time stamp that changes each time the screen refreshes.

[UNIX format]

Important: This number should change every time the screen refreshes. If it does not, then video may have been lost.

PEI The number of errors in the MPEG stream before reaching the broadband interface processor (BIP).

0 — Desired value

[Integer > 0] — Indicates an issue

PER The PERs reported by the MPEG decoder chip.

Digital — 0

Analog — 0

SER The number of server errors reported by the MPEG decoder chip.

Digital — 0

Analog — n/a

RST The number of times the software driver has restarted the MPEG decoding process.

0 — Desired value

[Integer > 0]

Note: If the RST value is incrementing, a source issue could exist. Contact Cisco Services for assistance.

Table 3 Second Tuner Status Screen (continued)

Field Name Description Possible Values

141

Page 142: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Digital Video Status Screen

Digital Video Status ScreenTasks that you can perform from this screen include the following:

Verify the decoding of digital video on a single screen.

Record this screen and then replay the recording later to determine the cause of any decoding issues.

142

Page 143: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Digital Video Status Screen

143

Page 144: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Digital Video Status Screen

Table 4 Digital Video Status Screen

Field Name Description Possible Values

Freq The frequency (in MHz) to which the QAM is tuned.

[Integer > 0]

Tuning Mode The tuning mode of the in-band tuner. Analog

Note: If "sap" or "stereo" is detected, one of the following displays in the Tuning Mode field of the diagnostic screen:

— Analog (sap)

— Analog (stereo)

— Analog (sap,stereo)

QAM-64

QAM-128

QAM-256

144

Page 145: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Digital Video Status Screen

TV Mgr The state of the resident application's TV tuner resource according to the TV Manager component of the PTV OS.

If the resident application is not using the tuner, the TV Mgr refers to the state of the active resource using the tuner (if any).

Active — Resident application's resource is currently active (in use/tuned)

Denied — Tuning request for the resource was denied

Inactive — TV Mgr is not in use; TV Manager is available to process requests

Notified — TV Mgr has instructed the resident application to release the resource on the tuner so that the TV Manager can use the tuner for a different request

Suspended — Resident application's tuner resource has been suspended

Suspending — TV Mgr has notified the owner of the currently active resource to suspend so that it can use the tuner for another request

Unknown — Received an unknown state from the TV Manager

Waiting PAT — TV Mgr is waiting for the PAT to arrive on a QAM channel before tuning request can complete

Waiting PMT — TV Mgr is waiting for the PMT to arrive on a QAM channel before tuning request can complete

Uncorr Blks The number of data blocks received in error that were not successfully corrected by the FEC code.

[Integer > 0]

Important: This value should increment slowly. If incrementing rapidly, the picture may be freezing or macroblocking may be present.

n/a — Tuned to an analog channel

Seconds The number of seconds that the frequency has been locked.

[Integer > 0]

n/a — Tuned to an analog channel

Table 4 Digital Video Status Screen (continued)

Field Name Description Possible Values

145

Page 146: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Digital Video Status Screen

Level The approximate received signal level (dBmV).

-8 to +8 (value displayed in white) — Signal level is nominal

>+8 or <-8 (value displayed in amber) — Signal level is marginally too high or too low; you should correct the signal problem

<Range or >Range (value displayed in red) — Signal level is too high or too low

n/a — Tuned to an analog channel

Channel The channel number and, optionally, a status for the tuned channel.

[Channel] = Clear to Air-Unencrypted

[Channel] = Free Preview

[Channel] = n/a (if tuned to a PPV channel)

[Channel] = Purchased-Pay-per-view

[Channel] = Subscription

[Channel] = Unauthorized

BFS Dir The date and time that the BFS directory was last read (MMDD.hhmmss).

[Time]

System Heap The amount of memory available to the system.

Free: [Integer > 0]

Largest: [Integer > 0]

Video Heap The amount of memory available for video.

Free: [Integer > 0]

Largest: [Integer > 0]

Error Total number of errors that have occurred.

[Hexadecimal number = 0] — No errors occurred

[Hexadecimal number > 0] — Errors have occurred

Cmd/Err The last error that occurred. [Hexadecimal number = 0] — No errors occurred

[Hexadecimal number > 0] — Errors have occurred

Date Time The time when the last error occurred (MMDD.hhmmss).

[Date.Time]

Never — No errors occurred

ISE The number of PowerKEY errors that have occurred.

0 — Expected value

[Integer > 0] — Issue with encryption on channel

Table 4 Digital Video Status Screen (continued)

Field Name Description Possible Values

146

Page 147: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Digital Video Status Screen

Sub Expires The date and time that the subscription authorizations expire (MMDD.hhmmss).

Expired — Subscription has already expired

[Time]

Note:

— Time less than 20 to 30 days into the future indicates a problem.

— Subscription authorizations generally expire 30 days from the last time they were renewed.

Late Keys The number of times that a program key decryption operation occurred after the DHCT received the program data.

0 — Desired value

[Integer > 0] — Issue with decryption

Last Late Keys The time that the last late key occurred (MMDD.hhmmss).

[Date.Time]

Never — No late key

FPM Poll The date and time of the last FPM. [Date.Time]

Never — No request was sent

Decrypt Fail The time of the last program decryption failure (MMDD.hhmmss).

[Date.Time]

Never — No decryption failure

A/V Disc The sum of the discontinuity errors encountered on either the audio or video streams that have occurred since the current stream was tuned

Note: Discontinuity errors indicate that packets were transmitted out of order or with a gap between them, and indicate data loss.

0 — Desired value

[Integer > 0] — Indicates an issue

n/a — Tuned to an analog channel

PER The number of PERs reported by the MPEG decoder chip (MMDD.hhmmss).

0 — Desired value

[Integer > 0]

n/a — Tuned to an analog channel

PTS A presentation time stamp that changes each time the screen refreshes.

[UNIX format]

Important: This number should change every time the screen refreshes. If it does not, then video may have been lost.

n/a — Tuned to an analog channel

Table 4 Digital Video Status Screen (continued)

Field Name Description Possible Values

147

Page 148: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Copy Protection Screen

Copy Protection ScreenTasks that you can perform from this screen include the following:

Determine coy protection settings associated with the content stream that is currently playing.

Determine the copy protection schemes and policies that are currently applied to particular output ports.

PEI The number of errors in the MPEG stream before reaching the BIP.

0 — Desired value

[Integer > 0] — Indicates an issue

n/a — Tuned to an analog channel

SER The number of server errors reported by the MPEG decoder chip

Digital — 0

n/a — Tuned to an analog channel

RST The number of times the software driver has restarted the MPEG decoding process.

0 — Desired value

[Integer > 0]

Note: If the RST value is incrementing, then a possible source issue may exist. Contact Cisco Services for assistance.

n/a — Tuned to an analog channel

Table 4 Digital Video Status Screen (continued)

Field Name Description Possible Values

148

Page 149: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Copy Protection Screen

Table 5 Copy Protection Screen

Field Name Description Possible Values

Outputs

DVI/HDMI Indicates the status of copy protection for the DVI/HDMI output.

Protection Type:

HDCP - High

none

Enabled:

no

yes

Constrained:

no

yes

YPrPb Indicates the status of copy protection for the YPrPb output.

Protection Type:

none

Enabled:

no

yes

Constrained:

no

yes

1394 Indicates the status of copy protection for the 1394 output.

Protection Type:

disabled

DTCP

unavailable

none

Enabled:

disabled

no

yes

Constrained:

N/A

149

Page 150: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Copy Protection Screen

Composite Indicates the status of copy protection for the composite output.

Protection Type:

Macrovision (Rovi)

none

Enabled:

N/A

Constrained:

N/A

Policies

HDMI The group and version number for the copy control policy relating to HDMI ports.

Note: The possible values for the policy bits only apply to version 1 of the policy format.

Format: 8-bit value [HDMI policy] [policy format version]

[Bit 0]

1 — Disable (block) HDMI port at all times

[Bit 1]

1 — Output a constrained image to HDMI port when HDCP authentication fails

[Bit 2]

1 — Block output to HDMI port when HDCP authentication fails

[Bit 3-4]

00 — Use HDCP if EMI is NOT 'copy freely', or if CIT bit is set;

01 — Always use HDCP

10 — Never use HDCP

[Bits 5-7] — Reserved

[v1] — Version number of policy format

Table 5 Copy Protection Screen (continued)

Field Name Description Possible Values

150

Page 151: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Copy Protection Screen

YPrPb The group and version number for the copy control policy relating to YPrPb ports.

Note: The possible values for the policy bits only apply to version 1 of the policy format.

Format: 8-bit value [YPrPb policy] [policy format version]

[Bit 0]

1 — Disable (block) YPrPb port at all times

[Bit 1]

1 — Output a constrained image to YPrPb port when CIT bit is set

[Bit 2]

1 — Block output to HDMI port when CIT bit is set

[Bit 3]

1 — Enable Macrovision for YPrPb port when enabled on composite outputs

[Bits 4-7] — Reserved

[v1] — Version number of policy format

1394 The group and version number for the copy control policy relating to 1394 ports.

Note: The possible values for the policy bits only apply to version 1 of the policy format.

Format: 8-bit value [1394 policy] [policy format version]

[Bit 0]

1 — Disable (block) 1394 port at all times

[Bit 1-7]

1 — Reserved

[v1] — Version number of policy format

Composite The group and version number for the copy control policy relating to composite outputs.

Note: The possible values for the policy bits only apply to version 1 of the policy format.

Format: 8-bit value [Composite policy] [policy format version]

[Bit 0-7] — Reserved

[v1] — Version number of policy format

Table 5 Copy Protection Screen (continued)

Field Name Description Possible Values

151

Page 152: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Copy Protection Screen

VOD The group and version number for the copy control policy relating to VOD.

Note: The possible values for the policy bits only apply to version 1 of the policy format.

Format: 8-bit value [VOD policy] [policy format version]

[Bit 0]

0 — Do not override CCI settings for VOD content

1 — Override CCI settings for VOD content

[Bit 1-7] — Reserved

[v1] — Version number of policy format

CCI Events

Source The type of source that is carrying the input video stream.

Disk

Ext Video

Memory

RF

Destination The type of destination of the output stream.

Aux Video Out

Disk

In Home Net

Memory

Video Output

CIT The indicator that identifies whether the constrained image trigger was set for the input content.

Note: This bit does not necessarily cause the output to be constrained or blocked (policy-dependent).

no — CIT is not set

yes — CIT is set

EPN An indicator that identifies if encryption plus non-assertion (EPN) exists for the 1394 port.

Note: The EPN copy control bit is directly related to controlling content delivered via the IEEE 1394 port. Currently, the default state of the EPN is set to "no" in accordance to FCC en-coding rules.

no — Does not exist (default)

yes — Exists

Table 5 Copy Protection Screen (continued)

Field Name Description Possible Values

152

Page 153: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

VOD Information Screen

VOD Information ScreenTasks that you can perform from this screen include the following:

Confirm the status of the internal and external VOD services.

Verify the status of the VOD sessions.

Determine if SI data is in-band or out-of-band.

Verify that there is an EID associated with the VOD session.

Confirm the status of the internal and external VOD services.

Verify the status of the VOD sessions.

EMI The copy protection (encryption mode indicator [EMI]) mode.

freely — Unlimited copying of content

never — Content cannot be copied

no more — Content cannot be copied

once — Content can be copied once

BF An indicator that is embedded in programs that identifies the restriction rules for content.

yes — Content distribution is restricted

no — Content distribution is not restricted (copy freely)

APS A descriptor that identifies how the analog protection system (APS) is defined. APS will control how the Macrovision circuit is driven.

2 line — Rovi (Macrovision) circuit enabled with AGC Process On, 2 Line Split Burst On

disabled — No analog protection system (Macrovision is disabled)

Table 5 Copy Protection Screen (continued)

Field Name Description Possible Values

153

Page 154: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

VOD Information Screen

Table 6 VOD Information Screen

Field Name Description Possible Values

Service Group The service group and mapfile version from the BFS.

Available — Service group ID is available

Unavailable — Service group ID is not available

Note: The OS is not responsible for reporting service group data.

SI Received The indicator that describes how SI data is received.

OOB — Out-of-band (QPSK)

DMS The status of the digital multicast services (DMS) enabled flag from the DNCS.

DMS — Enabled

dms — Not enabled

Note: Enable "dms" to view secure digital services.

DIS The status of the digital interactive services (DIS) enabled flag (VOD).

DIS — Enabled

dis — Not enabled

Note: Enable "dms" for VOD and xOD to function.

EAID The EIADs that have been installed for the ISE or ESE into the DHCT.

EAID <ID number of agent> — EAID received

eaid — EAID not received

Int

IPPV cells A bit-map representation of the number of non-volatile storage cells available for PPV events.

FFFFFF00—desired value

Note: If FFFFFF00 does not appear, restage the set-top.

VOD cells A bit-map representation of the number of non-volatile storage cells available for VOD events.

FC000000 — Has type 8 EMMs needed for encryption

00000000 — Does not have type 8 EMMs needed for encryption

DMS The status of the digital multicast services (DMS) enabled flag from the DNCS.

DMS — Enabled

dms — Not enabled

Note: Enable "dms" to view secure digital services.

DIS The status of the digital interactive services (DIS) enabled flag (VOD).

DIS — Enabled

dis — Not enabled

EAID The EIADs that have been installed for the ISE or ESE into the DHCT.

EAID <ID number of agent> — EAID received

eaid — EAID not received

Ext

154

Page 155: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

VOD Diag Screen

VOD Diag ScreenTasks that you can perform from this screen include the following:

Confirm the status of the VOD package and VOD search package.

Verify the IP addresses of the connection manager and MET (ARRIS only).

Verify the status of the VOD database.

IPPV cells A bit map representation of the number of non-volatile storage cells available for PPV events.

FFFFFF00—desired value

Note: If FFFFFF00 does not appear, restage the set-top.

VOD cells A bit map representation of the number of non-volatile storage cells available for VOD events.

FC000000 — Has type 8 EMMs needed for encryption

00000000 — Does not have type 8 EMMs needed for encryption

State The status of the VOD session. Active

Failed

Inactive

Terminated

Session The OS session ID number. [Session ID]

(hexadecimal format)

Entitlement The corresponding EAID and EID pair for the active VOD session.

[Entitlement ID]

(hexadecimal format)

Stat The response code from the secure micro when it processes the authorization.

0x45 — Active VOD session (hexadecimal format)

0x00 — Inactive VOD session (hexadecimal format)

Activated The date and time when the session became active (YYMMDD@hhmmss or yymmdd@50000).

[Time]

Example: 211230@190000

[Time, Inactive]

Example: 960101@-50000

Table 6 VOD Information Screen (continued)

Field Name Description Possible Values

155

Page 156: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

VOD Diag Screen

Table 7 VOD Diag Screen

Field Name Description Possible Values

Manufacturer Manufacturer of the VOD server. [network-dependent]

Poster Art File Graphic file used when identifying the VOD file.

Ready

Not Ready

VOD VOD authorization. Authorized

Not Authorized

VOD Search VOD search authorization. Authorized

Not Authorized

Connection Manager IP IP address of the connection manager.

[network-dependent]

n/a

MET Server IP IP address of the Media Extraction Tool (ARRIS only).

[network-dependent]

unavailable

n/a

MET Communication

HTTP Request Sent Number of HTTP requests sent (ARRIS only).

[numeric value]

unavailable

n/a

HTTP Resp Rcvd Number of HTTP requests received (ARRIS only).

[numeric value]

unavailable

n/a

Assets in Response Number of purchased assets within the HTTP response received (ARRIS only).

[numeric value]

unavailable

n/a

Last Response Date stamp of the last response (ARRIS only).

[date]

unavailable

n/a

DB File Information

DB Creation Date Date the database was created (ARRIS only).

[date]

unavailable

n/a

Name Name of the database (ARRIS only). [network-dependent]

unavailable

n/a

156

Page 157: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

SAM Information Screen

SAM Information ScreenTasks that you can perform from this screen include the following:

Verify the name of downloaded applications.

Determine what services are currently running.

Verify the EID required to run an application.

SAM EDCT Information ScreenTasks that you can perform from this screen include the following:

Identify information about the currently loaded and currently assigned display channel table (DCT).

Determine the physical hub or bouquet ID assignment for the DHCT.

Evaluate possible errors that the DHCT experienced while attempting to load the Group Definitions File (GDF) from BFS.

Size (Bytes) Size of the database (ARRIS only). [file size in bytes]

unavailable

n/a

Download State Download state of the database (ARRIS only).

Downloading

Downloaded

unavailable

n/a

Schema Version Version of the database schema (ARRIS only).

[network-dependent]

unavailable

n/a

Asset Count Number of assets in the database (ARRIS only).

[numeric value]

unavailable

n/a

Table 7 VOD Diag Screen (continued)

Field Name Description Possible Values

Table 8 SAM Information Screen

Field Name Description Possible Values

Downloaded Apps Lists the downloaded applications available.

[Software-dependent]

Active Services Lists the active services available. [Software-dependent]

157

Page 158: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

SAM EDCT Information Screen

Table 9 SAM EDCT Information Screen

Field Name Description Possible Values

Current DCT The display channel table information including the channel table selection mode and identifier (hub, virtual hub, bouquet, or lineup group).

Format: <selection mode>=<id>, Version: <DCT version>, Change Time: <MMDD.hhmmss>

[Selection mode=Integer > 0], [Version: Integer > 0], [Time]

Unavailable: DCT is not loaded

Physical Hub ID The unique ID of the physical hub that the DHCT belongs to.

[Integer > 0]

Unavailable: DHCT is in a DVB-SI system environment using NDS conditional access.

Virtual Hub ID The unique identifier for the virtual hub that the DHCT belongs to.

[Integer > 0]

Unavailable: DHCT is in a DVB-SI system environment using NDS conditional access

Bouquet ID The unique identifier assigned to the DHCT that is used when applying the default channel table selection strategy.

[Integer > 0]

Unavailable: DHCT is not in a DVB-SI system environment. The Physical Hub ID should be used for the default channel table selection.

LUG ID The unique identifier of the lineup group (LUG) that is assigned to the DHCT.

Note:

The LUG ID will override the Hub ID if it is defined.

The LUG is a group of hubs that use the same DCT.

[Integer > 0]

Unavailable: No lineup ID is assigned

Group Def Info

LoadTime The date and time that the GDF was loaded on the DHCT (MMDD.hhmmss).

[Time]

Not Loaded: No GDF is currently loaded

Size The size of the currently loaded, uncompressed GDF (bytes).

[Integer > 1]

0: No GDF file is currently loaded

158

Page 159: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

RF Statistics Screen

RF Statistics ScreenTasks that you can perform from this screen include the following:

Confirm the power levels and frequencies of the FDC and the RDC.

Confirm the power levels and frequencies of the QAM modulator.

Monitor the average and instantaneous errors of the FDC and the QAM.

Last Load Err The last error experienced by the DHCT when the DHCT attempted to load the GDF from BFS.

NoErr: No load errors occurred

PathNotFound: The GDF does not exist on BFS

OutOfMemory: Not enough memory to load the GDF

ReadErr: Failed to read the file from BFS

ExceededMaxLength: The GDF exceeded the maximum allowable length

FileChanged: The GDF was modified on BFS while attempting to load on the DHCT

UnknownErr: Unknown error

Err Time The date and time when the last error occurred when the DHCT attempted to load GDF from BFS (MMDD.hhmmss).

[Time]

Active GDF Statement

Line Num The line number of the active GDF statement in the currently loaded GDF.

[Integer > 1]

n/a: No active GDF statement exists

GDF Error Syntax

Count The total number of lines with syntax errors in the currently loaded GDF.

[Integer > 0]

Note: A count of zero indicates that there are no syntax errors.

Table 9 SAM EDCT Information Screen (continued)

Field Name Description Possible Values

159

Page 160: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

RF Statistics Screen

Table 10 RF Statistics Screen

Field Name Description Possible Values

Current FDC

Freq The frequency (Freq) of the tuned QPSK receiver in MHz.

[Network-dependent]

DAVIC Shows whether the DHCT is connected to a DAVIC network.

Connected

n/a

Status The status of the receiver in regards to receiving valid data.

Locked — Receiver is locked onto a frequency with valid QPSK data.

Unlocked — Receiver is not locked onto a frequency with valid QPSK data.

Level The approximate received signal level (dBmV).

Refer to hardware specifications.

Value displayed in white — Signal level is nominal

Value displayed in amber — Signal level is marginally too high or too low

Value displayed in red — Signal level is unacceptably too high or too low

Seconds The number of seconds that the frequency has been locked.

[Integer > 0]

Corr Bytes The number of corrected bytes sent or received.

[Integer > 0]

Uncor Blks The number of uncorrected bytes sent or received.

[Integer > 0]

Errs Avg/Inst Two unique numbers that describe data errors:

First Number — The average number of errors during the time the frequency was locked

Second Number — The number of errors since the last time the screen was refreshed

[Integer > 0] / [Integer > 0]

Total Bytes The total number of data bytes successfully read since the frequency was locked.

[Integer > 0]

160

Page 161: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

RF Statistics Screen

S/N The signal-to-noise ratio. Refer to hardware specifications.

Value displayed in white — Signal level is nominal

Value displayed in amber — Signal level is marginally too high or too low

Value displayed in red — Signal level is unacceptably too high or too low

n/a — Not applicable for this DHCT

Current RDC

Freq The frequency (Freq) of the tuned QPSK receiver in MHz.

[Network-dependent]

Power The approximate received signal level (dBmV).

Refer to hardware specifications.

Value displayed in white — Signal level is nominal

Value displayed in amber — Signal level is marginally too high or too low

Value displayed in red — Signal level is unacceptably too high or too low

Delay The round-trip delay, in microseconds (μSec), between the set-top and the modem at the headend or hub that is used to determine when to transmit the slotted-aloha packets.

Note: Slotted-aloha packets are used to assign periods of time or slots when the set-top can transmit without interfering with other set-tops on the same hub.

[Integer > 0]

Retrans The total number of data bytes requiring retransmission since the frequency was locked.

[Integer > 0]

Current QAM

Freq The frequency (Freq) of the tuned QAM.

[Network-dependent]

Table 10 RF Statistics Screen (continued)

Field Name Description Possible Values

161

Page 162: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

RF Statistics Screen

Tuning Mode The tuning mode of the QAM. QAM-64

QAM-128

QAM-256

Status The status of the receiver in regards to receiving valid data.

Locked — Receiver is locked onto a frequency with valid QAM data

Unlocked — Receiver is not locked onto a frequency with valid QAM data

Level The approximate received signal level (dBmV).

Refer to hardware specifications.

Value displayed in white — Signal level is nominal

Value displayed in amber — Signal level is marginally too high or too low

Value displayed in red — Signal level is unacceptably too high or too low

S/N The signal-to-noise ratio in dB. Refer to hardware specifications.

Value displayed in white — Signal level is nominal

Value displayed in amber — Signal level is marginally too high or too low

Value displayed in red — Signal level is unacceptably too high or too low

n/a — Not applicable for this DHCT

Seconds The number of seconds that the frequency has been locked.

[Integer > 0]

Corr Bytes The number of corrected bytes sent or received.

[Integer > 0]

Table 10 RF Statistics Screen (continued)

Field Name Description Possible Values

162

Page 163: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

DVR Status Screen

DVR Status ScreenTasks that you can perform from this screen include the following:

Determine the current status of the ITFS, WDIDE, and AVFS.

Determine the status of cross links.

Verify whether any files are corrupt.

Important: The fields in the ITFS section should only change after a loss of power or after a reboot.

Note: After a loss of power or a reboot, the LostClusters field may display number(s) other than 0 (zero). This condition is expected; it indicates that a recording was in progress when the DHCT rebooted, and open files were not closed. The last few seconds of the recording might be lost and would be indicated here as "lost clusters." It is possible for the other fields to display number(s) other than 0 (zero) as well, but that would indicate more serious issues.

Uncor Blks The number of uncorrected bytes sent or received.

[Integer > 0]

Errs Avg/Inst Two unique numbers that describe data errors:

First Number — The average number of errors during the time the frequency was locked

Second Number — The number of errors since the last time the screen was refreshed

[Integer > 0] / [Integer > 0]

EQGain QAM equalizer gain. [Integer > 0]

Table 10 RF Statistics Screen (continued)

Field Name Description Possible Values

Table 11 DVR Status Screen

Field Name Description Possible Values

ITFS

Status The current working status of the ITFS.

Ready — This value should always appear

Note: If Ready does not appear, contact Cisco for assistance.

Corrupt Files The number of corrupt or impaired files within the ITFS.

0 — Desired value

[non-0] — Contact Cisco

Cross-Links The number of cross-links clusters. 0 — Desired value

[non-0] — Contact Cisco

LostClusters The number of allocated clusters not associated with any file.

0 — Desired value

[non-0] — Contact Cisco

WDIDE

163

Page 164: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

PPV Summary Screen

PPV Summary ScreenTasks that you can perform from this screen include the following:

Identify if a PPV has been purchased.

Determine if a PPV event is expired.

Identify the status of a barker.

Verify the purchase attempt for a PPV event.

Status The current working status of the IDE device driver.

Ready — Desired value

Note: If Ready does not appear, contact Cisco for assistance.

AVFS

Status The current working status of the audio video file system (AVFS) device driver.

Drive Asleep — May appear when the DHCT is powered off

Not Ready

Ready — Desired value

Table 11 DVR Status Screen (continued)

Field Name Description Possible Values

164

Page 165: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

PPV Summary Screen

165

Page 166: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

PPV Summary Screen

Table 12 PPV Summary Screen

Field Name Description Possible Values

PPV Service

State The present state of the PPV service on the tuned channel.

Countdown — An event has been purchased and is about to start, and countdown barker is displayed

Expired Event — Event purchase window has closed

Interstitial — No advertised event and interstitial event is displaying

Invalid Event — Current event definition is invalid (for example, DNCS DHCT error)

No Event Barker — No event advertised, no interstitial service defined, and no barker displayed

Not Active — Inactive PPV service

Preview Barker — Event has not been purchased and the free preview period is in effect

Preview Ended — No event purchased; free preview period has ended

Problem Barker — Problem with the PPV service (problem number displayed on the barker)

Purchase Barker — Event can be purchased and barker for that event is displayed

Subscription — Program is a subscription PPV service

Thank You — Event has been purchased and the Thank You for Purchasing barker appears

Waiting for Data — DHCT is waiting for data about the PPV service to arrive from DNCS

Watching Event — Current event is purchased and active

Svc Index A representation of the service internally as an index number.

Note: This field should match the Svc Index in the PPV Event section.

[Hexadecimal value]

n/a — PPV event not showing

Note: This value is used for Cisco troubleshooting purposes.

166

Page 167: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

PPV Summary Screen

PPV Svc The service associated with the PPV channel.

[Channel-dependent]

n/a

Interstitial The service that is shown when no event can be advertised.

None

n/a — Not applicable

Index Ver The version of the PPV index file that the set-top has in memory.

[Index version-dependent]

Note: All set-tops should display the same version of the PPV index file.

Immed Ver The version of the PPV immediate file that the set-top has in memory.

[PPV immediate file-dependent]

Note: All set-tops should display the same version of the PPV index file.

Event Svc The service associated with the PPV event.

[Channel-dependent]

n/a — Not tuned to PPV event

PPV Event

Title The title of the PPV event. [Channel-dependent]

n/a — PPV event not showing

Svc Index A representation of the service internally as an index number.

[Channel-dependent]

Note: This field should match the Svc Index in the PPV SEID.

EID The EID associated with the purchase of an event.

[Hexadecimal value]

n/a — PPV event not showing

Secure Buy The purchase state for the PPV event. n/a — PPV event not showing

Pending — Purchase is not allowed because buy window is not yet opened

Problem PPV# — Problem occurred when attempting to purchase event; # is the error number associated with the error

Processing — Purchase attempt is being processed

Ready — Purchase is accepted and event is viewable

Event The window of time the PPV event is shown (hh:mm-hh:mm am/pm).

n/a — PPV event not showing

[Time]

Example: (1:00-3:30pm)

Table 12 PPV Summary Screen (continued)

Field Name Description Possible Values

167

Page 168: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

SDV Diagnostic Screen

SDV Diagnostic ScreenTasks that you can perform from this screen include the following:

Determine if the client (DHCT) is authorized for SDV services.

Identify the status of the SDV server.

Verify details about the transmission of data for the SDV service.

Determine the date and time that the mini carousel (MC) was last loaded in cache.

Determine the current status for the mini carousel.

Identify the version for the mini carousel.

Determine the current status of an SDV session.

Determine the current status of the tuner.

Verify the name of the current SDV session.

Advertise The window of time the PPV event is advertised to those who have not yet purchased the event (hh:mm-hh:mm).

n/a — PPV event not showing

[Time]

Example: (1:00-3:30pm)

Preview The window of time the PPV event is appearing free (hh:mm-hh:mm).

n/a — PPV event not showing

[Time]

Example: (1:00-3:30pm)

Cancel End The time after which PPV event cancellations are no longer accepted (hh:mm am/pm).

[Time]

(12-hour time format)

n/a — PPV event not showing

n/a

GBAM The time that GBAMs for the PPV event appear on the network (hh:mm am/pm).

[Time]

(12-hour time format)

n/a — PPV event not showing

n/a

Table 12 PPV Summary Screen (continued)

Field Name Description Possible Values

168

Page 169: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

SDV Diagnostic Screen

Page 1: Client and Server

Table 13 SDV Diagnostic Screen - Page 1

Field Name Description Possible Values

Client

Authorized Indicates whether or not the client is authorized for SDV service (_SASD service), or indicates that the _SASD service does not exist.

Yes — Service is authorized

No — Service is not authorized

n/a — Service does not exist

Service Gp The ID of the service group to which this client belongs.

[Integer > 1]

n/a — Service does not exist

RF Id Addr The IP address for the RF network. [Network-dependent]

SDV Channels The number of SDV channels (WatchSDV services) in the channel lineup.

[Integer > 0]

Server

Status The current status of the client communications with the SDV server (init request and receiving a response).

Ready — (desired value) Init request is successfully confirmed and accepted by the SDV server

Pending — The set-top is in the process of establishing communications with the SDV server

Unavailable — Init request failed

Unknown — Init request not yet initiated

Time The time of the last successful initial request confirmed by the server.

[month/day@hh:mm:sec]

Pri Ip-Port The IP address and port number (IP address-Port number) for the primary SDV server.

0.0.0.0-n/a: Primary SDV server is not available

[Network-dependent]

Example: 192.168.99.5-2300

Sec Ip-Port The IP address and port number (IP address-Port number) for the secondary SDV server.

0.0.0.0-n/a: Secondary SDV server is not available

[Network-dependent]

Example: 192.168.99.5-2300

SelInd Rx The number of Select Indications received.

[Integer > 0]

SelResp Tx The number of Select Responses sent.

[Integer > 0]

QryReq Rx The number of Query Requests received.

[Integer > 0]

169

Page 170: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

SDV Diagnostic Screen

Qry Conf Tx The number of confirmed Query Responses sent.

[Integer > 0]

EvInd Rx The number of Event Indications received.

[Integer > 0]

EvResp Tx The number of Event Responses sent. [Integer > 0]

EvInd Tx The number of Event Indications sent. [Integer > 0]

LUA Rep Tx The number of LUA (Last User Activity) reports sent.

[Integer > 0]

Total Rx/Rx The total number of requests sent and received.

[Integer > 0] / [Integer > 0]

InitReq Tx The total number of init requests sent, excluding retransmissions.

[Integer > 0]

Init Conf Rx Total number of initial confirm messages received from SDV server that indicate success or failure.

[Integer > 0]

InitConfFails Rx Total number of initial confirms received from the SDV server that indicate failure.

[Integer > 0]

SelReq Tx The total number of select requests sent for SDV and non-SDV services, excluding retransmissions.

[Integer > 0]

SDV SelReq Tx The total number of select requests sent for SDV, excluding retransmissions.

[Integer > 0]

SelConf Rx The total number of select confirm messages received from SDV server that indicate success or failure.

[Integer > 0]

SelConfFails Rx The total number of select confirms received from the SDV server that indicate failure.

[Integer > 0]

Table 13 SDV Diagnostic Screen - Page 1 (continued)

Field Name Description Possible Values

170

Page 171: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

SDV Diagnostic Screen

Page 2: Media Carousel

Table 14 SDV Diagnostic Screen - Page 2

Field Name Description Possible Values

Media Carousel Info

Status The current status of the information from the mini carousel.

Init — Initial state at boot time prior to loading mini carousel data. Also the state reported when the set-top is not authorized for SDV

SgDiscovery — Client is performing or waiting to perform the service group discovery process

McpDiscFileRead — Client is reading or waiting to read the BFS file to obtain a list of SDV QAM frequencies to scan for mini carousel data

McpDiscovery — Client is scanning or waiting to scan SDV QAM frequencies in search of mini carousel data

CacheReady — (desired value) Mini carousel loaded and data acquired to allow viewing of SDV channels

Def Freq The default or home SDV frequency in MHz. The client will tune to this frequency to read the mini carousel data if not already tuned to another SDV frequency.

[Integer > 0]

Tvp/Tv Id The internal identifier of the logical hardware resource assigned or allocated for loading in-band mini carousel data.

[Integer > 0]

n/a — Logical tuner resource is currently assigned or allocated for loading the in-band mini carousel

Load Time The time when the mini carousel information was loaded into cache.

[month/day@hh:mm:sec]

Version The version number for the mini carousel cached file.

[0 > Integer < 31]

Size The size of the mini carousel data (in bytes).

[Integer > 0]

Num Entries The number of programs (channels) in the mini carousel data.

[Integer > 0]

171

Page 172: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

SDV Diagnostic Screen

Cache Hits The number of times requested tuning parameters were successfully received from the mini carousel cache

Note:

This includes cache hits after forcing a reload of the mini carousel.

This value is only reset to zero when it rolls over or the agent is reset.

[Integer > 0]

Cache Misses The number of times requested tuning parameters were not found in the mini carousel cache even after reloading mini carousel data.

Note: This value is only reset to zero when it rolls over or the agent is reset.

[Integer > 0]

Cache Overrides The number of times the cached tuning parameters from the mini carousel have been overridden by fresh tuning parameters received from the SDV server via CCP (Channel Change Protocol).

Note: This value is only reset to zero when it rolls over or the agent is reset.

[Integer > 0]

Load Count The number of times the mini carousel data has successfully been read (or loaded) by the client.

Note: This value is only reset to zero when it rolls over or the agent is reset.

[Integer > 0]

Load Failures The number of times the client has failed to read the mini carousel data.

Note: This value is only reset to zero when it rolls over or the agent is reset.

[Integer > 0]

Table 14 SDV Diagnostic Screen - Page 2 (continued)

Field Name Description Possible Values

172

Page 173: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

SDV Diagnostic Screen

Last Load Err The type of error for the last load (read) of the mini carousel.

NoErr — Last load was successful

ReadErr — Read of last load failed

MemFull — Not enough memory for last load

Aborted — Last load attempt was aborted

TuningErr — Tuning failure during last load

SGMismatch — Service group identified in the mini carousel data does not match the set-top's service group found during service group discovery

UnknownErr — An unknown error occurred during load

Err Time The time when the last error occurred in loading.

[month/day@hh:mm:sec]

n/a: No load errors have occurred since reset

Last Load Attempt The time when the last load was attempted on the set-top.

[month/day@hh:mm:sec]

00/00@00:00:00: No load errors have occurred since reset

MC Discovery File Info

Load Time The time when the MC Discovery file was loaded on the DHCT during discovery.

[month/day@hh:mm:sec]

n/a — File is not loaded

Version The current version of the MC Discovery File, expressed as a timestamp of when the file contents were generated.

[month/day@hh:mm:sec]

Size The size of the MC Discovery File in bytes.

[Integer > 0]

Num Entries The total number of tuning parameter entries in the MC Discovery File.

[Integer > 1]

0 — No entries

Service Gp The service group of the currently loaded MC Discovery File In systems with no parent/child service groups, this should match.

Note: The service group identified on the VOD Information and the Switched Digital Video diagnostic pages.

[Integer > 1]

n/a — MC Discovery file not loaded

Table 14 SDV Diagnostic Screen - Page 2 (continued)

Field Name Description Possible Values

173

Page 174: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

SDV Diagnostic Screen

Parent Svc Gp The next higher-level parent service group in the hierarchy above the child service group.

[Integer > 1]

n/a — MC Discovery file not loaded or there is no parent service group above the child service group

Last Load Err The error status from the last load of the mini-carousel data (MCD) in discovery. The status reflects the last error type after a successful load of the MCD.

NoErr — Successful load

BadParamErr — Bad parameters specified

OutOfStateErr — Load request denied due to inappropriate state

FileNotFoundErr — MCD file does not exist on BFS for this service group

OutOfMemoryErr — Insufficient memory to process request

ReadErr — Failed to read MCD file from BFS

TunerConflictErr — Could not load MCD file due to higher priority tuner request

FileChangedErr — MCD file changed on BFS during read

TimeoutErr — Request timed out

AbortedErr — Request was intentionally aborted

BadDataErr — The data was loaded successfully but is invalid

UnknownErr — Unknown error occurred during load attempt

Err Time The time at which the last discovery file load error was reported.

[month/day@hh:mm:sec]

n/a — No file load has occurred

Table 14 SDV Diagnostic Screen - Page 2 (continued)

Field Name Description Possible Values

174

Page 175: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

SDV Diagnostic Screen

Page 3: Session and Tuner Status

Table 15 SDV Diagnostic Screen - Page 3

Field Name Description Possible Values

Name-Status The name and current status of the session.

[Name of Session] and one of the following:

Ready — Tuning parameters have been acquired

Idle — No service is selected for this session

Pending — Session Manager is waiting for tuning parameters from either the cache manager or the SDV server

Unavailable — Failed to acquire tuning parameters for the selected SDV service

SessionId The 10-byte session ID that uniquely identifies the SDV client/server session within the system.

[Session-dependent]

SamSvcID/Type The SAM service ID identifying the program and type of service defined for that session.

[Integer > 0] / and one of the following:

Switched — Switched digital service

Broadcast — Broadcast service

n/a

Source Id The ATSC source ID. [Integer > 0]

Act Time The time of activation for the session. [month/day@hh:mm:sec]

Retries/Resends The number of times a select request has been resent due to timeout or user initiated retry, or due to a resend request for the currently selected service.

[Integer > 0] / [Integer > 0]

Retunes The number of times the client has received updated tuning parameters for currently selected service requiring a retune.

[Integer > 0]

Tuner Status The tuner status from an SDV perspective.

Active — Successfully tuned

Inactive — Not using a tuner

n/a — Session has not yet requested a tuner

175

Page 176: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

SDV Diagnostic Screen

Tuner Use An indication of how the tuner is being used.

Main — Tuner is being used for main TV display

Rec — Tuner is being used for a scheduled recording

PPV — Tuner is being used for pay-per-view (PPV) content

PIP — Tuner is being used for picture-in-picture (PIP)

n/a — No tuner is in use for this session

TV/Rec Rare The internal identifiers for the logical hardware resources allocated for presenting and recording the SDV service.

[Integer > 0] — Current service to viewer is either on main TV, PIP, or AUX OUT

0 — Current service to viewer is not on main TV, PIP, or AUX OUT

SDV Freq The frequency (in MHz) used by the agent to tune to the currently selected SDV service.

[Integer > 0]

Table 15 SDV Diagnostic Screen - Page 3 (continued)

Field Name Description Possible Values

176

Page 177: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

EAS Diagnostic Screen

EAS Diagnostic ScreenTasks that you can perform from this screen include the following:

View the number of text EAS messages that the DHCT has received.

View the number of force-tune EAS messages that the DHCT has received.

LUA Tx Time The time when the last user action was reported to the SDV server.

[month/day@hh:mm:sec]

n/a

Last CCP Err The last error from the CCP (Channel Change Protocol) for this session.

NoErr — No error was reported

Timeout — Timeout waiting on response from server

OutOfService — Program is no longer available

FormatErr — Invalid format in CCP sent to server

Redirect — Force tune indication from server

InvalidSG — Server cannot identify service group from its topology

UnknownClient — Agent has not registered with server

NoResource — Resource is unavailable

BWNotAvail — Bind on edge device failed

ExceedsCapacity — Server capacity of agents has exceeded

VerNotSupported — Agent version is not supported

unknownErr — Unknown error

n/a — CCP was not initiated

Err Time The time that the last error was reported from the CCP for this session.

[month/day@hh:mm:sec]

n/a — Errors reported

Table 15 SDV Diagnostic Screen - Page 3 (continued)

Field Name Description Possible Values

177

Page 178: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

EPG Info Diagnostic Screen

EPG Info Diagnostic ScreenTasks that you can perform from this screen include the following:

View the status of EPG search.

View the status of the EPG local database.

View the status of the EPG data in the local database.

Table 16 EAS Diagnostic Screen

Field Name Description Possible Values

Text Alerts

Total The total number of text-based EAS alert messages that the DHCT has received.

[Integer > 0]

Last Time Timestamp of the last time that the DHCT received a text-based EAS alert message.

[month/day@hh:mm:sec]

n/a

Last Duration The duration of the last text-based EAS alert message.

[Integer > 0]

Force Tune Alerts

Total The total number of force-tune EAS alert messages that the DHCT has received.

[Integer > 0]

Last Time Timestamp of the last time that the DHCT received a force-tune EAS alert message.

[month/day@hh:mm:sec]

n/a

178

Page 179: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

WiFi Summary Screen

WiFi Summary ScreenNote: The Wi-Fi Summary screen appears only on G8 set-tops attached to a Cisco VEN501 802.11n Wi-Fi Access Point (WAP).

This screen displays information about the attached VEN501 and any IP Client set-tops attached via the VEN501.

Tasks that you can perform from this screen include the following:

View operating status and parameters for the attached VEN501 WAP.

View operating status and parameters for any IP Client set-tops in the network.

Table 17 EPG Info Diagnostic Screen

Field Name Description Possible Values

EPG Search Authorized Shows whether native EPG search application is authorized. If not authorized, values in remaining fields will be Unavailable.

Authorized

Not Authorized

Number of Programs Number of programs in the database. [number]

DB Name Name of the database. [network-dependent]

DB Schema Version Schema version of the database. [network-dependent]

n/a

Last Updated Date of the latest database update. [date/time]

n/a

Last Pruned Date the database was last pruned. [date/time]

n/a

Last Audited Date the database was last audited. [date/time]

n/a

DB Size Size of the database. [size in bytes]

State of Database From the last 14 days, shows which days have data for the guide information (GI). If n/a, then all zeros.

Note: The screen example above shows the dates starting on the 19th of the month, in a 31-day month.

0 — Not started

– — Partial (in progress)

1 — Complete

179

Page 180: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

WiFi Summary Screen

Page 1: Access Point Information

Table 18 Wi-Fi Summary Screen: Page 1

Field Name Description Possible Values

Device Information

ModelName WAP model name. [String]

Example: VEN501

Default value =”- -“

SerialNumber WAP serial number. [String]

Default value=”- -“

HwVersion WAP hardware version. [String]

Default value=”- -“

SwVersion WAP software version. [String]

Default value=”- -“

DevicesConnected Number of IP Clients connected to this WAP.

[Number]

Default value=”- -“

DeviceMode The current access-point operating mode.

InfrastructureAccessPoint

WirelessBridge

Default value=”- -“

NTPServer1 IP Address of the host NTP server. The host is the STB that VEN501 attached via Ethernet.

[String]

Default value=”- -“

TotalChChanged Number of times the channel changed since last reboot.

[Number]

Default value=”- -“

TotalDfsChEntered Number of times entered in DFS channel since last reboot.

[Number]

Default value=”- -“

TotalDfsChExited Number of times exited from DFS channel since last reboot.

[Number]

Default value=”- -“

CurrentTime Current time in the VEN501. [Weekday name] [Month] [Day of Month] [hh:mm:ss] [Year]

Default value=“--”

ChannelsAvailable List of Wi-Fi channels in use. [String]

Default value=”- -“

DeviceStatus Current operational status of the device.

Up

Initializing

Error

Disabled [default]

180

Page 181: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

WiFi Summary Screen

SSID Service Set Identifier. The current SSID is in use by the connection.

[String]

Default value=”- -“

MacAddress MAC address of the WAP. [String]

Default value=”- -“

IPAddress IP address of the WAP. [String]

Default value=”- -“

TransmitPower Indicates the current transmit power level as a percentage of full power.

[Percentage (%)]

Default value=”- -“

UpTime Linux up time since the WAP was last restarted.

[Day hh::mm:ss]

Default value=”- -“

NtpSyncStatus Status of the CPE (VEN501) that is synchronized to the selected host NTP server. The “host” is the set-top that the VEN501 is attached to via Ethernet.

Note: A status of Error could be triggered by one of the following conditions:

Host not found

No IP address for that record

Non-recoverable name server error

Try again later

Unknown error

Error

Synchronized

Error_FailedToSynchronize

Default value=“--”

CurrentChannel The current radio channel used by the connection.

[Number]

Default value=“--”

LastDfsChEntered Date and time last entered in DFS channel since last reboot.

[Weekday name] [Month] [Day of Month] [hh:mm:ss] [Year]

Default value=“--”

LastDfsChExited Date and time last exited the DFS channel since last reboot.

[Weekday name] [Month] [Day of Month] [hh:mm:ss] [Year]

Default value=“--”

Firmware Upgrade Info

Table 18 Wi-Fi Summary Screen: Page 1 (continued)

Field Name Description Possible Values

181

Page 182: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

WiFi Summary Screen

FirmwareVersion Firmware build version number. [Number]

Default value=”- -“

DownloadedFile Firmware file name and file size in the format: Filename (File size in Bytes).

[String]

Default value=”- -“

DownloadURL The HTTP or TFTP download URL. [String]

Default value=”- -“

Table 18 Wi-Fi Summary Screen: Page 1 (continued)

Field Name Description Possible Values

182

Page 183: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Proxy Summary Screen

Pages 2-3: WiFi IP Client Information

Proxy Summary ScreenNote: The Proxy Summary screen appears only on G8 set-tops attached to a Cisco VEN501 802.11n Wi-Fi Access Point (WAP).

This screen displays information about the G8 acting as a proxy for downloads on behalf of any IP Client set-tops attached via the VEN501.

Tasks that you can perform from this screen include the following:

View Proxy Download configuration parameters for the G8 set-top.

Table 19 Wi-Fi Summary Screen: Pages 2-3

Field Name Description Possible Values

Device n Information (n = 1-3)

MAC Address The IP address of the Wi-Fi IP Client. [String]

Default value=”- -“

Friendly Name Friendly name of the UPnP device. [String]

Default value=”- -“

DownStreamRate Rate of last transmission downstream per associated device, in kb/s.

[kb/s]

Default value=”- -“

PacketsDownStream Count of packets downstream per associated device.

[Number]

Default value=”- -“

PacketsDropped Count of downstream packets dropped per associated device.

[Number]

Default value=”- -“

PacketsDropRate The packet error rate, shown as a percentage. The result is calculated by dividing downstream transmitted error packets by total transmitted packets.

[Number]

Default value=”- -“

UpStreamRate Rate of last transmission upstream per associated device in kb/s.

[kbps]

Default value=”- -“

PacketsUpStream Count of packets upstream per associated device.

[Number]

Default value=”- -“

Noise The noise level of the associated device in dBm.

[dBm]

Default value=”- -“

RSSI Received Signal Strength Indication. The RSSI of the associated wireless device in dBm.

[dBm]

Default value=”- -“

AssociatedTime The time duration that the IP Client is connected to the VEN501 WAP.

[Day hh::mm:ss]

Default value=”- -“

183

Page 184: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Proxy Summary Screen

Confirm the SA CVT version.

Identify the name and storage location of the last image download.

Examine client download trigger information.

184

Page 185: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

Proxy Summary Screen

Page 1: BFS, SA CVT, and Image Information

Pages 2-3: IP Client Information

Table 20 Proxy Summary Screen: Page 1

Field Name Description Possible Values

BFS Info

Min Backoff Time (seconds) The minimum amount of time to wait between download attempts.

[Number]

Default value = “Unavailable”

Max Backoff Time (seconds) The maximum amount of time to wait between download attempts.

[Number]

Default value = “Unavailable”

Max Retries The maximum number of download retries for a given trigger.

[Number]

Default value = “Unavailable”

User ID An optional username to use for the HTTP or HTTPS download.

[String]

Default value = “Unavailable”

Max Images The maximum number of IP Client STB images that may be stored on the G8 hard drive.

[Number]

Default value = “Unavailable”

URL The URL can describe an HTTP, HTTPS, or TFTP resource. If TFTP is selected, the G8 eCM uses TFTP to perform the download.

[String]

Default value = “Unavailable”

SA CVT Version

SA CVT Version SA CVT message version. If there is a version change, the Proxy Download server will parse the SA CVT pass-through message.

[Number]

Default value = “Unavailable”

Image Storage Info

Total Space (bytes) Total space of the hard drive. [Number]

Default value = “Unavailable”

Free Space (bytes) Free space of the hard drive. [Number]

Default value = “Unavailable”

Path The directory path of where the images are stored.

[String]

Default value = “Unavailable”

Latest Saved Image Details

Image Name Name of the last saved image. [String]

Default value = “Unavailable”

Size (bytes) Size of the last saved image in bytes. [Number]

Default value = “n/a”

185

Page 186: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

WebServices Summary Screen

WebServices Summary ScreenNote: The WebServices Summary screen appears only on G8 set-tops attached to a Cisco VEN501 802.11n Wi-Fi Access Point (WAP).

The G8 and any IP Client set-tops attached via the VEN501 communicate via representational state transfer (REST) and server-send event (SSE) web services. This screen displays information about these services.

Tasks that you can perform from this screen include the following:

View a summary of REST web server parameters.

View a summary of REST IP Client parameters.

View a summary of REST web services statistics.

Table 21 Proxy Summary Screen: Pages 2-3

Field Name Description Possible Values

IP Client n Information (n = 1-3)

New Image Name New image name from the SA CVT pass-through to be download to the IP Client STB.

[String]

Default value = “n/a”

Image Name The image name is currently running on the IP Client STB.

[String]

Default value = “n/a”

MAC Address The MAC address of the IP Client STB.

[String]

Default value = “n/a”

HW ID The hardware id of the IP Client STB. [Number]

Default value = “n/a”

Group ID The SA CVT group ID assigned to the IP Client STB.

[Number]

Default value = “n/a”

Priority Download type priority. Emergency

Immediate

Normal

Default value = “n/a

186

Page 187: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

WebServices Summary Screen

Page 1: REST Web Server Summary

Page 2: REST Web Clients Summary

Table 22 WebServices Summary Screen: Page 1

Field Name Description Possible Values

REST Server IP The gateway REST server IP address. [String]

Default value = “Unavailable”

Port (REST Server) The gateway REST server port number.

[Number]

Default value = “Unavailable”

REST Server Proxy Download IP The gateway REST server Proxy Download ip address.

[String]

Default value = “Unavailable”

Port (REST Server Proxy Download) The gateway REST server Proxy Download port number.

[Number]

Default value = “Unavailable”

SSE IP The gateway SSE server IP address. [String]

Default value = “Unavailable”

Port (SSE) The gateway SSE server port number. [Number]

Default value = “Unavailable”

REST Server State The state of the gateway REST server. Ready

Not Ready

Default value = “Unavailable”

Connected Client Count The number of connected IP Clients to this gateway.

[Number]

Default value = 0

Table 23 WebServices Summary Screen: Page 2

Field Name Description Possible Values

HN IP Address The Home Networking IP address of this connected IP Client to this gateway.

[String]

Default value = “Unavailable”

MAC Address The Home Networking MAC address of this connected IP Client to this gateway.

[String]

Default value = “Unavailable”

187

Page 188: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Services Diagnostics

WebServices Summary Screen

Pages 3-5: REST Web Services Statistics

HW Version The hardware version of this connected IP Client to this gateway.

[Number]

Default value = “Unavailable”

SW Version The software version of this connected IP Client to this gateway.

[Number]

Default value = “Unavailable”

SSE Connection Time The date and time that the SSE connection is established between this connected IP Client and this gateway.

[Weekday name] [Month] [Day of Month] [hh:mm:ss] [Year]

Default value = “Unavailable”

Table 23 WebServices Summary Screen: Page 2 (continued)

Field Name Description Possible Values

Table 24 WebServices Summary Screen: Pages 3-5

Field Name Description Possible Values

IP Client IP Client number of the first page. [Number]

Friendly Name The UPnP device friendly name of this connected IP Client to this gateway.

[String]

Default value = “Unavailable”

MAC Address The MAC address of the connected IP Client.

[String]

Default value = “Unavailable”

Requests Recd The number of HTTP requests per web service sent from this IP Client to the gateway REST web server.

[Number]

Default value = 0

HttpSuccess The number of HTTP success responses per web service sent from Gateway REST Web Server to IP Client.

The HTTP success response will be the counts of HTTP 200 OK or 202 Accepted.

[Number]

Default value = 0

HttpError The number of HTTP error responses per web service sent from Gateway REST Web Server to IP Client.

[Number]

Default value = 0

SSE Sent The number of SSE messages per web service sent from the Gateway SSE server to each IP Client.

[Number]

Default value = 0

188

Page 189: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Post & Boot DiagnosticsIntroduction

The Post & Boot diagnostic screens let you view the results of the self-test performed on each hardware component within the set-top at the beginning of the boot process.

Tasks that you can perform from this screen include the following:

Ensure that all hardware is present on the system.

Ensure that all hardware components are functioning properly.

Check the boot status of the set-top.

Determine if the set-top is ready to receive data.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

Post & Boot Result ScreenNote: When a subscriber plugs the set-top into an AC power outlet, the set-top performs a self-test on each component within the set-tpo. The POST results are not updated automatically. You must reboot the set-top to run another self-test.

Table 1 Post & Boot Result Screen

Field Name Description Possible Values

All fields in the Post Results section (for example, UNcfg, BFS, SI, SAM, IPG, and so on.)

Indicates the working status of each component within the set-top.

Failed - Self-test failed; the DHCT may be defective; contact your system administrator for assistance

n/a - The DHCT does not use the module tested in this field

Passed - Component is installed and functioning correctly

Unavailable - Component is not installed (optional components) or is not functioning correctly

189

Cisco Systems, Inc. www.cisco.com

Page 190: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Post & Boot Diagnostics

Post & Boot Result Screen

190

Page 191: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Version and MACs DiagnosticsIntroduction

The Version and MACs diagnostic screen lets you verify the version numbers and serial numbers for all applicable hardware and software modules in the set-top.

Tasks that you can perform from this screen include the following:

Confirm the hardware modules.

Confirm the software version.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

Version and MACs ScreenNote: When a subscriber plugs the set-top into an AC power outlet, the set-top performs a self-test on each component within the set-top. The POST results are not updated automatically. You must reboot the set-top to run another self-test.

191

Cisco Systems, Inc. www.cisco.com

Page 192: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Version and MACs Diagnostics

Version and MACs Screen

Table 1 Version and MACs Screen

Field Name Description Possible Values

Software Version

PTV OS The version for the PowerTV OS. [Software-dependent]

FLASH The version for the resident application.

[Software-dependent]

App(s) The names and version numbers of the applications available for execution.

[Software-dependent]

Hardware Modules

HW Config The version of the hardware configuration (HWConfig) module.

[Hardware module -dependent]

Note: This value should match the revision number (without decimals, for example, 5.9 appears as 59) printed on the set-top.

BIP Not applicable to Application Server.

AC3 Not applicable to Application Server.

BGATE Not applicable to Application Server.

BCM Not applicable to Application Server.

TVP Not applicable to Application Server.

RF Modem Not applicable to Application Server.

MAC Not applicable to Application Server.

QPSKRX Not applicable to Application Server.

QPSKTX Not applicable to Application Server.

ISE Not applicable to Application Server.

ESE Not applicable to Application Server.

DDS Not applicable to Application Server.

Serial Number

E-MAC The Ethernet media access control (E-MAC) adapter MAC address, if installed.

[Hardware-dependent]

Example: 00:18:68:BF:46:32

RF-MAC The RF network adapter MAC address.

[Hardware-dependent]

Example: 00:26:A4:BF:64:2F

ISE The ISE component serial number. [Hardware-dependent]

Example: 00:40:7B:BF:46:3D

ESE The serial number of the ESE smart card (optional component).

[Hardware-dependent]

Example: smart card is not currently in use.

192

Page 193: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

HDD Information DiagnosticsIntroduction

The HDD Information diagnostic screens let you view information related to the hard drive of a DVR set-top.

Note: These diagnostic screens only appear on set-top models that include a DVR.

These screens are divided into pages and sections that are devoted to specific tasks. Tasks that you can perform from these screens include the following:

DVR Information

Verify the storage capacity of the hard drive.

Determine if the hard drive is removable.

Partition Information

Verify the capacity of the partition.

Verify the amount of available space that remains in the partition.

Determine if any lost or bad clusters exist in the partition.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

Page 1: DVR InformationTasks that you can perform from this screen include the following:

Verify the storage capacity of the hard drive.

Determine if the hard drive is removable.

193

Cisco Systems, Inc. www.cisco.com

Page 194: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

HDD Information Diagnostics

Pages 2-3: Partition Information

Pages 2-3: Partition InformationTasks that you can perform from this screen include the following:

Verify the capacity of the partition.

Verify the amount of available space that remains in the partition.

Determine if any lost or bad clusters exist in the partition.

Table 1 HDD Info Screen - Page 1

Field Name Description Possible Values

Model Number Model number of the DVR hard drive. [Model-dependent]

Serial Number Serial number of the DVR hard drive. [Model-dependent]

Firmware version Firmware identification number. [Software-dependent]

Removable Indicates whether the DVR hard drive is removable.

Yes — The hard drive is removable (external)

No — The hard drive is not removable (internal)

Capacity Sector size for the DVR hard drive. [Hard-drive dependent]

Internal Temp Internal operating temperature of the DVR hard drive.

[Integer > 0]

Last scan status Time of the last scan. [Time]

Remapped sector count Remapped sector count for the Self-Monitoring, Analysis and Reporting Technology (SMART) DVR hard drive data.

0 — desired value

[Integer > 0] - Could indicate an issue

194

Page 195: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

HDD Information Diagnostics

Pages 2-3: Partition Information

Table 2 HDD Info Screen - Page 1

Field Name Description Possible Values

DeviceID The ID of the hardware device. 1

2

FS Type The type of file system present within the partition.

AVFS

ITFS

Reserved

Partin Size The total size of this partition within the hard drive.

[Integer > 0]

Free Space The amount of available space within this partition.

[Integer > 0]

Del. Files The number of files deleted from this partition.

[Integer >= 0]

X-Linked The number of cross-linked files that exist within the partition.

0 — desired value

Note: If this is a large value, call Cisco Services.

Lost Clusters The number of lost clusters (data fragment that does not associate with any files) within the partition.

0 — desired value

Note: If this is a large value, call Cisco Services

BadClusters The number of physically flawed clusters on the hard disk.

0 — desired value

Note: If this is a large value, call Cisco Services

195

Page 196: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

HDD Information Diagnostics

Pages 2-3: Partition Information

196

Page 197: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

CableCARD MMI DiagnosticsIntroduction

The CableCARD MMI diagnostic screen lets you view the last MMI message from the CableCARD module as received by the host. If there is no message, this page is blank.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

CableCARD MMI ScreenNote: The content of this screen is determined by the manufacturer of the CableCARD device installed in the set-top.

197

Cisco Systems, Inc. www.cisco.com

Page 198: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

CableCARD MMI Diagnostics

CableCARD MMI Screen

198

Page 199: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Media Shrink DiagnosticsIntroduction

The Media Shrink feature increases the recording capacity of a set-top by transcoding high-bitrate MPEG2 videos (both HD and SD) to low-bitrate MPEG4 video. Transcoding is performed automatically in the background without affecting the performance of the set-top. This chapter provides information on the diagnostic screens used to monitor and, if necessary, troubleshoot the Media Shrink feature.

These screens are divided into pages and sections that are devoted to specific tasks. Tasks that you can perform from these screens include the following:

Media Shrink Status

Verify whether the Media Shrink feature is enabled.

Check the disk quota information.

Check whether the current transcode failed due to resource conflict.

Media Shrink Session

Verify whether a file is being transcoded.

Check the status of the current transcode session.

Check the time taken to transcode a file.

Check the reduction in file size due to transcoding.

Media Shrink History

Review statistics for completed transcode sessions.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

Page 1: Media Shrink StatusTasks that you can perform from this screen include the following:

Verify whether the Media Shrink feature is enabled.

Check the disk quota information.

Check whether the current transcode failed due to resource conflict.

199

Cisco Systems, Inc. www.cisco.com

Page 200: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Media Shrink Diagnostics

Page 2: Media Shrink Session

Page 2: Media Shrink SessionTasks that you can perform from this screen include the following:

Verify whether a file is being transcoded.

Check the status of the current transcode session.

Check the time taken to transcode a file.

Table 1 Media Shrink Diagnostic Screen- Page 1

Field Name Description Possible Values

Status Indicates whether the background transcoding is enabled.

Enabled

Disabled

Include Paths The dvr directory paths from which recordings are transcoded.

Exclude Paths

Quota Set Indicates whether a quota has been specified in terms of space to be reserved for background transcodings.

True

False

Quota Size Indicates the size (in kilobytes) of the space reserved for background transcodings as per the quota.

[Integer > 0]

Quota % Full Indicates the percentage of the space reserved as per the quota that is currently in use.

0.0 - 100.0

Start Threshold Minimum free space (in kilobytes) that must be available on the target storage after subtracting the estimated size of the transcoded media file for the background transcoding to begin.

[Integer > 0]

Stop Threshold The free space (in kilobytes) on the target storage at which background transcoding must stop.

[Integer > 0]

Last Fail

File The name and directory path of the file whose transcoding failed most recently.

Date The date and time at which the last file transcoding failed.

DD MM YY hh:mm:ss

Reason The reason for the last transcoding failure.

Complete

Disk Full

Recording Aborted

Playback Aborted

Resource Conflict

Other

200

Page 201: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Media Shrink Diagnostics

Page 3: Media Shrink History

Check the reduction in file size due to transcoding.I

Page 3: Media Shrink HistoryTasks that you can perform from this screen include the following:

Review statistics for completed transcode sessions.

Table 2 Media Shrink Diagnostic Screen - Page 2

Field Name Description Possible Values

ID An unsigned integer value (in hexadecimal) that uniquely identifies the session.

0 - 0xFFFFFFFF

State The state of the transcoding session. Not Scheduled

Scheduled

Open Pending

Re-encrypt Pending

In Progress

Blocked

Commit Pending

Committed

Failed

Start Date The start date of the transcoding session.

DD Month YYYY

Start Time The start time of the transcoding session.

hh:mm:ss

% Complete Indicates the percentage of completion of file transcoding.

0.0 - 100.0

File Name Name of the file that is being transcoded.

Bitrate The bit-rate of the output file in bits per second.

0 - 40,000,000

File Size

Original The size (in kilobytes) of the file before transcoding.

[Integer > 0]

Predicted The estimated size of the transcoded file.

[Integer > 0]

Current The current size of the transcoded file.

[Integer > 0]

201

Page 202: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Media Shrink Diagnostics

Page 3: Media Shrink History

Table 3 Media Shrink Diagnostic Screen - Page 3

Field Name Description Possible Values

Reason Indicates whether the transcoding was completed, or specifies the reason for failure.

Complete

Disk Full

Recording Aborted

Playback Aborted

Resource Conflict

Other

Last State The state of the recording before transcoding was completed or failed.

Scheduled

File Name The name of the file that was to be transcoded.

Start Date The start date of file transcoding. DD Month YYYY

Start Time The start time of file transcoding. hh:mm:ss

End Date The end date of file transcoding. DD Month YYYY

End Time The end time of file transcoding. hh:mm:ss

File Size

Original The size (in kilobytes) of the file before transcoding.

[Integer > 0]

Final The size (in kilobytes) of the transcoded file.

[Integer > 0]

Ratio Ratio of the size of the transcoded file to the size of the original file.

0.01 - 1.00

202

Page 203: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Reboot STB Diagnostic ScreenIntroduction

The Reboot STB diagnostic screen lets you conveniently reboot the set-top from within the diagnostics.

NavigationFor instructions on navigating diagnostic screens, see Accessing Vantage Diagnostic Screens, page 37.

Rebooting the Set-topTo reboot the set-top:

1. Press SELECT on the set-top remote control or the set-top front panel to access the diagnostics Main Menu.

2. Choose Reboot STB from the Main Menu to enter the Reboot STB screen.

3. Press and hold SELECT for about 5 seconds. The set-top will reboot.

203

Cisco Systems, Inc. www.cisco.com

Page 204: JSON Diagnostics for VOD User Guide - Cisco€¦ · JSON Diagnostics for VOD User Guide ... BFS, SA CVT, and Image ... Notes contain helpful suggestions or references to material

Reboot STB Diagnostic Screen

Rebooting the Set-top

204