Page 1 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide First Published: 2017-10-23 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883...
Page 2 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.
Page 3: Table Of Contents
XML or JSON Response Body Base URI URI Parameters URI Arguments Access Type Port Information API Definitions C H A P T E R 2 Legacy API Backup Command Restore Command Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 4 Audio STC302 Decode Status Command Closed Caption (CC) Decode Status Command VBI Decode Status Command SDI Decode Status Command HDMI Decode Status Command Identity Status Command Device Status Command Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 5 DPM ASI/MOIP PE Output Configuration Command MOIP Output Stream Configuration Decode Configuration Commands Control Decode Configuration Command Video Decode Configuration Command Aspect Ratio (AR) Decode Configuration Command Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 6 Version Selection Device Control Command Reset Device Control Command Protocol Device Control Download Device Control Settings Diagnostics API IP Diagnostics Commands IP Diagnostics Trigger Command IP Diagnostics Operation Status Command Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 7 Contents IP Diagnostics Report Retrieval Command Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 8 Contents Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide viii...
Page 9 Related Documentation, page x • Obtaining Documentation and Submitting a Service Request, page xi Audience The audience of this guide includes developers who will build a client application to interface with the D9800 Network Transport Receiver. Conventions This guide uses the following conventions.
Page 10: Related Documentation
• Release Notes for Cisco D9800 Network Transport Receiver, available at the following URL: http:// www.cisco.com/go/receivers_release_notes. • Open Source Used In Cisco D9800 Network Transport Receiver, available at the following URL: http:/ /www.cisco.com/go/receivers_licensing. • Cisco D9800 Network Transport Receiver Data Sheet, available at the following URL: http:// www.cisco.com/c/en/us/products/video/digital-receivers-decoders/datasheet-listing.html.
Page 11 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. RSS feeds are a free service.
Page 12 Preface Obtaining Documentation and Submitting a Service Request Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 13: Web Services Api
192.168.0.1 in the message with the IP address of the target unit. By default, the D9800 web server redirects all incoming web traffic to HTTPS on port 443 and will respond to all HTTP URI requests with a redirect response to the equivalent HTTPS URI.
Page 14: Access Level (Login And Logout)
Access Level (Login and Logout) To access a single API, you can use cURL. For more information, see https://curl.haxx.se/. Since SSL certificates on D9800 units are self-signed, you can use "-k DEFAULT" options to bypass the security checks of the cURL command.
Page 15: Http Request Methods
The following is an example of a Block Data GET request. Passing a block of XML data from a file: curl -k -i -H "X-SESSION-ID: $token" --header "Content-type:application/xml" -d @"input.xml" "https://192.168.0.1/ws/v2/service_cfg/input" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 16: Post
We highly recommend that you use the alternate write from file method to set multiple arguments at the same time. HTTP Responses This section describes the HTTP status codes and content response types. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 17: Http Status Codes
Date: Fri, 23 Oct 2015 19:26:40 GMT Server: Hiawatha v9.14 Connection: keep-alive Transfer-Encoding: chunked Status: 404 The following is a list of the common HTTP return codes when communicating with D9800 (refer to RFC-1945 for the full list and descriptions): 200_HTTP_OK 400_HTTP_BAD_REQUEST 401_HTTP_UNAUTHORIZED...
Page 18: Xml Or Json Response Body
POST API is executed successfully. $ curl -k -H "X_SESSION-ID: $token" -X POST "https://192.168.0.1/ws/v2/service_cfg/input/rf?port=1&&dnlkfreq=3.51&js=1" "response": { "code": "10", "result": "success", "message": "" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 19: Base Uri
• Argument Description A brief description of the argument item. • Argument Type Currently 5 different data types are supported for query options: 1 Integer 2 String 3 Boolean Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 20: Access Type
There are three types of NTC boards: NTC Board Port Description NTC Basic One Ethernet port: • Management NTC MOIP Three Ethernet ports: • Management • DATA1 • DATA2 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 21 The ports are labeled on the backplane of an assembled unit. The Management port (port 0) is labeled Management. The DATA ports are labeled DATA1, DATA2, DATA3, and DATA4. The Management port is also referred to as "Control port" in this document. Note Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 22 Web Services API Port Information Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 23: Api Definitions
C H A P T E R API Definitions This section describes the API definitions for controling the D9800 Network Transport Receiver. • Legacy API, page 11 • Status API, page 25 • Configuration API, page 135 • Device Control Commands, page 265 •...
Page 24 If there is a problem with file transfer, timeout, or invoking the command, then the XML response to this command will indicate a failure response through the legacy command Status form. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 25: Restore Command
100 percent, or that it was aborted (operationStatus="Fail") due to errors. This operation may take over one minute, depending on the amount of data to validate and restore. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 26: Download User Defaults (Customer Presets) Command
This operation may take over one minute, depending on the amount of data to validate and restore. BKPRST Status Command Table 5: Command Details Command Detail Description Command URL https://192.168.0.1/ws/v1/table?t=BKPRSTSTAT Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 27: Legacy Cdt Upload Command
Restore Command, on page Legacy CDT Upload Command Table 6: Command Details Command Detail Description Command URL -F cdtfile=@"cdt_file_path/cdt_file_name" "https://192.168.0.1/ws/v1/cdt_upload.html" Command Information Upload a CDT file to the device. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 28: Chunky Cdt Upload Command
POST command): start offset byte (within the source file), end offset byte (included in the size of the current chunk), and total source file size (in bytes). Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 29 • Override of the default Content-Length header using –H option may be required to compensate for internal MIME boundary overhead (182 bytes in addition to range size), within the body of each transmitted chunk. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 30 HTTP(S) POST API implementation. Command Information Upload a CDT file to the device using Chunky algorithm. HTTP Method POST Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 31: Determining Support For Chunky Cdt Upload Command
Table 8: Command Details Command Detail Description Command URL https://192.168.0.1/ws/v2/device_ctl/download Command Information Show information about download command. HTTP Method GET, POST Access Type Read, Write Access Level Admin Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 32 Values: Enabled (default), Disabled (for testing only) This value is read-only and intended only for use by specific internal tools in Cisco test and manufacturing. It is not used by the D9800 Web UI, which is integrated within the target application software during fie upload.
Page 33: Upload Software License File Command
Command URL -F cdtfile=@"lic_file_path/lic_file_name" "https://192.168.0.1/cdt_upload.html" Command Information Software license files can be uploaded to the unit, the same as a CDT file. HTTP Method POST Access Type Write Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 34: Diagnostics Package (Export Debug File) Commands
Generate the diagnostics package file. HTTP Method POST Access Type Write Access Level User, Admin Restricted to lock level 0 only. Options: N/A Example of issuing the diagnostics trigger command: Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 35: Diagnostics Package Operation Status Command
Expected output (example of when diagnostics package preparation is 100% completed successfully): <?xml version="1.0" encoding="ISO-8859-1" ?><HDR><TABLE><RECORD><ITEM><ID>0x002D25CD</ID><VALUE><![CDATA[Pass]]></VALUE><NAME><! [CDATA[OPERSTATUS]]></NAME><HELP_STR_1><![CDATA[Indicates whether the most recent operation passed, failed, or is in progress]]></HELP_STR_1><HELP_STR_2><![CDATA[This item has 3 options Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 36: Diagnostics Package Retrieval Command
Expected output (example for success case, which indicates that Diag Package Retrieval was completed): % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 37: Status Api
Additional failure reason details may be determined by calling the DIAGSTAT API. Note <?xml version="1.0" encoding="ISO-8859-1" ?><SESSIONINFO><STATUS>response failure, rc=192512</STATUS></SESSIONINFO> Status API This section describes the commands used to obtain input, output, and decode status information on the D9800 receiver. RF Input Status Command Table 14: Command Details Command Detail...
Page 38 Values: "Auto", "1/2", "2/3", "3/4", "5/6", "7/8", "8/9" Modulation Type Type: String Values: "DVBS" or "DVB-S2" rolloff Rolloff Factor Type: String Values: ".20", ".25", ".35", "Auto" IQ Mode Type: String Values: "Normal" or "Opposite" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 39 Type: String Values: "N/A", "East", "West" afcrange AFC Range Value Type: Float Values: 0.0 ... 5.0 acqmode PSI Acquisition Mode Type : String Values : "Auto", "Basic", "Custom" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 40 Service List Mode (S./W Release 2.75 and up) Type : String Values : "Rigorous", "Relaxed" Note Service List Mode (Version 2.50 and earlier) Type : String Values : "Rigorous", "Degraded" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 41 "satlock": "No Lock", "inputrate": "0.0", "netname": "", "netid": "", "transid": "", "lsttunerea": "User_Change", "tunereason": "User", "freqmode": "NIT", "svclstmode": "Rigorous", "baten": "No", "niten": "Yes", "sdten": "Yes", "paten": "Yes" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 42 "svclstmode": "Rigorous", "baten": "No", "niten": "Yes", "sdten": "Yes", "paten": "Yes" "port": "4", "dnlkfreq": "12.31003", "symrate": "30.0", "fec": "9/10", "mod": "8PSK DVB-S2", "rolloff": ".35", "iq": "Normal", "pwr": "Off", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 43: Asi Input Status Command
Return information about ASI input. HTTP Method Access Type Read Access Level Guest, User, Admin Syntax GET "https://192.168.0.1/ws/v2/status/input/asi?js=1" URI Parameters (extension to the Command URL separated by /): N/A Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 44 Type: Integer Values: 0…4294967295 netname Network Name Type: String Values: Up to 64 characters netid Network ID Type: Integer Values: 0…65535 transid Transport ID Type: Integer Values: 0…65535 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 45 Service List Mode (Version 2.75 and later) • Type: String • Values: "Rigorous", "Relaxed" Service List Mode (Version 2.50 and earlier) • Type : String • Values : "Rigorous", "Degraded" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 46 "transid": "", "scrambmode": "Unk", "transerr": "Error", "asilinkerr": "Error", "asipktsize": "N/A", "lsttunerea": "User_Change", "tunereason": "User", "freqmode": "User Cfg", "svclstmode": "Rigorous", "baten": "No", "niten": "No", "sdten": "Yes", "paten": "Yes" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 47: Ip Input Status Command
Omitting this argument formats the output by default in XML. Table 22: Output Field Descriptions Output Field Description port Input Port status to be returned Type: Integer Values: 1 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 48 IP Signal Type: String Values: "None" or "Active" feclock FEC Lock Type: String Values: "None", "Column", "Row", or "Collision" pcrlock PCR Lock Type: String Values: "Yes" or "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 49 Service List Mode (Version 2.75 and later) • Type : String • Values : "Rigorous", "Relaxed" Service List Mode (Version 2.50 and earlier) • Type : String • Values : "Rigorous", "Degraded" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 50 "dejitlaten": "110", "datasrc1": "0.0.0.0", "datasrc2": "0.0.0.0", "data1tstyp": "Unk", "data2tstyp": "Unk", "lsttunerea": "User_Change", "tunereason": "User", "freqmode": "User Cfg", "svclstmode": "Rigorous", "baten": "No", "niten": "No", "sdten": "Yes", "paten": "Yes" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 51: Abr Input Status Command
Table 25: Output Field Descriptions Output Field Description Input is activated Type: String Values: "Yes" or "No" abrlock ASI Signal Lock Type: String Values: "No Lock", "Lock-Sig", "Lock+Sig" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 52 Values: "No_Change", "DR Change", "User_Change", "Preset_Change", "Uplink_Change", or "NIT_TS_Change" tunereason Last Tune Reason Type: String Values: Up to 24 characters freqmode Frequency Tuning Mode Type: String Values: "NIT", "User Cfg" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 53 Type: Float Values: 0…4294.967295 Mbps buflvlcurq1 Buffer level current queue 1 Type: Float Values: 0…4294.967295 Mb buflvlcurq2 Buffer level current queue 2 Type: Float Values: 0…4294.967295 Mb Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 54 Download stop time from the end of manifest Type: Integer Values: 0…4294967295 dlcurtrglat Download start time from the beginning of manifest Type: Integer Values: 0…4294967295 Input Example: curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/input/abr?js=1" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 55 "acqstatus": "Failed", "name": "ABR2", "rate": "0", "dlrate": "0.0", "buflvlcurq1": "0.0", "buflvlcurq2": "0.0", "manidur": "0", "manierr": "0", "dlmanicnt": "0", "dlmanierr": "0", "dlfragcnt": "0", "dlfragerr": "0", "fragerr": "0", "dlcurminlat": "0", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 56: Zixi Input Status Command
Values: any value or empty (for example, any of js=1 or js or js=0 or js=9999 are valid) Omitting this argument formats the output by default in XML. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 57 Network ID Type: Integer Values: 0…65535 transid Transport ID Type: Integer Values: 0…65535 scrambmode Scrambling Mode Type: String Values: "Unk", "DES", "DVB", "BISS1", "BISS2", or "BISS3" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 58 Enable PAT Reception Type String Values: "N/A", "Yes", "No" acqstatus Acquisition State Type: String Values: "Full", "Partial", "None" inputid Input Id Type: String Values: "ZIXI1", "ZIXI2" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 59 "act": "Yes", "lock": "Lock+Sig", "iplinkstat": "Up", "ipsignal": "Active", "inputrate": "7.17246", "netname": "", "netid": "", "transid": "1", "scrambmode": "Unk", "lsttunerea": "User_Change", "tunereason": "User", "freqmode": "User Cfg", "svclstmode": "Relaxed", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 60: Pe Status Command
Table 30: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &) URI Argument Description peid (key) Program Entry Identifier Type: Integer Value: 1..32 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 61 Values: String used to describe the channel name, less than 64 characters caauth CA authorized Type: String Values: "Yes", "No" caencrypt CA Encrypted Type: String Values: "Yes", "No" cascramble CA Scrambled Type: String Values: "Yes", "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 62 Values: "Not Started", "Primary", "Alternate" srtype SR Type Type: String Values: "None", "Scheduled", "CA", "Cue Trigger" srstartime SR start time Type: Time Values: for example, "2007/09/01 00:00:00" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 63 "caauth": "Yes", "caencrypt": "Yes", "cascramble": "Yes", "caid": "SA", "prgmstatus": "Active", "pmtpid": "5801", "pcrpid": "2100", "srstatus": "Primary", "srtype": "None", "srstartime": "2007/09/01 00:00:00", "srendtime": "2007/09/01 00:00:00", "peenabled": "Yes", "hdlicensed": "No", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 64: Ca Powervu Status Command
Values: any value or empty (ie any of js=1 or js or js=0 or js=9999 are valid) Omitting this argument formats the output by default in XML. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 65 Input Example (request JSON format): curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/ca/pvu?js=1" Expected output (values are for example purposes only): "ca": { "pvu": [ "iseuseradd": "000-529-2431-6", "encpktpass": "10490", "encpktrcv": "10490", "nencpktpass": "8390", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 66: Ci (Common Interface) Cam Status Command
Values: any value or empty (for example, any of js=1 or js or js=0 or js=9999 are valid) Omitting this argument formats the output by default in XML. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 67 Value: Inserted CAM Hardware Version in string format appver CAM Application Version Type: String Value: Inserted CAM Application Version in string format prodcode CAM Product Code Type: Integer Value: 0...0xFFFFFFFF Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 68: Cisys Status Command
Return information about Common Interface (CI) CAMs supported System IDs. HTTP Methods GET (All Access), POST (Restricted Access) Access Type Read Access Level Guest, User, Admin Display Details Syntax GET "https://192.168.0.1/ws/v2/status/ca/cisys" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 69 -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/ca/cisys" Expected output (values are for example purposes only): <?xml version="1.0" encoding="ISO-8859-1" ?> <ca> <cisys> <slotid>TOP</slotid> <sysids>2525</sysids> <sysname>News Dataco</sysname> <sysnameids>News Dataco (0x9dd)</sysnameids> </cisys> </ca> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 70: Useraddr Status Command
Values: any value or empty (for example, any of js=1 or js or js=0 or js=9999 are valid) Omitting this argument formats the output by default in XML. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 71: Output Status Command
Command Information This command can be used to get all output status parameters. HTTP Method Access Type Read Access Level User, Admin Display Details Syntax GET "https://192.168.0.1/ws/v2/status/output" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 72 <inpid>1102</inpid><outpid>1102</outpid><inchan>1102</inchan><type>AUD</type><received>Yes </received><pcr>No</pcr><scrambled>No</scrambled></pid><pid><peid>1</peid><row>13</row><inpid>1113 </inpid><outpid>1113</outpid><inchan>1113</inchan><type>AUD</type><received>Yes</received> <pcr>No</pcr><scrambled>No</scrambled></pid><pid><peid>1</peid><row>14</row><inpid>2750</inpid> <outpid>2750</outpid><inchan>2750</inchan><type>SUBT</type><received>Yes</received><pcr>No</pcr> <scrambled>No</scrambled></pid><collision><status>No Record in Dynamic Table</status></collision> </asi><moip><enginerr>No</enginerr><overflow>No</overflow><comrate>68.5</comrate><ts1rate>0.0 </ts1rate><ts2rate>0.0</ts2rate><pid><peid>1</peid><row>1</row><inpid>1500</inpid><outpid>1500 </outpid><inchan>1500</inchan><type>VID</type><received>No</received><pcr>No</pcr> <scrambled>No</scrambled></pid><pid><peid>1</peid><row>2</row><inpid>3349</inpid><outpid>3349 </outpid><inchan>3349</inchan><type>LSDT</type><received>Yes</received><pcr>No</pcr> <scrambled>No</scrambled></pid><pid><peid>1</peid><row>3</row><inpid>4001</inpid><outpid>4001 </outpid><inchan>4001</inchan><type>MPE</type><received>No</received><pcr>No</pcr> <scrambled>No</scrambled></pid><pid><peid>1</peid><row>4</row><inpid>4002</inpid><outpid>4002 </outpid><inchan>4002</inchan><type>MPE</type><received>No</received><pcr>No</pcr> <scrambled>No</scrambled></pid><pid><peid>1</peid><row>5</row><inpid>4003</inpid><outpid>4003 </outpid><inchan>4003</inchan><type>MPE</type><received>No</received><pcr>No</pcr> <scrambled>No</scrambled></pid><pid><peid>1</peid><row>6</row><inpid>4004</inpid><outpid>4004 </outpid><inchan>4004</inchan><type>MPE</type><received>No</received><pcr>No</pcr> <scrambled>No</scrambled></pid><pid><peid>1</peid><row>7</row><inpid>4005</inpid><outpid>4005 </outpid><inchan>4005</inchan><type>MPE</type><received>No</received><pcr>No</pcr> <scrambled>No</scrambled></pid><pid><peid>1</peid><row>8</row><inpid>1550</inpid><outpid>1550 </outpid><inchan>1550</inchan><type>DPI</type><received>No</received><pcr>No</pcr> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 73 "received": "No", "pcr": "No", "scrambled": "No" "peid": "1", "row": "4", "inpid": "4002", "outpid": "4002", "inchan": "4002", "type": "MPE", "received": "No", "pcr": "No", "scrambled": "No" "peid": "1", "row": "5", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 74 "inchan": "1511", "type": "AUD", "received": "Yes", "pcr": "No", "scrambled": "No" "peid": "1", "row": "11", "inpid": "1501", "outpid": "1501", "inchan": "1501", "type": "AUD", "received": "Yes", "pcr": "No", "scrambled": "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 75 "scrambled": "No" "peid": "1", "row": "2", "inpid": "3349", "outpid": "3349", "inchan": "3349", "type": "LSDT", "received": "Yes", "pcr": "No", "scrambled": "No" "peid": "1", "row": "3", "inpid": "4001", "outpid": "4001", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 76 "inchan": "1550", "type": "DPI", "received": "No", "pcr": "No", "scrambled": "No" "peid": "1", "row": "9", "inpid": "2906", "outpid": "2906", "inchan": "2906", "type": "VBI", "received": "No", "pcr": "No", "scrambled": "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 77 "scrambled": "No" "peid": "1", "row": "14", "inpid": "2750", "outpid": "2750", "inchan": "2750", "type": "SUBT", "received": "Yes", "pcr": "No", "scrambled": "No" "collision": { "status": "No Record in Dynamic Table" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 78: Asi Output Status Command
Values: any value or empty (ie any of js=1 or js or js=0 or js=9999 are valid) Omitting this argument formats the output by default in XML. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 79 "inchan": "1500", "type": "VID", "received": "No", "pcr": "No", "scrambled": "No" "peid": "1", "row": "2", "inpid": "3349", "outpid": "3349", "inchan": "3349", "type": "LSDT", "received": "Yes", "pcr": "No", "scrambled": "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 80 "inpid": "1550", "outpid": "1550", "inchan": "1550", "type": "DPI", "received": "No", "pcr": "No", "scrambled": "No" "peid": "1", "row": "9", "inpid": "2906", "outpid": "2906", "inchan": "2906", "type": "VBI", "received": "No", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 81 "scrambled": "No" "peid": "1", "row": "14", "inpid": "2750", "outpid": "2750", "inchan": "2750", "type": "SUBT", "received": "Yes", "pcr": "No", "scrambled": "No" "collision": { "status": "No Record in Dynamic Table" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 82: Moip Output Status
Values: any value or empty (for example, any of js=1 or js or js=0 or js=9999 are valid) Omitting this argument formats the output by default in XML. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 83 <?xml version="1.0" encoding="ISO-8859-1" ?> <output> <moip> <enginerr>No</enginerr> <overflow>No</overflow> <comrate>68.5</comrate> <ts1rate>0.0</ts1rate> <ts2rate>0.0</ts2rate> <pid> <peid>1</peid> <row>1</row> <inpid>2100</inpid> <outpid>2100</outpid> <inchan>2100</inchan> <type>VID</type> <received>Yes</received> <pcr>Yes</pcr> <scrambled>No</scrambled> </pid> <pid> <peid>1</peid> <row>2</row> <inpid>2110</inpid> <outpid>2110</outpid> <inchan>2110</inchan> <type>AUD</type> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 84: Dpm Pid Output Status Command
Partial response is not supported. This command returns Note the status of all active peid and row key combinations for all output fields for the specified MOIP or ASI. HTTP Method Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 85 IP output 2. Table 56: URI <level_2> URI Parameters (extension to the Command URL separated by /) URI Level 2 Parameter Description DPM PMT PID information. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 86 Values: "INVL", "PCR", "VID", "AUD", "SUBT", "VBI", "DPI", "MPE", "TTX", "DATA", "LSDT", "CDT", "ETV", "UNKN" received Input Received Type: Boolean Values: "Yes", "No" Type: Boolean Values: "Yes", "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 87 "peid": "1", "row": "2", "inpid": "2210", "outpid": "2210", "type": "AUD", "received": "Yes", "pcr": "No", "scrambled": "No" "peid": "1", "row": "3", "inpid": "18", "outpid": "18", "type": "UNKN", "received": "No", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 88 "output": { "asi2": { "pid": [ "peid": "1", "row": "1", "inpid": "2200", "outpid": "2200", "type": "VID", "received": "No", "pcr": "No", "scrambled": "" "peid": "1", "row": "2", "inpid": "2210", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 89: Dpm Active Collisions Status Command
"inpid": "18", "outpid": "18", "type": "UNKN", "received": "No", "pcr": "No", "scrambled": "No" DPM Active Collisions Status Command Table 59: Command Details Command Detail Description Command URL https://192.168.0.1/ws/v2/status/output/<level_1>/<level_2> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 90 IP output 2/ Table 61: URI <level_2> URI Parameters (extension to the Command URL separated by /) URI Level 2 Parameter Description collision DPM Active collision information. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 91 Values: 1..32 pmtrow1 PMT Row-1 Type: Integer Values: 1 … 65 peidx2 PE index-2 Type: Integer Values: 1..32 pmtrow2 PMT Row-2 Type: Integer Values: 1 … 65 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 92 "asi1": { "collision": { "status": "No Record in Dynamic Table" MOIP Example on NTC multi-stream unit (for which MOIP2 output was configured): curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/output/moip2/collision&js=1" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 93: Video Decode Status Command
Values: any value or empty (for example, any of js=1 or js or js=0 or js=9999 are valid) Omitting this argument formats the output by default in XML. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 94 Synch mode Type: String Values: "Auto", "Manual" encoding Encoding standard Type: String Values: "MPEG1", "MPEG2", "H264", "VC1", "MPEG_P2", or "Unknown" Example: curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/decode/video" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 95: Audio Decode Status Command
Omitting this argument formats the output by default in XML. Table 69: Output Field Descriptions Output Field Description mode Audio Mode Type: String Value: "Stereo", "Mixed", "L-MONO", "R-MONO" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 96 Expected output (values are for example purposes only): <?xml version="1.0" encoding="ISO-8859-1" ?> <decode> <audio> <device>1</device> <mode>None</mode> <bitrate>0</bitrate> <bufferlvl>0</bufferlvl> <sfr>0.0</sfr> <pid> </pid> <lang> </lang> <ddpmode>OFF</ddpmode> <dualmono>OFF</dualmono> </audio> <audio> <device>2</device> <mode>None</mode> <bitrate>0</bitrate> <bufferlvl>0</bufferlvl> <sfr>0.0</sfr> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 97: Audio Stc302 Decode Status Command
URI Parameters (extension to the Command URL separated by /): N/A Table 71: Output Field Descriptions Output Field Description device ST302 Device Instance Type: Integer Value: 1 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 98: Closed Caption (Cc) Decode Status Command
"aud_st302": { "device": "1", "streamformat": "Unknown", "numstreams": "0", "packetsize": "Unknown", "dolbyconfig": "Unknown" Closed Caption (CC) Decode Status Command Table 72: Command Details Command Detail Description Command URL https://192.168.0.1/ws/v2/status/decode/cc Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 99 Input example (request default XML format: curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/decode/cc" Expected output (values are for example purposes only): <?xml version="1.0" encoding="ISO-8859-1" ?> <decode> <cc> <ccoutact>Auto</ccoutact> </cc> </decode> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 100: Vbi Decode Status Command
Values: any value or empty (for example, any of js=1 or js or js=0 or js=9999 are valid) Omitting this argument formats the output by default in XML. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 101: Sdi Decode Status Command
SDI type. HTTP Method Access Type Read Access Level User, Admin Syntax GET "https://192.168.0.1/ws/v2/status/decode/sdigglb" or GET "https://192.168.0.1/ws/v2/status/decode/sdisvc" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 102 Values: 0 ... 4294967295 wordsline VANC words per line Type : Integer Values: 0 ... 4294967295 firstline VANC area: first line Type : Integer Values: 0 ... 4294967295 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 103 Line number where VANC service is located (in bottom field) Type: Integer Values: 0 ... 4294967295 maxlines Maximum number of lines used by VANC service Type: Integer Values: 0 ... 4294967295 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 104 "topline": "0", "bottomline": "0", "maxlines": "0", "avgdata": "0", "avgtranpkt": "0", "avgdroppkt": "0" "serviceid": "AFD", "active": "No", "adjline": "2", "topline": "0", "bottomline": "0", "maxlines": "0", "avgdata": "0", "avgtranpkt": "0", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 105: Hdmi Decode Status Command
Table 83: Command Details Command Detail Description Command URL https://192.168.0.1/ws/v2/status/decode/hdmi Command Information This command is used to read all or single device HDMI decode status. HTTP Method Access Type Read Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 106 HDMI device powered Type : String Values: "Yes", "No" monitorname Name of monitor name connected to HDMI output Type : String Values: Text, up to 40 characters Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 107 "colorspace": "Unknown", "colordepth": "Unknown", "colorrange": "Unknown", "matrixcoeff": "Unknown", "eotf": "Unknown" "hdmiindex": "2", "connected": "No", "powered": "No", "monitorname": "Unknown", "colorspace": "Unknown", "colordepth": "Unknown", "colorrange": "Unknown", "matrixcoeff": "Unknown", "eotf": "Unknown" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 108: Identity Status Command
HTTP Method Access Type Read Access Level User, Admin Syntax GET "https://192.168.0.1/ws/v2/status/identity" URI Parameters (extension to the Command URL separated by /): N/A Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 109 Value: "Yes" (if "No" then element will not be output) moipfec MPEG Over IP FEC Supported Type: String Value: "Yes" (if "No" then element will not be output) Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 110 Value: "Yes" (if "No" then element will not be output) AVC Decode License Licensed for AVC decode Type: String Value: "Yes" (if "No" then element will not be output) Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 111 Value: 1..N (if 0 then element will not be output) Tuner Number of tuner licenses Type: String Value: 1..N (if 0 then element will not be output) Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 112 Licensed for audio 3 and 4 output Type: String Value: "1" (if "0" then element will not be output) Input example (request default XML format): curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/identity" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 113 "feature": "Tuner", "enabled": "3", "feature": "DVB_S2", "enabled": "1", "feature": "AVC_Decode", "enabled": "1", "feature": "HEVC_Decode", "enabled": "1", "feature": "HD_Output", "enabled": "1", "feature": "Full_HD_Output", "enabled": "1", "feature": "AUD3_4", "enabled": "1" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 114: Device Status Command
Reads and returns current value of power status device items for all populated card slots. about Reads and returns current value of about specific (uncategorized) device items. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 115: About Status Command
(when Argument(s) are specified) clear Clears the life reset counter (liferstclr) in the relevant device/about output field. Requires the POST HTTP Method and only valid when specified after …/ws/v2/status/device/about. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 116 Type: String Value: Maximum of 50 characters boardrev Board revision Type: String Value: Maximum of 50 characters fpgatype FPGA type Type: String Value: Maximum of 50 characters Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 117 Type : Integer Values: 0..N lifereset Lifetime number of resets Type : Integer Values: 0..N liferstclr Clearable count of number of resets Type : Integer Values: 0..N Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 118 2\", available here:http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html", "about7": "<br>You can see the complete 3rd party open source licensing information at http://www.cisco.com/go/receivers_licensing. If you have any questions or problems accessing the link, please contact:external-opensource-requests@cisco.com." Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 119: Ecc Status Command
Return status of ecc (environmental characteristics and control) items. HTTP Method Access Type Read Access Level User, Admin Syntax GET "https://192.168.0.1/ws/v2/status/device/ecc" URI Parameters (extension to the Command URL separated by /): N/A Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 120 Value: 1 to number of slots in chassis Row number Type: Integer Value: 1 to number of rows on unit card Chassis card acronym Type: String Value: for example, "NTC" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 121 <displayOrderFlag>255</displayOrderFlag></ecc><ecc><slot>0</slot><row>4</row><card>NBP</card> <displayBoardName>System</displayBoardName><location>left fan</location><displayItemName>Left Fan</displayItemName> <type>Fan Status/Speed</type><value>11045 RPM</value><cardslot>NBP0</cardslot> <displayOrderFlag>253</displayOrderFlag></ecc><ecc><slot>0</slot><row>5</row><card>NBP</card> <displayBoardName>System</displayBoardName><location>right fan</location> <displayItemName>Right Fan</displayItemName><type>Fan Status/Speed</type><value>11430 RPM</value> <cardslot>NBP0</cardslot><displayOrderFlag>251</displayOrderFlag></ecc><ecc><slot>0</slot><row>6</row> <card>NBP</card><displayBoardName>System</displayBoardName><location>max temp</location> <displayItemName>Current Maximum Temp</displayItemName><type>Temperature</type><value>+71.4 C</value> <cardslot>NBP0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>7</row> <card>NTC</card><displayBoardName>Controller</displayBoardName><location>FPGA +1.0V</location> <displayItemName>FPGA +1.0V</displayItemName><type>Voltage</type><value>+0.97 V</value> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 122 <displayBoardName>Controller</displayBoardName><location>exhaust temp</location> <displayItemName>Rear Temp</displayItemName><type>Temperature</type><value>+41.2 C</value> <cardslot>NTC0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>23</row> <card>NTC</card><displayBoardName>Controller</displayBoardName><location>intake temp</location> <displayItemName>Front Temp</displayItemName><type>Temperature</type><value>+26.6 C</value><cardslot>NTC0</cardslot> <displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>24</row><card>NTC</card> <displayBoardName>Controller</displayBoardName><location>CPU temp</location><displayItemName>CPU temp</displayItemName> <type>Temperature</type><value>+42.2 C</value><cardslot>NTC0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc> <ecc><slot>1</slot><row>0</row><card>NFE</card><displayBoardName>Tuner</displayBoardName><location>FPGA +1.0V</location> <displayItemName>FPGA +1.0V</displayItemName><type>Voltage</type><value>+0.99 V</value><cardslot>NFE1</cardslot> <displayOrderFlag>2</displayOrderFlag></ecc><ecc><slot>1</slot><row>1</row><card>NFE</card> <displayBoardName>Tuner</displayBoardName><location>FPGA +1.8V</location><displayItemName>FPGA +1.8V</displayItemName> <type>Voltage</type><value>+1.79 V</value><cardslot>NFE1</cardslot><displayOrderFlag>2</displayOrderFlag></ecc> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 123 Input example (request JSON format, all ECC data): curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/device/ecc?js=1" Input example (request JSON format, ECC data only for slot 0, row 12): curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/device/ecc?slot=0&row=12&js=1" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 124: Ethernet Status Command
This is a key field for filtering output fields to a specified port. Ethernet port number Type: Integer Value: NTC Basic: 1 NTC MOIP: 1-3 NTC MS: 1-5 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 125 -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/device/eth?port=1&js=1" Expected output (values are for example purposes only): "device": { "eth": { "port": "1", "link": "Link Up", "speed": "1 Gbps", "duplex": "Full", "xover": "N/A" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 126: Power Status Command
Format output using JSON standard Type: exist Values: any value or empty (any of js=1, js, js=0, or js=9999 are valid) Omitting this argument formats the output by default in XML. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 127 "status": "Ok" "slot": "1", "good": "Yes", "displayBoardName": "Tuner", "status": "Ok" "slot": "2", "good": "Yes", "displayBoardName": "HEVC Proc1", "status": "Ok" "slot": "3", "good": "Yes", "displayBoardName": "Transcoder1", "status": "Ok" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 128: Alarms And Warnings
Table 105: Command Details Command Detail Description Command URL https://192.168.0.1/ws/v2/status/faults Command Information Returns all faults status details information. HTTP Method Access Type Read Access Level User, Admin Syntax GET "https://192.168.0.1/ws/v2/status/faults" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 129 "type": "Warning", "details": "ecc_reset_fpga_temp_warn", "setdatetim": "2017/03/03 23:06:27", "rstdatetim": "2017/03/03 23:06:48", "state": "Clear" "name": "Signal Status ", "type": "Alarm", "details": "RF1 Signal is lost", "setdatetim": "2017/03/21 22:25:11", "rstdatetim": "", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 130: Fault Actions Status Command
Omitting this argument formats the output by default in XML. Table 109: Output Field Descriptions Output Field Description clralarms Clear Alarm Faults clrwarns Clear Warnings Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 131: Faults Summary Status Command
Returns all faults status summary information. HTTP Method Access Type Read Access Level User, Admin Syntax GET "https://192.168.0.1/ws/v2/status/faults" URI Parameters (extension to the Command URL separated by /): N/A Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 132 Input example (read back all faults summary in JSON format): curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/summary?js=1" Expected output (values are for example purposes only): "faults": { "summary": { "actalarms": "1", "actwarns": "3", "clrfaults": "144" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 133: Faults Status Command
Fault Type Type: String Value: "Alarm", "Warning" name Fault name Type: String Value: Maximum of 24 characters details Fault description Type: String Value: Maximum of 64 characters Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 134 "name": "PMT warning ", "details": "PE 1 PMT is lost", "setsince": "2017/03/21 22:25:36" "type": "Warning", "name": "PAT warning ", "details": "RF1 PAT is lost", "setsince": "2017/03/21 22:25:36" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 135: Faults History Status Command
Values: any value or empty (any of js=1, js, js=0, or js=9999 are valid) Omitting this argument formats the output by default in XML. The following table lists the output fields: Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 136 </ record > < record > <type>Alarm</type> <name>PE 1: Loss of Input</name> <details>Loss of input detected</details> <setdatetim>2010/11/12 23:53:41</ondatetim> <rstdatetim> </rstdatetim> </ record > </ history > </faults> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 137: Disaster Recovery (D/R) Status Command
Table 119: Command Details Command Detail Description Command URL https://192.168.0.1/ws/v2/status/dr https://192.168.0.1/ws/v2/status/dr/<level_1_extension> Command Information This command can be used to read either all or a specific category of D/R details. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 138 Values: any value or empty (ie any of js=1 or js or js=0 or js=9999 are valid) Omitting this argument formats the output by default in XML. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 139: Disaster Recover (D/R) Global Status Command
Value: 5 … 255 siglost DR Signal Loss Timeout Vaule Type: Integer Value: 5 … 2160000 verify DR Verification Timeout Value Type: Integer Value: 10 … 255 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 140: Disaster Recover (D/R) Backup Tuning Status Command
All D/R backup tuning status. GET "https://192.168.0.1/ws/v2/status/dr/tuning" Single D/R backup tuning status, for example, GET "https://192.168.0.1/ws/v2/status/dr/tuning?csirec=1" URI Parameters (extension to the Command URL separated by /): N/A Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 141 D/R backup tuning FEC Mode. Type: String Values: "Auto”, "1/2", "2/3", "3/4", "5/6", "7/8", "8/9" rolloff D/R backup tuning RF rolloff. Type: String Values: ".20", ".25", ".35", "Auto" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 142 "csirec": "1", "fec": "AUTO", "ewflag": "N/A", "dnlkfreq": "3.53", "input": "RF2", "mod": "QPSK DVB-S", "netid": "1", "orbpos": "0.0", "pol": "Horiz", "symrate": "30.0", "rolloff": ".35", "source": "User", "rowstatus": "Yes" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 143: Disaster Recover (D/R) Backup Channels Status Command
Type: Integer Values: 1 … 16 bkpchan D/R backup channel number Type: Integer Values: 0 … 65535 rowstatus D/R backup channel status Type: String Values: "Yes", "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 144: Disaster Recovery (D/R) Origin Tuning Status Command
Table 129: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &): URI Argument Description input D/R origin tuning RF input Type: String Values: "RF1", "RF2", "RF3", "RF4" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 145 DR Orbital Position [Deg] Type: Float Values: 0.0 ... 360.0 DR Orbital Polarization Type: String Values: "Horiz", "Vert", "Circ_l", "Circ_r", "Auto" GET Examples Example 1: Retrieve D/R Orign tuning Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 146: Disaster Recover (D/R) Origin Channels Status Command
Table 131: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &): URI Argument Description peid (Key) D/R origin channel Program Entry ID Type: String Values: "PE1" … "PE16" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 147: Configuration Api
Command Information Allows inputs to be read or configured. HTTP Methods GET, POST Access Type Read/Write (with complex input data) Access Level User, Admin GET Syntax GET "https://192.168.0.1/ws/v2/service_cfg/input" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 148 -k -X POST -H "X-SESSION-ID: $token" --header "Content-type:application/xml" -d "<input><rf><port>1</port><act>Yes</act><dnlkfreq>12.31></dnlkfreq></rf><rf><port>2</port><dnlkfreq>3.40</dnlkfreq></rf></input>" "https://192.168.0.1/ws/v2/service_cfg/input" Expected output (values are for example purposes only) when validation of input parameter(s) pass: <?xml version="1.0" encoding="ISO-8859-1" ?> <response><code>10</code><result>success</result><message></message></response> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 149 <strm4sel>No</strm4sel><strm5sel>No</strm5sel><strm6sel>No</strm6sel><acqmode>Basic</acqmode> <netid>1</netid><freqmode>NIT</freqmode><svclstmode>Rigorous</svclstmode><niten>Yes</niten> <sdten>Yes</sdten><paten>Yes</paten></rf><rf><port>3</port><act>No</act><dnlkfreq>12.31</dnlkfreq> <symrate>30.0</symrate><fec>Auto</fec><mod>DVB-S2</mod><rolloff>Auto</rolloff><iq>Auto</iq> <pwr>Off</pwr><sel22khz>Off</sel22khz><lo1>5.15</lo1><lo2>0.0</lo2><xover>0.0</xover> <pol>Horizontal</pol><orbpos>0.0</orbpos><ewflag>N/A</ewflag><afcrange>3.0</afcrange> <strm1sel>No</strm1sel><strm2sel>No</strm2sel><strm3sel>No</strm3sel><strm4sel>No</strm4sel> <strm5sel>No</strm5sel><strm6sel>No</strm6sel><acqmode>Basic</acqmode><netid>1</netid> <freqmode>NIT</freqmode><svclstmode>Rigorous</svclstmode><niten>Yes</niten><sdten>Yes</sdten> <paten>Yes</paten></rf><rf><port>4</port><act>No</act><dnlkfreq>12.31</dnlkfreq> <symrate>30.0</symrate><fec>Auto</fec><mod>DVB-S2</mod><rolloff>Auto</rolloff><iq>Auto</iq> <pwr>Off</pwr><sel22khz>Off</sel22khz><lo1>5.15</lo1><lo2>0.0</lo2><xover>0.0</xover> <pol>Horizontal</pol><orbpos>0.0</orbpos><ewflag>N/A</ewflag><afcrange>3.0</afcrange> <strm1sel>No</strm1sel><strm2sel>No</strm2sel><strm3sel>No</strm3sel><strm4sel>No</strm4sel> <strm5sel>No</strm5sel><strm6sel>No</strm6sel><acqmode>Basic</acqmode><netid>1</netid> <freqmode>NIT</freqmode><svclstmode>Rigorous</svclstmode><niten>Yes</niten><sdten>Yes</sdten> <paten>Yes</paten></rf><asi><port>1</port><act>No</act><acqmode>Basic</acqmode><netid>1</netid> <freqmode>User Cfg</freqmode><svclstmode>Rigorous</svclstmode><niten>No</niten><sdten>Yes</sdten> <paten>Yes</paten></asi><moip><port>1</port><act>No</act><ipmode>SW Map</ipmode> <fecmode>None</fecmode><usemcast>Yes</usemcast><mcastaddr>225.1.1.1</mcastaddr> <tsdestport>49152</tsdestport><feccolport>49154</feccolport><fecrowport>49156</fecrowport> <usrsrcaddr>Yes</usrsrcaddr><srcfltmode>None</srcfltmode><dejalg>VBR</dejalg><acqmode>Basic</acqmode> <netid>1</netid><freqmode>User Cfg</freqmode><svclstmode>Rigorous</svclstmode><niten>No</niten> <sdten>Yes</sdten><paten>Yes</paten></moip></input> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 150: Rf Input Configuration Command
Since some parameters may have spaces or forward slashes or other reserved URL characters in them. We recommend that the D9800 web GUI, and other similar implementations, pass the full URL string through a safe-url character converter before issuing the command.
Page 151 Version 1.x Activate Input Type: String Values: "Yes" or "No" dnlkfreq Downlink Frequency Type: Float Values: 0.0 .. 15.0 symrate Symbol Rate Type: Float Values: 1.0 .. 45.0 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 152 Values: 0.0 … 15.0 LO Select 2 Type: Float Values: 0.0 … 15.0 xover Cross Over Frequency Type: Float Values: 0.0 … 15.0 Polarization Type: String Values: "Horizontal", "Vertical", "Auto" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 153 Select Stream 6 This is not applicable to Type: String Version 1.x Values: "Yes" or "No" acqmode PSI Acquisition Mode Type: String Values: "Auto", "Basic", "Custom" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 154 IP to the specific unit IP in use. This example changes the iq mode of RF 3 to Normal. curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/input/rf?port=3&verbose=1&iq=Normal" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 155 "afcrange": "3.0", "strm1sel": "Yes", "strm2sel": "No", "strm3sel": "No", "strm4sel": "No", "strm5sel": "No", "strm6sel": "No", "acqmode": "Basic", "netid": "1", "freqmode": "NIT", "svclstmode": "Rigorous", "niten": "No", "sdten": "Yes", "paten": "Yes" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 156 Client software must always first check HTTP return code. Re-check that URI parameters portion of the command (the part before the ?) is correctly input In the above example, /inputrf should be /input/rf. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 157: Asi Input Configuration Command
URI Parameters (extension to the Command URL separated by /): N/A Setting Parameters using command line arguments are limited to maximum of 26 arguments after Note the ?. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 158 PSI Acquisition Mode Type: String Values: "Auto", "Basic", "Custom" netid Network Identifier Type: Integer Values: 0 … 65535 freqmode Frequency Tuning Mode Type: String Values: "NIT", "User Cfg" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 159 The following example assumes that the user has successfully logged onto the unit, received the session id and set it to the variable token. In addition, it is assumed that the IP of the unit is 192.168.0.1. You must Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 160 In GET URIs only, the port argument must contain a value for the port, all other arguments do not contain values. curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/input/asi?port=1&acqmode" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 161: Moip Input Configuration Command
Command Information Allows MOIP tuning input settings to be read or configured. HTTP Methods GET, POST Access Type Read/Write (with complex input data) Access Level User, Admin Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 162 Type: String Values: "SW Map" or "UserCfg" fecmode FEC mechanism. Type: String Values: "None", "1D", or "2D" usemcast Use multicast address. Type: String Values: "Yes" or "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 163 Values: "Yes" , "No" pcrlostrig Redundancy Trigger on PCR Loss. Type: String Values: "Yes" , "No" pmtlostrig Redundancy Trigger on PMT Loss. Type: String Values: "Yes" , "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 164 • Values : "Rigorous", "Relaxed" Service List Mode (Version 2.50 and earlier) • Type : String • Values : "Rigorous", "Degraded" niten Enable NIT reception. Type: String Values: "Yes", "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 165 Values: "Add” (R/W), "Delete" (R/W), "Active" (RO), "Inactive" (RO) Output Fields: Output fields returned in GET results are the same names used for the possible arguments for this command. POST Examples: Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 166 "usemcast": "Yes", "mcastaddr": "225.1.1.1", "tsdestport": "49152", "feccolport": "49154", "fecrowport": "49156", "usrsrcaddr": "Yes", "srcfltmode": "None", "dejalg": "VBR", "acqmode": "Basic", "netid": "1", "freqmode": "NIT", "svclstmode": "Rigorous", "niten": "No", "sdten": "Yes", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 167 -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/input/moip?stream=1&paten&sdten&freqmode&niten" If successful, the return body will be: "input": { "moip": { "stream": "1", "freqmode": "NIT", "niten": "Yes", "paten": "Yes", "sdten": "Yes" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 168: Moip Input Source Filters Configuration Command
Filter slot to be configured Type: Integer Values: 1 to 8 IP Address Type : String Values : IP address in the dot format, for example, 192.168.0.1 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 169 Status: 200 Content-type: application/json "srcfilter": { "record": [ "idx": "1", "ip": "0.0.0.0", "oper": "Inactive" "idx": "2", "ip": "0.0.0.0", "oper": "Inactive" "idx": "3", "ip": "0.0.0.0", "oper": "Inactive" "idx": "4", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 170: Moip Input Source Select Configuration Command
Access Level User, Admin GET Syntax GET "https://192.168.0.1/ws/v2/service_cfg/input/moip/srcselect", or GET "https://192.168.0.1/ws/v2/service_cfg/input/moip/srcselect? stream=[stream#]&idx=[index#]" POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/input/moip/srcselect? stream=[stream#]&dat1srcaddr=10.10.10.10..." URI Parameters (extension to the Command URL separated by /): N/A Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 171 Value: "Yes", "No" data2avail IP is present in the DATA2 stream. Type: String Value: "Yes", "No" data2Enabled Allow DATA2 to be selected or not. Type: String Value: "Yes", "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 172 Value: IP address in the dot format, for example, 192.168.0.1 dat2srcaddr Set the IP address to lock from DATA2. Type: String Value: IP address in the dot format, for example, 192.168.0.1 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 173 "idx": "1", "ip": "0.0.0.0", "data1sel": "No", "data1avail": "No", "data1Enabled": "No", "data2sel": "No", "data2avail": "No", "data2Enabled": "No", "data3sel": "No", "data3avail": "No", "data3Enabled": "No", "data4sel": "No", "data4avail": "No", "data4Enabled": "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 174: Abr Input Configuration Command
Table 146: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &): URI Argument Description stream (Key) Multi Input Stream ID Type: Integer Values: 1..32 Activate Input Type: String Values: "Yes" or "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 175 • Type : String • Values : "Rigorous", "Degraded" baten Enable BAT Reception Type: String Values: "Yes", "No" niten Enable NIT Reception Type: String Values: "Yes", "No” Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 176 The following example assumes that the user has successfully logged onto the unit, received the session id, and set it to the variable token. In addition, it is assumed that the IP of the unit is 192.168.0.1. You must Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 177 IP to the specific unit IP in use. The following example retrieves one specific parameter value, camode, from the ABR settings for ABR stream 2. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 178: Zixi Input Configuration Command
Command Information Allows ZIXI input settings to be read or configured. HTTP Methods GET, POST Access Type Read/Write (with complex input data) Access Level User, Admin Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 179 Type: String Values: "Basic", "Auto", "Custom","FixPID" camode Select how programs that are marked as encrypted (and can not be decrypted) are handled. Type: String Values: "Std", "Open" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 180 Enable SDT Reception Type: String Values: "Yes", "No" paten Enable PAT Reception Type: String Values: "Yes", "No" Name (RO) ZIXI settings name Type: String Value: Up to 12 characters Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 181 Value: Up to 64 characters redmode Redundancy Mode Type: String Values: "Yes", "No" redsource Redundancy Backup ZIXI input source such as a URL Type: String Value: Up to 200 characters Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 182 Forward Error Correction Maximum Jitter Type: Integer Values: 0 … 10000 fecstufnul Forward Error Correction Stuff Null Type: String Values: "Yes", "No" latmode Latency Mode Type: String Values: "Static", "Increasing", "Dynamic" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 183 If successful, the return body will be: "input": { "zixi": { "stream": "2", "act": "Yes", "netid": "1", "acqmode": "Auto", "camode": "Std", "inputsel": "UserCfg", "freqmode": "User Cfg", "svclstmode": "Rigorous", "baten": "No", "niten": "No", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 184 -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/input/zixi?stream=2&camode&sdten&paten&niten&js =1" If successful, the return body will be: "input": { "zixi": { "stream": "1", "camode": "Std", "niten": "No", "paten": "Yes", "sdten": "Yes" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 185: Pe Configuration Command
Channel Number to be configured on this Program Entry Type: Integer No value required on GET (but may be used as filter for requested output, eg &chn&…) POST Values: 0 .. 65535 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 186 Use to display PE information in the format of XML or JSON, which is based on input parameters. Input (GET all PE Info and request default XML format output): curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/service_cfg/pe" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 187 <?xml version="1.0" encoding="ISO-8859-1" ?> <pe> <record><peid>1</peid><chn>802</chn><inp>RF1</inp></record> </pe> Input (GET single PE peid and chn info only and request JSON format output): curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/service_cfg/pe?peid=1&chn&js=1" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 188 -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https:// 192.168.0.1/ws/v2/service_cfg/pe?peid=1&chn=41" Expected output (values are for example purposes only): "response": { "code": "10", "result": "success", "message": "" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 189: Output Configuration Command
ASI, ASI1, or ASI2 Next Level Name Description mode Output Mode Type: String Values: "No Output", "Passthrough", "Service Channels Only", "Map Passthrough", "Map Service Channels Only", "Transcoding" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 190 Stream) action PE Action Type: String Values: "Drop", "Pass", "Map", "XCode" pmtpid Output PMT PID Type: Integer Values: 0..8191 outchan Output Channel Number Type: Integer Values: 0..65535 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 191 FEC arrangement : Block-aligned (0) or Non Block-aligned Type: String Values: "Block Aligned", "Non-Block Aligned" tpperframe Set the number of transport packets to be sent per IP packet Type: Integer Value: 1..7 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 192 (multi-stream), 1..16 (single-stream) action PE Action Type: String Values: "Drop", "Pass", "Map", "XCode" pmtpid Output PMT PID Type: Integer Values: 0..8191 outchan Output Channel Number Type: Integer Values: 0..65535 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 193 Values: 0..255 src_port Source UDP Port Type: Integer Values: 0..65534 src_port = 0 means use default UDP port ann_type Announce Type Type: String Values: "None", "RFC 2327" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 194 Values: 1..20 fec_row Fec Rows Depth Type: Integer Values: 4..20 fec_colport FEC Columns UDP Port Type: Integer Values: 1..65534 fec_rowport FEC Rows UDP Port Type: Integer Values: 1..65534 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 195 <pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE8</peid><action>Pass</action> <pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE9</peid><action>Pass</action> <pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE10</peid><action>Pass</action> <pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE11</peid><action>Pass</action> <pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE12</peid><action>Pass</action> <pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE13</peid><action>Pass</action> <pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE14</peid><action>Pass</action> <pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE15</peid><action>Pass</action> <pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE16</peid><action>Pass</action> <pmtpid>8191</pmtpid><outchan>0</outchan></pe></asi><moip><mode>Service Channels Only</mode> <dscrmode>Descrambled</dscrmode><ratemode>User</ratemode><rate>68.5</rate> <insertnul>Yes</insertnul><mcastip>224.2.127.254</mcastip><destport>9875</destport> <fecscheme>Block Aligned</fecscheme><tpperframe>7</tpperframe> <redunmode>Backup: First Port</redunmode><redundir>Revertive</redundir> <redundelfwd>0</redundelfwd><redundelbck>1</redundelbck><pe><peid>PE1</peid> <action>Pass</action><pmtpid>5801</pmtpid><outchan>801</outchan></pe><pe> <peid>PE2</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan> </pe><pe><peid>PE3</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan> </pe><pe><peid>PE4</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan> </pe><pe><peid>PE5</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan> </pe><pe><peid>PE6</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan> </pe><pe><peid>PE7</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 196: Asi Global Output Configuration Command
Or, alternatively: Single-stream (NTC Basic, NTC MOIP), asi output port (only one exists): https://192.168.0.1/ws/v2/service_cfg/output/asi2 Multi-stream unit, asi output port 1: https://192.168.0.1/ws/v2/service_cfg/output/asi1 Multi-stream unit, asi output port 2: https://192.168.0.1/ws/v2/service_cfg/output/asi2 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 197 Output Mode Type: String Values: "No Output", "Passthrough", "Service Channels Only", "Map Passthrough", "Map Service Channels Only", "Transcoding" dscrmode Output Descrambling Mode Type: String Values: "Descrambled", "Scrambled" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 198 Get, on page 3, in the URL input, the space in STRING should be replaced by %20, for example: "https://192.168.0.1/ws/v2/service_cfg/output/asi?mode=Map%20Service%20Channels%20Only. POST Examples: Example 1: Set Various Output ASI Parameters Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 199 IP to the specific unit IP in use. This example returns the specific ASI Output setting of the descrambled mode (dscrmode) and Output Mode (mode) parameters. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 200: Moip Global Output Configuration Command
Allows set or get of MOIP output parameters. HTTP Methods GET, POST Access Type Read, Write Access Level User, Admin GET Syntax One of the following: GET "https://192.168.0.1/ws/v2/service_cfg/output/moip", GET "https://192.168.0.1/ws/v2/service_cfg/output/moip1", or GET "https://192.168.0.1/ws/v2/service_cfg/output/moip2?mode" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 201 Output Descrambling Mode Type: String Values: "Descrambled", "Scrambled" ratemode Output Rate Control Mode Type: String Value: "User" rate Output Rate Type: Float Values: 0.0 ….. 206.0 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 202 Delay before switching from Main to Backup port, in ms Type: Integer Value: 0..10000 redundelbck Delay before switching from Backup to Main port, in sec Type: Integer Value: 0..120 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 203 Scrambled instead of Descrambled: curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/output/moip2?dscrmode=Scrambled&ratemode=User" GET Examples: Example 2: Get full table of MOIP Output Settings Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 204 -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/output/moip?&dscrmode&mode" If successful, the return body will be: "output": { "moip": { "dscrmode": "Descrambled", "mode": "No Output" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 205: Dpm Asi/Moip Pe Output Configuration Command
Command Information Allows set or get of ASI or MOIP DPM PE output parameters. HTTP Methods GET, POST Access Type Read, Write Access Level User, Admin Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 206 Table 164: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &) URI Argument Description peid (Key) Program Entry Identifier Type: String XML/JSON Format Value: PE1…PE32, P1A…P16A Command Line Input Value: 1…32 (multi-stream), 1..16 (single-stream) Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 207 -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/output/asi/pe?peid=1&action=Pass&outchan=105" If successful, the return body will be: "response": { "code": "10", "result": "success", "message": "" GET Examples: Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 208 IP to the specific unit IP in use. This example returns the pmtpid and output channel of the DPM ASI Output Settings for a specific PE, in this case PE 1. curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/output/asi/pe?peid=1&pmtpid&outchan" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 209: Moip Output Stream Configuration
HTTP Methods GET, POST Access Type Read, Write Access Level User, Admin GET Syntax Singlestream NTC MOIP unit: GET "https://192.168.0.1/ws/v2/service_cfg/output/moip/ipo" GET "https://192.168.0.1/ws/v2/service_cfg/output/moip1/ipo" Multistream unit: GET "https://192.168.0.1/ws/v2/service_cfg/output/moip1/ipo" GET "https://192.168.0.1/ws/v2/service_cfg/output/moip2/ipo" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 210 Values: "RTP", "UDP" dest_ip Destination IP Address Type: String Values: IP address in the dot format, for example, 192.168.0.1 dest_port Destination IP Port Type: Integer Values: 1..65534 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 211 Values: "None", "1D","2D" fec_col Fec Columns Depth Type: Integer Values: 1..20 fec_row Fec Rows Depth Type: Integer Values: 4..20 fec_colport FEC Columns UDP Port Type: Integer Values: 1..65534 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 212 "ann_src": "User String", "ann_title": "Cisco Default SAP1_1", "fec_mode": "2D", "fec_col": "4", "fec_row": "10", "fec_colport": "49154", "fec_rowport": "49156" "ipoid": "2", "iporate": "18.0", "encaps": "RTP", "dest_ip": "168.0.169.34", "dest_port": "49152", "toc": "0", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 213 -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/output/moip/ipo?ipoid=1&dest_ip&dest_port" If successful, the return body will be: "output": { "moip": { "ipo": { "ipoid": "1", "dest_ip": "225.1.1.101", "dest_port": "49152" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 214: Decode Configuration Commands
Table 168: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &) URI Argument Description decoder Decoder Identifier Type: String Values: "Video", "Audio1", "Audio2", "Audio3", "Audio4", "VBI", "Data","MPE1", "MPE2", "MPE3", "MPE4", "MPE5", "STT", "DPI" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 215 -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/decode/ctrl?&decoder=Video" If successful, the return body will look like: "decode": { "ctrl": { "decoder": "Video", "enable": "Yes" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 216: Video Decode Configuration Command
Note and shown in the output return body data in software Version 2.27 or below. The client software should ignore and not use or display this field. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 217 IP to the specific unit IP in use. This example will retrieve the PV Output Format and SD Video Output Format. curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/decode/video?&sdformat&pvformat" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 218: Aspect Ratio (Ar) Decode Configuration Command
Table 172: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &) URI Argument Description sdar Standard Definition Aspect Ratio Type : String Value: "4:3", "16:9" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 219 IP to the specific unit IP in use. The following example retrieves the Standard Definition Aspect Ratio and the Selected Aspect Ratio Conversion. curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/decode/ar?&arselect&sdar" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 220: Subtitle (Subt) Decode Configuration Command
Table 174: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &) URI Argument Description opmode Operational Mode of Subtitle Type: String Value: "Off", "On", "Imitext", "DVB" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 221 -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/decode/subt?imitext=Standard&foregndcol=Auto" If successful, the return body will look like: "response": { "code": "10", "result": "success", "message": "" GET Examples: Example 2: Retrieve the full Subtitle Settings Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 222: Closed Caption (Cc) Decode Configuration Command
Allows set or get of closed caption decode settings parameters. HTTP Methods GET, POST Access Type Read, Write Access Level User, Admin GET Syntax One of the following: GET "https://192.168.0.1/ws/v2/service_cfg/decode/cc", or GET "https://192.168.0.1/ws/v2/service_cfg/decode/cc?prefccmode" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 223 IP to the specific unit IP in use. curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/decode/cc" If successful, the return body will look like: "decode": { "cc": { "prefccmode": "Auto" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 224: Audio Decode Configuration Command
Audio device instances. Other filter parameters will currently be ignored when specified along with the GET device=all key for this command. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 225 Value: "Stereo", "Mixed", "L-MONO", "R-MONO" ac3comp AC3 Compression Type: String Value: "RF Mode", "Line Mode", "Custom 1", "Custom 0" left Left volume Type : Float Value: -6.0 .. 6.0 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 226 If successful, the return body will look like: "response": { "code": "10", "result": "success", "message": "" GET Examples: Example 2: Retrieve the full Audio Settings for a specific device Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 227 IP to the specific unit IP in use. This example is intended to be run only after Example 3 and sets the langmenu option to Language%20List. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 228 The device=all must be specified in the URI for Language%20Entry case when the existing value was Note previously set to PMT%20Order because that setting value cannot be combined with any other "Language%20List" or "Language%20Entry" option value for other devices. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 229 -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/decode/audio?device=2&langmenu=Language%20Entry" If successful, the return body will be: "response": { "code": "10", "result": "success", "message": "" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 230: Audio Device Sdi Preference Setting Command
Table 180: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &) URI Argument Description device (key) Audio Device Instance Type: Integer Value: 1 .. 2 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 231 URI. curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID:$token" -k "https://192.168.0.1/ws/v2/service_cfg/decode/audio?device=1&sdiindex=1&sdipref" If successful, the return body will look like: "decode": { "audio": { "sdipref": "Compressed" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 232: Audio Device Sdi1 Or Sdi2 Output Settings Command
Table 182: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &) URI Argument Description Sdi1output SDI1 Output Mode Type: String Value: "PVO", "SD" Sdi2output SDI2 Output Mode Type: String Value: "PVO", "SD" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 233: Audio St302 Device Settings Command
26 arguments after the ?. URI Parameters (extension to the Command URL separated by /): N/A URI Query/Set Arguments (possible fields and values preceded by ? and separated by &): Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 234 -X GET -i -H "Accept: application/json" -H "X-SESSION-ID:$token" -k "https://192.168.0.1/ws/v2/service_cfg/decode/aud_302" If successful, the return body will look like: "decode": { "aud_st302": { "device": "1", "streamid": "2" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 235: Sdi Decode Configuration Command
SDI Audio: GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdiaudio", or GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdiaudio? group=1&slot=1&sdiindex=1&decoder" SDI VANC (Vertical Ancillary Data): GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdivanc", or GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdivanc? serviceid=AFD&sdiindex=1&enable" SDI VII: GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdivii", or GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdivii? sdiindex=1" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 236 (key) Audio Group Type: Integer Value: 1..4 slot (key) Group Slot Type: Integer Value: 1/2, 3/4 sdiindex (key) Audio SDI Device Instance Type: Integer Value: 1..2 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 237 Table 188: SDIVII URI Query/Set Arguments (possible fields and values preceded by ? and separated by &) SDI VII Argument Description sdiindex (key) VII SDI Device Instance Type: Integer Value: 1..2 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 238: Hdmi Decode Configuration Command
Single HDMI Video setting: Setting parameters using POST "https://192.168.0.1/ws/v2/service_cfg/decode/hdmi? command line arguments is hdmiindex=1&colorspace=YCbCr420" limited to maximum of 26 Multiple HDMI Video settings: arguments after the ?. POST "https://192.168.0.1/ws/v2/service_cfg/decode/hdmi? hdmiindex=1&colorspace=YCbCr422&colorrange=Full&eotf=HDR" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 239 Type: String Value: "Auto", "SMPTE-2084", "HDR", “SDR” displaypref HDMI Display Preference Type: String Value: "Auto", "SDI1", "SDI2", "HDMI" forceedid HDMI Force EDID selector Type: String Value: "Yes", "No" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 240: Advanced Audio Decode Configuration Command
HDMI Audio Setting for specified HDMI instance/pair/slot: GET "https://192.168.0.1/ws/v2/service_cfg/decode/ advaudio_hdmi?hdmiindex=1&pair=1&slot=1&decoder=2" SDI Advanced Audio Settings All SDI Audio Settings: GET "https://192.168.0.1/ws/v2/service_cfg/decode/advaudio_sdi" Audio Setting for specified SDI instance/group/slot: GET "https://192.168.0.1/ws/v2/service_cfg/decode/ advaudio_sdi?sdiindex=1&group=1&slot=1" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 241 Table 193: HDMI Settings URI Query/Set Arguments (possible fields and values preceded by ? and separated by &) HDMI Settings URI Argument Description hdmiindex (key) HDMI Device Instance Type: Integer Value: 1..2 pair (key) PCM Pair Type: Integer Value: 1..4 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 242 Value: "PCM Pair 1", "PCM Pair 2", "PCM Pair 3", "PCM Pair 4", "Compressed Audio 1", "Compressed Audio 2", "Compressed Audio 3", "Compressed Audio 4", "Off" The space character must be replaced with ‘%20’ in Note POST command. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 243: Vbi Configuration Command
Table 196: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &) URI Argument Description wstinstart WST Line Start Type: String Value: "Standard", "Early" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 244 -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/decode/vbi?vitcdropfr=Enable&vitcmode=Suppress" If successful, the following is an example of the return body: "response": { "code": "10", "result": "success", "message": "" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 245: Ca (Conditonal Access) Configuration Commands
Table 197: Command Details Command Detail Description Command URL https://192.168.0.1/ws/v2/service_cfg/ca/pvu Command Information Allows set or get of PowerVu Conditonal Access configuration. HTTP Methods GET, POST Access Type Read, Write Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 246 IP to the specific unit IP in use. The following example sets the commode to Std. curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/ca/pvu?&camode=Std" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 247: Biss Ca Configuration Command
Allows set or get of BISS Conditional Access configuration. HTTP Methods GET, POST Access Type Read, Write Access Level User, Admin GET Syntax All BISS Settings: GET "https://192.168.0.1/ws/v2/service_cfg/ca/biss" Single BISS Setting: GET "https://192.168.0.1/ws/v2/service_cfg/ca/biss?bissmode" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 248 Value: String with 16 characters modeinjid Mode-e Injected ID (Write Only) Type: String Value: String with 14 characters POST Examples: Example 1: Set various BISS Setting Arguments Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 249: Ci (Common Interface) Configuration Command
Command URL https://192.168.0.1/ws/v2/service_cfg/ca/ci Command Information Allows set or get of Common Interface (CI) Conditional Access configuration. HTTP Methods GET, POST Access Type Read, Write Access Level User, Admin Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 250 Transport ID/ Original Network ID check Type: String Value: "Enable", "Disable" tsid Transport ID Type: Integer Value: 0..65535 onetid Original Network Identifier Type: Integer Value: 0..65535 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 251: Pe Ca Configuration Command
Command Detail Description Command URL https://192.168.0.1/ws/v2/service_cfg/ca/pe Command Information Allows set or get of Conditional Access Program Entry (PE) configuration. HTTP Methods GET, POST Access Type Read, Write Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 252 Value: "TOP", "BOTTOM", "AUTO" cislot CAM Slot for Program Entries other the PE1 Type: String Value: "TOP", "BOTTOM" POST Examples: Example 1: Set various PE Setting Arguments Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 253: Cicomp Ca Configuration Command
Command URL https://192.168.0.1/ws/v2/service_cfg/ca/cicomp Command Information Allows set or get of Conditional Access CI Component level configuration. HTTP Methods GET, POST Access Type Read, Write Access Level User, Admin Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 254 CI Component Mode Type: String Value: "PID", "STREAM" CI Component PID Type: Integer Value: 0..8192 strmcat Stream Category Type: String Value: "VID", "AUD", "SUBT", "TTX", "USER" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 255 "mode": "PID", "pid": "8192", "strmcat": "USER", "strmval": "0", "strminst": "1", "oper": "Inactive" POST Examples: Note POST requires previous knowledge of target row (idx – key) from GET command. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 256: Transcoding Configuration Commands
"cicomp": { "idx": "5", "peid": "1", "mode": "STREAM", "pid": "8192", "strmcat": "USER", "strmval": "0", "strminst": "1", "oper": "Inactive" Transcoding Configuration Commands This section lists the transcoding configuration commands. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 257: Hd Transcode Configuration Command
Values: 1..N (number of transcoders depends on model and installed options) vres Select the video format of the transcoded output Type: String Values: "Auto", "HD Output", "SD Output" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 258 The following example assumes that the user has successfully logged onto the unit, received the session id and set it to the variable token. In addition, it is assumed that the IP of the unit is 192.168.0.1. You must Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 259 In GET URIs, only the index argument must contain a value for the transcoder, all other arguments do not contain values. curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/transcode/hd?index=5&bitrate" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 260: Sd Transcode Configuration Command
Command Detail Description Command URL https://192.168.0.1/ws/v2/service_cfg/transcode/sd Command Information Allows set or get of SD transcode configuration. HTTP Methods GET, POST Access Type Read, Write Access Level User, Admin Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 261 Select the output horizontal resolution for HD video output Type: String Values: "Full", "3/4" bitratemode Select whether the output bit rate is constant or variable for HD video output Type: String Values: "CBR", "VBR" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 262 Select which content to place in the second Closed Captioning Packet for SD video output Type: String Values: "None", "CEA 708", "SCTE-20" POST Examples: Example 1: Changing one SD Transcoding Parameter Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 263 The following example assumes that the user has successfully logged onto the unit, received the session id and set it to the variable token. In addition, it is assumed that the IP of the unit is 192.168.0.1. You must Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 264 -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/transcode/sd?index=5&bitratemode&bitrate&pulldown32" If successful, the following is an example of the return body: "transcode": { "sd": { "index": "5", "bitrate": "14.0", "bitratemode": "CBR", "pulldown32": "Disabled" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 265: Subt (Subtitle) Transcode Configuration Command
Transcoder to be configured Type: Integer Values: 1..N (number of transcoders depends on model and installed options) opmode Operational Mode of Subtitle Type: String Value: "Off", "On", "Imitext", "DVB" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 266 -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/transcode/ subt?index=5&opmode=Imitext" If successful, the following is an example of the return body: "response": { "code": "10", "result": "success", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 267 The user must always specify the port number in the URI followed by the URI argument the user wishes Note to retrieve. This example retrieves the langmenu from transcoder 5. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 268: User Configuration Command
"langentry": "eng", "langmenu": "PMT Order" User Configuration Command Table 213: Command Details Command Detail Description Command URL https://192.168.0.1/ws/v2/service_cfg/user Command Information Allows set or get of user configuration. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 269 These elements do not currently support the use of JSON. Note curl -k -X POST -H "X-SESSION-ID:$token" "https://192.168.0.1/ws/v2/service_cfg/user?lossofinput=No%20Output" If successful, the following is an example of the return body: <?xml version="1.0" encoding="ISO-8859-1" ?> <response><code>10</code><result>success</result><message></message></response> GET Examples: Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 270: Disaster Recovery (D/R) Configuration Api
HTTP Methods GET, POST Access Type Read, Write Access Level User, Admin GET Syntax All D/R global Settings GET "https://192.168.0.1/ws/v2/service_cfg/dr/global" Single D/R global Setting, for example, GET "https://192.168.0.1/ws/v2/service_cfg/dr/global?enable" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 271 -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/dr/global?&siglock=40" If successful, the return body will be: "response": { "code": "10", "result": "success", "message": "" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 272: Disaster Recovery (D/R) Backup Transport Configuration Command
Access Level User, Admin GET Syntax All D/R backup tuning Settings GET "https://192.168.0.1/ws/v2/service_cfg/dr/tuning" Single D/R backup tuning Setting, for example, GET "https://192.168.0.1/ws/v2/service_cfg/dr/tuning?csirec=1", GET "https://192.168.0.1/ws/v2/service_cfg/dr/tuning?csirec=2", or GET "https://192.168.0.1/ws/v2/service_cfg/dr/tuning?csirec=3" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 273 Values: 0.0 … 15.0 symrate D/R backup tuning RF symbol rate Type: Float Values: 1.0 … 45.0 D/R backup tuning RF modulation system Type: String Values: "DVB-S", "DVB-S2" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 274 "input": "RF2", "mod": "DVB-S", "netid": "1", "symrate": "30.0", "rolloff": ".35", "rowstatus": "Active" "csirec": "2", "fec": "Auto", "dnlkfreq": "3.449", "input": "RF1", "mod": "DVB-S", "netid": "1", "symrate": "28.3465", "rolloff": ".35", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 275: Disaster Recovery (D/R) Backup Channels Configuration Command
URI Parameters (extension to the Command URL separated by /): N/A For POST, the value for the argument seen below must be specified, but for GET, there are no values Note for arguments. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 276 -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/dr/channels" If successful, the return body will be: "dr": { "channels": [ "peid": "PE1", "csirec": "1", "bkpchan": "201", "peid": "PE1", "csirec": "2", "bkpchan": "0", "peid": "PE1", Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 277: Device Control Commands
Single Ethernet port item: port numbers have +1 added. As a result, the Management Port is GET "https://192.168.0.1/ws/v2/device_ctl/eth/port? portid=1&ipv4addr" port1, DATA1 is port2, and DATA2 is port3, and so on. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 278 Notes: 1 - Management Port 2 – DATA1 3 – DATA2 4 – DATA3 5 – DATA4 name (Read-Only) Ethernet Port Name Type: string Value: control, data1, data2 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 279 Expected output (values are for example purposes only): <?xml version="1.0" encoding="ISO-8859-1" ?> <devicectl> <eth> <port> <portid>1</portid> <name>Management</name> <ipver>IPv4</ipver> <ipv4addr>192.168.0.1</ipv4addr> <ipv4mask>24</ipv4mask> <ipv4defgw>192.168.0.254</ipv4defgw> <phymode>Auto</phymode> </port> <port> <portid>2</portid> <name>Data1</name> <ipver>IPv4</ipver> <ipv4addr>192.168.1.2</ipv4addr> <ipv4mask>24</ipv4mask> <ipv4defgw>192.168.1.254</ipv4defgw> <phymode>Auto</phymode> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 280 If successful, the following is an example of the return body: "response": { "code": "10", "result": "success", "message": "" Data Port: curl -k -X POST -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/device_ctl/eth/port?portid=2&ipv4addr=192.131.244.7&js=1" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 281: Version Selection Device Control Command
Table 225: Level_1 URI Parameters (extension to the Command URL separated by /) URI Parameter Description verselect Version to be selected URI Query/Set Arguments below are only valid when this level URI parameter is used Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 282 Show all version info in XML: curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/device_ctl/ver" Expected output (values are for example purposes only): <?xml version="1.0" encoding="ISO-8859-1" ?> <devicectl><ver><verselect><idx>0</idx><name>1.10</name><reboot>No</reboot><erase>No</erase> </verselect><verselect><idx>1</idx><name>T2.25C1</name><reboot>No</reboot><erase>No</erase> </verselect><verselect><idx>2</idx><name>T2.25B7</name><reboot>No</reboot><erase>No</erase> </verselect><verselect><idx>3</idx><name></name><reboot>No</reboot><erase>No</erase></verselect> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 283 "name": "", "reboot": "No", "erase": "No" "idx": "8", "name": "", "reboot": "No", "erase": "No" POST Method Examples: Select a software version to run or delete the software version. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 284: Reset Device Control Command
Access Level User, Admin GET Syntax POST Syntax Factory Reset: Only HTTP data body is POST "https://192.168.0.1/ws/v2/device_ctl/reset/factory" supported. POST from Reboot: XML/JSON file is not supported. POST "https://192.168.0.1/ws/v2/device_ctl/reset/reboot" Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 285 If successful, the following is an example of the return body: "response": { "code": "10", "result": "success", "message": "" The system will reboot successfully to the same version (after about 1 minute). Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 286: Protocol Device Control
Table 231: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &) URI Argument Description http HTTP Protocol Control Type: String Value: Disable, HTTP, HTTPS snmp SNMP Protocol Control Type: String Value: Disable, Enable Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 287 1 Show all protocol control info in XML: curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/device_ctl/protocols" Expected output (values are for example purposes only): <?xml version="1.0" encoding="ISO-8859-1" ?> <devicectl><protocols><settings><http>HTTPS</http><snmp>Enable</snmp><igmp>Enable</igmp> <syslog>Syslog UDP</syslog><slogsrvip>0.0.0.0</slogsrvip><slogsrvprt>514</slogsrvprt> <mpe>Fwd None</mpe><idletimeout>0</idletimeout><globaldns>Enable</globaldns></settings> </protocols></devicectl> Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 288 -k -X POST -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/device_ctl/protocols?igmp=Disable&js=1" If successful, the return body will be: "response": { "code": "10", "result": "success", "message": "Success" And IGMP protocol will be disabled. Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 289: Download Device Control Settings
IP Diagnostics command may take up to 30 seconds, depending on status of the specified port and destination ip_address. To avoid blocking of the D9800 integrated applications, and to implement the Progress Bar feature on the web GUI, the required client software operation is a four phase approach: 1 Trigger a request for IP diagnostic.
Page 290 Expected output (for Success case which indicates only that IP Diag command was started): In XML: HTTP/1.1 200 OK Date: Mon, 26 Jun 2017 11:58:09 GMT Server: Hiawatha v9.14 Connection: keep-alive Transfer-Encoding: chunked Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 291 Date: Mon, 26 Jun 2017 12:00:15 GMT Server: Hiawatha v9.14 Connection: keep-alive Transfer-Encoding: chunked Status: 200 Content-type: application/json "response": { "code": "10", "result": "failure", "message": "failure to trigger request " Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 292: Ip Diagnostics Operation Status Command
<![CDATA[Item attribute: min(0), max(100), step size(1), unit()]]></HELP_STR_2> </ITEM></RECORD></TABLE></HDR> Expected output (example when ip diagnostics operation did not succeed): <?xml version="1.0" encoding="ISO-8859-1" ?><HDR><TABLE><RECORD><ITEM><ID>0x002D2600</ID><VALUE><![CDATA[Fail]]></VALUE> <NAME><![CDATA[OPERSTATUS]]></NAME><HELP_STR_1><![CDATA[Indicates whether the most recent Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 293 Expected output (example for Success case which indicates only that Diag Package Retrieval was completed): XML format: HTTP/1.1 200 OK Date: Mon, 26 Jun 2017 13:00:58 GMT Server: Hiawatha v9.14 Connection: keep-alive Transfer-Encoding: chunked Status: 200 Content-type: application/xml Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...
Page 294 -i -k -H "X-SESSION-ID: $token" "https://10.85.163.98/ws/v2/ip_diags/extra" HTTP/1.1 404 Not Found Date: Mon, 26 Jun 2017 13:06:33 GMT Server: Hiawatha v9.14 Connection: keep-alive Transfer-Encoding: chunked Status: 404 Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide...

Cisco D9800 Reference Manual

CHAPTER 1 Web Services API

CHAPTER 2 API Definitions

Quick Links

Related Manuals for Cisco D9800

Summary of Contents for Cisco D9800

Table of Contents