Cisco D9800 Network Transport Receiver Version 3.50 Restful Web Services API Reference Guide
Total Page:16
File Type:pdf, Size:1020Kb
Cisco D9800 Network Transport Receiver Version 3.50 RESTful Web Services API Reference Guide First Published: 2018-07-19 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883 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 following information is for FCC compliance of Class A devices: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio-frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference, in which case users will be required to correct the interference at their own expense. The following information is for FCC compliance of Class B devices: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If the equipment causes interference to radio or television reception, which can be determined by turning the equipment off and on, users are encouraged to try to correct the interference by using one or more of the following measures: • Reorient or relocate the receiving antenna. • Increase the separation between the equipment and receiver. • Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. • Consult the dealer or an experienced radio/TV technician for help. Modifications to this product not authorized by Cisco could void the FCC approval and negate your authority to operate the product 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. 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. (1721R) © 2018 Cisco Systems, Inc. All rights reserved. With each AVC/H.264 product, we are obligated to provide the following notice: AVC VIDEO LICENSE THIS PRODUCT IS LICENSED UNDER THE AVC PATENT PORTFOLIO LICENSE FOR THE PERSONAL AND NON-COMMERCIAL USE OF A CONSUMER TO (i) ENCODE VIDEO IN COMPLIANCE WITH THE AVC STANDARD ("AVC VIDEO") AND/OR (ii) DECODE AVC VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A PERSONAL AND NON-COMMERCIAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS GRANTED OR SHALL BE IMPLIED FOR ANY OTHER USE. ADDITIONAL INFORMATION MAY BE OBTAINED FROM MPEG LA, L.L.C. SEE http://www.mpegla.com. Accordingly, please be advised that service providers, content providers, and broadcasters are required to obtain a separate use license from MPEG LA prior to any use of AVC/H.264 encoders and/or decoders. © 2018 Cisco Systems, Inc. All rights reserved. CONTENTS PREFACE Preface xi Audience xi Conventions xi Related Documentation xii CHAPTER 1 Web Services API 1 About Web Services API 1 Accessing Web Services API 1 Access Level (Login and Logout) 2 HTTP Request Methods 3 Get 3 Post 4 HTTP Responses 5 HTTP Status Codes 5 Content Response Types 5 XML or JSON Response Body 6 Base URI 7 URI Parameters 7 URI Arguments 7 Access Type 8 Port Information 8 CHAPTER 2 API Definitions 11 Legacy API 11 Backup Command 11 Restore Command 12 Cisco D9800 Network Transport Receiver Version 3.50 RESTful Web Services API Reference Guide v Contents Download User Defaults (Customer Presets) Command 13 BKPRST Status Command 14 Legacy CDT Upload Command 15 Chunky CDT Upload Command 16 Determining Support for Chunky CDT Upload Command 18 Upload Software License File Command 20 Diagnostics Package (Export Debug File) Commands 21 Diagnostics Package Trigger Command 21 Diagnostics Package Operation Status Command 22 Diagnostics Package Retrieval Command 23 Status API 24 RF Input Status Command 24 ASI Input Status Command 30 IP Input Status Command 34 ABR Input Status Command 40 Zixi Input Status Command 45 PE Status Command 49 CA PowerVu Status Command 53 CI (Common Interface) CAM Status Command 55 CISYS Status Command 57 Useraddr Status Command 59 Output Status Command 60 ASI Output Status Command 67 MOIP Output Status 71 DPM PID Output Status Command 74 DPM Active Collisions Status Command 80 Video Decode Status Command 83 Audio Decode Status Command 85 Audio STC302 Decode Status Command 87 Closed Caption (CC) Decode Status Command 89 VBI Decode Status Command 90 SDI Decode Status Command 91 HDMI Decode Status Command 96 Identity Status Command 98 Cisco D9800 Network Transport Receiver Version 3.50 RESTful Web Services API Reference Guide vi Contents Licenses Command 104 Device Identification Command 107 Hardware Options Command 110 Device Status Command 112 About Status Command 113 ECC Status Command 117 Ethernet Status Command 122 Power Status Command 124 Alarms and Warnings 126 Fault Details Status Command 127 Fault Actions Status Command 128 Faults Summary Status Command 129 Faults Status Command 131 Faults History Status Command 133 Disaster Recovery (D/R) Status Command 136 Disaster Recover (D/R) Global Status Command 137 Disaster Recovery (D/R) Search Status Command 139 Disaster Recovery (D/R) Backups (Profiles) Global Status Command 140 Disaster Recover (D/R) RF Backup Status Command 142 Disaster Recovery (D/R) MOIP Backup Status Command 144 Disaster Recovery (D/R) Zixi Backup Status 147 Disaster Recovery (D/R) ABR Backup Status Command 150 Disaster Recovery (D/R) ASI Backup Status Command 152 Disaster Recover (D/R) Backup Nodes (Search Path) Status Command 153 Disaster Recover (D/R) RF Origin Tuning Command 155 Disaster Recover (D/R) Origin Channels Command 157 Configuration API 158 Input Configuration Command 158 RF Input Configuration Command 161 ASI Input Configuration Command 169 MOIP Input Configuration Command 173 MOIP Input Source Filters Configuration Command 181 MOIP Input Source Select Configuration Command 183 ABR Input Configuration Command 187 Cisco D9800 Network Transport Receiver Version 3.50 RESTful Web Services API Reference Guide vii Contents Zixi Input Configuration Command 192 PE Configuration Command 199 Output Configuration Command 203 ASI Global Output Configuration Command 212 MOIP Global Output Configuration Command 216 DPM ASI/MOIP PE Output Configuration Command 221 MOIP Output Stream Configuration 225 Decode Configuration Commands 230 Control Decode Configuration Command 230 Video Decode Configuration Command 232 Aspect Ratio (AR) Decode Configuration Command 234 Subtitle (SUBT) Decode Configuration Command 236 Closed Caption (CC) Decode Configuration Command 238 Audio Decode Configuration Command 240 SDI Decode Configuration Command 251 HDMI Decode Configuration Command 254 Advanced Audio Decode Configuration Command